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