tests/python/bl_keymap_completeness.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 # simple script to test 'keyconfig_utils' contains correct values.
  22
  23
  24 from bpy_extras import keyconfig_utils
  25
  26
  27 def check_maps():
  28     maps = {}
  29
  30     def fill_maps(ls):
  31         for km_name, km_space_type, km_region_type, km_sub in ls:
  32             maps[km_name] = (km_space_type, km_region_type)
  33             fill_maps(km_sub)
  34
  35     fill_maps(keyconfig_utils.KM_HIERARCHY)
  36
  37     import bpy
  38     keyconf = bpy.context.window_manager.keyconfigs.active
  39     maps_bl = set(keyconf.keymaps.keys())
  40     maps_py = set(maps.keys())
  41
  42     err = False
  43     # Check keyconfig contains only maps that exist in blender
  44     test = maps_py - maps_bl
  45     if test:
  46         print("Keymaps that are in 'keyconfig_utils' but not blender")
  47         for km_id in sorted(test):
  48             print("\t%s" % km_id)
  49         err = True
  50
  51     test = maps_bl - maps_py
  52     if test:
  53         print("Keymaps that are in blender but not in 'keyconfig_utils'")
  54         for km_id in sorted(test):
  55             km = keyconf.keymaps[km_id]
  56             print("    ('%s', '%s', '%s', [])," % (km_id, km.space_type, km.region_type))
  57         err = True
  58
  59     # Check space/region's are OK
  60     print("Comparing keymap space/region types...")
  61     for km_id, km in keyconf.keymaps.items():
  62         km_py = maps.get(km_id)
  63         if km_py is not None:
  64             km_space_type, km_region_type = km_py
  65             if km_space_type != km.space_type or km_region_type != km.region_type:
  66                 print("  Error:")
  67                 print("    expected -- ('%s', '%s', '%s', [])," % (km_id, km.space_type, km.region_type))
  68                 print("    got      -- ('%s', '%s', '%s', [])," % (km_id, km_space_type, km_region_type))
  69     print("done!")
  70
  71     return err
  72
  73
  74 def main():
  75     err = check_maps()
  76
  77     import bpy
  78     if err and bpy.app.background:
  79         # alert CTest we failed
  80         import sys
  81         sys.exit(1)
  82
  83
  84 if __name__ == "__main__":
  85     main()