blob: 3377a7b07a8cd8f168285adc0dae866281875ea3 [file] [log] [blame]
Jeremy Hylton3e0055f2005-10-20 19:59:25 +00001"""This module includes tests of the code object representation.
2
3>>> def f(x):
4... def g(y):
5... return x + y
6... return g
7...
8
Neal Norwitz221085d2007-02-25 20:55:47 +00009>>> dump(f.__code__)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000010name: f
11argcount: 1
Guido van Rossum4f72a782006-10-27 23:31:49 +000012kwonlyargcount: 0
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000013names: ()
14varnames: ('x', 'g')
15cellvars: ('x',)
16freevars: ()
17nlocals: 2
18flags: 3
Antoine Pitrou86a36b52011-11-25 18:56:07 +010019consts: ('None', '<code object g>', "'f.<locals>.g'")
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000020
Neal Norwitz221085d2007-02-25 20:55:47 +000021>>> dump(f(4).__code__)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000022name: g
23argcount: 1
Guido van Rossum4f72a782006-10-27 23:31:49 +000024kwonlyargcount: 0
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000025names: ()
26varnames: ('y',)
27cellvars: ()
28freevars: ('x',)
29nlocals: 1
30flags: 19
31consts: ('None',)
32
33>>> def h(x, y):
34... a = x + y
35... b = x - y
36... c = a * b
37... return c
Tim Peters536cf992005-12-25 23:18:31 +000038...
Guido van Rossum4f72a782006-10-27 23:31:49 +000039
Neal Norwitz221085d2007-02-25 20:55:47 +000040>>> dump(h.__code__)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000041name: h
42argcount: 2
Guido van Rossum4f72a782006-10-27 23:31:49 +000043kwonlyargcount: 0
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000044names: ()
45varnames: ('x', 'y', 'a', 'b', 'c')
46cellvars: ()
47freevars: ()
48nlocals: 5
49flags: 67
50consts: ('None',)
51
52>>> def attrs(obj):
Guido van Rossum7131f842007-02-09 20:13:25 +000053... print(obj.attr1)
54... print(obj.attr2)
55... print(obj.attr3)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000056
Neal Norwitz221085d2007-02-25 20:55:47 +000057>>> dump(attrs.__code__)
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000058name: attrs
59argcount: 1
Guido van Rossum4f72a782006-10-27 23:31:49 +000060kwonlyargcount: 0
Georg Brandl88fc6642007-02-09 21:28:07 +000061names: ('print', 'attr1', 'attr2', 'attr3')
Jeremy Hylton3e0055f2005-10-20 19:59:25 +000062varnames: ('obj',)
63cellvars: ()
64freevars: ()
65nlocals: 1
66flags: 67
67consts: ('None',)
68
Thomas Wouters0e3f5912006-08-11 14:57:12 +000069>>> def optimize_away():
70... 'doc string'
71... 'not a docstring'
72... 53
Guido van Rossume2a383d2007-01-15 16:59:06 +000073... 0x53
Thomas Wouters0e3f5912006-08-11 14:57:12 +000074
Neal Norwitz221085d2007-02-25 20:55:47 +000075>>> dump(optimize_away.__code__)
Thomas Wouters0e3f5912006-08-11 14:57:12 +000076name: optimize_away
77argcount: 0
Guido van Rossum4f72a782006-10-27 23:31:49 +000078kwonlyargcount: 0
Thomas Wouters0e3f5912006-08-11 14:57:12 +000079names: ()
80varnames: ()
81cellvars: ()
82freevars: ()
83nlocals: 0
84flags: 67
85consts: ("'doc string'", 'None')
86
Guido van Rossum4f72a782006-10-27 23:31:49 +000087>>> def keywordonly_args(a,b,*,k1):
88... return a,b,k1
89...
90
Neal Norwitz221085d2007-02-25 20:55:47 +000091>>> dump(keywordonly_args.__code__)
Guido van Rossum4f72a782006-10-27 23:31:49 +000092name: keywordonly_args
93argcount: 2
94kwonlyargcount: 1
95names: ()
96varnames: ('a', 'b', 'k1')
97cellvars: ()
98freevars: ()
99nlocals: 3
100flags: 67
101consts: ('None',)
102
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000103"""
104
Alexandre Vassalotti7b82b402009-07-21 04:30:03 +0000105import unittest
Collin Winter4222e9c2010-03-18 22:46:40 +0000106import weakref
Alexandre Vassalotti7b82b402009-07-21 04:30:03 +0000107import _testcapi
108
Collin Winter4222e9c2010-03-18 22:46:40 +0000109
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000110def consts(t):
111 """Yield a doctest-safe sequence of object reprs."""
112 for elt in t:
113 r = repr(elt)
114 if r.startswith("<code object"):
115 yield "<code object %s>" % elt.co_name
116 else:
117 yield r
118
119def dump(co):
120 """Print out a text representation of a code object."""
Guido van Rossum4f72a782006-10-27 23:31:49 +0000121 for attr in ["name", "argcount", "kwonlyargcount", "names", "varnames",
122 "cellvars", "freevars", "nlocals", "flags"]:
Guido van Rossumbe19ed72007-02-09 05:37:30 +0000123 print("%s: %s" % (attr, getattr(co, "co_" + attr)))
124 print("consts:", tuple(consts(co.co_consts)))
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000125
Alexandre Vassalotti7b82b402009-07-21 04:30:03 +0000126
127class CodeTest(unittest.TestCase):
128
129 def test_newempty(self):
130 co = _testcapi.code_newempty("filename", "funcname", 15)
Ezio Melottib3aedd42010-11-20 19:04:17 +0000131 self.assertEqual(co.co_filename, "filename")
132 self.assertEqual(co.co_name, "funcname")
133 self.assertEqual(co.co_firstlineno, 15)
Alexandre Vassalotti7b82b402009-07-21 04:30:03 +0000134
135
Collin Winter4222e9c2010-03-18 22:46:40 +0000136class CodeWeakRefTest(unittest.TestCase):
137
138 def test_basic(self):
139 # Create a code object in a clean environment so that we know we have
140 # the only reference to it left.
141 namespace = {}
142 exec("def f(): pass", globals(), namespace)
143 f = namespace["f"]
144 del namespace
145
146 self.called = False
147 def callback(code):
148 self.called = True
149
150 # f is now the last reference to the function, and through it, the code
151 # object. While we hold it, check that we can create a weakref and
152 # deref it. Then delete it, and check that the callback gets called and
153 # the reference dies.
154 coderef = weakref.ref(f.__code__, callback)
155 self.assertTrue(bool(coderef()))
156 del f
157 self.assertFalse(bool(coderef()))
158 self.assertTrue(self.called)
159
160
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000161def test_main(verbose=None):
Alexandre Vassalotti7b82b402009-07-21 04:30:03 +0000162 from test.support import run_doctest, run_unittest
Jeremy Hylton3e0055f2005-10-20 19:59:25 +0000163 from test import test_code
164 run_doctest(test_code, verbose)
Collin Winter4222e9c2010-03-18 22:46:40 +0000165 run_unittest(CodeTest, CodeWeakRefTest)
Benjamin Petersonad9d48d2008-04-02 21:49:44 +0000166
167
Collin Winter4222e9c2010-03-18 22:46:40 +0000168if __name__ == "__main__":
Benjamin Petersonad9d48d2008-04-02 21:49:44 +0000169 test_main()