[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [21698] branches/blender2.5/blender: Python operators

Campbell Barton ideasman42 at gmail.com
Sun Jul 19 15:32:02 CEST 2009


Revision: 21698
          http://projects.blender.org/plugins/scmsvn/viewcvs.php?view=rev&root=bf-blender&revision=21698
Author:   campbellbarton
Date:     2009-07-19 15:32:02 +0200 (Sun, 19 Jul 2009)

Log Message:
-----------
Python operators
- simplified C operator API bpy.__ops__ since its wrapped by python now.
- needs the class to have an __idname__ rather then __name__ (like menus, headers)
- convert python names "console.exec" into blender names "CONSOLE_OT_exec" when registering (store the blender name as class.__idname_bl__, users scripters wont notice)
- bpy.props.props ???, removed

Modified Paths:
--------------
    branches/blender2.5/blender/release/io/export_ply.py
    branches/blender2.5/blender/release/ui/bpy_ops.py
    branches/blender2.5/blender/release/ui/space_console.py
    branches/blender2.5/blender/source/blender/editors/space_view3d/space_view3d.c
    branches/blender2.5/blender/source/blender/python/intern/bpy_operator.c
    branches/blender2.5/blender/source/blender/python/intern/bpy_operator_wrap.c
    branches/blender2.5/blender/source/blender/python/intern/bpy_rna.c
    branches/blender2.5/blender/source/blender/python/intern/bpy_util.c
    branches/blender2.5/blender/source/blender/python/intern/bpy_util.h

Modified: branches/blender2.5/blender/release/io/export_ply.py
===================================================================
--- branches/blender2.5/blender/release/io/export_ply.py	2009-07-19 13:06:18 UTC (rev 21697)
+++ branches/blender2.5/blender/release/io/export_ply.py	2009-07-19 13:32:02 UTC (rev 21698)
@@ -240,6 +240,7 @@
 	'''
 	Operator documentatuon text, will be used for the operator tooltip and python docs.
 	'''
+	__idname__ = "export.ply"
 	__label__ = "Export PLY"
 	
 	# List of operator properties, the attributes will be assigned

Modified: branches/blender2.5/blender/release/ui/bpy_ops.py
===================================================================
--- branches/blender2.5/blender/release/ui/bpy_ops.py	2009-07-19 13:06:18 UTC (rev 21697)
+++ branches/blender2.5/blender/release/ui/bpy_ops.py	2009-07-19 13:32:02 UTC (rev 21698)
@@ -1,8 +1,9 @@
-import bpy
+# for slightly faster access
+from bpy.__ops__ import add		as op_add
+from bpy.__ops__ import remove		as op_remove
+from bpy.__ops__ import dir		as op_dir
+from bpy.__ops__ import call		as op_call
 
-# This class is used for bpy.ops
-#
-
 class bpy_ops(object):
 	'''
 	Fake module like class.
@@ -10,10 +11,10 @@
 	 bpy.ops
 	'''
 	def add(self, pyop):
-		bpy.__ops__.add(pyop)
+		op_add(pyop)
 	
 	def remove(self, pyop):
-		bpy.__ops__.remove(pyop)
+		op_remove(pyop)
 	
 	def __getattr__(self, module):
 		'''
@@ -25,11 +26,8 @@
 		
 		submodules = set()
 		
-		for id_name in dir(bpy.__ops__):
+		for id_name in op_dir():
 			
-			if id_name.startswith('__'):
-				continue
-				
 			id_split = id_name.split('_OT_', 1)
 			
 			if len(id_split) == 2:
@@ -66,7 +64,7 @@
 		
 		module_upper = self.module.upper()
 		
-		for id_name in dir(bpy.__ops__):
+		for id_name in op_dir():
 			
 			if id_name.startswith('__'):
 				continue
@@ -96,12 +94,10 @@
 		id_name = self.module.upper() + '_OT_' + self.func
 		
 		# Get the operator from 
-		internal_op = getattr(bpy.__ops__, id_name)
+		return op_call(id_name, kw)
 		
-		# Call the op
-		return internal_op(**kw)
-		
 	def __repr__(self):
 		return "<function bpy.ops.%s.%s at 0x%x'>" % (self.module, self.func, id(self))
 
+import bpy
 bpy.ops = bpy_ops()

Modified: branches/blender2.5/blender/release/ui/space_console.py
===================================================================
--- branches/blender2.5/blender/release/ui/space_console.py	2009-07-19 13:06:18 UTC (rev 21697)
+++ branches/blender2.5/blender/release/ui/space_console.py	2009-07-19 13:32:02 UTC (rev 21698)
@@ -120,6 +120,7 @@
 	'''
 	Operator documentatuon text, will be used for the operator tooltip and python docs.
 	'''
+	__idname__ = "console.exec"
 	__label__ = "Console Execute"
 	__register__ = False
 	
@@ -396,6 +397,7 @@
 	'''
 	Operator documentatuon text, will be used for the operator tooltip and python docs.
 	'''
+	__idname__ = "console.autocomplete"
 	__label__ = "Console Autocomplete"
 	__register__ = False
 	

Modified: branches/blender2.5/blender/source/blender/editors/space_view3d/space_view3d.c
===================================================================
--- branches/blender2.5/blender/source/blender/editors/space_view3d/space_view3d.c	2009-07-19 13:06:18 UTC (rev 21697)
+++ branches/blender2.5/blender/source/blender/editors/space_view3d/space_view3d.c	2009-07-19 13:32:02 UTC (rev 21698)
@@ -52,6 +52,7 @@
 #include "ED_armature.h"
 #include "ED_space_api.h"
 #include "ED_screen.h"
+#include "ED_object.h"
 
 #include "BIF_gl.h"
 

Modified: branches/blender2.5/blender/source/blender/python/intern/bpy_operator.c
===================================================================
--- branches/blender2.5/blender/source/blender/python/intern/bpy_operator.c	2009-07-19 13:06:18 UTC (rev 21697)
+++ branches/blender2.5/blender/source/blender/python/intern/bpy_operator.c	2009-07-19 13:32:02 UTC (rev 21698)
@@ -23,65 +23,79 @@
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/* Note, this module is not to be used directly by the user.
+ * its accessed from blender with bpy.__ops__
+ * */
+
 #include "bpy_operator.h"
 #include "bpy_operator_wrap.h"
 #include "bpy_rna.h" /* for setting arg props only - pyrna_py_to_prop() */
 #include "bpy_compat.h"
 #include "bpy_util.h"
 
-//#include "blendef.h"
-#include "BLI_dynstr.h"
-
 #include "WM_api.h"
 #include "WM_types.h"
 
 #include "MEM_guardedalloc.h"
-//#include "BKE_idprop.h"
 #include "BKE_report.h"
 
-extern ListBase global_ops; /* evil, temp use */
 
-static PyObject *pyop_base_dir(PyObject *self);
-static PyObject *pyop_base_rna(PyObject *self, PyObject *pyname);
-static struct PyMethodDef pyop_base_methods[] = {
-	{"__dir__", (PyCFunction)pyop_base_dir, METH_NOARGS, ""},
-	{"__rna__", (PyCFunction)pyop_base_rna, METH_O, ""},
-	{"add", (PyCFunction)PYOP_wrap_add, METH_O, ""},
-	{"remove", (PyCFunction)PYOP_wrap_remove, METH_O, ""},
-	{NULL, NULL, 0, NULL}
-};
-
 /* 'self' stores the operator string */
-static PyObject *pyop_base_call( PyObject * self, PyObject * args,  PyObject * kw)
+static PyObject *pyop_call( PyObject * self, PyObject * args)
 {
 	wmOperatorType *ot;
 	int error_val = 0;
 	PointerRNA ptr;
 	
+	char *opname;
+	PyObject *kw= NULL;
+
 	// XXX Todo, work out a better solution for passing on context, could make a tuple from self and pack the name and Context into it...
 	bContext *C = BPy_GetContext();
 	
-	char *opname = _PyUnicode_AsString(self);
 
-	if (PyTuple_Size(args)) {
-		PyErr_SetString( PyExc_AttributeError, "All operator args must be keywords");
+	switch(PyTuple_Size(args)) {
+	case 2:
+		kw = PyTuple_GET_ITEM(args, 1);
+
+		if(!PyDict_Check(kw)) {
+			PyErr_SetString( PyExc_AttributeError, "bpy.__ops__.call: expected second arg to be a dict");
+			return NULL;
+		}
+		/* pass through */
+	case 1:
+		opname = _PyUnicode_AsString(PyTuple_GET_ITEM(args, 0));
+
+		if(opname==NULL) {
+			PyErr_SetString( PyExc_AttributeError, "bpy.__ops__.call: expected the first arg to be a string");
+			return NULL;
+		}
+		break;
+	default:
+		PyErr_SetString( PyExc_AttributeError, "bpy.__ops__.call: expected a string and optional dict");
 		return NULL;
 	}
 
+
 	ot= WM_operatortype_find(opname, 1);
+
 	if (ot == NULL) {
-		PyErr_Format( PyExc_SystemError, "Operator \"%s\"could not be found", opname);
+		PyErr_Format( PyExc_SystemError, "bpy.__ops__.call: operator \"%s\"could not be found", opname);
 		return NULL;
 	}
 	
 	if(ot->poll && (ot->poll(C) == 0)) {
-		PyErr_SetString( PyExc_SystemError, "Operator poll() function failed, context is incorrect");
+		PyErr_SetString( PyExc_SystemError, "bpy.__ops__.call: operator poll() function failed, context is incorrect");
 		return NULL;
 	}
 	
-	WM_operator_properties_create(&ptr, opname);
+	/* WM_operator_properties_create(&ptr, opname); */
+	/* Save another lookup */
+	RNA_pointer_create(NULL, ot->srna, NULL, &ptr);
 	
-	error_val= pyrna_pydict_to_props(&ptr, kw, "Converting py args to operator properties: ");
+	if(kw && PyDict_Size(kw))
+		error_val= pyrna_pydict_to_props(&ptr, kw, "Converting py args to operator properties: ");
+
 	
 	if (error_val==0) {
 		ReportList reports;
@@ -118,96 +132,34 @@
 	Py_RETURN_NONE;
 }
 
-static PyMethodDef pyop_base_call_meth[] = {
-	{"__op_call__", (PyCFunction)pyop_base_call, METH_VARARGS|METH_KEYWORDS, "generic operator calling function"}
-};
-
-
-//---------------getattr--------------------------------------------
-static PyObject *pyop_base_getattro( BPy_OperatorBase * self, PyObject *pyname )
+static PyObject *pyop_dir(PyObject *self)
 {
-	char *name = _PyUnicode_AsString(pyname);
-	PyObject *ret;
-	wmOperatorType *ot;
-	
-	/* First look for the operator, then our own methods if that fails.
-	 * when methods are searched first, PyObject_GenericGetAttr will raise an error
-	 * each time we want to call an operator, we could clear the error but I prefer
-	 * not to since calling operators is a lot more common then adding and removing. - Campbell */
-	
-	if ((ot= WM_operatortype_find(name, 1))) {
-		ret = PyCFunction_New( pyop_base_call_meth, pyname); /* set the name string as self, PyCFunction_New incref's self */
-	}
-	else if ((ret = PyObject_GenericGetAttr((PyObject *)self, pyname))) {
-		/* do nothing, this accounts for methoddef's add and remove
-		 * An exception is raised when PyObject_GenericGetAttr fails
-		 * but its ok because its overwritten below */
-	}
-	else {
-		PyErr_Format( PyExc_AttributeError, "Operator \"%s\" not found", name);
-		ret= NULL;
-	}
-
-	return ret;
-}
-
-static PyObject *pyop_base_dir(PyObject *self)
-{
 	PyObject *list = PyList_New(0), *name;
 	wmOperatorType *ot;
-	PyMethodDef *meth;
 	
 	for(ot= WM_operatortype_first(); ot; ot= ot->next) {
 		name = PyUnicode_FromString(ot->idname);
 		PyList_Append(list, name);
 		Py_DECREF(name);
 	}
-
-	for(meth=pyop_base_methods; meth->ml_name; meth++) {
-		name = PyUnicode_FromString(meth->ml_name);
-		PyList_Append(list, name);
-		Py_DECREF(name);
-	}
 	
 	return list;
 }
 
-static PyObject *pyop_base_rna(PyObject *self, PyObject *pyname)
+PyObject *BPY_operator_module( void )
 {
-	char *name = _PyUnicode_AsString(pyname);
-	wmOperatorType *ot;
-	
-	if ((ot= WM_operatortype_find(name, 1))) {
-		BPy_StructRNA *pyrna;
-		PointerRNA ptr;
-		
-		/* XXX POINTER - if this 'ot' is python generated, it could be free'd */
-		RNA_pointer_create(NULL, ot->srna, NULL, &ptr);
-		
-		pyrna= (BPy_StructRNA *)pyrna_struct_CreatePyObject(&ptr); /* were not really using &ptr, overwite next */
-		//pyrna->freeptr= 1;
-		return (PyObject *)pyrna;
-	}
-	else {
-		PyErr_Format(PyExc_AttributeError, "Operator \"%s\" not found", name);
-		return NULL;
-	}
-}
+	static PyMethodDef pyop_call_meth =		{"call", (PyCFunction) pyop_call, METH_VARARGS, NULL};
+	static PyMethodDef pyop_dir_meth =		{"dir", (PyCFunction) pyop_dir, METH_NOARGS, NULL};
+	static PyMethodDef pyop_add_meth =		{"add", (PyCFunction) PYOP_wrap_add, METH_O, NULL};
+	static PyMethodDef pyop_remove_meth =	{"remove", (PyCFunction) PYOP_wrap_remove, METH_O, NULL};
 
-PyTypeObject pyop_base_Type = {NULL};
+	PyObject *submodule = PyModule_New("bpy.__ops__");
+	PyDict_SetItemString(PySys_GetObject("modules"), "bpy.__ops__", submodule);
 
-PyObject *BPY_operator_module( void )
-{
-	pyop_base_Type.tp_name = "OperatorBase";
-	pyop_base_Type.tp_basicsize = sizeof( BPy_OperatorBase );
-	pyop_base_Type.tp_getattro = ( getattrofunc )pyop_base_getattro;
-	pyop_base_Type.tp_flags = Py_TPFLAGS_DEFAULT;
-	pyop_base_Type.tp_methods = pyop_base_methods;
-	
-	if( PyType_Ready( &pyop_base_Type ) < 0 )
-		return NULL;

@@ Diff output truncated at 10240 characters. @@




More information about the Bf-blender-cvs mailing list