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