4 * ***** BEGIN GPL LICENSE BLOCK *****
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License
8 * as published by the Free Software Foundation; either version 2
9 * of the License, or (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software Foundation,
18 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
20 * Contributor(s): Michel Selten, Willian P. Germano, Stephen Swaney,
21 * Chris Keith, Chris Want, Ken Hughes, Campbell Barton
23 * ***** END GPL LICENSE BLOCK *****
32 /* grr, python redefines */
33 #ifdef _POSIX_C_SOURCE
34 #undef _POSIX_C_SOURCE
38 #include "compile.h" /* for the PyCodeObject */
39 #include "eval.h" /* for PyEval_EvalCode */
42 #include "bpy_operator.h"
49 #include "BLI_winstuff.h"
52 #include "DNA_space_types.h"
53 #include "DNA_text_types.h"
55 #include "MEM_guardedalloc.h"
57 #include "BLI_path_util.h"
58 #include "BLI_storage.h"
59 #include "BLI_fileops.h"
60 #include "BLI_string.h"
62 #include "BKE_context.h"
64 #include "BKE_context.h"
65 #include "BKE_global.h"
68 #include "BPY_extern.h"
70 #include "../generic/bpy_internal_import.h" // our own imports
71 /* external util modules */
73 #include "../generic/Mathutils.h"
74 #include "../generic/Geometry.h"
75 #include "../generic/BGL.h"
76 #include "../generic/IDProp.h"
78 /* for internal use, when starting and ending python scripts */
80 /* incase a python script triggers another python call, stop bpy_context_clear from invalidating */
81 static int py_call_level= 0;
89 static int bpy_timer_count = 0;
90 static double bpy_timer; /* time since python starts */
91 static double bpy_timer_run; /* time for each python script run */
92 static double bpy_timer_run_tot; /* accumulate python runs */
95 void bpy_context_set(bContext *C, PyGILState_STATE *gilstate)
100 *gilstate = PyGILState_Ensure();
102 if(py_call_level==1) {
104 if(C) { // XXX - should always be true.
106 bpy_import_main_set(CTX_data_main(C));
109 fprintf(stderr, "ERROR: Python context called with a NULL Context. this should not happen!\n");
112 BPY_update_modules(); /* can give really bad results if this isnt here */
115 if(bpy_timer_count==0) {
116 /* record time from the beginning */
117 bpy_timer= PIL_check_seconds_timer();
118 bpy_timer_run = bpy_timer_run_tot = 0.0;
120 bpy_timer_run= PIL_check_seconds_timer();
128 void bpy_context_clear(bContext *C, PyGILState_STATE *gilstate)
133 PyGILState_Release(*gilstate);
135 if(py_call_level < 0) {
136 fprintf(stderr, "ERROR: Python context internal state bug. this should not happen!\n");
138 else if(py_call_level==0) {
139 // XXX - Calling classes currently wont store the context :\, cant set NULL because of this. but this is very flakey still.
140 //BPy_SetContext(NULL);
141 //bpy_import_main_set(NULL);
144 bpy_timer_run_tot += PIL_check_seconds_timer() - bpy_timer_run;
151 static void bpy_import_test(char *modname)
153 PyObject *mod= PyImport_ImportModuleLevel(modname, NULL, NULL, NULL, 0);
163 void BPY_free_compiled_text( struct Text *text )
165 if( text->compiled ) {
166 Py_DECREF( ( PyObject * ) text->compiled );
167 text->compiled = NULL;
171 /*****************************************************************************
172 * Description: Creates the bpy module and adds it to sys.modules for importing
173 *****************************************************************************/
174 static BPy_StructRNA *bpy_context_module= NULL; /* for fast access */
175 static void bpy_init_modules( void )
179 /* Needs to be first since this dir is needed for future modules */
180 char *modpath= BLI_gethome_folder("scripts/modules", BLI_GETHOME_ALL);
182 PyObject *sys_path= PySys_GetObject("path"); /* borrow */
183 PyObject *py_modpath= PyUnicode_FromString(modpath);
184 PyList_Insert(sys_path, 0, py_modpath); /* add first */
185 Py_DECREF(py_modpath);
188 /* stand alone utility modules not related to blender directly */
195 mod = PyModule_New("_bpy");
197 /* add the module so we can import it */
198 PyDict_SetItemString(PySys_GetObject("modules"), "_bpy", mod);
201 /* run first, initializes rna types */
204 PyModule_AddObject( mod, "types", BPY_rna_types() ); /* needs to be first so bpy_types can run */
205 bpy_import_test("bpy_types");
206 PyModule_AddObject( mod, "data", BPY_rna_module() ); /* imports bpy_types by running this */
207 bpy_import_test("bpy_types");
208 /* PyModule_AddObject( mod, "doc", BPY_rna_doc() ); */
209 PyModule_AddObject( mod, "props", BPY_rna_props() );
210 PyModule_AddObject( mod, "ops", BPY_operator_module() ); /* ops is now a python module that does the conversion from SOME_OT_foo -> some.foo */
211 PyModule_AddObject( mod, "ui", BPY_ui_module() ); // XXX very experimental, consider this a test, especially PyCObject is not meant to be permanent
217 bpy_context_module= ( BPy_StructRNA * ) PyObject_NEW( BPy_StructRNA, &pyrna_struct_Type );
218 RNA_pointer_create(NULL, &RNA_Context, NULL, &bpy_context_module->ptr);
220 PyModule_AddObject(mod, "context", (PyObject *)bpy_context_module);
223 /* add our own modules dir, this is a python package */
224 bpy_import_test("bpy");
227 void BPY_update_modules( void )
229 #if 0 // slow, this runs all the time poll, draw etc 100's of time a sec.
230 PyObject *mod= PyImport_ImportModuleLevel("bpy", NULL, NULL, NULL, 0);
231 PyModule_AddObject( mod, "data", BPY_rna_module() );
232 PyModule_AddObject( mod, "types", BPY_rna_types() ); // atm this does not need updating
235 /* refreshes the main struct */
236 BPY_update_rna_module();
237 bpy_context_module->ptr.data= (void *)BPy_GetContext();
240 /*****************************************************************************
241 * Description: This function creates a new Python dictionary object.
242 *****************************************************************************/
243 static PyObject *CreateGlobalDictionary( bContext *C, const char *filename )
247 PyObject *dict = PyDict_New( );
248 PyDict_SetItemString( dict, "__builtins__", PyEval_GetBuiltins( ) );
250 item = PyUnicode_FromString( "__main__" );
251 PyDict_SetItemString( dict, "__name__", item );
254 /* __file__ only for nice UI'ness */
256 PyObject *item = PyUnicode_FromString( filename );
257 PyDict_SetItemString( dict, "__file__", item );
261 /* add bpy to global namespace */
262 mod= PyImport_ImportModuleLevel("bpy", NULL, NULL, NULL, 0);
263 PyDict_SetItemString( dict, "bpy", mod );
269 /* must be called before Py_Initialize */
270 void BPY_start_python_path(void)
272 char *py_path_bundle= BLI_gethome_folder("python", BLI_GETHOME_ALL);
274 if(py_path_bundle==NULL)
277 /* set the environment path */
278 printf("found bundled python: %s\n", py_path_bundle);
281 /* OSX allow file/directory names to contain : character (represented as / in the Finder)
282 but current Python lib (release 3.1.1) doesn't handle these correctly */
283 if(strchr(py_path_bundle, ':'))
284 printf("Warning : Blender application is located in a path containing : or / chars\
285 \nThis may make python import function fail\n");
289 BLI_setenv("PYTHONHOME", py_path_bundle);
290 BLI_setenv("PYTHONPATH", py_path_bundle);
294 static wchar_t py_path_bundle_wchar[FILE_MAXDIR];
296 mbstowcs(py_path_bundle_wchar, py_path_bundle, FILE_MAXDIR);
297 Py_SetPythonHome(py_path_bundle_wchar);
303 void BPY_set_context(bContext *C)
308 /* call BPY_set_context first */
309 void BPY_start_python( int argc, char **argv )
311 PyThreadState *py_tstate = NULL;
313 BPY_start_python_path(); /* allow to use our own included python */
317 // PySys_SetArgv( argc, argv); // broken in py3, not a huge deal
318 /* sigh, why do python guys not have a char** version anymore? :( */
322 PyObject *py_argv= PyList_New(argc);
323 for (i=0; i<argc; i++)
324 PyList_SET_ITEM(py_argv, i, PyUnicode_FromString(argv[i]));
326 #else // should fix bug #20021 - utf path name problems
327 PyObject *py_argv= PyList_New(0);
328 for (i=0; i<argc; i++) {
329 PyObject *item= PyUnicode_Decode(argv[i], strlen(argv[i]), Py_FileSystemDefaultEncoding, NULL);
330 if(item==NULL) { // should never happen
335 PyList_Append(py_argv, item);
340 PySys_SetObject("argv", py_argv);
344 /* Initialize thread support (also acquires lock) */
345 PyEval_InitThreads();
348 /* bpy.* and lets us import it */
351 { /* our own import and reload functions */
353 //PyObject *m = PyImport_AddModule("__builtin__");
354 //PyObject *d = PyModule_GetDict(m);
355 PyObject *d = PyEval_GetBuiltins( );
356 PyDict_SetItemString(d, "reload", item=PyCFunction_New(bpy_reload_meth, NULL)); Py_DECREF(item);
357 PyDict_SetItemString(d, "__import__", item=PyCFunction_New(bpy_import_meth, NULL)); Py_DECREF(item);
362 py_tstate = PyGILState_GetThisThreadState();
363 PyEval_ReleaseThread(py_tstate);
366 void BPY_end_python( void )
368 // fprintf(stderr, "Ending Python!\n");
370 PyGILState_Ensure(); /* finalizing, no need to grab the state */
372 // free other python data.
375 /* clear all python data from structs */
380 // measure time since py started
381 bpy_timer = PIL_check_seconds_timer() - bpy_timer;
383 printf("*bpy stats* - ");
384 printf("tot exec: %d, ", bpy_timer_count);
385 printf("tot run: %.4fsec, ", bpy_timer_run_tot);
386 if(bpy_timer_count>0)
387 printf("average run: %.6fsec, ", (bpy_timer_run_tot/bpy_timer_count));
390 printf("tot usage %.4f%%", (bpy_timer_run_tot/bpy_timer)*100.0);
394 // fprintf(stderr, "Ending Python Done!\n");
400 /* Can run a file or text block */
401 int BPY_run_python_script( bContext *C, const char *fn, struct Text *text, struct ReportList *reports)
403 PyObject *py_dict, *py_result= NULL;
404 PyGILState_STATE gilstate;
406 if (fn==NULL && text==NULL) {
410 bpy_context_set(C, &gilstate);
412 py_dict = CreateGlobalDictionary(C, text?text->id.name+2:fn);
416 if( !text->compiled ) { /* if it wasn't already compiled, do it now */
417 char *buf = txt_to_buf( text );
420 Py_CompileString( buf, text->id.name+2, Py_file_input );
424 if( PyErr_Occurred( ) ) {
425 BPY_free_compiled_text( text );
429 py_result = PyEval_EvalCode( text->compiled, py_dict, py_dict );
432 FILE *fp= fopen(fn, "r");
435 /* Previously we used PyRun_File to run directly the code on a FILE
436 * object, but as written in the Python/C API Ref Manual, chapter 2,
437 * 'FILE structs for different C libraries can be different and
439 * So now we load the script file data to a buffer */
444 pystring= malloc(strlen(fn) + 32);
446 sprintf(pystring, "exec(open(r'%s').read())", fn);
447 py_result = PyRun_String( pystring, Py_file_input, py_dict, py_dict );
450 py_result = PyRun_File(fp, fn, Py_file_input, py_dict, py_dict);
455 PyErr_Format(PyExc_SystemError, "Python file \"%s\" could not be opened: %s", fn, strerror(errno));
461 BPy_errors_to_report(reports);
463 Py_DECREF( py_result );
468 bpy_context_clear(C, &gilstate);
470 return py_result ? 1:0;
474 /* TODO - move into bpy_space.c ? */
475 /* GUI interface routines */
477 /* Copied from Draw.c */
478 static void exit_pydraw( SpaceScript * sc, short err )
480 Script *script = NULL;
482 if( !sc || !sc->script )
488 BPy_errors_to_report(NULL); // TODO, reports
489 script->flags = 0; /* mark script struct for deletion */
490 SCRIPT_SET_NULL(script);
491 script->scriptname[0] = '\0';
492 script->scriptarg[0] = '\0';
493 // XXX 2.5 error_pyscript();
494 // XXX 2.5 scrarea_queue_redraw( sc->area );
498 BPy_Set_DrawButtonsList(sc->but_refs);
499 BPy_Free_DrawButtonsList(); /*clear all temp button references*/
504 Py_XDECREF( ( PyObject * ) script->py_draw );
505 Py_XDECREF( ( PyObject * ) script->py_event );
506 Py_XDECREF( ( PyObject * ) script->py_button );
508 script->py_draw = script->py_event = script->py_button = NULL;
511 static int bpy_run_script_init(bContext *C, SpaceScript * sc)
513 if (sc->script==NULL)
516 if (sc->script->py_draw==NULL && sc->script->scriptname[0] != '\0')
517 BPY_run_python_script(C, sc->script->scriptname, NULL, NULL);
519 if (sc->script->py_draw==NULL)
525 int BPY_run_script_space_draw(const struct bContext *C, SpaceScript * sc)
527 if (bpy_run_script_init( (bContext *)C, sc)) {
528 PyGILState_STATE gilstate = PyGILState_Ensure();
529 PyObject *result = PyObject_CallObject( sc->script->py_draw, NULL );
534 PyGILState_Release(gilstate);
539 // XXX - not used yet, listeners dont get a context
540 int BPY_run_script_space_listener(bContext *C, SpaceScript * sc)
542 if (bpy_run_script_init(C, sc)) {
543 PyGILState_STATE gilstate = PyGILState_Ensure();
545 PyObject *result = PyObject_CallObject( sc->script->py_draw, NULL );
550 PyGILState_Release(gilstate);
555 void BPY_DECREF(void *pyob_ptr)
557 PyGILState_STATE gilstate = PyGILState_Ensure();
558 Py_DECREF((PyObject *)pyob_ptr);
559 PyGILState_Release(gilstate);
563 /* called from the the scripts window, assume context is ok */
564 int BPY_run_python_script_space(const char *modulename, const char *func)
566 PyObject *py_dict, *py_result= NULL;
568 PyGILState_STATE gilstate;
570 /* for calling the module function */
573 gilstate = PyGILState_Ensure();
575 py_dict = CreateGlobalDictionary(C);
577 PyObject *module = PyImport_ImportModule(scpt->script.filename);
579 PyErr_SetFormat(PyExc_SystemError, "could not import '%s'", scpt->script.filename);
582 py_func = PyObject_GetAttrString(modulename, func);
584 PyErr_SetFormat(PyExc_SystemError, "module has no function '%s.%s'\n", scpt->script.filename, func);
588 if (!PyCallable_Check(py_func)) {
589 PyErr_SetFormat(PyExc_SystemError, "module item is not callable '%s.%s'\n", scpt->script.filename, func);
592 py_result= PyObject_CallObject(py_func, NULL); // XXX will need args eventually
598 BPy_errors_to_report(NULL); // TODO - reports
600 Py_DECREF( py_result );
606 PyGILState_Release(gilstate);
611 // #define TIME_REGISTRATION
613 #ifdef TIME_REGISTRATION
614 #include "PIL_time.h"
618 int BPY_button_eval(bContext *C, char *expr, double *value)
620 PyGILState_STATE gilstate;
621 PyObject *dict, *mod, *retval;
624 if (!value || !expr || expr[0]=='\0') return -1;
626 bpy_context_set(C, &gilstate);
628 dict= CreateGlobalDictionary(C, NULL);
630 /* import some modules: builtins,math*/
631 PyDict_SetItemString(dict, "__builtins__", PyEval_GetBuiltins());
633 mod = PyImport_ImportModule("math");
635 PyDict_Merge(dict, PyModule_GetDict(mod), 0); /* 0 - dont overwrite existing values */
637 /* Only keep for backwards compat! - just import all math into root, they are standard */
638 PyDict_SetItemString(dict, "math", mod);
639 PyDict_SetItemString(dict, "m", mod);
643 retval = PyRun_String(expr, Py_eval_input, dict, dict);
645 if (retval == NULL) {
651 if(PyTuple_Check(retval)) {
652 /* Users my have typed in 10km, 2m
653 * add up all values */
657 for(i=0; i<PyTuple_GET_SIZE(retval); i++) {
658 val+= PyFloat_AsDouble(PyTuple_GET_ITEM(retval, i));
662 val = PyFloat_AsDouble(retval);
666 if(val==-1 && PyErr_Occurred()) {
675 BPy_errors_to_report(CTX_wm_reports(C));
679 bpy_context_clear(C, &gilstate);
684 void BPY_load_user_modules(bContext *C)
686 PyGILState_STATE gilstate;
689 bpy_context_set(C, &gilstate);
691 for(text=CTX_data_main(C)->text.first; text; text= text->id.next) {
692 if(text->flags & TXT_ISSCRIPT && BLI_testextensie(text->id.name+2, ".py")) {
693 PyObject *module= bpy_text_import(text);
704 bpy_context_clear(C, &gilstate);
707 int BPY_context_get(bContext *C, const char *member, bContextDataResult *result)
709 PyObject *pyctx= (PyObject *)CTX_py_dict_get(C);
710 PyObject *item= PyDict_GetItemString(pyctx, member);
711 PointerRNA *ptr= NULL;
717 else if(item==Py_None) {
720 else if(BPy_StructRNA_Check(item)) {
721 ptr= &(((BPy_StructRNA *)item)->ptr);
723 //result->ptr= ((BPy_StructRNA *)item)->ptr;
724 CTX_data_pointer_set(result, ptr->id.data, ptr->type, ptr->data);
727 else if (PySequence_Check(item)) {
728 PyObject *seq_fast= PySequence_Fast(item, "bpy_context_get sequence conversion");
729 if (seq_fast==NULL) {
734 int len= PySequence_Fast_GET_SIZE(seq_fast);
736 for(i = 0; i < len; i++) {
737 PyObject *list_item= PySequence_Fast_GET_ITEM(seq_fast, i);
739 if(BPy_StructRNA_Check(list_item)) {
741 CollectionPointerLink *link= MEM_callocN(sizeof(CollectionPointerLink), "bpy_context_get");
742 link->ptr= ((BPy_StructRNA *)item)->ptr;
743 BLI_addtail(&result->list, link);
745 ptr= &(((BPy_StructRNA *)list_item)->ptr);
746 CTX_data_list_add(result, ptr->id.data, ptr->type, ptr->data);
749 printf("List item not a valid type\n");
760 if (item) printf("Context '%s' not a valid type\n", member);
761 else printf("Context '%s' not found\n", member);
763 else if (G.f & G_DEBUG) {
764 printf("Context '%s' found\n", member);