Lib/test/test_pyclbr.py

   1 '''
   2    Test cases for pyclbr.py
   3    Nick Mathewson
   4 '''
   5 from test.test_support import run_unittest
   6 import unittest, sys
   7 from types import ClassType, FunctionType, MethodType
   8 import pyclbr
   9 from unittest import TestCase
  10
  11 # This next line triggers an error on old versions of pyclbr.
  12
  13 from commands import getstatus
  14
  15 # Here we test the python class browser code.
  16 #
  17 # The main function in this suite, 'testModule', compares the output
  18 # of pyclbr with the introspected members of a module.  Because pyclbr
  19 # is imperfect (as designed), testModule is called with a set of
  20 # members to ignore.
  21
  22 class PyclbrTest(TestCase):
  23
  24     def assertListEq(self, l1, l2, ignore):
  25         ''' succeed iff {l1} - {ignore} == {l2} - {ignore} '''
  26         l1.sort()
  27         l2.sort()
  28         try:
  29             for p1, p2 in (l1, l2), (l2, l1):
  30                 for item in p1:
  31                     ok = (item in p2) or (item in ignore)
  32                     if not ok:
  33                         self.fail("%r missing" % item)
  34         except:
  35             print >>sys.stderr, "l1=%r\nl2=%r\nignore=%r" % (l1, l2, ignore)
  36             raise
  37
  38     def assertHasattr(self, obj, attr, ignore):
  39         ''' succeed iff hasattr(obj,attr) or attr in ignore. '''
  40         if attr in ignore: return
  41         if not hasattr(obj, attr): print "???", attr
  42         self.failUnless(hasattr(obj, attr),
  43                         'expected hasattr(%r, %r)' % (obj, attr))
  44
  45
  46     def assertHaskey(self, obj, key, ignore):
  47         ''' succeed iff obj.has_key(key) or key in ignore. '''
  48         if key in ignore: return
  49         if not obj.has_key(key):
  50             print >>sys.stderr, "***",key
  51         self.failUnless(obj.has_key(key))
  52
  53     def assertEquals(self, a, b, ignore=None):
  54         ''' succeed iff a == b or a in ignore or b in ignore '''
  55         if (ignore == None) or (a in ignore) or (b in ignore): return
  56
  57         unittest.TestCase.assertEquals(self, a, b)
  58
  59     def checkModule(self, moduleName, module=None, ignore=()):
  60         ''' succeed iff pyclbr.readmodule_ex(modulename) corresponds
  61             to the actual module object, module.  Any identifiers in
  62             ignore are ignored.   If no module is provided, the appropriate
  63             module is loaded with __import__.'''
  64
  65         if module == None:
  66             # Import it.
  67             # ('<silly>' is to work around an API silliness in __import__)
  68             module = __import__(moduleName, globals(), {}, ['<silly>'])
  69
  70         dict = pyclbr.readmodule_ex(moduleName)
  71
  72         def ismethod(obj, name):
  73             if not  isinstance(obj, MethodType):
  74                 return False
  75             if obj.im_self is not None:
  76                 return False
  77             objname = obj.__name__
  78             if objname.startswith("__") and not objname.endswith("__"):
  79                 objname = "_%s%s" % (obj.im_class.__name__, objname)
  80             return objname == name
  81
  82         # Make sure the toplevel functions and classes are the same.
  83         for name, value in dict.items():
  84             if name in ignore:
  85                 continue
  86             self.assertHasattr(module, name, ignore)
  87             py_item = getattr(module, name)
  88             if isinstance(value, pyclbr.Function):
  89                 self.assertEquals(type(py_item), FunctionType)
  90             else:
  91                 self.assertEquals(type(py_item), ClassType)
  92                 real_bases = [base.__name__ for base in py_item.__bases__]
  93                 pyclbr_bases = [ getattr(base, 'name', base)
  94                                  for base in value.super ]
  95
  96                 try:
  97                     self.assertListEq(real_bases, pyclbr_bases, ignore)
  98                 except:
  99                     print >>sys.stderr, "class=%s" % py_item
 100                     raise
 101
 102                 actualMethods = []
 103                 for m in py_item.__dict__.keys():
 104                     if ismethod(getattr(py_item, m), m):
 105                         actualMethods.append(m)
 106                 foundMethods = []
 107                 for m in value.methods.keys():
 108                     if m[:2] == '__' and m[-2:] != '__':
 109                         foundMethods.append('_'+name+m)
 110                     else:
 111                         foundMethods.append(m)
 112
 113                 try:
 114                     self.assertListEq(foundMethods, actualMethods, ignore)
 115                     self.assertEquals(py_item.__module__, value.module)
 116
 117                     self.assertEquals(py_item.__name__, value.name, ignore)
 118                     # can't check file or lineno
 119                 except:
 120                     print >>sys.stderr, "class=%s" % py_item
 121                     raise
 122
 123         # Now check for missing stuff.
 124         def defined_in(item, module):
 125             if isinstance(item, ClassType):
 126                 return item.__module__ == module.__name__
 127             if isinstance(item, FunctionType):
 128                 return item.func_globals is module.__dict__
 129             return False
 130         for name in dir(module):
 131             item = getattr(module, name)
 132             if isinstance(item,  (ClassType, FunctionType)):
 133                 if defined_in(item, module):
 134                     self.assertHaskey(dict, name, ignore)
 135
 136     def test_easy(self):
 137         self.checkModule('pyclbr')
 138         self.checkModule('doctest')
 139         self.checkModule('rfc822')
 140         self.checkModule('difflib')
 141
 142     def test_others(self):
 143         cm = self.checkModule
 144
 145         # These were once about the 10 longest modules
 146         cm('random', ignore=('Random',))  # from _random import Random as CoreGenerator
 147         cm('cgi', ignore=('log',))      # set with = in module
 148         cm('mhlib')
 149         cm('urllib', ignore=('getproxies_registry',
 150                              'open_https')) # not on all platforms
 151         cm('pickle', ignore=('g',))     # from types import *
 152         cm('aifc', ignore=('openfp',))  # set with = in module
 153         cm('Cookie')
 154         cm('sre_parse', ignore=('dump',)) # from sre_constants import *
 155         cm('pdb')
 156         cm('pydoc')
 157
 158         # Tests for modules inside packages
 159         cm('email.Parser')
 160         cm('test.test_pyclbr')
 161
 162
 163 def test_main():
 164     run_unittest(PyclbrTest)
 165
 166
 167 if __name__ == "__main__":
 168     test_main()