blob: 15b88ceb3982cad1707abc3464da38c34632b93c [file] [log] [blame]
Walter Dörwaldc3502462003-02-03 23:03:49 +00001# -*- coding: iso-8859-1 -*-
2import unittest, test.test_support
Georg Brandla4f46e12010-02-07 17:03:15 +00003import sys, os, cStringIO
Robert Schuppenies41a7ce02008-06-25 09:20:03 +00004import struct
Eric Smithee931b72010-01-27 00:28:29 +00005import operator
Walter Dörwaldc3502462003-02-03 23:03:49 +00006
7class SysModuleTest(unittest.TestCase):
8
Antoine Pitroue171edc2009-10-27 19:23:56 +00009 def tearDown(self):
10 test.test_support.reap_children()
11
Walter Dörwaldc3502462003-02-03 23:03:49 +000012 def test_original_displayhook(self):
13 import __builtin__
14 savestdout = sys.stdout
15 out = cStringIO.StringIO()
16 sys.stdout = out
17
18 dh = sys.__displayhook__
19
20 self.assertRaises(TypeError, dh)
21 if hasattr(__builtin__, "_"):
22 del __builtin__._
23
24 dh(None)
25 self.assertEqual(out.getvalue(), "")
Benjamin Peterson5c8da862009-06-30 22:57:08 +000026 self.assertTrue(not hasattr(__builtin__, "_"))
Walter Dörwaldc3502462003-02-03 23:03:49 +000027 dh(42)
28 self.assertEqual(out.getvalue(), "42\n")
29 self.assertEqual(__builtin__._, 42)
30
31 del sys.stdout
32 self.assertRaises(RuntimeError, dh, 42)
33
34 sys.stdout = savestdout
35
36 def test_lost_displayhook(self):
37 olddisplayhook = sys.displayhook
38 del sys.displayhook
39 code = compile("42", "<string>", "single")
40 self.assertRaises(RuntimeError, eval, code)
41 sys.displayhook = olddisplayhook
42
43 def test_custom_displayhook(self):
44 olddisplayhook = sys.displayhook
45 def baddisplayhook(obj):
46 raise ValueError
47 sys.displayhook = baddisplayhook
48 code = compile("42", "<string>", "single")
49 self.assertRaises(ValueError, eval, code)
50 sys.displayhook = olddisplayhook
51
52 def test_original_excepthook(self):
53 savestderr = sys.stderr
54 err = cStringIO.StringIO()
55 sys.stderr = err
56
57 eh = sys.__excepthook__
58
59 self.assertRaises(TypeError, eh)
60 try:
61 raise ValueError(42)
62 except ValueError, exc:
63 eh(*sys.exc_info())
64
65 sys.stderr = savestderr
Benjamin Peterson5c8da862009-06-30 22:57:08 +000066 self.assertTrue(err.getvalue().endswith("ValueError: 42\n"))
Walter Dörwaldc3502462003-02-03 23:03:49 +000067
Walter Dörwalde7028ac2003-02-03 23:05:27 +000068 # FIXME: testing the code for a lost or replaced excepthook in
Walter Dörwaldc3502462003-02-03 23:03:49 +000069 # Python/pythonrun.c::PyErr_PrintEx() is tricky.
70
Guido van Rossum46d3dc32003-03-01 03:20:41 +000071 def test_exc_clear(self):
Senthil Kumarance8e33a2010-01-08 19:04:16 +000072 self.assertRaises(TypeError, sys.exc_clear, 42)
Guido van Rossum46d3dc32003-03-01 03:20:41 +000073
74 # Verify that exc_info is present and matches exc, then clear it, and
75 # check that it worked.
76 def clear_check(exc):
Guido van Rossumd6473d12003-03-01 03:25:41 +000077 typ, value, traceback = sys.exc_info()
Benjamin Peterson5c8da862009-06-30 22:57:08 +000078 self.assertTrue(typ is not None)
79 self.assertTrue(value is exc)
80 self.assertTrue(traceback is not None)
Guido van Rossum46d3dc32003-03-01 03:20:41 +000081
Senthil Kumarance8e33a2010-01-08 19:04:16 +000082 sys.exc_clear()
Guido van Rossum46d3dc32003-03-01 03:20:41 +000083
Guido van Rossumd6473d12003-03-01 03:25:41 +000084 typ, value, traceback = sys.exc_info()
Benjamin Peterson5c8da862009-06-30 22:57:08 +000085 self.assertTrue(typ is None)
86 self.assertTrue(value is None)
87 self.assertTrue(traceback is None)
Guido van Rossum46d3dc32003-03-01 03:20:41 +000088
89 def clear():
Guido van Rossumd6473d12003-03-01 03:25:41 +000090 try:
91 raise ValueError, 42
92 except ValueError, exc:
93 clear_check(exc)
Guido van Rossum46d3dc32003-03-01 03:20:41 +000094
95 # Raise an exception and check that it can be cleared
96 clear()
97
98 # Verify that a frame currently handling an exception is
99 # unaffected by calling exc_clear in a nested frame.
100 try:
Guido van Rossumd6473d12003-03-01 03:25:41 +0000101 raise ValueError, 13
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000102 except ValueError, exc:
Guido van Rossumd6473d12003-03-01 03:25:41 +0000103 typ1, value1, traceback1 = sys.exc_info()
104 clear()
105 typ2, value2, traceback2 = sys.exc_info()
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000106
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000107 self.assertTrue(typ1 is typ2)
108 self.assertTrue(value1 is exc)
109 self.assertTrue(value1 is value2)
110 self.assertTrue(traceback1 is traceback2)
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000111
112 # Check that an exception can be cleared outside of an except block
113 clear_check(exc)
114
Walter Dörwaldc3502462003-02-03 23:03:49 +0000115 def test_exit(self):
116 self.assertRaises(TypeError, sys.exit, 42, 42)
117
118 # call without argument
119 try:
120 sys.exit(0)
121 except SystemExit, exc:
122 self.assertEquals(exc.code, 0)
123 except:
124 self.fail("wrong exception")
125 else:
126 self.fail("no exception")
127
128 # call with tuple argument with one entry
129 # entry will be unpacked
130 try:
131 sys.exit(42)
132 except SystemExit, exc:
133 self.assertEquals(exc.code, 42)
134 except:
135 self.fail("wrong exception")
136 else:
137 self.fail("no exception")
138
139 # call with integer argument
140 try:
141 sys.exit((42,))
142 except SystemExit, exc:
143 self.assertEquals(exc.code, 42)
144 except:
145 self.fail("wrong exception")
146 else:
147 self.fail("no exception")
148
149 # call with string argument
150 try:
151 sys.exit("exit")
152 except SystemExit, exc:
153 self.assertEquals(exc.code, "exit")
154 except:
155 self.fail("wrong exception")
156 else:
157 self.fail("no exception")
158
159 # call with tuple argument with two entries
160 try:
161 sys.exit((17, 23))
162 except SystemExit, exc:
163 self.assertEquals(exc.code, (17, 23))
164 except:
165 self.fail("wrong exception")
166 else:
167 self.fail("no exception")
168
Michael W. Hudsonf0588582005-02-15 15:26:11 +0000169 # test that the exit machinery handles SystemExits properly
170 import subprocess
171 # both unnormalized...
172 rc = subprocess.call([sys.executable, "-c",
173 "raise SystemExit, 46"])
174 self.assertEqual(rc, 46)
175 # ... and normalized
176 rc = subprocess.call([sys.executable, "-c",
177 "raise SystemExit(47)"])
178 self.assertEqual(rc, 47)
Tim Petersf0db38d2005-02-15 21:50:12 +0000179
180
Walter Dörwaldc3502462003-02-03 23:03:49 +0000181 def test_getdefaultencoding(self):
182 if test.test_support.have_unicode:
183 self.assertRaises(TypeError, sys.getdefaultencoding, 42)
184 # can't check more than the type, as the user might have changed it
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000185 self.assertIsInstance(sys.getdefaultencoding(), str)
Walter Dörwaldc3502462003-02-03 23:03:49 +0000186
187 # testing sys.settrace() is done in test_trace.py
188 # testing sys.setprofile() is done in test_profile.py
189
190 def test_setcheckinterval(self):
Tim Petersf2715e02003-02-19 02:35:07 +0000191 self.assertRaises(TypeError, sys.setcheckinterval)
Tim Peterse5e065b2003-07-06 18:36:54 +0000192 orig = sys.getcheckinterval()
193 for n in 0, 100, 120, orig: # orig last to restore starting state
194 sys.setcheckinterval(n)
195 self.assertEquals(sys.getcheckinterval(), n)
Walter Dörwaldc3502462003-02-03 23:03:49 +0000196
197 def test_recursionlimit(self):
Tim Petersf2715e02003-02-19 02:35:07 +0000198 self.assertRaises(TypeError, sys.getrecursionlimit, 42)
199 oldlimit = sys.getrecursionlimit()
200 self.assertRaises(TypeError, sys.setrecursionlimit)
201 self.assertRaises(ValueError, sys.setrecursionlimit, -42)
202 sys.setrecursionlimit(10000)
203 self.assertEqual(sys.getrecursionlimit(), 10000)
204 sys.setrecursionlimit(oldlimit)
Walter Dörwaldc3502462003-02-03 23:03:49 +0000205
206 def test_getwindowsversion(self):
Eric Smith59529e12010-01-27 01:21:15 +0000207 # Raise SkipTest if sys doesn't have getwindowsversion attribute
208 test.test_support.get_attribute(sys, "getwindowsversion")
209 v = sys.getwindowsversion()
210 self.assertEqual(len(v), 5)
211 self.assertIsInstance(v[0], int)
212 self.assertIsInstance(v[1], int)
213 self.assertIsInstance(v[2], int)
214 self.assertIsInstance(v[3], int)
215 self.assertIsInstance(v[4], str)
216 self.assertRaises(IndexError, operator.getitem, v, 5)
217 self.assertIsInstance(v.major, int)
218 self.assertIsInstance(v.minor, int)
219 self.assertIsInstance(v.build, int)
220 self.assertIsInstance(v.platform, int)
221 self.assertIsInstance(v.service_pack, str)
Eric Smith74c25772010-01-27 02:06:25 +0000222 self.assertIsInstance(v.service_pack_minor, int)
223 self.assertIsInstance(v.service_pack_major, int)
224 self.assertIsInstance(v.suite_mask, int)
225 self.assertIsInstance(v.product_type, int)
Eric Smith59529e12010-01-27 01:21:15 +0000226 self.assertEqual(v[0], v.major)
227 self.assertEqual(v[1], v.minor)
228 self.assertEqual(v[2], v.build)
229 self.assertEqual(v[3], v.platform)
230 self.assertEqual(v[4], v.service_pack)
Eric Smithee931b72010-01-27 00:28:29 +0000231
Eric Smith59529e12010-01-27 01:21:15 +0000232 # This is how platform.py calls it. Make sure tuple
233 # still has 5 elements
234 maj, min, buildno, plat, csd = sys.getwindowsversion()
Walter Dörwaldc3502462003-02-03 23:03:49 +0000235
236 def test_dlopenflags(self):
237 if hasattr(sys, "setdlopenflags"):
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000238 self.assertTrue(hasattr(sys, "getdlopenflags"))
Walter Dörwaldc3502462003-02-03 23:03:49 +0000239 self.assertRaises(TypeError, sys.getdlopenflags, 42)
240 oldflags = sys.getdlopenflags()
241 self.assertRaises(TypeError, sys.setdlopenflags)
242 sys.setdlopenflags(oldflags+1)
243 self.assertEqual(sys.getdlopenflags(), oldflags+1)
244 sys.setdlopenflags(oldflags)
245
246 def test_refcount(self):
Georg Brandld8fb6ac2009-04-01 00:04:33 +0000247 # n here must be a global in order for this test to pass while
248 # tracing with a python function. Tracing calls PyFrame_FastToLocals
249 # which will add a copy of any locals to the frame object, causing
250 # the reference count to increase by 2 instead of 1.
251 global n
Walter Dörwaldc3502462003-02-03 23:03:49 +0000252 self.assertRaises(TypeError, sys.getrefcount)
253 c = sys.getrefcount(None)
254 n = None
255 self.assertEqual(sys.getrefcount(None), c+1)
256 del n
257 self.assertEqual(sys.getrefcount(None), c)
258 if hasattr(sys, "gettotalrefcount"):
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000259 self.assertIsInstance(sys.gettotalrefcount(), int)
Walter Dörwaldc3502462003-02-03 23:03:49 +0000260
261 def test_getframe(self):
262 self.assertRaises(TypeError, sys._getframe, 42, 42)
Neal Norwitzeb2a5ef2003-02-18 15:22:10 +0000263 self.assertRaises(ValueError, sys._getframe, 2000000000)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000264 self.assertTrue(
Walter Dörwaldc3502462003-02-03 23:03:49 +0000265 SysModuleTest.test_getframe.im_func.func_code \
266 is sys._getframe().f_code
267 )
268
Tim Peters32a83612006-07-10 21:08:24 +0000269 # sys._current_frames() is a CPython-only gimmick.
270 def test_current_frames(self):
Tim Peters112aad32006-07-19 00:03:19 +0000271 have_threads = True
272 try:
273 import thread
274 except ImportError:
275 have_threads = False
276
277 if have_threads:
278 self.current_frames_with_threads()
279 else:
280 self.current_frames_without_threads()
281
282 # Test sys._current_frames() in a WITH_THREADS build.
Antoine Pitroue171edc2009-10-27 19:23:56 +0000283 @test.test_support.reap_threads
Tim Peters112aad32006-07-19 00:03:19 +0000284 def current_frames_with_threads(self):
Tim Peters32a83612006-07-10 21:08:24 +0000285 import threading, thread
286 import traceback
287
288 # Spawn a thread that blocks at a known place. Then the main
289 # thread does sys._current_frames(), and verifies that the frames
290 # returned make sense.
291 entered_g = threading.Event()
292 leave_g = threading.Event()
293 thread_info = [] # the thread's id
294
295 def f123():
296 g456()
297
298 def g456():
299 thread_info.append(thread.get_ident())
300 entered_g.set()
301 leave_g.wait()
302
303 t = threading.Thread(target=f123)
304 t.start()
305 entered_g.wait()
306
Tim Peters0c4a3b32006-07-25 04:07:22 +0000307 # At this point, t has finished its entered_g.set(), although it's
308 # impossible to guess whether it's still on that line or has moved on
309 # to its leave_g.wait().
Tim Peters32a83612006-07-10 21:08:24 +0000310 self.assertEqual(len(thread_info), 1)
311 thread_id = thread_info[0]
312
313 d = sys._current_frames()
314
315 main_id = thread.get_ident()
Ezio Melottiaa980582010-01-23 23:04:36 +0000316 self.assertIn(main_id, d)
317 self.assertIn(thread_id, d)
Tim Peters32a83612006-07-10 21:08:24 +0000318
319 # Verify that the captured main-thread frame is _this_ frame.
320 frame = d.pop(main_id)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000321 self.assertTrue(frame is sys._getframe())
Tim Peters32a83612006-07-10 21:08:24 +0000322
323 # Verify that the captured thread frame is blocked in g456, called
324 # from f123. This is a litte tricky, since various bits of
325 # threading.py are also in the thread's call stack.
326 frame = d.pop(thread_id)
327 stack = traceback.extract_stack(frame)
328 for i, (filename, lineno, funcname, sourceline) in enumerate(stack):
329 if funcname == "f123":
330 break
331 else:
332 self.fail("didn't find f123() on thread's call stack")
333
334 self.assertEqual(sourceline, "g456()")
335
336 # And the next record must be for g456().
337 filename, lineno, funcname, sourceline = stack[i+1]
338 self.assertEqual(funcname, "g456")
Ezio Melottiaa980582010-01-23 23:04:36 +0000339 self.assertIn(sourceline, ["leave_g.wait()", "entered_g.set()"])
Tim Peters32a83612006-07-10 21:08:24 +0000340
341 # Reap the spawned thread.
342 leave_g.set()
343 t.join()
344
Tim Peters112aad32006-07-19 00:03:19 +0000345 # Test sys._current_frames() when thread support doesn't exist.
346 def current_frames_without_threads(self):
347 # Not much happens here: there is only one thread, with artificial
348 # "thread id" 0.
349 d = sys._current_frames()
350 self.assertEqual(len(d), 1)
Ezio Melottiaa980582010-01-23 23:04:36 +0000351 self.assertIn(0, d)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000352 self.assertTrue(d[0] is sys._getframe())
Tim Peters112aad32006-07-19 00:03:19 +0000353
Walter Dörwaldc3502462003-02-03 23:03:49 +0000354 def test_attributes(self):
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000355 self.assertIsInstance(sys.api_version, int)
356 self.assertIsInstance(sys.argv, list)
Ezio Melottiaa980582010-01-23 23:04:36 +0000357 self.assertIn(sys.byteorder, ("little", "big"))
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000358 self.assertIsInstance(sys.builtin_module_names, tuple)
359 self.assertIsInstance(sys.copyright, basestring)
360 self.assertIsInstance(sys.exec_prefix, basestring)
361 self.assertIsInstance(sys.executable, basestring)
Christian Heimesdfdfaab2007-12-01 11:20:10 +0000362 self.assertEqual(len(sys.float_info), 11)
Christian Heimesc94e2b52008-01-14 04:13:37 +0000363 self.assertEqual(sys.float_info.radix, 2)
Mark Dickinsonefc82f72009-03-20 15:51:55 +0000364 self.assertEqual(len(sys.long_info), 2)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000365 self.assertTrue(sys.long_info.bits_per_digit % 5 == 0)
366 self.assertTrue(sys.long_info.sizeof_digit >= 1)
Mark Dickinson48e3fd22009-04-02 18:39:37 +0000367 self.assertEqual(type(sys.long_info.bits_per_digit), int)
368 self.assertEqual(type(sys.long_info.sizeof_digit), int)
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000369 self.assertIsInstance(sys.hexversion, int)
370 self.assertIsInstance(sys.maxint, int)
Walter Dörwald4e41a4b2005-08-03 17:09:04 +0000371 if test.test_support.have_unicode:
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000372 self.assertIsInstance(sys.maxunicode, int)
373 self.assertIsInstance(sys.platform, basestring)
374 self.assertIsInstance(sys.prefix, basestring)
375 self.assertIsInstance(sys.version, basestring)
Walter Dörwaldc3502462003-02-03 23:03:49 +0000376 vi = sys.version_info
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000377 self.assertIsInstance(vi[:], tuple)
Walter Dörwaldc3502462003-02-03 23:03:49 +0000378 self.assertEqual(len(vi), 5)
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000379 self.assertIsInstance(vi[0], int)
380 self.assertIsInstance(vi[1], int)
381 self.assertIsInstance(vi[2], int)
Ezio Melottiaa980582010-01-23 23:04:36 +0000382 self.assertIn(vi[3], ("alpha", "beta", "candidate", "final"))
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000383 self.assertIsInstance(vi[4], int)
384 self.assertIsInstance(vi.major, int)
385 self.assertIsInstance(vi.minor, int)
386 self.assertIsInstance(vi.micro, int)
Ezio Melottiaa980582010-01-23 23:04:36 +0000387 self.assertIn(vi.releaselevel, ("alpha", "beta", "candidate", "final"))
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000388 self.assertIsInstance(vi.serial, int)
Eric Smith81fe0932009-02-06 00:48:26 +0000389 self.assertEqual(vi[0], vi.major)
390 self.assertEqual(vi[1], vi.minor)
391 self.assertEqual(vi[2], vi.micro)
392 self.assertEqual(vi[3], vi.releaselevel)
393 self.assertEqual(vi[4], vi.serial)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000394 self.assertTrue(vi > (1,0,0))
Mark Dickinsonda8652d92009-10-24 14:01:08 +0000395 self.assertIsInstance(sys.float_repr_style, str)
Ezio Melottiaa980582010-01-23 23:04:36 +0000396 self.assertIn(sys.float_repr_style, ('short', 'legacy'))
Walter Dörwaldc3502462003-02-03 23:03:49 +0000397
Martin v. Löwisa8cd7a22006-04-03 11:05:39 +0000398 def test_43581(self):
399 # Can't use sys.stdout, as this is a cStringIO object when
400 # the test runs under regrtest.
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000401 self.assertTrue(sys.__stdout__.encoding == sys.__stderr__.encoding)
Martin v. Löwisa8cd7a22006-04-03 11:05:39 +0000402
Christian Heimesf31b69f2008-01-14 03:42:48 +0000403 def test_sys_flags(self):
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000404 self.assertTrue(sys.flags)
Christian Heimesf31b69f2008-01-14 03:42:48 +0000405 attrs = ("debug", "py3k_warning", "division_warning", "division_new",
406 "inspect", "interactive", "optimize", "dont_write_bytecode",
Andrew M. Kuchling7ce9b182008-01-15 01:29:16 +0000407 "no_site", "ignore_environment", "tabcheck", "verbose",
Brett Cannonbe1501b2008-05-08 20:23:06 +0000408 "unicode", "bytes_warning")
Christian Heimesf31b69f2008-01-14 03:42:48 +0000409 for attr in attrs:
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000410 self.assertTrue(hasattr(sys.flags, attr), attr)
Christian Heimesf31b69f2008-01-14 03:42:48 +0000411 self.assertEqual(type(getattr(sys.flags, attr)), int, attr)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000412 self.assertTrue(repr(sys.flags))
Christian Heimesf31b69f2008-01-14 03:42:48 +0000413
Christian Heimes422051a2008-02-04 18:00:12 +0000414 def test_clear_type_cache(self):
415 sys._clear_type_cache()
416
Martin v. Löwis99815892008-06-01 07:20:46 +0000417 def test_ioencoding(self):
Georg Brandla4f46e12010-02-07 17:03:15 +0000418 import subprocess
Martin v. Löwis99815892008-06-01 07:20:46 +0000419 env = dict(os.environ)
420
421 # Test character: cent sign, encoded as 0x4A (ASCII J) in CP424,
422 # not representable in ASCII.
423
424 env["PYTHONIOENCODING"] = "cp424"
425 p = subprocess.Popen([sys.executable, "-c", 'print unichr(0xa2)'],
426 stdout = subprocess.PIPE, env=env)
Antoine Pitroue171edc2009-10-27 19:23:56 +0000427 out = p.communicate()[0].strip()
Martin v. Löwis99815892008-06-01 07:20:46 +0000428 self.assertEqual(out, unichr(0xa2).encode("cp424"))
429
430 env["PYTHONIOENCODING"] = "ascii:replace"
431 p = subprocess.Popen([sys.executable, "-c", 'print unichr(0xa2)'],
432 stdout = subprocess.PIPE, env=env)
Antoine Pitroue171edc2009-10-27 19:23:56 +0000433 out = p.communicate()[0].strip()
Martin v. Löwis99815892008-06-01 07:20:46 +0000434 self.assertEqual(out, '?')
435
Victor Stinnerb4b0a292010-01-31 22:32:15 +0000436 def test_call_tracing(self):
437 self.assertEqual(sys.call_tracing(str, (2,)), "2")
438 self.assertRaises(TypeError, sys.call_tracing, str, 2)
439
Martin v. Löwis99815892008-06-01 07:20:46 +0000440
Robert Schuppenies51df0642008-06-01 16:16:17 +0000441class SizeofTest(unittest.TestCase):
442
Robert Schuppenies47629022008-07-10 17:13:55 +0000443 TPFLAGS_HAVE_GC = 1<<14
444 TPFLAGS_HEAPTYPE = 1L<<9
445
Robert Schuppenies51df0642008-06-01 16:16:17 +0000446 def setUp(self):
Robert Schuppenies41a7ce02008-06-25 09:20:03 +0000447 self.c = len(struct.pack('c', ' '))
448 self.H = len(struct.pack('H', 0))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000449 self.i = len(struct.pack('i', 0))
450 self.l = len(struct.pack('l', 0))
Robert Schuppenies41a7ce02008-06-25 09:20:03 +0000451 self.P = len(struct.pack('P', 0))
452 # due to missing size_t information from struct, it is assumed that
453 # sizeof(Py_ssize_t) = sizeof(void*)
Robert Schuppenies161b9212008-06-26 15:20:35 +0000454 self.header = 'PP'
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000455 self.vheader = self.header + 'P'
Robert Schuppenies51df0642008-06-01 16:16:17 +0000456 if hasattr(sys, "gettotalrefcount"):
Robert Schuppenies41a7ce02008-06-25 09:20:03 +0000457 self.header += '2P'
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000458 self.vheader += '2P'
Mark Dickinsonefc82f72009-03-20 15:51:55 +0000459 self.longdigit = sys.long_info.sizeof_digit
Robert Schuppenies47629022008-07-10 17:13:55 +0000460 import _testcapi
461 self.gc_headsize = _testcapi.SIZEOF_PYGC_HEAD
Robert Schuppenies51df0642008-06-01 16:16:17 +0000462 self.file = open(test.test_support.TESTFN, 'wb')
463
464 def tearDown(self):
465 self.file.close()
Georg Brandl7a6de8b2008-06-01 16:42:16 +0000466 test.test_support.unlink(test.test_support.TESTFN)
Robert Schuppenies51df0642008-06-01 16:16:17 +0000467
Robert Schuppenies9be2ec12008-07-10 15:24:04 +0000468 def check_sizeof(self, o, size):
Robert Schuppenies51df0642008-06-01 16:16:17 +0000469 result = sys.getsizeof(o)
Robert Schuppenies47629022008-07-10 17:13:55 +0000470 if ((type(o) == type) and (o.__flags__ & self.TPFLAGS_HEAPTYPE) or\
471 ((type(o) != type) and (type(o).__flags__ & self.TPFLAGS_HAVE_GC))):
472 size += self.gc_headsize
Robert Schuppenies9be2ec12008-07-10 15:24:04 +0000473 msg = 'wrong size for %s: got %d, expected %d' \
474 % (type(o), result, size)
475 self.assertEqual(result, size, msg)
Robert Schuppenies51df0642008-06-01 16:16:17 +0000476
Robert Schuppenies41a7ce02008-06-25 09:20:03 +0000477 def calcsize(self, fmt):
478 """Wrapper around struct.calcsize which enforces the alignment of the
479 end of a structure to the alignment requirement of pointer.
Robert Schuppenies51df0642008-06-01 16:16:17 +0000480
Robert Schuppenies41a7ce02008-06-25 09:20:03 +0000481 Note: This wrapper should only be used if a pointer member is included
482 and no member with a size larger than a pointer exists.
483 """
484 return struct.calcsize(fmt + '0P')
Robert Schuppenies51df0642008-06-01 16:16:17 +0000485
Robert Schuppenies47629022008-07-10 17:13:55 +0000486 def test_gc_head_size(self):
487 # Check that the gc header size is added to objects tracked by the gc.
488 h = self.header
489 size = self.calcsize
490 gc_header_size = self.gc_headsize
491 # bool objects are not gc tracked
492 self.assertEqual(sys.getsizeof(True), size(h + 'l'))
493 # but lists are
494 self.assertEqual(sys.getsizeof([]), size(h + 'P PP') + gc_header_size)
495
496 def test_default(self):
497 h = self.header
498 size = self.calcsize
499 self.assertEqual(sys.getsizeof(True, -1), size(h + 'l'))
500
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000501 def test_objecttypes(self):
502 # check all types defined in Objects/
Robert Schuppenies41a7ce02008-06-25 09:20:03 +0000503 h = self.header
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000504 vh = self.vheader
Robert Schuppenies41a7ce02008-06-25 09:20:03 +0000505 size = self.calcsize
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000506 check = self.check_sizeof
Robert Schuppenies51df0642008-06-01 16:16:17 +0000507 # bool
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000508 check(True, size(h + 'l'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000509 # buffer
Senthil Kumarance8e33a2010-01-08 19:04:16 +0000510 check(buffer(''), size(h + '2P2Pil'))
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000511 # builtin_function_or_method
512 check(len, size(h + '3P'))
Robert Schuppenies9be2ec12008-07-10 15:24:04 +0000513 # bytearray
514 samples = ['', 'u'*100000]
515 for sample in samples:
516 x = bytearray(sample)
517 check(x, size(vh + 'iPP') + x.__alloc__() * self.c)
518 # bytearray_iterator
519 check(iter(bytearray()), size(h + 'PP'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000520 # cell
521 def get_cell():
522 x = 42
523 def inner():
524 return x
525 return inner
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000526 check(get_cell().func_closure[0], size(h + 'P'))
527 # classobj (old-style class)
Robert Schuppenies51df0642008-06-01 16:16:17 +0000528 class class_oldstyle():
529 def method():
530 pass
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000531 check(class_oldstyle, size(h + '6P'))
532 # instance (old-style class)
533 check(class_oldstyle(), size(h + '3P'))
534 # instancemethod (old-style class)
535 check(class_oldstyle().method, size(h + '4P'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000536 # complex
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000537 check(complex(0,1), size(h + '2d'))
538 # code
539 check(get_cell().func_code, size(h + '4i8Pi2P'))
540 # BaseException
541 check(BaseException(), size(h + '3P'))
542 # UnicodeEncodeError
543 check(UnicodeEncodeError("", u"", 0, 0, ""), size(h + '5P2PP'))
544 # UnicodeDecodeError
545 check(UnicodeDecodeError("", "", 0, 0, ""), size(h + '5P2PP'))
546 # UnicodeTranslateError
547 check(UnicodeTranslateError(u"", 0, 1, ""), size(h + '5P2PP'))
548 # method_descriptor (descriptor object)
549 check(str.lower, size(h + '2PP'))
550 # classmethod_descriptor (descriptor object)
551 # XXX
552 # member_descriptor (descriptor object)
553 import datetime
554 check(datetime.timedelta.days, size(h + '2PP'))
555 # getset_descriptor (descriptor object)
556 import __builtin__
557 check(__builtin__.file.closed, size(h + '2PP'))
558 # wrapper_descriptor (descriptor object)
559 check(int.__add__, size(h + '2P2P'))
560 # dictproxy
561 class C(object): pass
562 check(C.__dict__, size(h + 'P'))
563 # method-wrapper (descriptor object)
564 check({}.__iter__, size(h + '2P'))
565 # dict
Robert Schuppenies2ee623b2008-07-14 08:42:18 +0000566 check({}, size(h + '3P2P' + 8*'P2P'))
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000567 x = {1:1, 2:2, 3:3, 4:4, 5:5, 6:6, 7:7, 8:8}
Robert Schuppenies2ee623b2008-07-14 08:42:18 +0000568 check(x, size(h + '3P2P' + 8*'P2P') + 16*size('P2P'))
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000569 # dictionary-keyiterator
570 check({}.iterkeys(), size(h + 'P2PPP'))
571 # dictionary-valueiterator
572 check({}.itervalues(), size(h + 'P2PPP'))
573 # dictionary-itemiterator
574 check({}.iteritems(), size(h + 'P2PPP'))
575 # ellipses
576 check(Ellipsis, size(h + ''))
577 # EncodingMap
578 import codecs, encodings.iso8859_3
579 x = codecs.charmap_build(encodings.iso8859_3.decoding_table)
580 check(x, size(h + '32B2iB'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000581 # enumerate
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000582 check(enumerate([]), size(h + 'l3P'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000583 # file
Antoine Pitroubb445a12010-02-05 17:05:54 +0000584 check(self.file, size(h + '4P2i4P3i3P3i'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000585 # float
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000586 check(float(0), size(h + 'd'))
587 # sys.floatinfo
588 check(sys.float_info, size(vh) + self.P * len(sys.float_info))
Robert Schuppenies9be2ec12008-07-10 15:24:04 +0000589 # frame
590 import inspect
591 CO_MAXBLOCKS = 20
592 x = inspect.currentframe()
593 ncells = len(x.f_code.co_cellvars)
594 nfrees = len(x.f_code.co_freevars)
595 extras = x.f_code.co_stacksize + x.f_code.co_nlocals +\
596 ncells + nfrees - 1
Robert Schuppenies2ee623b2008-07-14 08:42:18 +0000597 check(x, size(vh + '12P3i' + CO_MAXBLOCKS*'3i' + 'P' + extras*'P'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000598 # function
599 def func(): pass
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000600 check(func, size(h + '9P'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000601 class c():
602 @staticmethod
603 def foo():
604 pass
605 @classmethod
606 def bar(cls):
607 pass
608 # staticmethod
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000609 check(foo, size(h + 'P'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000610 # classmethod
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000611 check(bar, size(h + 'P'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000612 # generator
613 def get_gen(): yield 1
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000614 check(get_gen(), size(h + 'Pi2P'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000615 # integer
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000616 check(1, size(h + 'l'))
617 check(100, size(h + 'l'))
618 # iterator
619 check(iter('abc'), size(h + 'lP'))
620 # callable-iterator
621 import re
622 check(re.finditer('',''), size(h + '2P'))
623 # list
624 samples = [[], [1,2,3], ['1', '2', '3']]
625 for sample in samples:
626 check(sample, size(vh + 'PP') + len(sample)*self.P)
627 # sortwrapper (list)
628 # XXX
629 # cmpwrapper (list)
630 # XXX
631 # listiterator (list)
632 check(iter([]), size(h + 'lP'))
633 # listreverseiterator (list)
634 check(reversed([]), size(h + 'lP'))
635 # long
Mark Dickinson2ffb26f2009-02-15 10:13:41 +0000636 check(0L, size(vh))
Mark Dickinsonefc82f72009-03-20 15:51:55 +0000637 check(1L, size(vh) + self.longdigit)
638 check(-1L, size(vh) + self.longdigit)
639 PyLong_BASE = 2**sys.long_info.bits_per_digit
Mark Dickinson48e3fd22009-04-02 18:39:37 +0000640 check(long(PyLong_BASE), size(vh) + 2*self.longdigit)
641 check(long(PyLong_BASE**2-1), size(vh) + 2*self.longdigit)
642 check(long(PyLong_BASE**2), size(vh) + 3*self.longdigit)
Robert Schuppenies51df0642008-06-01 16:16:17 +0000643 # module
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000644 check(unittest, size(h + 'P'))
645 # None
646 check(None, size(h + ''))
647 # object
648 check(object(), size(h + ''))
649 # property (descriptor object)
650 class C(object):
651 def getx(self): return self.__x
652 def setx(self, value): self.__x = value
653 def delx(self): del self.__x
654 x = property(getx, setx, delx, "")
655 check(x, size(h + '4Pi'))
656 # PyCObject
657 # XXX
658 # rangeiterator
659 check(iter(xrange(1)), size(h + '4l'))
660 # reverse
661 check(reversed(''), size(h + 'PP'))
Robert Schuppenies9be2ec12008-07-10 15:24:04 +0000662 # set
663 # frozenset
664 PySet_MINSIZE = 8
665 samples = [[], range(10), range(50)]
Robert Schuppenies2ee623b2008-07-14 08:42:18 +0000666 s = size(h + '3P2P' + PySet_MINSIZE*'lP' + 'lP')
Robert Schuppenies9be2ec12008-07-10 15:24:04 +0000667 for sample in samples:
668 minused = len(sample)
669 if minused == 0: tmp = 1
670 # the computation of minused is actually a bit more complicated
671 # but this suffices for the sizeof test
672 minused = minused*2
673 newsize = PySet_MINSIZE
674 while newsize <= minused:
675 newsize = newsize << 1
676 if newsize <= 8:
677 check(set(sample), s)
678 check(frozenset(sample), s)
679 else:
680 check(set(sample), s + newsize*struct.calcsize('lP'))
681 check(frozenset(sample), s + newsize*struct.calcsize('lP'))
682 # setiterator
683 check(iter(set()), size(h + 'P3P'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000684 # slice
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000685 check(slice(1), size(h + '3P'))
686 # str
Mark Dickinson826f3fe2008-12-05 21:55:28 +0000687 check('', struct.calcsize(vh + 'li') + 1)
688 check('abc', struct.calcsize(vh + 'li') + 1 + 3*self.c)
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000689 # super
690 check(super(int), size(h + '3P'))
691 # tuple
692 check((), size(vh))
693 check((1,2,3), size(vh) + 3*self.P)
694 # tupleiterator
695 check(iter(()), size(h + 'lP'))
696 # type
697 # (PyTypeObject + PyNumberMethods + PyMappingMethods +
698 # PySequenceMethods + PyBufferProcs)
Robert Schuppenies2ee623b2008-07-14 08:42:18 +0000699 s = size(vh + 'P2P15Pl4PP9PP11PI') + size('41P 10P 3P 6P')
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000700 class newstyleclass(object):
701 pass
702 check(newstyleclass, s)
703 # builtin type
704 check(int, s)
705 # NotImplementedType
706 import types
707 check(types.NotImplementedType, s)
Robert Schuppenies901c9972008-06-10 10:10:31 +0000708 # unicode
Robert Schuppenies59f3ade2008-06-17 08:42:15 +0000709 usize = len(u'\0'.encode('unicode-internal'))
Robert Schuppenies901c9972008-06-10 10:10:31 +0000710 samples = [u'', u'1'*100]
711 # we need to test for both sizes, because we don't know if the string
712 # has been cached
713 for s in samples:
Robert Schuppenies9be2ec12008-07-10 15:24:04 +0000714 check(s, size(h + 'PPlP') + usize * (len(s) + 1))
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000715 # weakref
716 import weakref
717 check(weakref.ref(int), size(h + '2Pl2P'))
718 # weakproxy
719 # XXX
720 # weakcallableproxy
721 check(weakref.proxy(int), size(h + '2Pl2P'))
722 # xrange
723 check(xrange(1), size(h + '3l'))
724 check(xrange(66000), size(h + '3l'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000725
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000726 def test_pythontypes(self):
727 # check all types defined in Python/
728 h = self.header
729 vh = self.vheader
730 size = self.calcsize
731 check = self.check_sizeof
732 # _ast.AST
733 import _ast
734 check(_ast.AST(), size(h + ''))
735 # imp.NullImporter
736 import imp
737 check(imp.NullImporter(self.file.name), size(h + ''))
738 try:
739 raise TypeError
740 except TypeError:
741 tb = sys.exc_info()[2]
742 # traceback
743 if tb != None:
744 check(tb, size(h + '2P2i'))
745 # symtable entry
746 # XXX
747 # sys.flags
748 check(sys.flags, size(vh) + self.P * len(sys.flags))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000749
750
Walter Dörwaldc3502462003-02-03 23:03:49 +0000751def test_main():
Robert Schuppenies51df0642008-06-01 16:16:17 +0000752 test_classes = (SysModuleTest, SizeofTest)
753
754 test.test_support.run_unittest(*test_classes)
Walter Dörwaldc3502462003-02-03 23:03:49 +0000755
756if __name__ == "__main__":
757 test_main()