pep8 edits and avoid naming conflicts with python builtins
[blender.git] / release / scripts / modules / bpy / 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-80 compliant>
20
21 """
22 This module contains utility functions specific to blender but
23 not assosiated with blenders internal data.
24 """
25
26 __all__ = (
27     "blend_paths",
28     "keyconfig_set",
29     "load_scripts",
30     "modules_from_path",
31     "preset_find",
32     "preset_paths",
33     "refresh_script_paths",
34     "register_class",
35     "register_module",
36     "resource_path",
37     "script_paths",
38     "smpte_from_frame",
39     "smpte_from_seconds",
40     "unregister_class",
41     "unregister_module",
42     "user_resource",
43     "user_script_path",
44     )
45
46 from _bpy import register_class, unregister_class, blend_paths, resource_path
47 from _bpy import script_paths as _bpy_script_paths
48 from _bpy import user_resource as _user_resource
49
50 import bpy as _bpy
51 import os as _os
52 import sys as _sys
53
54 import addon_utils as _addon_utils
55
56 _script_module_dirs = "startup", "modules"
57
58
59 def _test_import(module_name, loaded_modules):
60     use_time = _bpy.app.debug
61
62     if module_name in loaded_modules:
63         return None
64     if "." in module_name:
65         print("Ignoring '%s', can't import files containing "
66               "multiple periods" % module_name)
67         return None
68
69     if use_time:
70         import time
71         t = time.time()
72
73     try:
74         mod = __import__(module_name)
75     except:
76         import traceback
77         traceback.print_exc()
78         return None
79
80     if use_time:
81         print("time %s %.4f" % (module_name, time.time() - t))
82
83     loaded_modules.add(mod.__name__)  # should match mod.__name__ too
84     return mod
85
86
87 def _sys_path_ensure(path):
88     if path not in _sys.path:  # reloading would add twice
89         _sys.path.insert(0, path)
90
91
92 def modules_from_path(path, loaded_modules):
93     """
94     Load all modules in a path and return them as a list.
95
96     :arg path: this path is scanned for scripts and packages.
97     :type path: string
98     :arg loaded_modules: already loaded module names, files matching these
99        names will be ignored.
100     :type loaded_modules: set
101     :return: all loaded modules.
102     :rtype: list
103     """
104     modules = []
105
106     for mod_name, mod_path in _bpy.path.module_names(path):
107         mod = _test_import(mod_name, loaded_modules)
108         if mod:
109             modules.append(mod)
110
111     return modules
112
113
114 _global_loaded_modules = []  # store loaded module names for reloading.
115 import bpy_types as _bpy_types  # keep for comparisons, never ever reload this.
116
117
118 def load_scripts(reload_scripts=False, refresh_scripts=False):
119     """
120     Load scripts and run each modules register function.
121
122     :arg reload_scripts: Causes all scripts to have their unregister method
123        called before loading.
124     :type reload_scripts: bool
125     :arg refresh_scripts: only load scripts which are not already loaded
126        as modules.
127     :type refresh_scripts: bool
128     """
129     use_time = _bpy.app.debug
130
131     prefs = _bpy.context.user_preferences
132
133     if use_time:
134         import time
135         t_main = time.time()
136
137     loaded_modules = set()
138
139     if refresh_scripts:
140         original_modules = _sys.modules.values()
141
142     if reload_scripts:
143         _bpy_types.TypeMap.clear()
144
145         # just unload, don't change user defaults, this means we can sync
146         # to reload. note that they will only actually reload of the
147         # modification time changes. This `won't` work for packages so...
148         # its not perfect.
149         for module_name in [ext.module for ext in prefs.addons]:
150             _addon_utils.disable(module_name, default_set=False)
151
152     def register_module_call(mod):
153         register = getattr(mod, "register", None)
154         if register:
155             try:
156                 register()
157             except:
158                 import traceback
159                 traceback.print_exc()
160         else:
161             print("\nWarning! '%s' has no register function, "
162                   "this is now a requirement for registerable scripts" %
163                   mod.__file__)
164
165     def unregister_module_call(mod):
166         unregister = getattr(mod, "unregister", None)
167         if unregister:
168             try:
169                 unregister()
170             except:
171                 import traceback
172                 traceback.print_exc()
173
174     def test_reload(mod):
175         import imp
176         # reloading this causes internal errors
177         # because the classes from this module are stored internally
178         # possibly to refresh internal references too but for now, best not to.
179         if mod == _bpy_types:
180             return mod
181
182         try:
183             return imp.reload(mod)
184         except:
185             import traceback
186             traceback.print_exc()
187
188     def test_register(mod):
189
190         if refresh_scripts and mod in original_modules:
191             return
192
193         if reload_scripts and mod:
194             print("Reloading:", mod)
195             mod = test_reload(mod)
196
197         if mod:
198             register_module_call(mod)
199             _global_loaded_modules.append(mod.__name__)
200
201     if reload_scripts:
202
203         # module names -> modules
204         _global_loaded_modules[:] = [_sys.modules[mod_name]
205                                      for mod_name in _global_loaded_modules]
206
207         # loop over and unload all scripts
208         _global_loaded_modules.reverse()
209         for mod in _global_loaded_modules:
210             unregister_module_call(mod)
211
212         for mod in _global_loaded_modules:
213             test_reload(mod)
214
215         _global_loaded_modules[:] = []
216
217     for base_path in script_paths():
218         for path_subdir in _script_module_dirs:
219             path = _os.path.join(base_path, path_subdir)
220             if _os.path.isdir(path):
221                 _sys_path_ensure(path)
222
223                 # only add this to sys.modules, don't run
224                 if path_subdir == "modules":
225                     continue
226
227                 for mod in modules_from_path(path, loaded_modules):
228                     test_register(mod)
229
230     # deal with addons separately
231     _addon_utils.reset_all(reload_scripts)
232
233     # run the active integration preset
234     filepath = preset_find(prefs.inputs.active_keyconfig, "keyconfig")
235
236     if filepath:
237         keyconfig_set(filepath)
238
239     if reload_scripts:
240         import gc
241         print("gc.collect() -> %d" % gc.collect())
242
243     if use_time:
244         print("Python Script Load Time %.4f" % (time.time() - t_main))
245
246
247 # base scripts
248 _scripts = _os.path.join(_os.path.dirname(__file__),
249                          _os.path.pardir,
250                          _os.path.pardir,
251                          )
252 _scripts = (_os.path.normpath(_scripts), )
253
254
255 def user_script_path():
256     prefs = _bpy.context.user_preferences
257     path = prefs.filepaths.script_directory
258
259     if path:
260         path = _os.path.normpath(path)
261         return path
262     else:
263         return None
264
265
266 def script_paths(subdir=None, user_pref=True, check_all=False):
267     """
268     Returns a list of valid script paths.
269
270     :arg subdir: Optional subdir.
271     :type subdir: string
272     :arg user_pref: Include the user preference script path.
273     :type user_pref: bool
274     :arg check_all: Include local, user and system paths rather just the paths
275        blender uses.
276     :type check_all: bool
277     :return: script paths.
278     :rtype: list
279     """
280     scripts = list(_scripts)
281     prefs = _bpy.context.user_preferences
282
283     # add user scripts dir
284     if user_pref:
285         user_script_path = prefs.filepaths.script_directory
286     else:
287         user_script_path = None
288
289     if check_all:
290         # all possible paths
291         base_paths = tuple(_os.path.join(resource_path(res), "scripts")
292                            for res in ('LOCAL', 'USER', 'SYSTEM'))
293     else:
294         # only paths blender uses
295         base_paths = _bpy_script_paths()
296
297     for path in base_paths + (user_script_path, ):
298         if path:
299             path = _os.path.normpath(path)
300             if path not in scripts and _os.path.isdir(path):
301                 scripts.append(path)
302
303     if subdir is None:
304         return scripts
305
306     script_paths = []
307     for path in scripts:
308         path_subdir = _os.path.join(path, subdir)
309         if _os.path.isdir(path_subdir):
310             script_paths.append(path_subdir)
311
312     return script_paths
313
314
315 def refresh_script_paths():
316     """
317     Run this after creating new script paths to update sys.path
318     """
319
320     for base_path in script_paths():
321         for path_subdir in _script_module_dirs:
322             path = _os.path.join(base_path, path_subdir)
323             if _os.path.isdir(path):
324                 _sys_path_ensure(path)
325
326     for path in _addon_utils.paths():
327         _sys_path_ensure(path)
328         path = _os.path.join(path, "modules")
329         if _os.path.isdir(path):
330             _sys_path_ensure(path)
331
332
333 _presets = _os.path.join(_scripts[0], "presets")  # FIXME - multiple paths
334
335
336 def preset_paths(subdir):
337     """
338     Returns a list of paths for a specific preset.
339
340     :arg subdir: preset subdirectory (must not be an absolute path).
341     :type subdir: string
342     :return: script paths.
343     :rtype: list
344     """
345     dirs = []
346     for path in script_paths("presets", check_all=True):
347         directory = _os.path.join(path, subdir)
348         if not directory.startswith(path):
349             raise Exception("invalid subdir given %r" % subdir)
350         elif _os.path.isdir(directory):
351             dirs.append(directory)
352     return dirs
353
354
355 def smpte_from_seconds(time, fps=None):
356     """
357     Returns an SMPTE formatted string from the time in seconds: "HH:MM:SS:FF".
358
359     If the *fps* is not given the current scene is used.
360     """
361     import math
362
363     if fps is None:
364         fps = _bpy.context.scene.render.fps
365
366     hours = minutes = seconds = frames = 0
367
368     if time < 0:
369         time = - time
370         neg = "-"
371     else:
372         neg = ""
373
374     if time >= 3600.0:  # hours
375         hours = int(time / 3600.0)
376         time = time % 3600.0
377     if time >= 60.0:  # minutes
378         minutes = int(time / 60.0)
379         time = time % 60.0
380
381     seconds = int(time)
382     frames = int(round(math.floor(((time - seconds) * fps))))
383
384     return "%s%02d:%02d:%02d:%02d" % (neg, hours, minutes, seconds, frames)
385
386
387 def smpte_from_frame(frame, fps=None, fps_base=None):
388     """
389     Returns an SMPTE formatted string from the frame: "HH:MM:SS:FF".
390
391     If *fps* and *fps_base* are not given the current scene is used.
392     """
393
394     if fps is None:
395         fps = _bpy.context.scene.render.fps
396
397     if fps_base is None:
398         fps_base = _bpy.context.scene.render.fps_base
399
400     return smpte_from_seconds((frame * fps_base) / fps, fps)
401
402
403 def preset_find(name, preset_path, display_name=False):
404     if not name:
405         return None
406
407     for directory in preset_paths(preset_path):
408
409         if display_name:
410             filename = ""
411             for fn in _os.listdir(directory):
412                 if fn.endswith(".py") and name == _bpy.path.display_name(fn):
413                     filename = fn
414                     break
415         else:
416             filename = name + ".py"
417
418         if filename:
419             filepath = _os.path.join(directory, filename)
420             if _os.path.exists(filepath):
421                 return filepath
422
423
424 def keyconfig_set(filepath):
425     from os.path import basename, splitext
426
427     if _bpy.app.debug:
428         print("loading preset:", filepath)
429
430     keyconfigs = _bpy.context.window_manager.keyconfigs
431
432     keyconfigs_old = keyconfigs[:]
433
434     try:
435         keyfile = open(filepath)
436         exec(compile(keyfile.read(), filepath, 'exec'), {"__file__": filepath})
437         keyfile.close()
438     except:
439         import traceback
440         traceback.print_exc()
441
442     kc_new = [kc for kc in keyconfigs if kc not in keyconfigs_old][0]
443
444     kc_new.name = ""
445
446     # remove duplicates
447     name = splitext(basename(filepath))[0]
448     while True:
449         kc_dupe = keyconfigs.get(name)
450         if kc_dupe:
451             keyconfigs.remove(kc_dupe)
452         else:
453             break
454
455     kc_new.name = name
456     keyconfigs.active = kc_new
457
458
459 def user_resource(type, path="", create=False):
460     """
461     Return a user resource path (normally from the users home directory).
462
463     :arg type: Resource type in ['DATAFILES', 'CONFIG', 'SCRIPTS', 'AUTOSAVE'].
464     :type type: string
465     :arg subdir: Optional subdirectory.
466     :type subdir: string
467     :arg create: Treat the path as a directory and create
468        it if its not existing.
469     :type create: boolean
470     :return: a path.
471     :rtype: string
472     """
473
474     target_path = _user_resource(type, path)
475
476     if create:
477         # should always be true.
478         if target_path:
479             # create path if not existing.
480             if not _os.path.exists(target_path):
481                 try:
482                     _os.makedirs(target_path)
483                 except:
484                     import traceback
485                     traceback.print_exc()
486                     target_path = ""
487             elif not _os.path.isdir(target_path):
488                 print("Path %r found but isn't a directory!" % target_path)
489                 target_path = ""
490
491     return target_path
492
493
494 def _bpy_module_classes(module, is_registered=False):
495     typemap_list = _bpy_types.TypeMap.get(module, ())
496     i = 0
497     while i < len(typemap_list):
498         cls_weakref = typemap_list[i]
499         cls = cls_weakref()
500
501         if cls is None:
502             del typemap_list[i]
503         else:
504             if is_registered == cls.is_registered:
505                 yield cls
506             i += 1
507
508
509 def register_module(module, verbose=False):
510     if verbose:
511         print("bpy.utils.register_module(%r): ..." % module)
512     cls = None
513     for cls in _bpy_module_classes(module, is_registered=False):
514         if verbose:
515             print("    %r" % cls)
516         try:
517             register_class(cls)
518         except:
519             print("bpy.utils.register_module(): "
520                   "failed to registering class %r" % cls)
521             import traceback
522             traceback.print_exc()
523     if verbose:
524         print("done.\n")
525     if cls is None:
526         raise Exception("register_module(%r): defines no classes" % module)
527
528
529 def unregister_module(module, verbose=False):
530     if verbose:
531         print("bpy.utils.unregister_module(%r): ..." % module)
532     for cls in _bpy_module_classes(module, is_registered=True):
533         if verbose:
534             print("    %r" % cls)
535         try:
536             unregister_class(cls)
537         except:
538             print("bpy.utils.unregister_module(): "
539                   "failed to unregistering class %r" % cls)
540             import traceback
541             traceback.print_exc()
542     if verbose:
543         print("done.\n")