[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [35015] trunk/blender: move addon utilities into their own module, these were getting mixed between bpy.utils and space_userpref.
Campbell Barton
ideasman42 at gmail.com
Mon Feb 21 08:07:44 CET 2011
Revision: 35015
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=35015
Author: campbellbarton
Date: 2011-02-21 07:07:44 +0000 (Mon, 21 Feb 2011)
Log Message:
-----------
move addon utilities into their own module, these were getting mixed between bpy.utils and space_userpref.
Modified Paths:
--------------
trunk/blender/release/scripts/modules/bpy/utils.py
trunk/blender/release/scripts/ui/space_userpref.py
trunk/blender/source/creator/creator.c
Added Paths:
-----------
trunk/blender/release/scripts/modules/addon_utils.py
Added: trunk/blender/release/scripts/modules/addon_utils.py
===================================================================
--- trunk/blender/release/scripts/modules/addon_utils.py (rev 0)
+++ trunk/blender/release/scripts/modules/addon_utils.py 2011-02-21 07:07:44 UTC (rev 35015)
@@ -0,0 +1,319 @@
+# ##### 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,
+# Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+#
+# ##### END GPL LICENSE BLOCK #####
+
+# <pep8 compliant>
+
+__all__ = (
+ "paths",
+ "modules",
+ "check",
+ "enable",
+ "disable",
+ "reset_all",
+ "module_bl_info",
+)
+
+import bpy
+
+
+def paths():
+ # RELEASE SCRIPTS: official scripts distributed in Blender releases
+ paths = bpy.utils.script_paths("addons")
+
+ # CONTRIB SCRIPTS: good for testing but not official scripts yet
+ # if folder addons_contrib/ exists, scripts in there will be loaded too
+ paths += bpy.utils.script_paths("addons_contrib")
+
+ # EXTERN SCRIPTS: external projects scripts
+ # if folder addons_extern/ exists, scripts in there will be loaded too
+ paths += bpy.utils.script_paths("addons_extern")
+
+ return paths
+
+
+def modules(module_cache):
+ import os
+ import sys
+ import time
+
+ path_list = paths()
+
+ # fake module importing
+ def fake_module(mod_name, mod_path, speedy=True):
+ if bpy.app.debug:
+ print("fake_module", mod_path, mod_name)
+ import ast
+ ModuleType = type(ast)
+ file_mod = open(mod_path, "r", encoding='UTF-8')
+ if speedy:
+ lines = []
+ line_iter = iter(file_mod)
+ l = ""
+ while not l.startswith("bl_info"):
+ l = line_iter.readline()
+ if len(l) == 0:
+ break
+ while l.rstrip():
+ lines.append(l)
+ l = line_iter.readline()
+ data = "".join(lines)
+
+ else:
+ data = file_mod.read()
+
+ file_mod.close()
+
+ try:
+ ast_data = ast.parse(data, filename=mod_path)
+ except:
+ print("Syntax error 'ast.parse' can't read %r" % mod_path)
+ import traceback
+ traceback.print_exc()
+ ast_data = None
+
+ body_info = None
+
+ if ast_data:
+ for body in ast_data.body:
+ if body.__class__ == ast.Assign:
+ if len(body.targets) == 1:
+ if getattr(body.targets[0], "id", "") == "bl_info":
+ body_info = body
+ break
+
+ if body_info:
+ mod = ModuleType(mod_name)
+ mod.bl_info = ast.literal_eval(body.value)
+ mod.__file__ = mod_path
+ mod.__time__ = os.path.getmtime(mod_path)
+ return mod
+ else:
+ return None
+
+ modules_stale = set(module_cache.keys())
+
+ for path in path_list:
+ for mod_name, mod_path in bpy.path.module_names(path):
+ modules_stale -= {mod_name}
+ mod = module_cache.get(mod_name)
+ if mod:
+ if mod.__time__ != os.path.getmtime(mod_path):
+ print("reloading addon:", mod_name, mod.__time__, os.path.getmtime(mod_path), mod_path)
+ del module_cache[mod_name]
+ mod = None
+
+ if mod is None:
+ mod = fake_module(mod_name, mod_path)
+ if mod:
+ module_cache[mod_name] = mod
+
+ # just incase we get stale modules, not likely
+ for mod_stale in modules_stale:
+ del module_cache[mod_stale]
+ del modules_stale
+
+ mod_list = list(module_cache.values())
+ mod_list.sort(key=lambda mod: (mod.bl_info['category'], mod.bl_info['name']))
+ return mod_list
+
+
+def check(module_name):
+ """
+ Returns the loaded state of the addon.
+
+ :arg module_name: The name of the addon and module.
+ :type module_name: string
+ :return: (loaded_default, loaded_state)
+ :rtype: tuple of booleans
+ """
+ import sys
+ loaded_default = module_name in bpy.context.user_preferences.addons
+
+ mod = sys.modules.get(module_name)
+ loaded_state = mod and getattr(mod, "__addon_enabled__", Ellipsis)
+
+ if loaded_state is Ellipsis:
+ print("Warning: addon-module %r found module but without"
+ " __addon_enabled__ field, possible name collision from file: %r" %
+ (module_name, getattr(mod, "__file__", "<unknown>")))
+
+ loaded_state = False
+
+ return loaded_default, loaded_state
+
+
+def enable(module_name, default_set=True):
+ """
+ Enables an addon by name.
+
+ :arg module_name: The name of the addon and module.
+ :type module_name: string
+ :return: the loaded module or None on failier.
+ :rtype: module
+ """
+ # note, this still gets added to _bpy_types.TypeMap
+
+ import os
+ import sys
+ import bpy_types as _bpy_types
+ import imp
+
+ def handle_error():
+ import traceback
+ traceback.print_exc()
+
+ # reload if the mtime changes
+ mod = sys.modules.get(module_name)
+ if mod:
+ mod.__addon_enabled__ = False
+ mtime_orig = getattr(mod, "__time__", 0)
+ mtime_new = os.path.getmtime(mod.__file__)
+ if mtime_orig != mtime_new:
+ print("module changed on disk:", mod.__file__, "reloading...")
+
+ try:
+ imp.reload(mod)
+ except:
+ handle_error()
+ del sys.modules[module_name]
+ return None
+ mod.__addon_enabled__ = False
+
+ # Split registering up into 3 steps so we can undo if it fails par way through
+ # 1) try import
+ try:
+ mod = __import__(module_name)
+ mod.__time__ = os.path.getmtime(mod.__file__)
+ mod.__addon_enabled__ = False
+ except:
+ handle_error()
+ return None
+
+ # 2) try register collected modules
+ # removed, addons need to handle own registration now.
+
+ # 3) try run the modules register function
+ try:
+ mod.register()
+ except:
+ handle_error()
+ del sys.modules[module_name]
+ return None
+
+ # * OK loaded successfully! *
+ if default_set:
+ # just incase its enabled alredy
+ ext = bpy.context.user_preferences.addons.get(module_name)
+ if not ext:
+ ext = bpy.context.user_preferences.addons.new()
+ ext.module = module_name
+
+ mod.__addon_enabled__ = True
+
+ if bpy.app.debug:
+ print("\taddon_utils.enable", mod.__name__)
+
+ return mod
+
+
+def disable(module_name, default_set=True):
+ """
+ Disables an addon by name.
+
+ :arg module_name: The name of the addon and module.
+ :type module_name: string
+ """
+ import sys
+ import traceback
+ import bpy_types as _bpy_types
+
+ mod = sys.modules.get(module_name)
+
+ # possible this addon is from a previous session and didnt load a module this time.
+ # so even if the module is not found, still disable the addon in the user prefs.
+ if mod:
+ mod.__addon_enabled__ = False
+
+ try:
+ mod.unregister()
+ except:
+ traceback.print_exc()
+ else:
+ print("addon_utils.disable", module_name, "not loaded")
+
+ # could be in more then once, unlikely but better do this just incase.
+ addons = bpy.context.user_preferences.addons
+
+ if default_set:
+ while module_name in addons:
+ addon = addons.get(module_name)
+ if addon:
+ addons.remove(addon)
+
+ if bpy.app.debug:
+ print("\taddon_utils.disable", module_name)
+
+
+def reset_all(reload_scripts=False):
+ """
+ Sets the addon state based on the user preferences.
+ """
+ import sys
+ import imp
+
+ # RELEASE SCRIPTS: official scripts distributed in Blender releases
+ paths_list = paths()
+
+ for path in paths_list:
+ bpy.utils._sys_path_ensure(path)
+ for mod_name, mod_path in bpy.path.module_names(path):
+ is_enabled, is_loaded = check(mod_name)
+
+ # first check if reload is needed before changing state.
+ if reload_scripts:
+ mod = sys.modules.get(mod_name)
+ if mod:
+ imp.reload(mod)
+
+ if is_enabled == is_loaded:
+ pass
+ elif is_enabled:
+ enable(mod_name)
+ elif is_loaded:
+ print("\taddon_utils.reset_all unloading", mod_name)
+ addon_disable(mod_name)
+
+
+def module_bl_info(mod, info_basis={"name": "", "author": "", "version": (), "blender": (), "api": 0, "location": "", "description": "", "wiki_url": "", "tracker_url": "", "support": 'COMMUNITY', "category": "", "warning": "", "show_expanded": False}):
+ addon_info = getattr(mod, "bl_info", {})
+
+ # avoid re-initializing
+ if "_init" in addon_info:
+ return addon_info
+
+ if not addon_info:
+ mod.bl_info = addon_info
+
+ for key, value in info_basis.items():
+ addon_info.setdefault(key, value)
+
+ if not addon_info["name"]:
+ addon_info["name"] = mod.__name__
+
+ addon_info["_init"] = None
+ return addon_info
Modified: trunk/blender/release/scripts/modules/bpy/utils.py
===================================================================
--- trunk/blender/release/scripts/modules/bpy/utils.py 2011-02-21 06:58:46 UTC (rev 35014)
+++ trunk/blender/release/scripts/modules/bpy/utils.py 2011-02-21 07:07:44 UTC (rev 35015)
@@ -34,6 +34,7 @@
import os as _os
import sys as _sys
+import addon_utils
def _test_import(module_name, loaded_modules):
import traceback
@@ -114,7 +115,7 @@
# note that they will only actually reload of the modification time changes.
# this `wont` work for packages so... its not perfect.
for module_name in [ext.module for ext in _bpy.context.user_preferences.addons]:
- addon_disable(module_name, default_set=False)
+ addon_utils.disable(module_name, default_set=False)
def register_module_call(mod):
register = getattr(mod, "register", None)
@@ -194,7 +195,7 @@
test_register(mod)
# deal with addons seperately
- addon_reset_all(reload_scripts)
+ addon_utils.reset_all(reload_scripts)
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list