source/tests/bl_run_operators.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 # semi-useful script, runs all operators in a number of different
  22 # contexts, cheap way to find misc small bugs but is in no way a complete test.
  23 #
  24 # only error checked for here is a segfault.
  25
  26 import bpy
  27 import sys
  28
  29 op_blacklist = (
  30     "script.reload",
  31     "export*.*",
  32     "import*.*",
  33     "*.save_*",
  34     "*.read_*",
  35     "*.open_*",
  36     "*.link_append",
  37     "render.render",
  38     "*.*_export",
  39     "*.*_import",
  40     "wm.blenderplayer_start",
  41     "wm.url_open",
  42     "wm.doc_view",
  43     "wm.path_open",
  44     "help.operator_cheat_sheet",
  45     "wm.keyconfig_test",     # just annoying - but harmless
  46     "wm.memory_statistics",  # another annoying one
  47     "console.*",             # just annoying - but harmless
  48     )
  49
  50
  51 def filter_op_list(operators):
  52     from fnmatch import fnmatchcase
  53
  54     def is_op_ok(op):
  55         for op_match in op_blacklist:
  56             if fnmatchcase(op, op_match):
  57                 print("    skipping: %s (%s)" % (op, op_match))
  58                 return False
  59         return True
  60
  61     operators[:] = [op for op in operators if is_op_ok(op[0])]
  62
  63
  64 def run_ops(operators, setup_func=None, reset=True):
  65     print("\ncontext:", setup_func.__name__)
  66     # first invoke
  67     for op_id, op in operators:
  68         if op.poll():
  69             print("    operator:", op_id)
  70             sys.stdout.flush()  # in case of crash
  71
  72             # disable will get blender in a bad state and crash easy!
  73             if reset:
  74                 bpy.ops.wm.read_factory_settings()
  75
  76             setup_func()
  77
  78             for mode in {'EXEC_DEFAULT', 'INVOKE_DEFAULT'}:
  79                 try:
  80                     op(mode)
  81                 except:
  82                     #import traceback
  83                     #traceback.print_exc()
  84                     pass
  85
  86     if not operators:
  87         # run test
  88         if reset:
  89             bpy.ops.wm.read_factory_settings()
  90         setup_func()
  91
  92 # contexts
  93 def ctx_clear_scene():  # copied from batch_import.py
  94     unique_obs = set()
  95     for scene in bpy.data.scenes:
  96         for obj in scene.objects[:]:
  97             scene.objects.unlink(obj)
  98             unique_obs.add(obj)
  99
 100     # remove obdata, for now only worry about the startup scene
 101     for bpy_data_iter in (bpy.data.objects, bpy.data.meshes, bpy.data.lamps, bpy.data.cameras):
 102         for id_data in bpy_data_iter:
 103             bpy_data_iter.remove(id_data)
 104
 105
 106 def ctx_editmode_mesh():
 107     bpy.ops.object.mode_set(mode='EDIT')
 108
 109
 110 def ctx_editmode_mesh_extra():
 111     bpy.ops.object.vertex_group_add()
 112     bpy.ops.object.shape_key_add(from_mix=False)
 113     bpy.ops.object.shape_key_add(from_mix=True)
 114     bpy.ops.mesh.uv_texture_add()
 115     bpy.ops.mesh.vertex_color_add()
 116     bpy.ops.object.material_slot_add()
 117     # editmode last!
 118     bpy.ops.object.mode_set(mode='EDIT')
 119
 120
 121 def ctx_editmode_mesh_empty():
 122     bpy.ops.object.mode_set(mode='EDIT')
 123     bpy.ops.mesh.select_all(action='SELECT')
 124     bpy.ops.mesh.delete()
 125
 126
 127 def ctx_editmode_curves():
 128     bpy.ops.curve.primitive_nurbs_circle_add()
 129     bpy.ops.object.mode_set(mode='EDIT')
 130
 131
 132 def ctx_editmode_curves_empty():
 133     bpy.ops.curve.primitive_nurbs_circle_add()
 134     bpy.ops.object.mode_set(mode='EDIT')
 135     bpy.ops.curve.delete(type='ALL')
 136
 137
 138 def ctx_editmode_surface():
 139     bpy.ops.surface.primitive_nurbs_surface_torus_add()
 140     bpy.ops.object.mode_set(mode='EDIT')
 141
 142
 143 def ctx_editmode_mball():
 144     bpy.ops.object.metaball_add()
 145     bpy.ops.object.mode_set(mode='EDIT')
 146
 147
 148 def ctx_editmode_text():
 149     bpy.ops.object.text_add()
 150     bpy.ops.object.mode_set(mode='EDIT')
 151
 152
 153 def ctx_editmode_armature():
 154     bpy.ops.object.armature_add()
 155     bpy.ops.object.mode_set(mode='EDIT')
 156
 157
 158 def ctx_editmode_armature_empty():
 159     bpy.ops.object.armature_add()
 160     bpy.ops.object.mode_set(mode='EDIT')
 161     bpy.ops.armature.select_all(action='SELECT')
 162     bpy.ops.armature.delete()
 163
 164
 165 def ctx_editmode_lattice():
 166     bpy.ops.object.add(type='LATTICE')
 167     bpy.ops.object.mode_set(mode='EDIT')
 168     # bpy.ops.object.vertex_group_add()
 169
 170
 171 def ctx_object_empty():
 172     bpy.ops.object.add(type='EMPTY')
 173
 174
 175 def ctx_object_pose():
 176     bpy.ops.object.armature_add()
 177     bpy.ops.object.mode_set(mode='POSE')
 178     bpy.ops.pose.select_all(action='SELECT')
 179
 180
 181 def ctx_object_paint_weight():
 182     bpy.ops.object.mode_set(mode='WEIGHT_PAINT')
 183
 184
 185 def ctx_object_paint_vertex():
 186     bpy.ops.object.mode_set(mode='VERTEX_PAINT')
 187
 188
 189 def ctx_object_paint_sculpt():
 190     bpy.ops.object.mode_set(mode='SCULPT')
 191
 192
 193 def ctx_object_paint_texture():
 194     bpy.ops.object.mode_set(mode='TEXTURE_PAINT')
 195
 196
 197 def bpy_check_type_duplicates():
 198     # non essential sanity check
 199     bl_types = dir(bpy.types)
 200     bl_types_unique = set(bl_types)
 201
 202     if len(bl_types) != len(bl_types_unique):
 203         print("Error, found duplicates in 'bpy.types'")
 204         for t in sorted(bl_types_unique):
 205             tot = bl_types.count(t)
 206             if tot > 1:
 207                 print("    '%s', %d" % (t, tot))
 208         import sys
 209         sys.exit(1)
 210
 211
 212 def main():
 213
 214     bpy_check_type_duplicates()
 215
 216     # bpy.ops.wm.read_factory_settings()
 217     import bpy
 218     operators = []
 219     for mod_name in dir(bpy.ops):
 220         mod = getattr(bpy.ops, mod_name)
 221         for submod_name in dir(mod):
 222             op = getattr(mod, submod_name)
 223             operators.append(("%s.%s" % (mod_name, submod_name), op))
 224
 225     operators.sort(key=lambda op: op[0])
 226
 227     filter_op_list(operators)
 228
 229     # for testing, mix the list up.
 230     #operators.reverse()
 231
 232     #import random
 233     #random.shuffle(operators)
 234
 235     # 2 passes, first just run setup_func to make sure they are ok
 236     for operators_test in ((), operators):
 237         # Run the operator tests in different contexts
 238         run_ops(operators_test, setup_func=lambda: None)
 239         run_ops(operators_test, setup_func=ctx_clear_scene)
 240         # object modes
 241         run_ops(operators_test, setup_func=ctx_object_empty)
 242         run_ops(operators_test, setup_func=ctx_object_pose)
 243         run_ops(operators_test, setup_func=ctx_object_paint_weight)
 244         run_ops(operators_test, setup_func=ctx_object_paint_vertex)
 245         run_ops(operators_test, setup_func=ctx_object_paint_sculpt)
 246         run_ops(operators_test, setup_func=ctx_object_paint_texture)
 247         # mesh
 248         run_ops(operators_test, setup_func=ctx_editmode_mesh)
 249         run_ops(operators_test, setup_func=ctx_editmode_mesh_extra)
 250         run_ops(operators_test, setup_func=ctx_editmode_mesh_empty)
 251         # armature
 252         run_ops(operators_test, setup_func=ctx_editmode_armature)
 253         run_ops(operators_test, setup_func=ctx_editmode_armature_empty)
 254         # curves
 255         run_ops(operators_test, setup_func=ctx_editmode_curves)
 256         run_ops(operators_test, setup_func=ctx_editmode_curves_empty)
 257         run_ops(operators_test, setup_func=ctx_editmode_surface)
 258         # other
 259         run_ops(operators_test, setup_func=ctx_editmode_mball)
 260         run_ops(operators_test, setup_func=ctx_editmode_text)
 261         run_ops(operators_test, setup_func=ctx_editmode_lattice)
 262
 263         if not operators_test:
 264             print("All setup functions run fine!")
 265
 266     print("Finished %r" % __file__)
 267
 268 if __name__ == "__main__":
 269     main()