archive/blender-archive
Archived
1
1
Fork 0
Code Pull Requests Packages Activity
This repository has been archived on 2023-10-09. You can view files and clone it, but cannot push or open issues or pull requests.
Files
32896bbf591e71486d8ca643ca9436ce6d145f2f
blender-archive/source/blender/python/intern/bpy_util.c

125 lines
3.2 KiB
C
Raw Normal View History

doxygen: prevent GPL license block from being parsed as doxygen comment.
2011-02-23 10:52:22 +00:00
/*
PyOperator invoke function now receives the wmEvent and default properties as 2 python dictionary args. the Python invoke function can then edit the properties based on the event, once its finished the properties are copied back to the operator. python exec and invoke functions can now return RUNNING_MODAL, CANCELLED, FINISHED, PASS_THROUGH flags Still need to look into how python operators can make use of invoke/exec for a practical case. (Need to bring back the popup menu's)
2008-12-28 08:41:49 +00:00
* ***** BEGIN GPL LICENSE BLOCK *****
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
correct fsf address
2010-02-12 13:34:04 +00:00
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
PyOperator invoke function now receives the wmEvent and default properties as 2 python dictionary args. the Python invoke function can then edit the properties based on the event, once its finished the properties are copied back to the operator. python exec and invoke functions can now return RUNNING_MODAL, CANCELLED, FINISHED, PASS_THROUGH flags Still need to look into how python operators can make use of invoke/exec for a practical case. (Need to bring back the popup menu's)
2008-12-28 08:41:49 +00:00
*
* Contributor(s): Campbell Barton
*
* ***** END GPL LICENSE BLOCK *****
*/
doxygen: blender/python tagged.
2011-02-27 20:10:08 +00:00
/** \file blender/python/intern/bpy_util.c
* \ingroup pythonintern
documentation - brief descriptions for bpy api files.
2011-11-05 08:21:12 +00:00
*
* This file contains blender/python utility functions for the api's internal
* use (unrelated to 'bpy.utils')
doxygen: blender/python tagged.
2011-02-27 20:10:08 +00:00
*/
python api renaming and added headers for some files which didnt have one, no functionality change.
2011-02-14 04:15:25 +00:00
#include <Python.h>
PyOperator invoke function now receives the wmEvent and default properties as 2 python dictionary args. the Python invoke function can then edit the properties based on the event, once its finished the properties are copied back to the operator. python exec and invoke functions can now return RUNNING_MODAL, CANCELLED, FINISHED, PASS_THROUGH flags Still need to look into how python operators can make use of invoke/exec for a practical case. (Need to bring back the popup menu's)
2008-12-28 08:41:49 +00:00
#include "bpy_util.h"
#include "BLI_dynstr.h"
#include "MEM_guardedalloc.h"
RNA: Generic Type Registration The Python API to define Panels and Operators is based on subclassing, this makes that system more generic, and based on RNA. Hopefully that will make it easy to make various parts of Blender more extensible. * The system simply uses RNA properties and functions and marks them with REGISTER to make them part of the type registration process. Additionally, the struct must provide a register/unregister callback to create/free the PanelType or similar. * From the python side there were some small changes, mainly that registration now goes trough bpy.types.register instead of bpy.ui.addPanel. * Only Panels have been wrapped this way now. Check rna_ui.c to see how this code works. There's still some rough edges and possibilities to make it cleaner, though it works without any manual python code. * Started some docs here: http://wiki.blender.org/index.php/BlenderDev/Blender2.5/RNATypeRegistration * Also changed some RNA_property and RNA_struct functions to not require a PointerRNA anymore, where they were not required (which is actually the cause of most changed files).
2009-04-19 13:37:59 +00:00
#include "BKE_report.h"
bugfix [#23285] Exporters not available whel using special characters in path name - ID properties now suopport non utf-8 strings for their values but not their keys. - moved utility functions into py_capi_utils.c from bpy_utils and bpy_rna. - import/export paths have to be printed with repr() or %r, so non utf-8 chars are escaped.
2010-09-01 14:13:48 +00:00
#include "BKE_context.h"
PyOperator invoke function now receives the wmEvent and default properties as 2 python dictionary args. the Python invoke function can then edit the properties based on the event, once its finished the properties are copied back to the operator. python exec and invoke functions can now return RUNNING_MODAL, CANCELLED, FINISHED, PASS_THROUGH flags Still need to look into how python operators can make use of invoke/exec for a practical case. (Need to bring back the popup menu's)
2008-12-28 08:41:49 +00:00
bugfix [#23285] Exporters not available whel using special characters in path name - ID properties now suopport non utf-8 strings for their values but not their keys. - moved utility functions into py_capi_utils.c from bpy_utils and bpy_rna. - import/export paths have to be printed with repr() or %r, so non utf-8 chars are escaped.
2010-09-01 14:13:48 +00:00
#include "../generic/py_capi_utils.h"
Store the context for python in a static variable with assessor functions - BPy_GetContext/BPy_SetContext, Still not happy with this in the long term but its less problematic then storing the context in pythons namespace which couldn't be set before importing modules. This might fix a crash quite a few people have reported (but I cant reproduce).
2009-05-25 13:48:44 +00:00
C, style changes (mostly white space edits), no functional change.
2011-03-19 11:12:48 +00:00
static bContext* __py_context= NULL;
fix for some pedantic warnings.
2010-12-03 01:52:28 +00:00
bContext* BPy_GetContext(void) { return __py_context; }
void BPy_SetContext(bContext *C) { __py_context= C; }
Store the context for python in a static variable with assessor functions - BPy_GetContext/BPy_SetContext, Still not happy with this in the long term but its less problematic then storing the context in pythons namespace which couldn't be set before importing modules. This might fix a crash quite a few people have reported (but I cant reproduce).
2009-05-25 13:48:44 +00:00
Python Panels WIP - Register python panels - Added a generic class checking function BPY_class_validate() for panels/operators. - No button drawing yet Brecht, Added RNA_enum_value_from_id() and RNA_enum_id_from_value() to rna_access.c to do lookups between identifiers and values of EnumPropertyItem's, Not sure if these should go here.
2009-04-01 12:43:07 +00:00
char *BPy_enum_as_string(EnumPropertyItem *item)
{
DynStr *dynstr= BLI_dynstr_new();
EnumPropertyItem *e;
char *cstring;
for (e= item; item->identifier; item++) {
formatting edits & remove debug print.
2011-10-13 01:29:08 +00:00
if (item->identifier[0])
RNA * Enums can now be dynamically created in the _itemf callback, using RNA_enum_item(s)_add, RNA_enum_item_end. All places asking for enum items now need to potentially free the items. * This callback now also gets context, this was added specifically for operators. This doesn't fit design well at all, needed to do some ugly hacks, but can't find a good solution at the moment. * All enums must have a default list of items too, even with an _itemf callback, for docs and fallback in case there is no context. * Used by MESH_OT_merge, MESH_OT_select_similar, TFM_OT_select_orientation. * Also changes some operator properties that were enums to booleas (unselected, deselect), to make them consistent with other ops.
2009-07-10 19:56:13 +00:00
BLI_dynstr_appendf(dynstr, (e==item)?"'%s'":", '%s'", item->identifier);
Python Panels WIP - Register python panels - Added a generic class checking function BPY_class_validate() for panels/operators. - No button drawing yet Brecht, Added RNA_enum_value_from_id() and RNA_enum_id_from_value() to rna_access.c to do lookups between identifiers and values of EnumPropertyItem's, Not sure if these should go here.
2009-04-01 12:43:07 +00:00
}
C, style changes (mostly white space edits), no functional change.
2011-03-19 11:12:48 +00:00
cstring= BLI_dynstr_get_cstring(dynstr);
Python Panels WIP - Register python panels - Added a generic class checking function BPY_class_validate() for panels/operators. - No button drawing yet Brecht, Added RNA_enum_value_from_id() and RNA_enum_id_from_value() to rna_access.c to do lookups between identifiers and values of EnumPropertyItem's, Not sure if these should go here.
2009-04-01 12:43:07 +00:00
BLI_dynstr_free(dynstr);
return cstring;
}
RNA: Generic Type Registration The Python API to define Panels and Operators is based on subclassing, this makes that system more generic, and based on RNA. Hopefully that will make it easy to make various parts of Blender more extensible. * The system simply uses RNA properties and functions and marks them with REGISTER to make them part of the type registration process. Additionally, the struct must provide a register/unregister callback to create/free the PanelType or similar. * From the python side there were some small changes, mainly that registration now goes trough bpy.types.register instead of bpy.ui.addPanel. * Only Panels have been wrapped this way now. Check rna_ui.c to see how this code works. There's still some rough edges and possibilities to make it cleaner, though it works without any manual python code. * Started some docs here: http://wiki.blender.org/index.php/BlenderDev/Blender2.5/RNATypeRegistration * Also changed some RNA_property and RNA_struct functions to not require a PointerRNA anymore, where they were not required (which is actually the cause of most changed files).
2009-04-19 13:37:59 +00:00
py/rna: BPy_reports_to_error() now takes the exception type as an argument and returns -1 as an error value
2011-03-12 15:18:08 +00:00
short BPy_reports_to_error(ReportList *reports, PyObject *exception, const short clear)
RNA: Generic Type Registration The Python API to define Panels and Operators is based on subclassing, this makes that system more generic, and based on RNA. Hopefully that will make it easy to make various parts of Blender more extensible. * The system simply uses RNA properties and functions and marks them with REGISTER to make them part of the type registration process. Additionally, the struct must provide a register/unregister callback to create/free the PanelType or similar. * From the python side there were some small changes, mainly that registration now goes trough bpy.types.register instead of bpy.ui.addPanel. * Only Panels have been wrapped this way now. Check rna_ui.c to see how this code works. There's still some rough edges and possibilities to make it cleaner, though it works without any manual python code. * Started some docs here: http://wiki.blender.org/index.php/BlenderDev/Blender2.5/RNATypeRegistration * Also changed some RNA_property and RNA_struct functions to not require a PointerRNA anymore, where they were not required (which is actually the cause of most changed files).
2009-04-19 13:37:59 +00:00
{
char *report_str;
report_str= BKE_reports_string(reports, RPT_ERROR);
formatting edits & remove debug print.
2011-10-13 01:29:08 +00:00
if (clear) {
update python api with changes from Joshua's commit r33917. translate reports into python errors.
2010-12-31 05:40:30 +00:00
BKE_reports_clear(reports);
}
formatting edits & remove debug print.
2011-10-13 01:29:08 +00:00
if (report_str) {
py/rna: BPy_reports_to_error() now takes the exception type as an argument and returns -1 as an error value
2011-03-12 15:18:08 +00:00
PyErr_SetString(exception, report_str);
RNA: Generic Type Registration The Python API to define Panels and Operators is based on subclassing, this makes that system more generic, and based on RNA. Hopefully that will make it easy to make various parts of Blender more extensible. * The system simply uses RNA properties and functions and marks them with REGISTER to make them part of the type registration process. Additionally, the struct must provide a register/unregister callback to create/free the PanelType or similar. * From the python side there were some small changes, mainly that registration now goes trough bpy.types.register instead of bpy.ui.addPanel. * Only Panels have been wrapped this way now. Check rna_ui.c to see how this code works. There's still some rough edges and possibilities to make it cleaner, though it works without any manual python code. * Started some docs here: http://wiki.blender.org/index.php/BlenderDev/Blender2.5/RNATypeRegistration * Also changed some RNA_property and RNA_struct functions to not require a PointerRNA anymore, where they were not required (which is actually the cause of most changed files).
2009-04-19 13:37:59 +00:00
MEM_freeN(report_str);
}
py/rna: BPy_reports_to_error() now takes the exception type as an argument and returns -1 as an error value
2011-03-12 15:18:08 +00:00
return (report_str == NULL) ? 0 : -1;
RNA: Generic Type Registration The Python API to define Panels and Operators is based on subclassing, this makes that system more generic, and based on RNA. Hopefully that will make it easy to make various parts of Blender more extensible. * The system simply uses RNA properties and functions and marks them with REGISTER to make them part of the type registration process. Additionally, the struct must provide a register/unregister callback to create/free the PanelType or similar. * From the python side there were some small changes, mainly that registration now goes trough bpy.types.register instead of bpy.ui.addPanel. * Only Panels have been wrapped this way now. Check rna_ui.c to see how this code works. There's still some rough edges and possibilities to make it cleaner, though it works without any manual python code. * Started some docs here: http://wiki.blender.org/index.php/BlenderDev/Blender2.5/RNATypeRegistration * Also changed some RNA_property and RNA_struct functions to not require a PointerRNA anymore, where they were not required (which is actually the cause of most changed files).
2009-04-19 13:37:59 +00:00
}
Blender/Python API Send the full python stack trace to the reporting api, added BPY_exception_buffer which temporarily overrides sys.stdout and sys.stderr to get the output (uses the io module in py3 StringIO in py2 to avoid writing into a real file), pity the Py/C api has no function to do this. fix for crash when showing menu's that have no items.
2009-06-14 12:53:47 +00:00
update python api with changes from Joshua's commit r33917. translate reports into python errors.
2010-12-31 05:40:30 +00:00
short BPy_errors_to_report(ReportList *reports)
Blender/Python API Send the full python stack trace to the reporting api, added BPY_exception_buffer which temporarily overrides sys.stdout and sys.stderr to get the output (uses the io module in py3 StringIO in py2 to avoid writing into a real file), pity the Py/C api has no function to do this. fix for crash when showing menu's that have no items.
2009-06-14 12:53:47 +00:00
{
PyObject *pystring;
workaround for an error with BKE_reportf (actually BLI_dynstr_vappendf) fixes a crash that happens when formatting a python exception into a report. - for now use pythons string formatting function. happens when running the simple operator template so not sure if its worth re-tagging :S
2009-11-23 17:36:44 +00:00
PyObject *pystring_format= NULL; // workaround, see below
Blender/Python API Send the full python stack trace to the reporting api, added BPY_exception_buffer which temporarily overrides sys.stdout and sys.stderr to get the output (uses the io module in py3 StringIO in py2 to avoid writing into a real file), pity the Py/C api has no function to do this. fix for crash when showing menu's that have no items.
2009-06-14 12:53:47 +00:00
char *cstring;
- missing return values - more detailed exceptions (always give file:line incase the python exception doesnt) - fix some errors in the edit docs editing docs still fails, need to figure out why.
2009-11-04 22:36:46 +00:00
- PyLineSpit() - used to print the filename and line number for internal errors now works when executing class functions in a module. - replaced PySys_GetObject("modules") with PyImport_GetModuleDict() - use defaults for keymap import/export rather then setting the same value every time from the UI scripts.
2010-08-14 05:33:20 +00:00
const char *filename;
- missing return values - more detailed exceptions (always give file:line incase the python exception doesnt) - fix some errors in the edit docs editing docs still fails, need to figure out why.
2009-11-04 22:36:46 +00:00
int lineno;
Blender/Python API Send the full python stack trace to the reporting api, added BPY_exception_buffer which temporarily overrides sys.stdout and sys.stderr to get the output (uses the io module in py3 StringIO in py2 to avoid writing into a real file), pity the Py/C api has no function to do this. fix for crash when showing menu's that have no items.
2009-06-14 12:53:47 +00:00
if (!PyErr_Occurred())
return 1;
/* less hassle if we allow NULL */
formatting edits & remove debug print.
2011-10-13 01:29:08 +00:00
if (reports==NULL) {
Blender/Python API Send the full python stack trace to the reporting api, added BPY_exception_buffer which temporarily overrides sys.stdout and sys.stderr to get the output (uses the io module in py3 StringIO in py2 to avoid writing into a real file), pity the Py/C api has no function to do this. fix for crash when showing menu's that have no items.
2009-06-14 12:53:47 +00:00
PyErr_Print();
PyErr_Clear();
return 1;
}
bugfix [#23285] Exporters not available whel using special characters in path name - ID properties now suopport non utf-8 strings for their values but not their keys. - moved utility functions into py_capi_utils.c from bpy_utils and bpy_rna. - import/export paths have to be printed with repr() or %r, so non utf-8 chars are escaped.
2010-09-01 14:13:48 +00:00
pystring= PyC_ExceptionBuffer();
Blender/Python API Send the full python stack trace to the reporting api, added BPY_exception_buffer which temporarily overrides sys.stdout and sys.stderr to get the output (uses the io module in py3 StringIO in py2 to avoid writing into a real file), pity the Py/C api has no function to do this. fix for crash when showing menu's that have no items.
2009-06-14 12:53:47 +00:00
formatting edits & remove debug print.
2011-10-13 01:29:08 +00:00
if (pystring==NULL) {
minor changes - remove some warnings - fix typos - cmake allow in-source build (when WITH_IN_SOURCE_BUILD is defined) - cmake, use an explicit list of rna files (don't glob)
2011-04-21 05:49:47 +00:00
BKE_report(reports, RPT_ERROR, "unknown py-exception, couldn't convert");
Blender/Python API Send the full python stack trace to the reporting api, added BPY_exception_buffer which temporarily overrides sys.stdout and sys.stderr to get the output (uses the io module in py3 StringIO in py2 to avoid writing into a real file), pity the Py/C api has no function to do this. fix for crash when showing menu's that have no items.
2009-06-14 12:53:47 +00:00
return 0;
}
bugfix [#23285] Exporters not available whel using special characters in path name - ID properties now suopport non utf-8 strings for their values but not their keys. - moved utility functions into py_capi_utils.c from bpy_utils and bpy_rna. - import/export paths have to be printed with repr() or %r, so non utf-8 chars are escaped.
2010-09-01 14:13:48 +00:00
PyC_FileAndNum(&filename, &lineno);
formatting edits & remove debug print.
2011-10-13 01:29:08 +00:00
if (filename==NULL)
workaround for an error with BKE_reportf (actually BLI_dynstr_vappendf) fixes a crash that happens when formatting a python exception into a report. - for now use pythons string formatting function. happens when running the simple operator template so not sure if its worth re-tagging :S
2009-11-23 17:36:44 +00:00
filename= "<unknown location>";
- missing return values - more detailed exceptions (always give file:line incase the python exception doesnt) - fix some errors in the edit docs editing docs still fails, need to figure out why.
2009-11-04 22:36:46 +00:00
Blender/Python API Send the full python stack trace to the reporting api, added BPY_exception_buffer which temporarily overrides sys.stdout and sys.stderr to get the output (uses the io module in py3 StringIO in py2 to avoid writing into a real file), pity the Py/C api has no function to do this. fix for crash when showing menu's that have no items.
2009-06-14 12:53:47 +00:00
cstring= _PyUnicode_AsString(pystring);
workaround for an error with BKE_reportf (actually BLI_dynstr_vappendf) fixes a crash that happens when formatting a python exception into a report. - for now use pythons string formatting function. happens when running the simple operator template so not sure if its worth re-tagging :S
2009-11-23 17:36:44 +00:00
#if 0 // ARG!. workaround for a bug in blenders use of vsnprintf
- missing return values - more detailed exceptions (always give file:line incase the python exception doesnt) - fix some errors in the edit docs editing docs still fails, need to figure out why.
2009-11-04 22:36:46 +00:00
BKE_reportf(reports, RPT_ERROR, "%s\nlocation:%s:%d\n", cstring, filename, lineno);
workaround for an error with BKE_reportf (actually BLI_dynstr_vappendf) fixes a crash that happens when formatting a python exception into a report. - for now use pythons string formatting function. happens when running the simple operator template so not sure if its worth re-tagging :S
2009-11-23 17:36:44 +00:00
#else
pystring_format= PyUnicode_FromFormat("%s\nlocation:%s:%d\n", cstring, filename, lineno);
cstring= _PyUnicode_AsString(pystring_format);
BKE_report(reports, RPT_ERROR, cstring);
#endif
- missing return values - more detailed exceptions (always give file:line incase the python exception doesnt) - fix some errors in the edit docs editing docs still fails, need to figure out why.
2009-11-04 22:36:46 +00:00
fprintf(stderr, "%s\nlocation:%s:%d\n", cstring, filename, lineno); // not exactly needed. just for testing
Blender/Python API Send the full python stack trace to the reporting api, added BPY_exception_buffer which temporarily overrides sys.stdout and sys.stderr to get the output (uses the io module in py3 StringIO in py2 to avoid writing into a real file), pity the Py/C api has no function to do this. fix for crash when showing menu's that have no items.
2009-06-14 12:53:47 +00:00
Py_DECREF(pystring);
workaround for an error with BKE_reportf (actually BLI_dynstr_vappendf) fixes a crash that happens when formatting a python exception into a report. - for now use pythons string formatting function. happens when running the simple operator template so not sure if its worth re-tagging :S
2009-11-23 17:36:44 +00:00
Py_DECREF(pystring_format); // workaround
Blender/Python API Send the full python stack trace to the reporting api, added BPY_exception_buffer which temporarily overrides sys.stdout and sys.stderr to get the output (uses the io module in py3 StringIO in py2 to avoid writing into a real file), pity the Py/C api has no function to do this. fix for crash when showing menu's that have no items.
2009-06-14 12:53:47 +00:00
return 1;
}
Copy Permalink