Benjamin Peterson | 25cd7eb | 2010-03-30 18:42:32 +0000 | [diff] [blame] | 1 | import re |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 2 | import sys |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 3 | import types |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 4 | import unittest |
| 5 | import inspect |
R. David Murray | a1b3740 | 2010-06-17 02:04:29 +0000 | [diff] [blame] | 6 | import linecache |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 7 | import datetime |
Guido van Rossum | 813b0e5 | 2007-05-21 18:11:34 +0000 | [diff] [blame] | 8 | import collections |
Christian Heimes | a3538eb | 2007-11-06 11:44:48 +0000 | [diff] [blame] | 9 | from os.path import normcase |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 10 | |
Georg Brandl | 1b37e87 | 2010-03-14 10:45:50 +0000 | [diff] [blame] | 11 | from test.support import run_unittest |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 12 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 13 | from test import inspect_fodder as mod |
| 14 | from test import inspect_fodder2 as mod2 |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 15 | |
R. David Murray | 74b8924 | 2009-05-13 17:33:03 +0000 | [diff] [blame] | 16 | # C module for test_findsource_binary |
R. David Murray | b565577 | 2009-05-14 16:17:50 +0000 | [diff] [blame] | 17 | import unicodedata |
R. David Murray | 74b8924 | 2009-05-13 17:33:03 +0000 | [diff] [blame] | 18 | |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 19 | # Functions tested in this suite: |
| 20 | # ismodule, isclass, ismethod, isfunction, istraceback, isframe, iscode, |
Christian Heimes | 7131fd9 | 2008-02-19 14:21:46 +0000 | [diff] [blame] | 21 | # isbuiltin, isroutine, isgenerator, isgeneratorfunction, getmembers, |
| 22 | # getdoc, getfile, getmodule, getsourcefile, getcomments, getsource, |
| 23 | # getclasstree, getargspec, getargvalues, formatargspec, formatargvalues, |
| 24 | # currentframe, stack, trace, isdatadescriptor |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 25 | |
Nick Coghlan | f088e5e | 2008-12-14 11:50:48 +0000 | [diff] [blame] | 26 | # NOTE: There are some additional tests relating to interaction with |
| 27 | # zipimport in the test_zipimport_support test module. |
| 28 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 29 | modfile = mod.__file__ |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 30 | if modfile.endswith(('c', 'o')): |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 31 | modfile = modfile[:-1] |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 32 | |
Christian Heimes | a3538eb | 2007-11-06 11:44:48 +0000 | [diff] [blame] | 33 | # Normalize file names: on Windows, the case of file names of compiled |
| 34 | # modules depends on the path used to start the python executable. |
| 35 | modfile = normcase(modfile) |
| 36 | |
| 37 | def revise(filename, *args): |
| 38 | return (normcase(filename),) + args |
| 39 | |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 40 | import builtins |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 41 | |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 42 | try: |
| 43 | 1/0 |
| 44 | except: |
Guido van Rossum | e7ba495 | 2007-06-06 23:52:48 +0000 | [diff] [blame] | 45 | tb = sys.exc_info()[2] |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 46 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 47 | git = mod.StupidGit() |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 48 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 49 | class IsTestBase(unittest.TestCase): |
| 50 | predicates = set([inspect.isbuiltin, inspect.isclass, inspect.iscode, |
| 51 | inspect.isframe, inspect.isfunction, inspect.ismethod, |
Christian Heimes | 7131fd9 | 2008-02-19 14:21:46 +0000 | [diff] [blame] | 52 | inspect.ismodule, inspect.istraceback, |
| 53 | inspect.isgenerator, inspect.isgeneratorfunction]) |
Tim Peters | 5a9fb3c | 2005-01-07 16:01:32 +0000 | [diff] [blame] | 54 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 55 | def istest(self, predicate, exp): |
| 56 | obj = eval(exp) |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 57 | self.assertTrue(predicate(obj), '%s(%s)' % (predicate.__name__, exp)) |
Tim Peters | 5a9fb3c | 2005-01-07 16:01:32 +0000 | [diff] [blame] | 58 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 59 | for other in self.predicates - set([predicate]): |
Christian Heimes | 7131fd9 | 2008-02-19 14:21:46 +0000 | [diff] [blame] | 60 | if predicate == inspect.isgeneratorfunction and\ |
| 61 | other == inspect.isfunction: |
| 62 | continue |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 63 | self.assertFalse(other(obj), 'not %s(%s)' % (other.__name__, exp)) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 64 | |
Christian Heimes | 7131fd9 | 2008-02-19 14:21:46 +0000 | [diff] [blame] | 65 | def generator_function_example(self): |
| 66 | for i in range(2): |
| 67 | yield i |
| 68 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 69 | class TestPredicates(IsTestBase): |
Christian Heimes | 227c800 | 2008-03-03 20:34:40 +0000 | [diff] [blame] | 70 | def test_sixteen(self): |
Guido van Rossum | c1f779c | 2007-07-03 08:25:58 +0000 | [diff] [blame] | 71 | count = len([x for x in dir(inspect) if x.startswith('is')]) |
Christian Heimes | 7131fd9 | 2008-02-19 14:21:46 +0000 | [diff] [blame] | 72 | # This test is here for remember you to update Doc/library/inspect.rst |
Christian Heimes | 7864476 | 2008-03-04 23:39:23 +0000 | [diff] [blame] | 73 | # which claims there are 16 such functions |
Christian Heimes | 227c800 | 2008-03-03 20:34:40 +0000 | [diff] [blame] | 74 | expected = 16 |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 75 | err_msg = "There are %d (not %d) is* functions" % (count, expected) |
| 76 | self.assertEqual(count, expected, err_msg) |
Tim Peters | 5a9fb3c | 2005-01-07 16:01:32 +0000 | [diff] [blame] | 77 | |
Christian Heimes | 7131fd9 | 2008-02-19 14:21:46 +0000 | [diff] [blame] | 78 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 79 | def test_excluding_predicates(self): |
| 80 | self.istest(inspect.isbuiltin, 'sys.exit') |
| 81 | self.istest(inspect.isbuiltin, '[].append') |
Neal Norwitz | 221085d | 2007-02-25 20:55:47 +0000 | [diff] [blame] | 82 | self.istest(inspect.iscode, 'mod.spam.__code__') |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 83 | self.istest(inspect.isframe, 'tb.tb_frame') |
| 84 | self.istest(inspect.isfunction, 'mod.spam') |
Christian Heimes | 4a22b5d | 2007-11-25 09:39:14 +0000 | [diff] [blame] | 85 | self.istest(inspect.isfunction, 'mod.StupidGit.abuse') |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 86 | self.istest(inspect.ismethod, 'git.argue') |
| 87 | self.istest(inspect.ismodule, 'mod') |
| 88 | self.istest(inspect.istraceback, 'tb') |
Guido van Rossum | 813b0e5 | 2007-05-21 18:11:34 +0000 | [diff] [blame] | 89 | self.istest(inspect.isdatadescriptor, 'collections.defaultdict.default_factory') |
Christian Heimes | 7131fd9 | 2008-02-19 14:21:46 +0000 | [diff] [blame] | 90 | self.istest(inspect.isgenerator, '(x for x in range(2))') |
| 91 | self.istest(inspect.isgeneratorfunction, 'generator_function_example') |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 92 | if hasattr(types, 'GetSetDescriptorType'): |
| 93 | self.istest(inspect.isgetsetdescriptor, |
| 94 | 'type(tb.tb_frame).f_locals') |
| 95 | else: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 96 | self.assertFalse(inspect.isgetsetdescriptor(type(tb.tb_frame).f_locals)) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 97 | if hasattr(types, 'MemberDescriptorType'): |
| 98 | self.istest(inspect.ismemberdescriptor, 'datetime.timedelta.days') |
| 99 | else: |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 100 | self.assertFalse(inspect.ismemberdescriptor(datetime.timedelta.days)) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 101 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 102 | def test_isroutine(self): |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 103 | self.assertTrue(inspect.isroutine(mod.spam)) |
| 104 | self.assertTrue(inspect.isroutine([].count)) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 105 | |
Benjamin Peterson | c465600 | 2009-01-17 22:41:18 +0000 | [diff] [blame] | 106 | def test_isclass(self): |
| 107 | self.istest(inspect.isclass, 'mod.StupidGit') |
| 108 | self.assertTrue(inspect.isclass(list)) |
| 109 | |
| 110 | class CustomGetattr(object): |
| 111 | def __getattr__(self, attr): |
| 112 | return None |
| 113 | self.assertFalse(inspect.isclass(CustomGetattr())) |
| 114 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 115 | def test_get_slot_members(self): |
| 116 | class C(object): |
| 117 | __slots__ = ("a", "b") |
| 118 | |
| 119 | x = C() |
| 120 | x.a = 42 |
| 121 | members = dict(inspect.getmembers(x)) |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 122 | self.assertIn('a', members) |
| 123 | self.assertNotIn('b', members) |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 124 | |
Benjamin Peterson | a0dfa82 | 2009-11-13 02:25:08 +0000 | [diff] [blame] | 125 | def test_isabstract(self): |
| 126 | from abc import ABCMeta, abstractmethod |
| 127 | |
| 128 | class AbstractClassExample(metaclass=ABCMeta): |
| 129 | |
| 130 | @abstractmethod |
| 131 | def foo(self): |
| 132 | pass |
| 133 | |
| 134 | class ClassExample(AbstractClassExample): |
| 135 | def foo(self): |
| 136 | pass |
| 137 | |
| 138 | a = ClassExample() |
| 139 | |
| 140 | # Test general behaviour. |
| 141 | self.assertTrue(inspect.isabstract(AbstractClassExample)) |
| 142 | self.assertFalse(inspect.isabstract(ClassExample)) |
| 143 | self.assertFalse(inspect.isabstract(a)) |
| 144 | self.assertFalse(inspect.isabstract(int)) |
| 145 | self.assertFalse(inspect.isabstract(5)) |
| 146 | |
Benjamin Peterson | 058e31e | 2009-01-16 03:54:08 +0000 | [diff] [blame] | 147 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 148 | class TestInterpreterStack(IsTestBase): |
| 149 | def __init__(self, *args, **kwargs): |
| 150 | unittest.TestCase.__init__(self, *args, **kwargs) |
Tim Peters | 5a9fb3c | 2005-01-07 16:01:32 +0000 | [diff] [blame] | 151 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 152 | git.abuse(7, 8, 9) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 153 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 154 | def test_abuse_done(self): |
| 155 | self.istest(inspect.istraceback, 'git.ex[2]') |
| 156 | self.istest(inspect.isframe, 'mod.fr') |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 157 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 158 | def test_stack(self): |
Benjamin Peterson | c9c0f20 | 2009-06-30 23:06:06 +0000 | [diff] [blame] | 159 | self.assertTrue(len(mod.st) >= 5) |
Christian Heimes | a3538eb | 2007-11-06 11:44:48 +0000 | [diff] [blame] | 160 | self.assertEqual(revise(*mod.st[0][1:]), |
Tim Peters | 5a9fb3c | 2005-01-07 16:01:32 +0000 | [diff] [blame] | 161 | (modfile, 16, 'eggs', [' st = inspect.stack()\n'], 0)) |
Christian Heimes | a3538eb | 2007-11-06 11:44:48 +0000 | [diff] [blame] | 162 | self.assertEqual(revise(*mod.st[1][1:]), |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 163 | (modfile, 9, 'spam', [' eggs(b + d, c + f)\n'], 0)) |
Christian Heimes | a3538eb | 2007-11-06 11:44:48 +0000 | [diff] [blame] | 164 | self.assertEqual(revise(*mod.st[2][1:]), |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 165 | (modfile, 43, 'argue', [' spam(a, b, c)\n'], 0)) |
Christian Heimes | a3538eb | 2007-11-06 11:44:48 +0000 | [diff] [blame] | 166 | self.assertEqual(revise(*mod.st[3][1:]), |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 167 | (modfile, 39, 'abuse', [' self.argue(a, b, c)\n'], 0)) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 168 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 169 | def test_trace(self): |
| 170 | self.assertEqual(len(git.tr), 3) |
Florent Xicluna | c857592 | 2010-03-24 17:37:49 +0000 | [diff] [blame] | 171 | self.assertEqual(revise(*git.tr[0][1:]), |
| 172 | (modfile, 43, 'argue', [' spam(a, b, c)\n'], 0)) |
| 173 | self.assertEqual(revise(*git.tr[1][1:]), |
| 174 | (modfile, 9, 'spam', [' eggs(b + d, c + f)\n'], 0)) |
| 175 | self.assertEqual(revise(*git.tr[2][1:]), |
| 176 | (modfile, 18, 'eggs', [' q = y / 0\n'], 0)) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 177 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 178 | def test_frame(self): |
| 179 | args, varargs, varkw, locals = inspect.getargvalues(mod.fr) |
| 180 | self.assertEqual(args, ['x', 'y']) |
| 181 | self.assertEqual(varargs, None) |
| 182 | self.assertEqual(varkw, None) |
| 183 | self.assertEqual(locals, {'x': 11, 'p': 11, 'y': 14}) |
| 184 | self.assertEqual(inspect.formatargvalues(args, varargs, varkw, locals), |
| 185 | '(x=11, y=14)') |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 186 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 187 | def test_previous_frame(self): |
| 188 | args, varargs, varkw, locals = inspect.getargvalues(mod.fr.f_back) |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 189 | self.assertEqual(args, ['a', 'b', 'c', 'd', 'e', 'f']) |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 190 | self.assertEqual(varargs, 'g') |
| 191 | self.assertEqual(varkw, 'h') |
| 192 | self.assertEqual(inspect.formatargvalues(args, varargs, varkw, locals), |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 193 | '(a=7, b=8, c=9, d=3, e=4, f=5, *g=(), **h={})') |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 194 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 195 | class GetSourceBase(unittest.TestCase): |
| 196 | # Subclasses must override. |
| 197 | fodderFile = None |
Tim Peters | 5a9fb3c | 2005-01-07 16:01:32 +0000 | [diff] [blame] | 198 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 199 | def __init__(self, *args, **kwargs): |
| 200 | unittest.TestCase.__init__(self, *args, **kwargs) |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 201 | |
Philip Jenvey | a27c5bd | 2009-05-28 06:09:08 +0000 | [diff] [blame] | 202 | with open(inspect.getsourcefile(self.fodderFile)) as fp: |
| 203 | self.source = fp.read() |
Ka-Ping Yee | 6397c7c | 2001-02-27 14:43:21 +0000 | [diff] [blame] | 204 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 205 | def sourcerange(self, top, bottom): |
| 206 | lines = self.source.split("\n") |
| 207 | return "\n".join(lines[top-1:bottom]) + "\n" |
Tim Peters | e0b2d7a | 2001-09-22 06:10:55 +0000 | [diff] [blame] | 208 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 209 | def assertSourceEqual(self, obj, top, bottom): |
| 210 | self.assertEqual(inspect.getsource(obj), |
| 211 | self.sourcerange(top, bottom)) |
Tim Peters | 5a9fb3c | 2005-01-07 16:01:32 +0000 | [diff] [blame] | 212 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 213 | class TestRetrievingSourceCode(GetSourceBase): |
| 214 | fodderFile = mod |
Tim Peters | 5a9fb3c | 2005-01-07 16:01:32 +0000 | [diff] [blame] | 215 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 216 | def test_getclasses(self): |
| 217 | classes = inspect.getmembers(mod, inspect.isclass) |
| 218 | self.assertEqual(classes, |
| 219 | [('FesteringGob', mod.FesteringGob), |
| 220 | ('MalodorousPervert', mod.MalodorousPervert), |
| 221 | ('ParrotDroppings', mod.ParrotDroppings), |
| 222 | ('StupidGit', mod.StupidGit)]) |
| 223 | tree = inspect.getclasstree([cls[1] for cls in classes], 1) |
| 224 | self.assertEqual(tree, |
Thomas Wouters | 725af87 | 2006-04-15 09:13:19 +0000 | [diff] [blame] | 225 | [(object, ()), |
| 226 | [(mod.ParrotDroppings, (object,)), |
| 227 | (mod.StupidGit, (object,)), |
| 228 | [(mod.MalodorousPervert, (mod.StupidGit,)), |
| 229 | [(mod.FesteringGob, (mod.MalodorousPervert, |
| 230 | mod.ParrotDroppings)) |
| 231 | ] |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 232 | ] |
| 233 | ] |
| 234 | ]) |
Tim Peters | 5a9fb3c | 2005-01-07 16:01:32 +0000 | [diff] [blame] | 235 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 236 | def test_getfunctions(self): |
| 237 | functions = inspect.getmembers(mod, inspect.isfunction) |
| 238 | self.assertEqual(functions, [('eggs', mod.eggs), |
| 239 | ('spam', mod.spam)]) |
Johannes Gijsbers | c473c99 | 2004-08-18 12:40:31 +0000 | [diff] [blame] | 240 | |
R. David Murray | 378c0cf | 2010-02-24 01:46:21 +0000 | [diff] [blame] | 241 | @unittest.skipIf(sys.flags.optimize >= 2, |
| 242 | "Docstrings are omitted with -O2 and above") |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 243 | def test_getdoc(self): |
| 244 | self.assertEqual(inspect.getdoc(mod), 'A module docstring.') |
| 245 | self.assertEqual(inspect.getdoc(mod.StupidGit), |
| 246 | 'A longer,\n\nindented\n\ndocstring.') |
| 247 | self.assertEqual(inspect.getdoc(git.abuse), |
| 248 | 'Another\n\ndocstring\n\ncontaining\n\ntabs') |
Johannes Gijsbers | c473c99 | 2004-08-18 12:40:31 +0000 | [diff] [blame] | 249 | |
Georg Brandl | 0c77a82 | 2008-06-10 16:37:50 +0000 | [diff] [blame] | 250 | def test_cleandoc(self): |
| 251 | self.assertEqual(inspect.cleandoc('An\n indented\n docstring.'), |
| 252 | 'An\nindented\ndocstring.') |
| 253 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 254 | def test_getcomments(self): |
| 255 | self.assertEqual(inspect.getcomments(mod), '# line 1\n') |
| 256 | self.assertEqual(inspect.getcomments(mod.StupidGit), '# line 20\n') |
Johannes Gijsbers | c473c99 | 2004-08-18 12:40:31 +0000 | [diff] [blame] | 257 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 258 | def test_getmodule(self): |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 259 | # Check actual module |
| 260 | self.assertEqual(inspect.getmodule(mod), mod) |
| 261 | # Check class (uses __module__ attribute) |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 262 | self.assertEqual(inspect.getmodule(mod.StupidGit), mod) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 263 | # Check a method (no __module__ attribute, falls back to filename) |
| 264 | self.assertEqual(inspect.getmodule(mod.StupidGit.abuse), mod) |
| 265 | # Do it again (check the caching isn't broken) |
| 266 | self.assertEqual(inspect.getmodule(mod.StupidGit.abuse), mod) |
| 267 | # Check a builtin |
Georg Brandl | 1a3284e | 2007-12-02 09:40:06 +0000 | [diff] [blame] | 268 | self.assertEqual(inspect.getmodule(str), sys.modules["builtins"]) |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 269 | # Check filename override |
| 270 | self.assertEqual(inspect.getmodule(None, modfile), mod) |
Johannes Gijsbers | c473c99 | 2004-08-18 12:40:31 +0000 | [diff] [blame] | 271 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 272 | def test_getsource(self): |
| 273 | self.assertSourceEqual(git.abuse, 29, 39) |
| 274 | self.assertSourceEqual(mod.StupidGit, 21, 46) |
Johannes Gijsbers | c473c99 | 2004-08-18 12:40:31 +0000 | [diff] [blame] | 275 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 276 | def test_getsourcefile(self): |
Christian Heimes | a3538eb | 2007-11-06 11:44:48 +0000 | [diff] [blame] | 277 | self.assertEqual(normcase(inspect.getsourcefile(mod.spam)), modfile) |
| 278 | self.assertEqual(normcase(inspect.getsourcefile(git.abuse)), modfile) |
R. David Murray | a1b3740 | 2010-06-17 02:04:29 +0000 | [diff] [blame] | 279 | fn = "_non_existing_filename_used_for_sourcefile_test.py" |
| 280 | co = compile("None", fn, "exec") |
| 281 | self.assertEqual(normcase(inspect.getsourcefile(co)), None) |
| 282 | linecache.cache[co.co_filename] = (1, None, "None", co.co_filename) |
| 283 | self.assertEqual(normcase(inspect.getsourcefile(co)), fn) |
Johannes Gijsbers | c473c99 | 2004-08-18 12:40:31 +0000 | [diff] [blame] | 284 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 285 | def test_getfile(self): |
| 286 | self.assertEqual(inspect.getfile(mod.StupidGit), mod.__file__) |
Johannes Gijsbers | c473c99 | 2004-08-18 12:40:31 +0000 | [diff] [blame] | 287 | |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 288 | def test_getmodule_recursion(self): |
Christian Heimes | 45f9af3 | 2007-11-27 21:50:00 +0000 | [diff] [blame] | 289 | from types import ModuleType |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 290 | name = '__inspect_dummy' |
Christian Heimes | 45f9af3 | 2007-11-27 21:50:00 +0000 | [diff] [blame] | 291 | m = sys.modules[name] = ModuleType(name) |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 292 | m.__file__ = "<string>" # hopefully not a real filename... |
| 293 | m.__loader__ = "dummy" # pretend the filename is understood by a loader |
Georg Brandl | 7cae87c | 2006-09-06 06:51:57 +0000 | [diff] [blame] | 294 | exec("def x(): pass", m.__dict__) |
Neal Norwitz | 221085d | 2007-02-25 20:55:47 +0000 | [diff] [blame] | 295 | self.assertEqual(inspect.getsourcefile(m.x.__code__), '<string>') |
Thomas Wouters | 0e3f591 | 2006-08-11 14:57:12 +0000 | [diff] [blame] | 296 | del sys.modules[name] |
| 297 | inspect.getmodule(compile('a=10','','single')) |
| 298 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 299 | class TestDecorators(GetSourceBase): |
| 300 | fodderFile = mod2 |
Johannes Gijsbers | c473c99 | 2004-08-18 12:40:31 +0000 | [diff] [blame] | 301 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 302 | def test_wrapped_decorator(self): |
Christian Heimes | 09aaa88 | 2008-02-23 15:01:06 +0000 | [diff] [blame] | 303 | self.assertSourceEqual(mod2.wrapped, 14, 17) |
Johannes Gijsbers | c473c99 | 2004-08-18 12:40:31 +0000 | [diff] [blame] | 304 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 305 | def test_replacing_decorator(self): |
| 306 | self.assertSourceEqual(mod2.gone, 9, 10) |
Tim Peters | e0b2d7a | 2001-09-22 06:10:55 +0000 | [diff] [blame] | 307 | |
Johannes Gijsbers | 1542f34 | 2004-12-12 16:46:28 +0000 | [diff] [blame] | 308 | class TestOneliners(GetSourceBase): |
| 309 | fodderFile = mod2 |
| 310 | def test_oneline_lambda(self): |
| 311 | # Test inspect.getsource with a one-line lambda function. |
| 312 | self.assertSourceEqual(mod2.oll, 25, 25) |
Tim Peters | 5a9fb3c | 2005-01-07 16:01:32 +0000 | [diff] [blame] | 313 | |
Johannes Gijsbers | 1542f34 | 2004-12-12 16:46:28 +0000 | [diff] [blame] | 314 | def test_threeline_lambda(self): |
| 315 | # Test inspect.getsource with a three-line lambda function, |
| 316 | # where the second and third lines are _not_ indented. |
Tim Peters | 5a9fb3c | 2005-01-07 16:01:32 +0000 | [diff] [blame] | 317 | self.assertSourceEqual(mod2.tll, 28, 30) |
| 318 | |
Johannes Gijsbers | 1542f34 | 2004-12-12 16:46:28 +0000 | [diff] [blame] | 319 | def test_twoline_indented_lambda(self): |
| 320 | # Test inspect.getsource with a two-line lambda function, |
| 321 | # where the second line _is_ indented. |
| 322 | self.assertSourceEqual(mod2.tlli, 33, 34) |
Tim Peters | 5a9fb3c | 2005-01-07 16:01:32 +0000 | [diff] [blame] | 323 | |
Johannes Gijsbers | 1542f34 | 2004-12-12 16:46:28 +0000 | [diff] [blame] | 324 | def test_onelinefunc(self): |
| 325 | # Test inspect.getsource with a regular one-line function. |
| 326 | self.assertSourceEqual(mod2.onelinefunc, 37, 37) |
Tim Peters | 5a9fb3c | 2005-01-07 16:01:32 +0000 | [diff] [blame] | 327 | |
Johannes Gijsbers | 1542f34 | 2004-12-12 16:46:28 +0000 | [diff] [blame] | 328 | def test_manyargs(self): |
| 329 | # Test inspect.getsource with a regular function where |
| 330 | # the arguments are on two lines and _not_ indented and |
| 331 | # the body on the second line with the last arguments. |
| 332 | self.assertSourceEqual(mod2.manyargs, 40, 41) |
Tim Peters | 5a9fb3c | 2005-01-07 16:01:32 +0000 | [diff] [blame] | 333 | |
Johannes Gijsbers | 1542f34 | 2004-12-12 16:46:28 +0000 | [diff] [blame] | 334 | def test_twolinefunc(self): |
| 335 | # Test inspect.getsource with a regular function where |
| 336 | # the body is on two lines, following the argument list and |
| 337 | # continued on the next line by a \\. |
| 338 | self.assertSourceEqual(mod2.twolinefunc, 44, 45) |
Tim Peters | 5a9fb3c | 2005-01-07 16:01:32 +0000 | [diff] [blame] | 339 | |
Johannes Gijsbers | 1542f34 | 2004-12-12 16:46:28 +0000 | [diff] [blame] | 340 | def test_lambda_in_list(self): |
| 341 | # Test inspect.getsource with a one-line lambda function |
| 342 | # defined in a list, indented. |
| 343 | self.assertSourceEqual(mod2.a[1], 49, 49) |
Tim Peters | 5a9fb3c | 2005-01-07 16:01:32 +0000 | [diff] [blame] | 344 | |
Johannes Gijsbers | 1542f34 | 2004-12-12 16:46:28 +0000 | [diff] [blame] | 345 | def test_anonymous(self): |
| 346 | # Test inspect.getsource with a lambda function defined |
| 347 | # as argument to another function. |
| 348 | self.assertSourceEqual(mod2.anonymous, 55, 55) |
| 349 | |
Johannes Gijsbers | a5855d5 | 2005-03-12 16:37:11 +0000 | [diff] [blame] | 350 | class TestBuggyCases(GetSourceBase): |
| 351 | fodderFile = mod2 |
| 352 | |
| 353 | def test_with_comment(self): |
| 354 | self.assertSourceEqual(mod2.with_comment, 58, 59) |
| 355 | |
| 356 | def test_multiline_sig(self): |
| 357 | self.assertSourceEqual(mod2.multiline_sig[0], 63, 64) |
| 358 | |
Armin Rigo | dd5c023 | 2005-09-25 11:45:45 +0000 | [diff] [blame] | 359 | def test_nested_class(self): |
| 360 | self.assertSourceEqual(mod2.func69().func71, 71, 72) |
| 361 | |
| 362 | def test_one_liner_followed_by_non_name(self): |
| 363 | self.assertSourceEqual(mod2.func77, 77, 77) |
| 364 | |
| 365 | def test_one_liner_dedent_non_name(self): |
| 366 | self.assertSourceEqual(mod2.cls82.func83, 83, 83) |
| 367 | |
| 368 | def test_with_comment_instead_of_docstring(self): |
| 369 | self.assertSourceEqual(mod2.func88, 88, 90) |
| 370 | |
Thomas Wouters | 00ee7ba | 2006-08-21 19:07:27 +0000 | [diff] [blame] | 371 | def test_method_in_dynamic_class(self): |
| 372 | self.assertSourceEqual(mod2.method_in_dynamic_class, 95, 97) |
| 373 | |
R. David Murray | b565577 | 2009-05-14 16:17:50 +0000 | [diff] [blame] | 374 | @unittest.skipIf( |
| 375 | not hasattr(unicodedata, '__file__') or |
| 376 | unicodedata.__file__[-4:] in (".pyc", ".pyo"), |
| 377 | "unicodedata is not an external binary module") |
R. David Murray | 74b8924 | 2009-05-13 17:33:03 +0000 | [diff] [blame] | 378 | def test_findsource_binary(self): |
R. David Murray | b565577 | 2009-05-14 16:17:50 +0000 | [diff] [blame] | 379 | self.assertRaises(IOError, inspect.getsource, unicodedata) |
| 380 | self.assertRaises(IOError, inspect.findsource, unicodedata) |
R. David Murray | 74b8924 | 2009-05-13 17:33:03 +0000 | [diff] [blame] | 381 | |
R. David Murray | a1b3740 | 2010-06-17 02:04:29 +0000 | [diff] [blame] | 382 | def test_findsource_code_in_linecache(self): |
| 383 | lines = ["x=1"] |
| 384 | co = compile(lines[0], "_dynamically_created_file", "exec") |
| 385 | self.assertRaises(IOError, inspect.findsource, co) |
| 386 | self.assertRaises(IOError, inspect.getsource, co) |
| 387 | linecache.cache[co.co_filename] = (1, None, lines, co.co_filename) |
| 388 | self.assertEquals(inspect.findsource(co), (lines,0)) |
| 389 | self.assertEquals(inspect.getsource(co), lines[0]) |
| 390 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 391 | # Helper for testing classify_class_attrs. |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 392 | def attrs_wo_objs(cls): |
| 393 | return [t[:3] for t in inspect.classify_class_attrs(cls)] |
| 394 | |
Tim Peters | 5a9fb3c | 2005-01-07 16:01:32 +0000 | [diff] [blame] | 395 | class TestClassesAndFunctions(unittest.TestCase): |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 396 | def test_newstyle_mro(self): |
| 397 | # The same w/ new-class MRO. |
| 398 | class A(object): pass |
| 399 | class B(A): pass |
| 400 | class C(A): pass |
| 401 | class D(B, C): pass |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 402 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 403 | expected = (D, B, C, A, object) |
| 404 | got = inspect.getmro(D) |
| 405 | self.assertEqual(expected, got) |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 406 | |
Christian Heimes | 3795b53 | 2007-11-08 13:48:53 +0000 | [diff] [blame] | 407 | def assertArgSpecEquals(self, routine, args_e, varargs_e=None, |
| 408 | varkw_e=None, defaults_e=None, formatted=None): |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 409 | args, varargs, varkw, defaults = inspect.getargspec(routine) |
| 410 | self.assertEqual(args, args_e) |
| 411 | self.assertEqual(varargs, varargs_e) |
| 412 | self.assertEqual(varkw, varkw_e) |
| 413 | self.assertEqual(defaults, defaults_e) |
| 414 | if formatted is not None: |
| 415 | self.assertEqual(inspect.formatargspec(args, varargs, varkw, defaults), |
| 416 | formatted) |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 417 | |
Christian Heimes | 3795b53 | 2007-11-08 13:48:53 +0000 | [diff] [blame] | 418 | def assertFullArgSpecEquals(self, routine, args_e, varargs_e=None, |
| 419 | varkw_e=None, defaults_e=None, |
| 420 | kwonlyargs_e=[], kwonlydefaults_e=None, |
| 421 | ann_e={}, formatted=None): |
| 422 | args, varargs, varkw, defaults, kwonlyargs, kwonlydefaults, ann = \ |
| 423 | inspect.getfullargspec(routine) |
| 424 | self.assertEqual(args, args_e) |
| 425 | self.assertEqual(varargs, varargs_e) |
| 426 | self.assertEqual(varkw, varkw_e) |
| 427 | self.assertEqual(defaults, defaults_e) |
| 428 | self.assertEqual(kwonlyargs, kwonlyargs_e) |
| 429 | self.assertEqual(kwonlydefaults, kwonlydefaults_e) |
| 430 | self.assertEqual(ann, ann_e) |
| 431 | if formatted is not None: |
| 432 | self.assertEqual(inspect.formatargspec(args, varargs, varkw, defaults, |
| 433 | kwonlyargs, kwonlydefaults, ann), |
| 434 | formatted) |
| 435 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 436 | def test_getargspec(self): |
Christian Heimes | 3795b53 | 2007-11-08 13:48:53 +0000 | [diff] [blame] | 437 | self.assertArgSpecEquals(mod.eggs, ['x', 'y'], formatted='(x, y)') |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 438 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 439 | self.assertArgSpecEquals(mod.spam, |
Guido van Rossum | 1bc535d | 2007-05-15 18:46:22 +0000 | [diff] [blame] | 440 | ['a', 'b', 'c', 'd', 'e', 'f'], |
| 441 | 'g', 'h', (3, 4, 5), |
| 442 | '(a, b, c, d=3, e=4, f=5, *g, **h)') |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 443 | |
Christian Heimes | 3795b53 | 2007-11-08 13:48:53 +0000 | [diff] [blame] | 444 | self.assertRaises(ValueError, self.assertArgSpecEquals, |
| 445 | mod2.keyworded, []) |
| 446 | |
| 447 | self.assertRaises(ValueError, self.assertArgSpecEquals, |
| 448 | mod2.annotated, []) |
Benjamin Peterson | 9953a8d | 2009-01-17 04:15:01 +0000 | [diff] [blame] | 449 | self.assertRaises(ValueError, self.assertArgSpecEquals, |
| 450 | mod2.keyword_only_arg, []) |
| 451 | |
Christian Heimes | 3795b53 | 2007-11-08 13:48:53 +0000 | [diff] [blame] | 452 | |
| 453 | def test_getfullargspec(self): |
| 454 | self.assertFullArgSpecEquals(mod2.keyworded, [], varargs_e='arg1', |
| 455 | kwonlyargs_e=['arg2'], |
| 456 | kwonlydefaults_e={'arg2':1}, |
| 457 | formatted='(*arg1, arg2=1)') |
| 458 | |
| 459 | self.assertFullArgSpecEquals(mod2.annotated, ['arg1'], |
Christian Heimes | c9543e4 | 2007-11-28 08:28:28 +0000 | [diff] [blame] | 460 | ann_e={'arg1' : list}, |
Christian Heimes | 3795b53 | 2007-11-08 13:48:53 +0000 | [diff] [blame] | 461 | formatted='(arg1: list)') |
Benjamin Peterson | 9953a8d | 2009-01-17 04:15:01 +0000 | [diff] [blame] | 462 | self.assertFullArgSpecEquals(mod2.keyword_only_arg, [], |
| 463 | kwonlyargs_e=['arg'], |
| 464 | formatted='(*, arg)') |
| 465 | |
Christian Heimes | 3795b53 | 2007-11-08 13:48:53 +0000 | [diff] [blame] | 466 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 467 | def test_getargspec_method(self): |
| 468 | class A(object): |
| 469 | def m(self): |
| 470 | pass |
| 471 | self.assertArgSpecEquals(A.m, ['self']) |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 472 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 473 | def test_classify_newstyle(self): |
| 474 | class A(object): |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 475 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 476 | def s(): pass |
| 477 | s = staticmethod(s) |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 478 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 479 | def c(cls): pass |
| 480 | c = classmethod(c) |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 481 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 482 | def getp(self): pass |
| 483 | p = property(getp) |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 484 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 485 | def m(self): pass |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 486 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 487 | def m1(self): pass |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 488 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 489 | datablob = '1' |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 490 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 491 | attrs = attrs_wo_objs(A) |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 492 | self.assertIn(('s', 'static method', A), attrs, 'missing static method') |
| 493 | self.assertIn(('c', 'class method', A), attrs, 'missing class method') |
| 494 | self.assertIn(('p', 'property', A), attrs, 'missing property') |
Ezio Melotti | b58e0bd | 2010-01-23 15:40:09 +0000 | [diff] [blame] | 495 | self.assertIn(('m', 'method', A), attrs, |
| 496 | 'missing plain method: %r' % attrs) |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 497 | self.assertIn(('m1', 'method', A), attrs, 'missing plain method') |
| 498 | self.assertIn(('datablob', 'data', A), attrs, 'missing data') |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 499 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 500 | class B(A): |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 501 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 502 | def m(self): pass |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 503 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 504 | attrs = attrs_wo_objs(B) |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 505 | self.assertIn(('s', 'static method', A), attrs, 'missing static method') |
| 506 | self.assertIn(('c', 'class method', A), attrs, 'missing class method') |
| 507 | self.assertIn(('p', 'property', A), attrs, 'missing property') |
| 508 | self.assertIn(('m', 'method', B), attrs, 'missing plain method') |
| 509 | self.assertIn(('m1', 'method', A), attrs, 'missing plain method') |
| 510 | self.assertIn(('datablob', 'data', A), attrs, 'missing data') |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 511 | |
| 512 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 513 | class C(A): |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 514 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 515 | def m(self): pass |
| 516 | def c(self): pass |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 517 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 518 | attrs = attrs_wo_objs(C) |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 519 | self.assertIn(('s', 'static method', A), attrs, 'missing static method') |
| 520 | self.assertIn(('c', 'method', C), attrs, 'missing plain method') |
| 521 | self.assertIn(('p', 'property', A), attrs, 'missing property') |
| 522 | self.assertIn(('m', 'method', C), attrs, 'missing plain method') |
| 523 | self.assertIn(('m1', 'method', A), attrs, 'missing plain method') |
| 524 | self.assertIn(('datablob', 'data', A), attrs, 'missing data') |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 525 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 526 | class D(B, C): |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 527 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 528 | def m1(self): pass |
Tim Peters | 13b49d3 | 2001-09-23 02:00:29 +0000 | [diff] [blame] | 529 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 530 | attrs = attrs_wo_objs(D) |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 531 | self.assertIn(('s', 'static method', A), attrs, 'missing static method') |
| 532 | self.assertIn(('c', 'method', C), attrs, 'missing plain method') |
| 533 | self.assertIn(('p', 'property', A), attrs, 'missing property') |
| 534 | self.assertIn(('m', 'method', B), attrs, 'missing plain method') |
| 535 | self.assertIn(('m1', 'method', D), attrs, 'missing plain method') |
| 536 | self.assertIn(('datablob', 'data', A), attrs, 'missing data') |
Jeremy Hylton | c4bf5ed | 2003-06-27 18:43:12 +0000 | [diff] [blame] | 537 | |
Benjamin Peterson | 25cd7eb | 2010-03-30 18:42:32 +0000 | [diff] [blame] | 538 | class TestGetcallargsFunctions(unittest.TestCase): |
| 539 | |
| 540 | def assertEqualCallArgs(self, func, call_params_string, locs=None): |
| 541 | locs = dict(locs or {}, func=func) |
| 542 | r1 = eval('func(%s)' % call_params_string, None, locs) |
| 543 | r2 = eval('inspect.getcallargs(func, %s)' % call_params_string, None, |
| 544 | locs) |
| 545 | self.assertEqual(r1, r2) |
| 546 | |
| 547 | def assertEqualException(self, func, call_param_string, locs=None): |
| 548 | locs = dict(locs or {}, func=func) |
| 549 | try: |
| 550 | eval('func(%s)' % call_param_string, None, locs) |
| 551 | except Exception as e: |
| 552 | ex1 = e |
| 553 | else: |
| 554 | self.fail('Exception not raised') |
| 555 | try: |
| 556 | eval('inspect.getcallargs(func, %s)' % call_param_string, None, |
| 557 | locs) |
| 558 | except Exception as e: |
| 559 | ex2 = e |
| 560 | else: |
| 561 | self.fail('Exception not raised') |
| 562 | self.assertIs(type(ex1), type(ex2)) |
| 563 | self.assertEqual(str(ex1), str(ex2)) |
| 564 | del ex1, ex2 |
| 565 | |
| 566 | def makeCallable(self, signature): |
| 567 | """Create a function that returns its locals()""" |
| 568 | code = "lambda %s: locals()" |
| 569 | return eval(code % signature) |
| 570 | |
| 571 | def test_plain(self): |
| 572 | f = self.makeCallable('a, b=1') |
| 573 | self.assertEqualCallArgs(f, '2') |
| 574 | self.assertEqualCallArgs(f, '2, 3') |
| 575 | self.assertEqualCallArgs(f, 'a=2') |
| 576 | self.assertEqualCallArgs(f, 'b=3, a=2') |
| 577 | self.assertEqualCallArgs(f, '2, b=3') |
| 578 | # expand *iterable / **mapping |
| 579 | self.assertEqualCallArgs(f, '*(2,)') |
| 580 | self.assertEqualCallArgs(f, '*[2]') |
| 581 | self.assertEqualCallArgs(f, '*(2, 3)') |
| 582 | self.assertEqualCallArgs(f, '*[2, 3]') |
| 583 | self.assertEqualCallArgs(f, '**{"a":2}') |
| 584 | self.assertEqualCallArgs(f, 'b=3, **{"a":2}') |
| 585 | self.assertEqualCallArgs(f, '2, **{"b":3}') |
| 586 | self.assertEqualCallArgs(f, '**{"b":3, "a":2}') |
| 587 | # expand UserList / UserDict |
| 588 | self.assertEqualCallArgs(f, '*collections.UserList([2])') |
| 589 | self.assertEqualCallArgs(f, '*collections.UserList([2, 3])') |
| 590 | self.assertEqualCallArgs(f, '**collections.UserDict(a=2)') |
| 591 | self.assertEqualCallArgs(f, '2, **collections.UserDict(b=3)') |
| 592 | self.assertEqualCallArgs(f, 'b=2, **collections.UserDict(a=3)') |
| 593 | |
| 594 | def test_varargs(self): |
| 595 | f = self.makeCallable('a, b=1, *c') |
| 596 | self.assertEqualCallArgs(f, '2') |
| 597 | self.assertEqualCallArgs(f, '2, 3') |
| 598 | self.assertEqualCallArgs(f, '2, 3, 4') |
| 599 | self.assertEqualCallArgs(f, '*(2,3,4)') |
| 600 | self.assertEqualCallArgs(f, '2, *[3,4]') |
| 601 | self.assertEqualCallArgs(f, '2, 3, *collections.UserList([4])') |
| 602 | |
| 603 | def test_varkw(self): |
| 604 | f = self.makeCallable('a, b=1, **c') |
| 605 | self.assertEqualCallArgs(f, 'a=2') |
| 606 | self.assertEqualCallArgs(f, '2, b=3, c=4') |
| 607 | self.assertEqualCallArgs(f, 'b=3, a=2, c=4') |
| 608 | self.assertEqualCallArgs(f, 'c=4, **{"a":2, "b":3}') |
| 609 | self.assertEqualCallArgs(f, '2, c=4, **{"b":3}') |
| 610 | self.assertEqualCallArgs(f, 'b=2, **{"a":3, "c":4}') |
| 611 | self.assertEqualCallArgs(f, '**collections.UserDict(a=2, b=3, c=4)') |
| 612 | self.assertEqualCallArgs(f, '2, c=4, **collections.UserDict(b=3)') |
| 613 | self.assertEqualCallArgs(f, 'b=2, **collections.UserDict(a=3, c=4)') |
| 614 | |
| 615 | def test_keyword_only(self): |
| 616 | f = self.makeCallable('a=3, *, c, d=2') |
| 617 | self.assertEqualCallArgs(f, 'c=3') |
| 618 | self.assertEqualCallArgs(f, 'c=3, a=3') |
| 619 | self.assertEqualCallArgs(f, 'a=2, c=4') |
| 620 | self.assertEqualCallArgs(f, '4, c=4') |
| 621 | self.assertEqualException(f, '') |
| 622 | self.assertEqualException(f, '3') |
| 623 | self.assertEqualException(f, 'a=3') |
| 624 | self.assertEqualException(f, 'd=4') |
| 625 | |
| 626 | def test_multiple_features(self): |
| 627 | f = self.makeCallable('a, b=2, *f, **g') |
| 628 | self.assertEqualCallArgs(f, '2, 3, 7') |
| 629 | self.assertEqualCallArgs(f, '2, 3, x=8') |
| 630 | self.assertEqualCallArgs(f, '2, 3, x=8, *[(4,[5,6]), 7]') |
| 631 | self.assertEqualCallArgs(f, '2, x=8, *[3, (4,[5,6]), 7], y=9') |
| 632 | self.assertEqualCallArgs(f, 'x=8, *[2, 3, (4,[5,6])], y=9') |
| 633 | self.assertEqualCallArgs(f, 'x=8, *collections.UserList(' |
| 634 | '[2, 3, (4,[5,6])]), **{"y":9, "z":10}') |
| 635 | self.assertEqualCallArgs(f, '2, x=8, *collections.UserList([3, ' |
| 636 | '(4,[5,6])]), **collections.UserDict(' |
| 637 | 'y=9, z=10)') |
| 638 | |
| 639 | def test_errors(self): |
| 640 | f0 = self.makeCallable('') |
| 641 | f1 = self.makeCallable('a, b') |
| 642 | f2 = self.makeCallable('a, b=1') |
| 643 | # f0 takes no arguments |
| 644 | self.assertEqualException(f0, '1') |
| 645 | self.assertEqualException(f0, 'x=1') |
| 646 | self.assertEqualException(f0, '1,x=1') |
| 647 | # f1 takes exactly 2 arguments |
| 648 | self.assertEqualException(f1, '') |
| 649 | self.assertEqualException(f1, '1') |
| 650 | self.assertEqualException(f1, 'a=2') |
| 651 | self.assertEqualException(f1, 'b=3') |
| 652 | # f2 takes at least 1 argument |
| 653 | self.assertEqualException(f2, '') |
| 654 | self.assertEqualException(f2, 'b=3') |
| 655 | for f in f1, f2: |
| 656 | # f1/f2 takes exactly/at most 2 arguments |
| 657 | self.assertEqualException(f, '2, 3, 4') |
| 658 | self.assertEqualException(f, '1, 2, 3, a=1') |
| 659 | self.assertEqualException(f, '2, 3, 4, c=5') |
| 660 | self.assertEqualException(f, '2, 3, 4, a=1, c=5') |
| 661 | # f got an unexpected keyword argument |
| 662 | self.assertEqualException(f, 'c=2') |
| 663 | self.assertEqualException(f, '2, c=3') |
| 664 | self.assertEqualException(f, '2, 3, c=4') |
| 665 | self.assertEqualException(f, '2, c=4, b=3') |
| 666 | self.assertEqualException(f, '**{u"\u03c0\u03b9": 4}') |
| 667 | # f got multiple values for keyword argument |
| 668 | self.assertEqualException(f, '1, a=2') |
| 669 | self.assertEqualException(f, '1, **{"a":2}') |
| 670 | self.assertEqualException(f, '1, 2, b=3') |
| 671 | # XXX: Python inconsistency |
| 672 | # - for functions and bound methods: unexpected keyword 'c' |
| 673 | # - for unbound methods: multiple values for keyword 'a' |
| 674 | #self.assertEqualException(f, '1, c=3, a=2') |
| 675 | |
| 676 | class TestGetcallargsMethods(TestGetcallargsFunctions): |
| 677 | |
| 678 | def setUp(self): |
| 679 | class Foo(object): |
| 680 | pass |
| 681 | self.cls = Foo |
| 682 | self.inst = Foo() |
| 683 | |
| 684 | def makeCallable(self, signature): |
| 685 | assert 'self' not in signature |
| 686 | mk = super(TestGetcallargsMethods, self).makeCallable |
| 687 | self.cls.method = mk('self, ' + signature) |
| 688 | return self.inst.method |
| 689 | |
| 690 | class TestGetcallargsUnboundMethods(TestGetcallargsMethods): |
| 691 | |
| 692 | def makeCallable(self, signature): |
| 693 | super(TestGetcallargsUnboundMethods, self).makeCallable(signature) |
| 694 | return self.cls.method |
| 695 | |
| 696 | def assertEqualCallArgs(self, func, call_params_string, locs=None): |
| 697 | return super(TestGetcallargsUnboundMethods, self).assertEqualCallArgs( |
| 698 | *self._getAssertEqualParams(func, call_params_string, locs)) |
| 699 | |
| 700 | def assertEqualException(self, func, call_params_string, locs=None): |
| 701 | return super(TestGetcallargsUnboundMethods, self).assertEqualException( |
| 702 | *self._getAssertEqualParams(func, call_params_string, locs)) |
| 703 | |
| 704 | def _getAssertEqualParams(self, func, call_params_string, locs=None): |
| 705 | assert 'inst' not in call_params_string |
| 706 | locs = dict(locs or {}, inst=self.inst) |
| 707 | return (func, 'inst,' + call_params_string, locs) |
| 708 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 709 | def test_main(): |
Benjamin Peterson | 25cd7eb | 2010-03-30 18:42:32 +0000 | [diff] [blame] | 710 | run_unittest( |
| 711 | TestDecorators, TestRetrievingSourceCode, TestOneliners, TestBuggyCases, |
| 712 | TestInterpreterStack, TestClassesAndFunctions, TestPredicates, |
| 713 | TestGetcallargsFunctions, TestGetcallargsMethods, |
| 714 | TestGetcallargsUnboundMethods) |
Martin v. Löwis | 893ffa4 | 2003-10-31 15:35:53 +0000 | [diff] [blame] | 715 | |
Johannes Gijsbers | cb9015d | 2004-12-12 16:20:22 +0000 | [diff] [blame] | 716 | if __name__ == "__main__": |
| 717 | test_main() |