add 'idprop' module so we can document idprop.types.*, currently doc generator has...
[blender.git] / source / blender / python / intern / bpy_interface.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Contributor(s): Michel Selten, Willian P. Germano, Stephen Swaney,
19  * Chris Keith, Chris Want, Ken Hughes, Campbell Barton
20  *
21  * ***** END GPL LICENSE BLOCK *****
22  */
23
24 /** \file blender/python/intern/bpy_interface.c
25  *  \ingroup pythonintern
26  *
27  * This file deals with embedding the python interpreter within blender,
28  * starting and stopping python and exposing blender/python modules so they can
29  * be accesses from scripts.
30  */
31
32  
33 /* grr, python redefines */
34 #ifdef _POSIX_C_SOURCE
35 #  undef _POSIX_C_SOURCE
36 #endif
37
38 #include <Python.h>
39
40 #include "MEM_guardedalloc.h"
41
42 #include "RNA_types.h"
43
44 #include "bpy.h"
45 #include "gpu.h"
46 #include "bpy_rna.h"
47 #include "bpy_util.h"
48 #include "bpy_traceback.h"
49 #include "bpy_intern_string.h"
50
51 #include "DNA_space_types.h"
52 #include "DNA_text_types.h"
53
54 #include "BLI_path_util.h"
55 #include "BLI_fileops.h"
56 #include "BLI_math_base.h"
57 #include "BLI_string.h"
58 #include "BLI_string_utf8.h"
59 #include "BLI_utildefines.h"
60 #include "BLI_threads.h"
61
62 #include "BKE_context.h"
63 #include "BKE_text.h"
64 #include "BKE_main.h"
65 #include "BKE_global.h" /* only for script checking */
66
67 #include "CCL_api.h"
68
69 #include "BPY_extern.h"
70
71 #include "../generic/bpy_internal_import.h" // our own imports
72 #include "../generic/py_capi_utils.h"
73
74 /* inittab initialization functions */
75 #include "../generic/bgl.h"
76 #include "../generic/blf_py_api.h"
77 #include "../generic/idprop_py_api.h"
78 #include "../bmesh/bmesh_py_api.h"
79 #include "../mathutils/mathutils.h"
80
81
82 /* for internal use, when starting and ending python scripts */
83
84 /* in case a python script triggers another python call, stop bpy_context_clear from invalidating */
85 static int py_call_level = 0;
86 BPy_StructRNA *bpy_context_module = NULL; /* for fast access */
87
88 // #define TIME_PY_RUN // simple python tests. prints on exit.
89
90 #ifdef TIME_PY_RUN
91 #include "PIL_time.h"
92 static int     bpy_timer_count = 0;
93 static double  bpy_timer;   /* time since python starts */
94 static double  bpy_timer_run;   /* time for each python script run */
95 static double  bpy_timer_run_tot;   /* accumulate python runs */
96 #endif
97
98 /* use for updating while a python script runs - in case of file load */
99 void bpy_context_update(bContext *C)
100 {
101         /* don't do this from a non-main (e.g. render) thread, it can cause a race
102            condition on C->data.recursion. ideal solution would be to disable
103            context entirely from non-main threads, but that's more complicated */
104         if(!BLI_thread_is_main())
105                 return;
106
107         BPy_SetContext(C);
108         bpy_import_main_set(CTX_data_main(C));
109         BPY_modules_update(C); /* can give really bad results if this isn't here */
110 }
111
112 void bpy_context_set(bContext *C, PyGILState_STATE *gilstate)
113 {
114         py_call_level++;
115
116         if (gilstate)
117                 *gilstate = PyGILState_Ensure();
118
119         if (py_call_level == 1) {
120                 bpy_context_update(C);
121
122 #ifdef TIME_PY_RUN
123                 if (bpy_timer_count == 0) {
124                         /* record time from the beginning */
125                         bpy_timer = PIL_check_seconds_timer();
126                         bpy_timer_run = bpy_timer_run_tot = 0.0;
127                 }
128                 bpy_timer_run = PIL_check_seconds_timer();
129
130
131                 bpy_timer_count++;
132 #endif
133         }
134 }
135
136 /* context should be used but not now because it causes some bugs */
137 void bpy_context_clear(bContext *UNUSED(C), PyGILState_STATE *gilstate)
138 {
139         py_call_level--;
140
141         if (gilstate)
142                 PyGILState_Release(*gilstate);
143
144         if (py_call_level < 0) {
145                 fprintf(stderr, "ERROR: Python context internal state bug. this should not happen!\n");
146         }
147         else if (py_call_level == 0) {
148                 /* XXX - Calling classes currently wont store the context :\,
149                  * cant set NULL because of this. but this is very flakey still. */
150 #if 0
151                 BPy_SetContext(NULL);
152                 bpy_import_main_set(NULL);
153 #endif
154
155 #ifdef TIME_PY_RUN
156                 bpy_timer_run_tot += PIL_check_seconds_timer() - bpy_timer_run;
157                 bpy_timer_count++;
158 #endif
159
160         }
161 }
162
163 void BPY_text_free_code(Text *text)
164 {
165         if (text->compiled) {
166                 Py_DECREF((PyObject *)text->compiled);
167                 text->compiled = NULL;
168         }
169 }
170
171 void BPY_modules_update(bContext *C)
172 {
173 #if 0 // slow, this runs all the time poll, draw etc 100's of time a sec.
174         PyObject *mod = PyImport_ImportModuleLevel("bpy", NULL, NULL, NULL, 0);
175         PyModule_AddObject(mod, "data", BPY_rna_module());
176         PyModule_AddObject(mod, "types", BPY_rna_types()); // atm this does not need updating
177 #endif
178
179         /* refreshes the main struct */
180         BPY_update_rna_module();
181         bpy_context_module->ptr.data = (void *)C;
182 }
183
184 void BPY_context_set(bContext *C)
185 {
186         BPy_SetContext(C);
187 }
188
189 /* defined in AUD_C-API.cpp */
190 extern PyObject *AUD_initPython(void);
191
192 #ifdef WITH_CYCLES
193 /* defined in cycles module */
194 static PyObject *CCL_initPython(void)
195 {
196         return (PyObject *)CCL_python_module_init();
197 }
198 #endif
199
200 static struct _inittab bpy_internal_modules[] = {
201         {(char *)"mathutils", PyInit_mathutils},
202 //      {(char *)"mathutils.geometry", PyInit_mathutils_geometry},
203 //      {(char *)"mathutils.noise", PyInit_mathutils_noise},
204         {(char *)"bgl", BPyInit_bgl},
205         {(char *)"blf", BPyInit_blf},
206         {(char *)"bmesh", BPyInit_bmesh},
207         // {(char *)"bmesh.types", BPyInit_bmesh_types},
208         // {(char *)"bmesh.utils", BPyInit_bmesh_utils},
209 #ifdef WITH_AUDASPACE
210         {(char *)"aud", AUD_initPython},
211 #endif
212 #ifdef WITH_CYCLES
213         {(char *)"_cycles", CCL_initPython},
214 #endif
215         {(char *)"gpu", GPU_initPython},
216         {(char *)"idprop", BPyInit_idprop},
217         {NULL, NULL}
218 };
219
220 /* call BPY_context_set first */
221 void BPY_python_start(int argc, const char **argv)
222 {
223 #ifndef WITH_PYTHON_MODULE
224         PyThreadState *py_tstate = NULL;
225
226         /* not essential but nice to set our name */
227         static wchar_t program_path_wchar[FILE_MAX]; /* python holds a reference */
228         BLI_strncpy_wchar_from_utf8(program_path_wchar, BLI_program_path(), sizeof(program_path_wchar) / sizeof(wchar_t));
229         Py_SetProgramName(program_path_wchar);
230
231         /* must run before python initializes */
232         PyImport_ExtendInittab(bpy_internal_modules);
233
234         /* allow to use our own included python */
235         PyC_SetHomePath(BLI_get_folder(BLENDER_SYSTEM_PYTHON, NULL));
236
237         /* without this the sys.stdout may be set to 'ascii'
238          * (it is on my system at least), where printing unicode values will raise
239          * an error, this is highly annoying, another stumbling block for devs,
240          * so use a more relaxed error handler and enforce utf-8 since the rest of
241          * blender is utf-8 too - campbell */
242         BLI_setenv("PYTHONIOENCODING", "utf-8:surrogateescape");
243
244         /* Python 3.2 now looks for '2.xx/python/include/python3.2d/pyconfig.h' to
245          * parse from the 'sysconfig' module which is used by 'site',
246          * so for now disable site. alternatively we could copy the file. */
247         Py_NoSiteFlag = 1;
248
249         Py_Initialize();
250
251         // PySys_SetArgv(argc, argv); // broken in py3, not a huge deal
252         /* sigh, why do python guys not have a (char **) version anymore? */
253         {
254                 int i;
255                 PyObject *py_argv = PyList_New(argc);
256                 for (i = 0; i < argc; i++) {
257                         /* should fix bug #20021 - utf path name problems, by replacing
258                          * PyUnicode_FromString, with this one */
259                         PyList_SET_ITEM(py_argv, i, PyC_UnicodeFromByte(argv[i]));
260                 }
261
262                 PySys_SetObject("argv", py_argv);
263                 Py_DECREF(py_argv);
264         }
265         
266         /* Initialize thread support (also acquires lock) */
267         PyEval_InitThreads();
268 #else
269         (void)argc;
270         (void)argv;
271
272         /* must run before python initializes */
273         PyImport_ExtendInittab(bpy_internal_modules);
274 #endif
275
276         bpy_intern_string_init();
277
278         /* bpy.* and lets us import it */
279         BPy_init_modules();
280
281         bpy_import_init(PyEval_GetBuiltins());
282         
283         pyrna_alloc_types();
284
285 #ifndef WITH_PYTHON_MODULE
286         /* py module runs atexit when bpy is freed */
287         BPY_atexit_register(); /* this can init any time */
288
289         py_tstate = PyGILState_GetThisThreadState();
290         PyEval_ReleaseThread(py_tstate);
291 #endif
292 }
293
294 void BPY_python_end(void)
295 {
296         // fprintf(stderr, "Ending Python!\n");
297
298         PyGILState_Ensure(); /* finalizing, no need to grab the state */
299         
300         // free other python data.
301         pyrna_free_types();
302
303         /* clear all python data from structs */
304
305         bpy_intern_string_exit();
306
307 #ifndef WITH_PYTHON_MODULE
308         BPY_atexit_unregister(); /* without this we get recursive calls to WM_exit */
309 #endif
310
311         Py_Finalize();
312         
313 #ifdef TIME_PY_RUN
314         // measure time since py started
315         bpy_timer = PIL_check_seconds_timer() - bpy_timer;
316
317         printf("*bpy stats* - ");
318         printf("tot exec: %d,  ", bpy_timer_count);
319         printf("tot run: %.4fsec,  ", bpy_timer_run_tot);
320         if (bpy_timer_count > 0)
321                 printf("average run: %.6fsec,  ", (bpy_timer_run_tot / bpy_timer_count));
322
323         if (bpy_timer > 0.0)
324                 printf("tot usage %.4f%%", (bpy_timer_run_tot / bpy_timer) * 100.0);
325
326         printf("\n");
327
328         // fprintf(stderr, "Ending Python Done!\n");
329
330 #endif
331
332 }
333
334 static void python_script_error_jump_text(struct Text *text)
335 {
336         int lineno;
337         int offset;
338         python_script_error_jump(text->id.name + 2, &lineno, &offset);
339         if (lineno != -1) {
340                 /* select the line with the error */
341                 txt_move_to(text, lineno - 1, INT_MAX, FALSE);
342                 txt_move_to(text, lineno - 1, offset, TRUE);
343         }
344 }
345
346 /* super annoying, undo _PyModule_Clear(), bug [#23871] */
347 #define PYMODULE_CLEAR_WORKAROUND
348
349 #ifdef PYMODULE_CLEAR_WORKAROUND
350 /* bad!, we should never do this, but currently only safe way I could find to keep namespace.
351  * from being cleared. - campbell */
352 typedef struct {
353         PyObject_HEAD
354         PyObject *md_dict;
355         /* ommit other values, we only want the dict. */
356 } PyModuleObject;
357 #endif
358
359 static int python_script_exec(bContext *C, const char *fn, struct Text *text,
360                               struct ReportList *reports, const short do_jump)
361 {
362         PyObject *main_mod = NULL;
363         PyObject *py_dict = NULL, *py_result = NULL;
364         PyGILState_STATE gilstate;
365
366         BLI_assert(fn || text);
367
368         if (fn == NULL && text == NULL) {
369                 return 0;
370         }
371
372         bpy_context_set(C, &gilstate);
373
374         PyC_MainModule_Backup(&main_mod);
375
376         if (text) {
377                 char fn_dummy[FILE_MAXDIR];
378                 bpy_text_filename_get(fn_dummy, sizeof(fn_dummy), text);
379
380                 if (text->compiled == NULL) {   /* if it wasn't already compiled, do it now */
381                         char *buf = txt_to_buf(text);
382
383                         text->compiled = Py_CompileString(buf, fn_dummy, Py_file_input);
384
385                         MEM_freeN(buf);
386
387                         if (PyErr_Occurred()) {
388                                 if (do_jump) {
389                                         python_script_error_jump_text(text);
390                                 }
391                                 BPY_text_free_code(text);
392                         }
393                 }
394
395                 if (text->compiled) {
396                         py_dict = PyC_DefaultNameSpace(fn_dummy);
397                         py_result =  PyEval_EvalCode(text->compiled, py_dict, py_dict);
398                 }
399
400         }
401         else {
402                 FILE *fp = BLI_fopen(fn, "r");
403
404                 if (fp) {
405                         py_dict = PyC_DefaultNameSpace(fn);
406
407 #ifdef _WIN32
408                         /* Previously we used PyRun_File to run directly the code on a FILE
409                          * object, but as written in the Python/C API Ref Manual, chapter 2,
410                          * 'FILE structs for different C libraries can be different and
411                          * incompatible'.
412                          * So now we load the script file data to a buffer */
413                         {
414                                 char *pystring;
415
416                                 fclose(fp);
417
418                                 pystring = MEM_mallocN(strlen(fn) + 32, "pystring");
419                                 pystring[0] = '\0';
420                                 sprintf(pystring, "exec(open(r'%s').read())", fn);
421                                 py_result = PyRun_String(pystring, Py_file_input, py_dict, py_dict);
422                                 MEM_freeN(pystring);
423                         }
424 #else
425                         py_result = PyRun_File(fp, fn, Py_file_input, py_dict, py_dict);
426                         fclose(fp);
427 #endif
428                 }
429                 else {
430                         PyErr_Format(PyExc_IOError,
431                                      "Python file \"%s\" could not be opened: %s",
432                                      fn, strerror(errno));
433                         py_result = NULL;
434                 }
435         }
436
437         if (!py_result) {
438                 if (text) {
439                         if (do_jump) {
440                                 python_script_error_jump_text(text);
441                         }
442                 }
443                 BPy_errors_to_report(reports);
444         }
445         else {
446                 Py_DECREF(py_result);
447         }
448
449         if (py_dict) {
450 #ifdef PYMODULE_CLEAR_WORKAROUND
451                 PyModuleObject *mmod = (PyModuleObject *)PyDict_GetItemString(PyThreadState_GET()->interp->modules, "__main__");
452                 PyObject *dict_back = mmod->md_dict;
453                 /* freeing the module will clear the namespace,
454                  * gives problems running classes defined in this namespace being used later. */
455                 mmod->md_dict = NULL;
456                 Py_DECREF(dict_back);
457 #endif
458
459 #undef PYMODULE_CLEAR_WORKAROUND
460         }
461
462         PyC_MainModule_Restore(main_mod);
463
464         bpy_context_clear(C, &gilstate);
465
466         return (py_result != NULL);
467 }
468
469 /* Can run a file or text block */
470 int BPY_filepath_exec(bContext *C, const char *filepath, struct ReportList *reports)
471 {
472         return python_script_exec(C, filepath, NULL, reports, FALSE);
473 }
474
475
476 int BPY_text_exec(bContext *C, struct Text *text, struct ReportList *reports, const short do_jump)
477 {
478         return python_script_exec(C, NULL, text, reports, do_jump);
479 }
480
481 void BPY_DECREF(void *pyob_ptr)
482 {
483         PyGILState_STATE gilstate = PyGILState_Ensure();
484         Py_DECREF((PyObject *)pyob_ptr);
485         PyGILState_Release(gilstate);
486 }
487
488 /* return -1 on error, else 0 */
489 int BPY_button_exec(bContext *C, const char *expr, double *value, const short verbose)
490 {
491         PyGILState_STATE gilstate;
492         PyObject *py_dict, *mod, *retval;
493         int error_ret = 0;
494         PyObject *main_mod = NULL;
495         
496         if (!value || !expr) return -1;
497
498         if (expr[0] == '\0') {
499                 *value = 0.0;
500                 return error_ret;
501         }
502
503         bpy_context_set(C, &gilstate);
504
505         PyC_MainModule_Backup(&main_mod);
506
507         py_dict = PyC_DefaultNameSpace("<blender button>");
508
509         mod = PyImport_ImportModule("math");
510         if (mod) {
511                 PyDict_Merge(py_dict, PyModule_GetDict(mod), 0); /* 0 - don't overwrite existing values */
512                 Py_DECREF(mod);
513         }
514         else { /* highly unlikely but possibly */
515                 PyErr_Print();
516                 PyErr_Clear();
517         }
518         
519         retval = PyRun_String(expr, Py_eval_input, py_dict, py_dict);
520         
521         if (retval == NULL) {
522                 error_ret = -1;
523         }
524         else {
525                 double val;
526
527                 if (PyTuple_Check(retval)) {
528                         /* Users my have typed in 10km, 2m
529                          * add up all values */
530                         int i;
531                         val = 0.0;
532
533                         for (i = 0; i < PyTuple_GET_SIZE(retval); i++) {
534                                 val += PyFloat_AsDouble(PyTuple_GET_ITEM(retval, i));
535                         }
536                 }
537                 else {
538                         val = PyFloat_AsDouble(retval);
539                 }
540                 Py_DECREF(retval);
541                 
542                 if (val == -1 && PyErr_Occurred()) {
543                         error_ret = -1;
544                 }
545                 else if (!finite(val)) {
546                         *value = 0.0;
547                 }
548                 else {
549                         *value = val;
550                 }
551         }
552         
553         if (error_ret) {
554                 if (verbose) {
555                         BPy_errors_to_report(CTX_wm_reports(C));
556                 }
557                 else {
558                         PyErr_Clear();
559                 }
560         }
561
562         PyC_MainModule_Backup(&main_mod);
563         
564         bpy_context_clear(C, &gilstate);
565         
566         return error_ret;
567 }
568
569 int BPY_string_exec(bContext *C, const char *expr)
570 {
571         PyGILState_STATE gilstate;
572         PyObject *main_mod = NULL;
573         PyObject *py_dict, *retval;
574         int error_ret = 0;
575         Main *bmain_back; /* XXX, quick fix for release (Copy Settings crash), needs further investigation */
576
577         if (!expr) return -1;
578
579         if (expr[0] == '\0') {
580                 return error_ret;
581         }
582
583         bpy_context_set(C, &gilstate);
584
585         PyC_MainModule_Backup(&main_mod);
586
587         py_dict = PyC_DefaultNameSpace("<blender string>");
588
589         bmain_back = bpy_import_main_get();
590         bpy_import_main_set(CTX_data_main(C));
591
592         retval = PyRun_String(expr, Py_eval_input, py_dict, py_dict);
593
594         bpy_import_main_set(bmain_back);
595
596         if (retval == NULL) {
597                 error_ret = -1;
598
599                 BPy_errors_to_report(CTX_wm_reports(C));
600         }
601         else {
602                 Py_DECREF(retval);
603         }
604
605         PyC_MainModule_Restore(main_mod);
606
607         bpy_context_clear(C, &gilstate);
608         
609         return error_ret;
610 }
611
612
613 void BPY_modules_load_user(bContext *C)
614 {
615         PyGILState_STATE gilstate;
616         Main *bmain = CTX_data_main(C);
617         Text *text;
618
619         /* can happen on file load */
620         if (bmain == NULL)
621                 return;
622
623         /* update pointers since this can run from a nested script
624          * on file load */
625         if (py_call_level) {
626                 bpy_context_update(C);
627         }
628
629         bpy_context_set(C, &gilstate);
630
631         for (text = CTX_data_main(C)->text.first; text; text = text->id.next) {
632                 if (text->flags & TXT_ISSCRIPT && BLI_testextensie(text->id.name + 2, ".py")) {
633                         if (!(G.f & G_SCRIPT_AUTOEXEC)) {
634                                 printf("scripts disabled for \"%s\", skipping '%s'\n", bmain->name, text->id.name + 2);
635                         }
636                         else {
637                                 PyObject *module = bpy_text_import(text);
638
639                                 if (module == NULL) {
640                                         PyErr_Print();
641                                         PyErr_Clear();
642                                 }
643                                 else {
644                                         Py_DECREF(module);
645                                 }
646                         }
647                 }
648         }
649         bpy_context_clear(C, &gilstate);
650 }
651
652 int BPY_context_member_get(bContext *C, const char *member, bContextDataResult *result)
653 {
654         PyObject *pyctx = (PyObject *)CTX_py_dict_get(C);
655         PyObject *item = PyDict_GetItemString(pyctx, member);
656         PointerRNA *ptr = NULL;
657         int done = 0;
658
659         if (item == NULL) {
660                 /* pass */
661         }
662         else if (item == Py_None) {
663                 /* pass */
664         }
665         else if (BPy_StructRNA_Check(item)) {
666                 ptr = &(((BPy_StructRNA *)item)->ptr);
667
668                 //result->ptr = ((BPy_StructRNA *)item)->ptr;
669                 CTX_data_pointer_set(result, ptr->id.data, ptr->type, ptr->data);
670                 done = 1;
671         }
672         else if (PySequence_Check(item)) {
673                 PyObject *seq_fast = PySequence_Fast(item, "bpy_context_get sequence conversion");
674                 if (seq_fast == NULL) {
675                         PyErr_Print();
676                         PyErr_Clear();
677                 }
678                 else {
679                         int len = PySequence_Fast_GET_SIZE(seq_fast);
680                         int i;
681                         for (i = 0; i < len; i++) {
682                                 PyObject *list_item = PySequence_Fast_GET_ITEM(seq_fast, i);
683
684                                 if (BPy_StructRNA_Check(list_item)) {
685 #if 0
686                                         CollectionPointerLink *link = MEM_callocN(sizeof(CollectionPointerLink), "bpy_context_get");
687                                         link->ptr = ((BPy_StructRNA *)item)->ptr;
688                                         BLI_addtail(&result->list, link);
689 #endif
690                                         ptr = &(((BPy_StructRNA *)list_item)->ptr);
691                                         CTX_data_list_add(result, ptr->id.data, ptr->type, ptr->data);
692                                 }
693                                 else {
694                                         printf("List item not a valid type\n");
695                                 }
696
697                         }
698                         Py_DECREF(seq_fast);
699
700                         done = 1;
701                 }
702         }
703
704         if (done == 0) {
705                 if (item) printf("PyContext '%s' not a valid type\n", member);
706                 else      printf("PyContext '%s' not found\n", member);
707         }
708         else {
709                 if (G.debug & G_DEBUG_PYTHON) {
710                         printf("PyContext '%s' found\n", member);
711                 }
712         }
713
714         return done;
715 }
716
717 #ifdef WITH_PYTHON_MODULE
718 #include "BLI_fileops.h"
719 /* TODO, reloading the module isn't functional at the moment. */
720
721 static void bpy_module_free(void *mod);
722 extern int main_python_enter(int argc, const char **argv);
723 extern void main_python_exit(void);
724 static struct PyModuleDef bpy_proxy_def = {
725         PyModuleDef_HEAD_INIT,
726         "bpy",  /* m_name */
727         NULL,  /* m_doc */
728         0,  /* m_size */
729         NULL,  /* m_methods */
730         NULL,  /* m_reload */
731         NULL,  /* m_traverse */
732         NULL,  /* m_clear */
733         bpy_module_free,  /* m_free */
734 };
735
736 typedef struct {
737         PyObject_HEAD
738         /* Type-specific fields go here. */
739         PyObject *mod;
740 } dealloc_obj;
741
742 /* call once __file__ is set */
743 void bpy_module_delay_init(PyObject *bpy_proxy)
744 {
745         const int argc = 1;
746         const char *argv[2];
747
748         /* updating the module dict below will loose the reference to __file__ */
749         PyObject *filename_obj = PyModule_GetFilenameObject(bpy_proxy);
750
751         const char *filename_rel = _PyUnicode_AsString(filename_obj); /* can be relative */
752         char filename_abs[1024];
753
754         BLI_strncpy(filename_abs, filename_rel, sizeof(filename_abs));
755         BLI_path_cwd(filename_abs);
756
757         argv[0] = filename_abs;
758         argv[1] = NULL;
759         
760         // printf("module found %s\n", argv[0]);
761
762         main_python_enter(argc, argv);
763
764         /* initialized in BPy_init_modules() */
765         PyDict_Update(PyModule_GetDict(bpy_proxy), PyModule_GetDict(bpy_package_py));
766 }
767
768 static void dealloc_obj_dealloc(PyObject *self);
769
770 static PyTypeObject dealloc_obj_Type = {{{0}}};
771
772 /* use our own dealloc so we can free a property if we use one */
773 static void dealloc_obj_dealloc(PyObject *self)
774 {
775         bpy_module_delay_init(((dealloc_obj *)self)->mod);
776
777         /* Note, for subclassed PyObjects we cant just call PyObject_DEL() directly or it will crash */
778         dealloc_obj_Type.tp_free(self);
779 }
780
781 PyMODINIT_FUNC
782 PyInit_bpy(void)
783 {
784         PyObject *bpy_proxy = PyModule_Create(&bpy_proxy_def);
785         
786         /* Problem:
787          * 1) this init function is expected to have a private member defined - 'md_def'
788          *    but this is only set for C defined modules (not py packages)
789          *    so we cant return 'bpy_package_py' as is.
790          *
791          * 2) there is a 'bpy' C module for python to load which is basically all of blender,
792          *    and there is scripts/bpy/__init__.py, 
793          *    we may end up having to rename this module so there is no naming conflict here eg:
794          *    'from blender import bpy'
795          *
796          * 3) we don't know the filename at this point, workaround by assigning a dummy value
797          *    which calls back when its freed so the real loading can take place.
798          */
799
800         /* assign an object which is freed after __file__ is assigned */
801         dealloc_obj *dob;
802         
803         /* assign dummy type */
804         dealloc_obj_Type.tp_name = "dealloc_obj";
805         dealloc_obj_Type.tp_basicsize = sizeof(dealloc_obj);
806         dealloc_obj_Type.tp_dealloc = dealloc_obj_dealloc;
807         dealloc_obj_Type.tp_flags = Py_TPFLAGS_DEFAULT;
808         
809         if (PyType_Ready(&dealloc_obj_Type) < 0)
810                 return NULL;
811
812         dob = (dealloc_obj *) dealloc_obj_Type.tp_alloc(&dealloc_obj_Type, 0);
813         dob->mod = bpy_proxy; /* borrow */
814         PyModule_AddObject(bpy_proxy, "__file__", (PyObject *)dob); /* borrow */
815
816         return bpy_proxy;
817 }
818
819 static void bpy_module_free(void *UNUSED(mod))
820 {
821         main_python_exit();
822 }
823
824 #endif