source/gameengine/PyDoc/bge_api_validate_py.txt

   1 #~ This program is free software; you can redistribute it and/or modify
   2 #~ it under the terms of the GNU General Public License as published by
   3 #~ the Free Software Foundation; version 2 of the License.
   4
   5 #~ This program is distributed in the hope that it will be useful,
   6 #~ but WITHOUT ANY WARRANTY; without even the implied warranty of
   7 #~ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   8 #~ GNU General Public License for more details.
   9
  10 # This script must run from a logic brick so it has access to the game engine api
  11 # it assumes the root blender source directory is the current working directory
  12 #
  13 # Currently it only prints missing modules and methods (not attributes)
  14
  15 import sys, os
  16
  17 BGE_API_DOC_PATH = 'source/gameengine/PyDoc'
  18
  19
  20 mods = ['GameLogic', 'Rasterizer', 'GameKeys']
  21 mods_dict = {}
  22 for m in mods:
  23         mods_dict[m] = sys.modules[m]
  24
  25
  26 import GameTypes
  27 type_members = {}
  28
  29 for type_name in dir(GameTypes):
  30         if type_name.startswith('__'):
  31                 continue
  32
  33         type_object = getattr(GameTypes, type_name)
  34
  35         members = []
  36         type_members[type_object.__name__] = members
  37
  38         for member in type_object.__dict__.keys():
  39                 if member.startswith('__'):
  40                         continue
  41
  42                 # print type_object.__name__ + '.' + k
  43                 members.append(member)
  44
  45
  46
  47 doc_dir= os.path.join(os.getcwd(), BGE_API_DOC_PATH)
  48
  49 if doc_dir not in sys.path:
  50         sys.path.append(doc_dir)
  51
  52
  53 def check_attribute(type_mame, member):
  54         filename =      os.path.join(doc_dir, type_mame + '.py')
  55         # print filename
  56
  57         file = open(filename, 'rU')
  58
  59         for l in file:
  60                 l = l.strip()
  61
  62                 '''
  63                         @ivar foo: blah blah
  64                 to
  65                         foo
  66
  67                 '''
  68
  69                 if l.startswith('@ivar') or l.startswith('@var'):
  70                         var = l.split()[1].split(':')[0]
  71
  72                         if var == member:
  73                                 file.close()
  74                                 return True
  75
  76         file.close()
  77         return False
  78
  79
  80
  81
  82
  83
  84 print '\n\n\nChecking Docs'
  85
  86 PRINT_OK = False
  87
  88 for type_name in sorted(type_members.keys()):
  89         members = type_members[type_name]
  90
  91         try:
  92                 mod = __import__(type_name)
  93                 if PRINT_OK:
  94                         print "type: %s" % type_name
  95         except:
  96                 print "missing: %s - %s" % (type_name, str(sorted(members)))
  97                 continue
  98
  99         reload(mod) # incase were editing it
 100
 101         try:
 102                 type_class = getattr(mod, type_name)
 103         except:
 104                 print "missing class: %s.%s - %s" % (type_name, type_name, str(sorted(members)))
 105                 continue
 106
 107         for member in sorted(members):
 108                 try:
 109                         getattr(type_class, member)
 110                         if PRINT_OK:
 111                                 print "\tfound: %s.%s" % (type_name, member)
 112                 except:
 113                         if check_attribute(type_name, member):
 114                                 if PRINT_OK:
 115                                         print "\tfound attr: %s.%s" % (type_name, member)
 116                         else:
 117                                 print "\tmissing: %s.%s" % (type_name, member)
 118
 119
 120 # Now check the modules
 121 for mod_name, pymod in mods_dict.iteritems():
 122         print pymod
 123         del sys.modules[mod_name]
 124
 125         # Now well get the python version
 126         pydoc = __import__(mod_name)
 127         pydoc = reload(pydoc) # avoid using the out dated pyc file only
 128         print pydoc.__file__
 129
 130         for member in sorted(dir(pymod)):
 131                 if hasattr(pydoc, member) or check_attribute(mod_name, member):
 132                         if PRINT_OK:
 133                                 print "\tfound module attr: %s.%s" % (mod_name, member)
 134                 else:
 135                         print "\tmissing module attr: %s.%s" % (mod_name, member)
 136
 137         # Restore real module
 138         sys.modules[mod_name] = pymod
 139
 140
 141 sys.path.pop() # remove the pydoc dir from our import paths
 142
 143
 144
 145