pep8 cleanup
[blender.git] / release / scripts / modules / addon_utils.py
1 # ##### BEGIN GPL LICENSE BLOCK #####
2 #
3 #  This program is free software; you can redistribute it and/or
4 #  modify it under the terms of the GNU General Public License
5 #  as published by the Free Software Foundation; either version 2
6 #  of the License, or (at your option) any later version.
7 #
8 #  This program is distributed in the hope that it will be useful,
9 #  but WITHOUT ANY WARRANTY; without even the implied warranty of
10 #  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 #  GNU General Public License for more details.
12 #
13 #  You should have received a copy of the GNU General Public License
14 #  along with this program; if not, write to the Free Software Foundation,
15 #  Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ##### END GPL LICENSE BLOCK #####
18
19 # <pep8 compliant>
20
21 __all__ = (
22     "paths",
23     "modules",
24     "check",
25     "enable",
26     "disable",
27     "reset_all",
28     "module_bl_info",
29 )
30
31 import bpy as _bpy
32
33
34 def paths():
35     # RELEASE SCRIPTS: official scripts distributed in Blender releases
36     paths = _bpy.utils.script_paths("addons")
37
38     # CONTRIB SCRIPTS: good for testing but not official scripts yet
39     # if folder addons_contrib/ exists, scripts in there will be loaded too
40     paths += _bpy.utils.script_paths("addons_contrib")
41
42     # EXTERN SCRIPTS: external projects scripts
43     # if folder addons_extern/ exists, scripts in there will be loaded too
44     paths += _bpy.utils.script_paths("addons_extern")
45
46     return paths
47
48
49 def modules(module_cache):
50     import os
51     import sys
52     import time
53
54     path_list = paths()
55
56     # fake module importing
57     def fake_module(mod_name, mod_path, speedy=True):
58         if _bpy.app.debug:
59             print("fake_module", mod_path, mod_name)
60         import ast
61         ModuleType = type(ast)
62         file_mod = open(mod_path, "r", encoding='UTF-8')
63         if speedy:
64             lines = []
65             line_iter = iter(file_mod)
66             l = ""
67             while not l.startswith("bl_info"):
68                 l = line_iter.readline()
69                 if len(l) == 0:
70                     break
71             while l.rstrip():
72                 lines.append(l)
73                 l = line_iter.readline()
74             data = "".join(lines)
75
76         else:
77             data = file_mod.read()
78
79         file_mod.close()
80
81         try:
82             ast_data = ast.parse(data, filename=mod_path)
83         except:
84             print("Syntax error 'ast.parse' can't read %r" % mod_path)
85             import traceback
86             traceback.print_exc()
87             ast_data = None
88
89         body_info = None
90
91         if ast_data:
92             for body in ast_data.body:
93                 if body.__class__ == ast.Assign:
94                     if len(body.targets) == 1:
95                         if getattr(body.targets[0], "id", "") == "bl_info":
96                             body_info = body
97                             break
98
99         if body_info:
100             mod = ModuleType(mod_name)
101             mod.bl_info = ast.literal_eval(body.value)
102             mod.__file__ = mod_path
103             mod.__time__ = os.path.getmtime(mod_path)
104             return mod
105         else:
106             return None
107
108     modules_stale = set(module_cache.keys())
109
110     for path in path_list:
111         for mod_name, mod_path in _bpy.path.module_names(path):
112             modules_stale -= {mod_name}
113             mod = module_cache.get(mod_name)
114             if mod:
115                 if mod.__time__ != os.path.getmtime(mod_path):
116                     print("reloading addon:", mod_name, mod.__time__, os.path.getmtime(mod_path), mod_path)
117                     del module_cache[mod_name]
118                     mod = None
119
120             if mod is None:
121                 mod = fake_module(mod_name, mod_path)
122                 if mod:
123                     module_cache[mod_name] = mod
124
125     # just incase we get stale modules, not likely
126     for mod_stale in modules_stale:
127         del module_cache[mod_stale]
128     del modules_stale
129
130     mod_list = list(module_cache.values())
131     mod_list.sort(key=lambda mod: (mod.bl_info['category'], mod.bl_info['name']))
132     return mod_list
133
134
135 def check(module_name):
136     """
137     Returns the loaded state of the addon.
138
139     :arg module_name: The name of the addon and module.
140     :type module_name: string
141     :return: (loaded_default, loaded_state)
142     :rtype: tuple of booleans
143     """
144     import sys
145     loaded_default = module_name in _bpy.context.user_preferences.addons
146
147     mod = sys.modules.get(module_name)
148     loaded_state = mod and getattr(mod, "__addon_enabled__", Ellipsis)
149
150     if loaded_state is Ellipsis:
151         print("Warning: addon-module %r found module but without"
152                " __addon_enabled__ field, possible name collision from file: %r" %
153                (module_name, getattr(mod, "__file__", "<unknown>")))
154
155         loaded_state = False
156
157     return loaded_default, loaded_state
158
159
160 def enable(module_name, default_set=True):
161     """
162     Enables an addon by name.
163
164     :arg module_name: The name of the addon and module.
165     :type module_name: string
166     :return: the loaded module or None on failier.
167     :rtype: module
168     """
169     # note, this still gets added to _bpy_types.TypeMap
170
171     import os
172     import sys
173     import bpy_types as _bpy_types
174     import imp
175
176     def handle_error():
177         import traceback
178         traceback.print_exc()
179
180     # reload if the mtime changes
181     mod = sys.modules.get(module_name)
182     if mod:
183         mod.__addon_enabled__ = False
184         mtime_orig = getattr(mod, "__time__", 0)
185         mtime_new = os.path.getmtime(mod.__file__)
186         if mtime_orig != mtime_new:
187             print("module changed on disk:", mod.__file__, "reloading...")
188
189             try:
190                 imp.reload(mod)
191             except:
192                 handle_error()
193                 del sys.modules[module_name]
194                 return None
195             mod.__addon_enabled__ = False
196
197     # Split registering up into 3 steps so we can undo if it fails par way through
198     # 1) try import
199     try:
200         mod = __import__(module_name)
201         mod.__time__ = os.path.getmtime(mod.__file__)
202         mod.__addon_enabled__ = False
203     except:
204         handle_error()
205         return None
206
207     # 2) try register collected modules
208     # removed, addons need to handle own registration now.
209
210     # 3) try run the modules register function
211     try:
212         mod.register()
213     except:
214         handle_error()
215         del sys.modules[module_name]
216         return None
217
218     # * OK loaded successfully! *
219     if default_set:
220         # just incase its enabled alredy
221         ext = _bpy.context.user_preferences.addons.get(module_name)
222         if not ext:
223             ext = _bpy.context.user_preferences.addons.new()
224             ext.module = module_name
225
226     mod.__addon_enabled__ = True
227
228     if _bpy.app.debug:
229         print("\taddon_utils.enable", mod.__name__)
230
231     return mod
232
233
234 def disable(module_name, default_set=True):
235     """
236     Disables an addon by name.
237
238     :arg module_name: The name of the addon and module.
239     :type module_name: string
240     """
241     import sys
242     import traceback
243     import bpy_types as _bpy_types
244
245     mod = sys.modules.get(module_name)
246
247     # possible this addon is from a previous session and didnt load a module this time.
248     # so even if the module is not found, still disable the addon in the user prefs.
249     if mod:
250         mod.__addon_enabled__ = False
251
252         try:
253             mod.unregister()
254         except:
255             traceback.print_exc()
256     else:
257         print("addon_utils.disable", module_name, "not loaded")
258
259     # could be in more then once, unlikely but better do this just incase.
260     addons = _bpy.context.user_preferences.addons
261
262     if default_set:
263         while module_name in addons:
264             addon = addons.get(module_name)
265             if addon:
266                 addons.remove(addon)
267
268     if _bpy.app.debug:
269         print("\taddon_utils.disable", module_name)
270
271
272 def reset_all(reload_scripts=False):
273     """
274     Sets the addon state based on the user preferences.
275     """
276     import sys
277     import imp
278
279     # RELEASE SCRIPTS: official scripts distributed in Blender releases
280     paths_list = paths()
281
282     for path in paths_list:
283         _bpy.utils._sys_path_ensure(path)
284         for mod_name, mod_path in _bpy.path.module_names(path):
285             is_enabled, is_loaded = check(mod_name)
286
287             # first check if reload is needed before changing state.
288             if reload_scripts:
289                 mod = sys.modules.get(mod_name)
290                 if mod:
291                     imp.reload(mod)
292
293             if is_enabled == is_loaded:
294                 pass
295             elif is_enabled:
296                 enable(mod_name)
297             elif is_loaded:
298                 print("\taddon_utils.reset_all unloading", mod_name)
299                 disable(mod_name)
300
301
302 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}):
303     addon_info = getattr(mod, "bl_info", {})
304
305     # avoid re-initializing
306     if "_init" in addon_info:
307         return addon_info
308
309     if not addon_info:
310         mod.bl_info = addon_info
311
312     for key, value in info_basis.items():
313         addon_info.setdefault(key, value)
314
315     if not addon_info["name"]:
316         addon_info["name"] = mod.__name__
317
318     addon_info["_init"] = None
319     return addon_info