[Bf-blender-cvs] [dc8dd243514] master: PyAPI: remove support for importing text blocks as modules
Campbell Barton
noreply at git.blender.org
Thu Apr 18 15:02:54 CEST 2019
Commit: dc8dd24351462e73c5d0260564aad9cd56fd6c33
Author: Campbell Barton
Date: Thu Apr 18 14:45:23 2019 +0200
Branches: master
https://developer.blender.org/rBdc8dd24351462e73c5d0260564aad9cd56fd6c33
PyAPI: remove support for importing text blocks as modules
Allowing direct import of text blocks isn't especially useful,
instead add `text.as_module()` script authors can do this
explicitly if it's needed.
Now the text "Register" option executes
instead of loading as a module.
This removes the need to keep track of the current Main,
and C code to override Python's import & reload.
===================================================================
M release/scripts/modules/bpy_types.py
M source/blender/makesrna/intern/rna_text.c
M source/blender/python/generic/CMakeLists.txt
D source/blender/python/generic/bpy_internal_import.c
D source/blender/python/generic/bpy_internal_import.h
M source/blender/python/intern/bpy_interface.c
M source/blender/python/intern/bpy_operator.c
M source/blender/python/intern/stubs.c
===================================================================
diff --git a/release/scripts/modules/bpy_types.py b/release/scripts/modules/bpy_types.py
index 32e8fe40c6a..fb4ccfaff7a 100644
--- a/release/scripts/modules/bpy_types.py
+++ b/release/scripts/modules/bpy_types.py
@@ -523,6 +523,15 @@ class Text(bpy_types.ID):
self.clear()
self.write(string)
+ def as_module(self):
+ from os.path import splitext
+ from types import ModuleType
+ mod = ModuleType(splitext(self.name)[0])
+ # TODO: We could use Text.compiled (C struct member)
+ # if this is called often it will be much faster.
+ exec(self.as_string(), mod.__dict__)
+ return mod
+
class Sound(bpy_types.ID):
__slots__ = ()
diff --git a/source/blender/makesrna/intern/rna_text.c b/source/blender/makesrna/intern/rna_text.c
index 5b75937ce72..589f7818b68 100644
--- a/source/blender/makesrna/intern/rna_text.c
+++ b/source/blender/makesrna/intern/rna_text.c
@@ -172,9 +172,7 @@ static void rna_def_text(BlenderRNA *brna)
prop = RNA_def_property(srna, "use_module", PROP_BOOLEAN, PROP_NONE);
RNA_def_property_boolean_sdna(prop, NULL, "flags", TXT_ISSCRIPT);
RNA_def_property_ui_text(
- prop,
- "Register",
- "Register this text as a module on loading, Text name must end with \".py\"");
+ prop, "Register", "Run this text as a script on loading, Text name must end with \".py\"");
prop = RNA_def_property(srna, "use_tabs_as_spaces", PROP_BOOLEAN, PROP_NONE);
RNA_def_property_boolean_sdna(prop, NULL, "flags", TXT_TABSTOSPACES);
diff --git a/source/blender/python/generic/CMakeLists.txt b/source/blender/python/generic/CMakeLists.txt
index 3b4182bc795..fa73f161a5d 100644
--- a/source/blender/python/generic/CMakeLists.txt
+++ b/source/blender/python/generic/CMakeLists.txt
@@ -33,7 +33,6 @@ set(INC_SYS
set(SRC
bgl.c
blf_py_api.c
- bpy_internal_import.c
bpy_threads.c
idprop_py_api.c
imbuf_py_api.c
@@ -41,7 +40,6 @@ set(SRC
bgl.h
blf_py_api.h
- bpy_internal_import.h
idprop_py_api.h
imbuf_py_api.h
py_capi_utils.h
diff --git a/source/blender/python/generic/bpy_internal_import.c b/source/blender/python/generic/bpy_internal_import.c
deleted file mode 100644
index 2df828d89e0..00000000000
--- a/source/blender/python/generic/bpy_internal_import.c
+++ /dev/null
@@ -1,375 +0,0 @@
-/*
- * 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,
- * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
- */
-
-/** \file
- * \ingroup pygen
- *
- * This file defines replacements for pythons '__import__' and 'imp.reload'
- * functions which can import from blender textblocks.
- *
- * \note
- * This should eventually be replaced by import hooks (pep 302).
- */
-
-#include <Python.h>
-#include <stddef.h>
-
-#include "MEM_guardedalloc.h"
-
-#include "DNA_text_types.h"
-
-#include "BLI_listbase.h"
-#include "BLI_path_util.h"
-#include "BLI_string.h"
-#include "BLI_utildefines.h"
-
-#include "BKE_main.h"
-/* UNUSED */
-#include "BKE_text.h" /* txt_to_buf */
-
-#include "py_capi_utils.h"
-
-#include "bpy_internal_import.h" /* own include */
-
-static Main *bpy_import_main = NULL;
-static ListBase bpy_import_main_list;
-
-static PyMethodDef bpy_import_meth;
-static PyMethodDef bpy_reload_meth;
-static PyObject *imp_reload_orig = NULL;
-
-/* 'builtins' is most likely PyEval_GetBuiltins() */
-
-/**
- * \note to the discerning developer, yes - this is nasty
- * monkey-patching our own import into Python's builtin 'imp' module.
- *
- * However Python's alternative is to use import hooks,
- * which are implemented in a way that we can't use our own importer as a
- * fall-back (instead we must try and fail - raise an exception every time).
- * Since importing from blenders text-blocks is not the common case
- * I prefer to use Pythons import by default and fall-back to
- * Blenders - which we can only do by intercepting import calls I'm afraid.
- * - Campbell
- */
-void bpy_import_init(PyObject *builtins)
-{
- PyObject *item;
- PyObject *mod;
-
- PyDict_SetItemString(builtins, "__import__", item = PyCFunction_New(&bpy_import_meth, NULL));
- Py_DECREF(item);
-
- /* move reload here
- * XXX, use import hooks */
- mod = PyImport_ImportModuleLevel("importlib", NULL, NULL, NULL, 0);
- if (mod) {
- PyObject *mod_dict = PyModule_GetDict(mod);
-
- /* blender owns the function */
- imp_reload_orig = PyDict_GetItemString(mod_dict, "reload");
- Py_INCREF(imp_reload_orig);
-
- PyDict_SetItemString(mod_dict, "reload", item = PyCFunction_New(&bpy_reload_meth, NULL));
- Py_DECREF(item);
- Py_DECREF(mod);
- }
- else {
- BLI_assert(!"unable to load 'importlib' module.");
- }
-}
-
-static void free_compiled_text(Text *text)
-{
- if (text->compiled) {
- Py_DECREF((PyObject *)text->compiled);
- }
- text->compiled = NULL;
-}
-
-struct Main *bpy_import_main_get(void)
-{
- return bpy_import_main;
-}
-
-void bpy_import_main_set(struct Main *maggie)
-{
- bpy_import_main = maggie;
-}
-
-/* returns a dummy filename for a textblock so we can tell what file a text block comes from */
-void bpy_text_filename_get(char *fn, size_t fn_len, Text *text)
-{
- BLI_snprintf(
- fn, fn_len, "%s%c%s", ID_BLEND_PATH(bpy_import_main, &text->id), SEP, text->id.name + 2);
-}
-
-bool bpy_text_compile(Text *text)
-{
- char fn_dummy[FILE_MAX];
- PyObject *fn_dummy_py;
- char *buf;
-
- bpy_text_filename_get(fn_dummy, sizeof(fn_dummy), text);
-
- /* if previously compiled, free the object */
- free_compiled_text(text);
-
- fn_dummy_py = PyC_UnicodeFromByte(fn_dummy);
-
- buf = txt_to_buf(text);
- text->compiled = Py_CompileStringObject(buf, fn_dummy_py, Py_file_input, NULL, -1);
- MEM_freeN(buf);
-
- Py_DECREF(fn_dummy_py);
-
- if (PyErr_Occurred()) {
- PyErr_Print();
- PyErr_Clear();
- PySys_SetObject("last_traceback", NULL);
- free_compiled_text(text);
- return false;
- }
- else {
- return true;
- }
-}
-
-PyObject *bpy_text_import(Text *text)
-{
- char modulename[MAX_ID_NAME + 2];
- int len;
-
- if (!text->compiled) {
- if (bpy_text_compile(text) == false) {
- return NULL;
- }
- }
-
- len = strlen(text->id.name + 2);
- BLI_strncpy(modulename, text->id.name + 2, len);
- modulename[len - 3] = '\0'; /* remove .py */
- return PyImport_ExecCodeModule(modulename, text->compiled);
-}
-
-PyObject *bpy_text_import_name(const char *name, int *found)
-{
- Text *text;
- char txtname[MAX_ID_NAME - 2];
- int namelen = strlen(name);
- //XXX Main *maggie = bpy_import_main ? bpy_import_main : G_MAIN;
- Main *maggie = bpy_import_main;
-
- *found = 0;
-
- if (!maggie) {
- printf("ERROR: bpy_import_main_set() was not called before running python. this is a bug.\n");
- return NULL;
- }
-
- /* we know this cant be importable, the name is too long for blender! */
- if (namelen >= (MAX_ID_NAME - 2) - 3) {
- return NULL;
- }
-
- memcpy(txtname, name, namelen);
- memcpy(&txtname[namelen], ".py", 4);
-
- text = BLI_findstring(&maggie->texts, txtname, offsetof(ID, name) + 2);
-
- if (text) {
- *found = 1;
- return bpy_text_import(text);
- }
-
- /* If we still haven't found the module try additional modules form bpy_import_main_list */
- maggie = bpy_import_main_list.first;
- while (maggie && !text) {
- text = BLI_findstring(&maggie->texts, txtname, offsetof(ID, name) + 2);
- maggie = maggie->next;
- }
-
- if (!text) {
- return NULL;
- }
- else {
- *found = 1;
- }
-
- return bpy_text_import(text);
-}
-
-/*
- * find in-memory module and recompile
- */
-
-PyObject *bpy_text_reimport(PyObject *module, int *found)
-{
- Text *text;
- const char *name;
- const char *filepath;
- //XXX Main *maggie = bpy_import_main ? bpy_import_main : G_MAIN;
- Main *maggie = bpy_import_main;
-
- if (!maggie) {
- printf("ERROR: bpy_import_main_set() was not called before running python. this is a bug.\n");
- return NULL;
- }
-
- *found = 0;
-
- /* get name, filename from the module itself */
- if ((name = PyModule_GetName(module)) == NULL) {
- return NULL;
- }
-
- {
- PyObject *module_file = PyModule_GetFilenameObject(module);
- if (module_file == NULL) {
- return NULL;
- }
- filepath = _PyUnicode_AsString(module_file);
- Py_DECREF(module_file);
- if (filepath == NULL) {
- return NULL;
- }
- }
-
- /* look up the text object */
- text = BLI_findstring(&maggie->texts, BLI_path_basename(filepath), offsetof(ID, name) + 2);
-
- /* uh-oh.... didn't find it */
- if (!text) {
- return NULL;
- }
- else {
- *found = 1;
- }
-
- if (bpy_text_compile(text) == false) {
- return NULL;
- }
-
- /* make into a module */
- return PyImport_ExecCodeModule(name, text->compiled);
-}
-
-static PyObject *blender_import(PyObject *UNUSED(self), PyObject *args, PyObject *kw)
-{
- PyObject *exception, *err, *tb;
- const char *name;
- int found = 0;
- PyObject *globals = NULL, *locals = NULL, *fromlist = NULL;
- int level = 0; /* relative imports */
- PyObject *newmodule;
-
- static const char *_keywords[] = {"name", "globals", "locals", "fromlist", "level", NULL};
- static _PyArg_Parser _parser = {"s|OOOi:bpy_import_meth", _keywords, 0};
- if (!_PyArg_ParseTupleAndKeywordsFast(
- args, kw, &_parser, &name, &globals, &locals, &fromlist, &level)) {
- return NULL;
- }
-
- /* import existing builtin modules or modules that have been imported already */
- newmodule = PyImport_ImportModuleLevel(name, globals, locals, fromlist, level);
-
- if (newmodule) {
- return newmodule;
- }
-
- PyErr_Fetch(&exception,
- &err,
-
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list