blob: 17208753bebf8b706cca913a48d18357090c654f [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
Ezio Melottid80b4bf2010-03-17 13:52:48 +000082 with test.test_support.check_py3k_warnings():
83 sys.exc_clear()
Guido van Rossum46d3dc32003-03-01 03:20:41 +000084
Guido van Rossumd6473d12003-03-01 03:25:41 +000085 typ, value, traceback = sys.exc_info()
Benjamin Peterson5c8da862009-06-30 22:57:08 +000086 self.assertTrue(typ is None)
87 self.assertTrue(value is None)
88 self.assertTrue(traceback is None)
Guido van Rossum46d3dc32003-03-01 03:20:41 +000089
90 def clear():
Guido van Rossumd6473d12003-03-01 03:25:41 +000091 try:
92 raise ValueError, 42
93 except ValueError, exc:
94 clear_check(exc)
Guido van Rossum46d3dc32003-03-01 03:20:41 +000095
96 # Raise an exception and check that it can be cleared
97 clear()
98
99 # Verify that a frame currently handling an exception is
100 # unaffected by calling exc_clear in a nested frame.
101 try:
Guido van Rossumd6473d12003-03-01 03:25:41 +0000102 raise ValueError, 13
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000103 except ValueError, exc:
Guido van Rossumd6473d12003-03-01 03:25:41 +0000104 typ1, value1, traceback1 = sys.exc_info()
105 clear()
106 typ2, value2, traceback2 = sys.exc_info()
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000107
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000108 self.assertTrue(typ1 is typ2)
109 self.assertTrue(value1 is exc)
110 self.assertTrue(value1 is value2)
111 self.assertTrue(traceback1 is traceback2)
Guido van Rossum46d3dc32003-03-01 03:20:41 +0000112
113 # Check that an exception can be cleared outside of an except block
114 clear_check(exc)
115
Walter Dörwaldc3502462003-02-03 23:03:49 +0000116 def test_exit(self):
117 self.assertRaises(TypeError, sys.exit, 42, 42)
118
119 # call without argument
120 try:
121 sys.exit(0)
122 except SystemExit, exc:
123 self.assertEquals(exc.code, 0)
124 except:
125 self.fail("wrong exception")
126 else:
127 self.fail("no exception")
128
129 # call with tuple argument with one entry
130 # entry will be unpacked
131 try:
132 sys.exit(42)
133 except SystemExit, exc:
134 self.assertEquals(exc.code, 42)
135 except:
136 self.fail("wrong exception")
137 else:
138 self.fail("no exception")
139
140 # call with integer argument
141 try:
142 sys.exit((42,))
143 except SystemExit, exc:
144 self.assertEquals(exc.code, 42)
145 except:
146 self.fail("wrong exception")
147 else:
148 self.fail("no exception")
149
150 # call with string argument
151 try:
152 sys.exit("exit")
153 except SystemExit, exc:
154 self.assertEquals(exc.code, "exit")
155 except:
156 self.fail("wrong exception")
157 else:
158 self.fail("no exception")
159
160 # call with tuple argument with two entries
161 try:
162 sys.exit((17, 23))
163 except SystemExit, exc:
164 self.assertEquals(exc.code, (17, 23))
165 except:
166 self.fail("wrong exception")
167 else:
168 self.fail("no exception")
169
Michael W. Hudsonf0588582005-02-15 15:26:11 +0000170 # test that the exit machinery handles SystemExits properly
171 import subprocess
172 # both unnormalized...
173 rc = subprocess.call([sys.executable, "-c",
174 "raise SystemExit, 46"])
175 self.assertEqual(rc, 46)
176 # ... and normalized
177 rc = subprocess.call([sys.executable, "-c",
178 "raise SystemExit(47)"])
179 self.assertEqual(rc, 47)
Tim Petersf0db38d2005-02-15 21:50:12 +0000180
181
Walter Dörwaldc3502462003-02-03 23:03:49 +0000182 def test_getdefaultencoding(self):
183 if test.test_support.have_unicode:
184 self.assertRaises(TypeError, sys.getdefaultencoding, 42)
185 # can't check more than the type, as the user might have changed it
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000186 self.assertIsInstance(sys.getdefaultencoding(), str)
Walter Dörwaldc3502462003-02-03 23:03:49 +0000187
188 # testing sys.settrace() is done in test_trace.py
189 # testing sys.setprofile() is done in test_profile.py
190
191 def test_setcheckinterval(self):
Tim Petersf2715e02003-02-19 02:35:07 +0000192 self.assertRaises(TypeError, sys.setcheckinterval)
Tim Peterse5e065b2003-07-06 18:36:54 +0000193 orig = sys.getcheckinterval()
194 for n in 0, 100, 120, orig: # orig last to restore starting state
195 sys.setcheckinterval(n)
196 self.assertEquals(sys.getcheckinterval(), n)
Walter Dörwaldc3502462003-02-03 23:03:49 +0000197
198 def test_recursionlimit(self):
Tim Petersf2715e02003-02-19 02:35:07 +0000199 self.assertRaises(TypeError, sys.getrecursionlimit, 42)
200 oldlimit = sys.getrecursionlimit()
201 self.assertRaises(TypeError, sys.setrecursionlimit)
202 self.assertRaises(ValueError, sys.setrecursionlimit, -42)
203 sys.setrecursionlimit(10000)
204 self.assertEqual(sys.getrecursionlimit(), 10000)
205 sys.setrecursionlimit(oldlimit)
Walter Dörwaldc3502462003-02-03 23:03:49 +0000206
207 def test_getwindowsversion(self):
Eric Smith59529e12010-01-27 01:21:15 +0000208 # Raise SkipTest if sys doesn't have getwindowsversion attribute
209 test.test_support.get_attribute(sys, "getwindowsversion")
210 v = sys.getwindowsversion()
211 self.assertEqual(len(v), 5)
212 self.assertIsInstance(v[0], int)
213 self.assertIsInstance(v[1], int)
214 self.assertIsInstance(v[2], int)
215 self.assertIsInstance(v[3], int)
216 self.assertIsInstance(v[4], str)
217 self.assertRaises(IndexError, operator.getitem, v, 5)
218 self.assertIsInstance(v.major, int)
219 self.assertIsInstance(v.minor, int)
220 self.assertIsInstance(v.build, int)
221 self.assertIsInstance(v.platform, int)
222 self.assertIsInstance(v.service_pack, str)
Eric Smith74c25772010-01-27 02:06:25 +0000223 self.assertIsInstance(v.service_pack_minor, int)
224 self.assertIsInstance(v.service_pack_major, int)
225 self.assertIsInstance(v.suite_mask, int)
226 self.assertIsInstance(v.product_type, int)
Eric Smith59529e12010-01-27 01:21:15 +0000227 self.assertEqual(v[0], v.major)
228 self.assertEqual(v[1], v.minor)
229 self.assertEqual(v[2], v.build)
230 self.assertEqual(v[3], v.platform)
231 self.assertEqual(v[4], v.service_pack)
Eric Smithee931b72010-01-27 00:28:29 +0000232
Eric Smith59529e12010-01-27 01:21:15 +0000233 # This is how platform.py calls it. Make sure tuple
234 # still has 5 elements
235 maj, min, buildno, plat, csd = sys.getwindowsversion()
Walter Dörwaldc3502462003-02-03 23:03:49 +0000236
237 def test_dlopenflags(self):
238 if hasattr(sys, "setdlopenflags"):
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000239 self.assertTrue(hasattr(sys, "getdlopenflags"))
Walter Dörwaldc3502462003-02-03 23:03:49 +0000240 self.assertRaises(TypeError, sys.getdlopenflags, 42)
241 oldflags = sys.getdlopenflags()
242 self.assertRaises(TypeError, sys.setdlopenflags)
243 sys.setdlopenflags(oldflags+1)
244 self.assertEqual(sys.getdlopenflags(), oldflags+1)
245 sys.setdlopenflags(oldflags)
246
247 def test_refcount(self):
Georg Brandld8fb6ac2009-04-01 00:04:33 +0000248 # n here must be a global in order for this test to pass while
249 # tracing with a python function. Tracing calls PyFrame_FastToLocals
250 # which will add a copy of any locals to the frame object, causing
251 # the reference count to increase by 2 instead of 1.
252 global n
Walter Dörwaldc3502462003-02-03 23:03:49 +0000253 self.assertRaises(TypeError, sys.getrefcount)
254 c = sys.getrefcount(None)
255 n = None
256 self.assertEqual(sys.getrefcount(None), c+1)
257 del n
258 self.assertEqual(sys.getrefcount(None), c)
259 if hasattr(sys, "gettotalrefcount"):
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000260 self.assertIsInstance(sys.gettotalrefcount(), int)
Walter Dörwaldc3502462003-02-03 23:03:49 +0000261
262 def test_getframe(self):
263 self.assertRaises(TypeError, sys._getframe, 42, 42)
Neal Norwitzeb2a5ef2003-02-18 15:22:10 +0000264 self.assertRaises(ValueError, sys._getframe, 2000000000)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000265 self.assertTrue(
Walter Dörwaldc3502462003-02-03 23:03:49 +0000266 SysModuleTest.test_getframe.im_func.func_code \
267 is sys._getframe().f_code
268 )
269
Tim Peters32a83612006-07-10 21:08:24 +0000270 # sys._current_frames() is a CPython-only gimmick.
271 def test_current_frames(self):
Tim Peters112aad32006-07-19 00:03:19 +0000272 have_threads = True
273 try:
274 import thread
275 except ImportError:
276 have_threads = False
277
278 if have_threads:
279 self.current_frames_with_threads()
280 else:
281 self.current_frames_without_threads()
282
283 # Test sys._current_frames() in a WITH_THREADS build.
Antoine Pitroue171edc2009-10-27 19:23:56 +0000284 @test.test_support.reap_threads
Tim Peters112aad32006-07-19 00:03:19 +0000285 def current_frames_with_threads(self):
Tim Peters32a83612006-07-10 21:08:24 +0000286 import threading, thread
287 import traceback
288
289 # Spawn a thread that blocks at a known place. Then the main
290 # thread does sys._current_frames(), and verifies that the frames
291 # returned make sense.
292 entered_g = threading.Event()
293 leave_g = threading.Event()
294 thread_info = [] # the thread's id
295
296 def f123():
297 g456()
298
299 def g456():
300 thread_info.append(thread.get_ident())
301 entered_g.set()
302 leave_g.wait()
303
304 t = threading.Thread(target=f123)
305 t.start()
306 entered_g.wait()
307
Tim Peters0c4a3b32006-07-25 04:07:22 +0000308 # At this point, t has finished its entered_g.set(), although it's
309 # impossible to guess whether it's still on that line or has moved on
310 # to its leave_g.wait().
Tim Peters32a83612006-07-10 21:08:24 +0000311 self.assertEqual(len(thread_info), 1)
312 thread_id = thread_info[0]
313
314 d = sys._current_frames()
315
316 main_id = thread.get_ident()
Ezio Melottiaa980582010-01-23 23:04:36 +0000317 self.assertIn(main_id, d)
318 self.assertIn(thread_id, d)
Tim Peters32a83612006-07-10 21:08:24 +0000319
320 # Verify that the captured main-thread frame is _this_ frame.
321 frame = d.pop(main_id)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000322 self.assertTrue(frame is sys._getframe())
Tim Peters32a83612006-07-10 21:08:24 +0000323
324 # Verify that the captured thread frame is blocked in g456, called
325 # from f123. This is a litte tricky, since various bits of
326 # threading.py are also in the thread's call stack.
327 frame = d.pop(thread_id)
328 stack = traceback.extract_stack(frame)
329 for i, (filename, lineno, funcname, sourceline) in enumerate(stack):
330 if funcname == "f123":
331 break
332 else:
333 self.fail("didn't find f123() on thread's call stack")
334
335 self.assertEqual(sourceline, "g456()")
336
337 # And the next record must be for g456().
338 filename, lineno, funcname, sourceline = stack[i+1]
339 self.assertEqual(funcname, "g456")
Ezio Melottiaa980582010-01-23 23:04:36 +0000340 self.assertIn(sourceline, ["leave_g.wait()", "entered_g.set()"])
Tim Peters32a83612006-07-10 21:08:24 +0000341
342 # Reap the spawned thread.
343 leave_g.set()
344 t.join()
345
Tim Peters112aad32006-07-19 00:03:19 +0000346 # Test sys._current_frames() when thread support doesn't exist.
347 def current_frames_without_threads(self):
348 # Not much happens here: there is only one thread, with artificial
349 # "thread id" 0.
350 d = sys._current_frames()
351 self.assertEqual(len(d), 1)
Ezio Melottiaa980582010-01-23 23:04:36 +0000352 self.assertIn(0, d)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000353 self.assertTrue(d[0] is sys._getframe())
Tim Peters112aad32006-07-19 00:03:19 +0000354
Walter Dörwaldc3502462003-02-03 23:03:49 +0000355 def test_attributes(self):
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000356 self.assertIsInstance(sys.api_version, int)
357 self.assertIsInstance(sys.argv, list)
Ezio Melottiaa980582010-01-23 23:04:36 +0000358 self.assertIn(sys.byteorder, ("little", "big"))
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000359 self.assertIsInstance(sys.builtin_module_names, tuple)
360 self.assertIsInstance(sys.copyright, basestring)
361 self.assertIsInstance(sys.exec_prefix, basestring)
362 self.assertIsInstance(sys.executable, basestring)
Christian Heimesdfdfaab2007-12-01 11:20:10 +0000363 self.assertEqual(len(sys.float_info), 11)
Christian Heimesc94e2b52008-01-14 04:13:37 +0000364 self.assertEqual(sys.float_info.radix, 2)
Mark Dickinsonefc82f72009-03-20 15:51:55 +0000365 self.assertEqual(len(sys.long_info), 2)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000366 self.assertTrue(sys.long_info.bits_per_digit % 5 == 0)
367 self.assertTrue(sys.long_info.sizeof_digit >= 1)
Mark Dickinson48e3fd22009-04-02 18:39:37 +0000368 self.assertEqual(type(sys.long_info.bits_per_digit), int)
369 self.assertEqual(type(sys.long_info.sizeof_digit), int)
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000370 self.assertIsInstance(sys.hexversion, int)
371 self.assertIsInstance(sys.maxint, int)
Walter Dörwald4e41a4b2005-08-03 17:09:04 +0000372 if test.test_support.have_unicode:
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000373 self.assertIsInstance(sys.maxunicode, int)
374 self.assertIsInstance(sys.platform, basestring)
375 self.assertIsInstance(sys.prefix, basestring)
376 self.assertIsInstance(sys.version, basestring)
Walter Dörwaldc3502462003-02-03 23:03:49 +0000377 vi = sys.version_info
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000378 self.assertIsInstance(vi[:], tuple)
Walter Dörwaldc3502462003-02-03 23:03:49 +0000379 self.assertEqual(len(vi), 5)
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000380 self.assertIsInstance(vi[0], int)
381 self.assertIsInstance(vi[1], int)
382 self.assertIsInstance(vi[2], int)
Ezio Melottiaa980582010-01-23 23:04:36 +0000383 self.assertIn(vi[3], ("alpha", "beta", "candidate", "final"))
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000384 self.assertIsInstance(vi[4], int)
385 self.assertIsInstance(vi.major, int)
386 self.assertIsInstance(vi.minor, int)
387 self.assertIsInstance(vi.micro, int)
Ezio Melottiaa980582010-01-23 23:04:36 +0000388 self.assertIn(vi.releaselevel, ("alpha", "beta", "candidate", "final"))
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000389 self.assertIsInstance(vi.serial, int)
Eric Smith81fe0932009-02-06 00:48:26 +0000390 self.assertEqual(vi[0], vi.major)
391 self.assertEqual(vi[1], vi.minor)
392 self.assertEqual(vi[2], vi.micro)
393 self.assertEqual(vi[3], vi.releaselevel)
394 self.assertEqual(vi[4], vi.serial)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000395 self.assertTrue(vi > (1,0,0))
Mark Dickinsonda8652d92009-10-24 14:01:08 +0000396 self.assertIsInstance(sys.float_repr_style, str)
Ezio Melottiaa980582010-01-23 23:04:36 +0000397 self.assertIn(sys.float_repr_style, ('short', 'legacy'))
Walter Dörwaldc3502462003-02-03 23:03:49 +0000398
Martin v. Löwisa8cd7a22006-04-03 11:05:39 +0000399 def test_43581(self):
400 # Can't use sys.stdout, as this is a cStringIO object when
401 # the test runs under regrtest.
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000402 self.assertTrue(sys.__stdout__.encoding == sys.__stderr__.encoding)
Martin v. Löwisa8cd7a22006-04-03 11:05:39 +0000403
Christian Heimesf31b69f2008-01-14 03:42:48 +0000404 def test_sys_flags(self):
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000405 self.assertTrue(sys.flags)
Christian Heimesf31b69f2008-01-14 03:42:48 +0000406 attrs = ("debug", "py3k_warning", "division_warning", "division_new",
407 "inspect", "interactive", "optimize", "dont_write_bytecode",
Andrew M. Kuchling7ce9b182008-01-15 01:29:16 +0000408 "no_site", "ignore_environment", "tabcheck", "verbose",
Brett Cannonbe1501b2008-05-08 20:23:06 +0000409 "unicode", "bytes_warning")
Christian Heimesf31b69f2008-01-14 03:42:48 +0000410 for attr in attrs:
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000411 self.assertTrue(hasattr(sys.flags, attr), attr)
Christian Heimesf31b69f2008-01-14 03:42:48 +0000412 self.assertEqual(type(getattr(sys.flags, attr)), int, attr)
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000413 self.assertTrue(repr(sys.flags))
Christian Heimesf31b69f2008-01-14 03:42:48 +0000414
Christian Heimes422051a2008-02-04 18:00:12 +0000415 def test_clear_type_cache(self):
416 sys._clear_type_cache()
417
Martin v. Löwis99815892008-06-01 07:20:46 +0000418 def test_ioencoding(self):
Georg Brandla4f46e12010-02-07 17:03:15 +0000419 import subprocess
Martin v. Löwis99815892008-06-01 07:20:46 +0000420 env = dict(os.environ)
421
422 # Test character: cent sign, encoded as 0x4A (ASCII J) in CP424,
423 # not representable in ASCII.
424
425 env["PYTHONIOENCODING"] = "cp424"
426 p = subprocess.Popen([sys.executable, "-c", 'print unichr(0xa2)'],
427 stdout = subprocess.PIPE, env=env)
Antoine Pitroue171edc2009-10-27 19:23:56 +0000428 out = p.communicate()[0].strip()
Martin v. Löwis99815892008-06-01 07:20:46 +0000429 self.assertEqual(out, unichr(0xa2).encode("cp424"))
430
431 env["PYTHONIOENCODING"] = "ascii:replace"
432 p = subprocess.Popen([sys.executable, "-c", 'print unichr(0xa2)'],
433 stdout = subprocess.PIPE, env=env)
Antoine Pitroue171edc2009-10-27 19:23:56 +0000434 out = p.communicate()[0].strip()
Martin v. Löwis99815892008-06-01 07:20:46 +0000435 self.assertEqual(out, '?')
436
Victor Stinnerb4b0a292010-01-31 22:32:15 +0000437 def test_call_tracing(self):
438 self.assertEqual(sys.call_tracing(str, (2,)), "2")
439 self.assertRaises(TypeError, sys.call_tracing, str, 2)
440
Victor Stinner4a7e0c852010-03-11 12:34:39 +0000441 def test_executable(self):
442 # Issue #7774: Ensure that sys.executable is an empty string if argv[0]
443 # has been set to an non existent program name and Python is unable to
444 # retrieve the real program name
445 import subprocess
Victor Stinner44786622010-03-11 13:46:06 +0000446 # For a normal installation, it should work without 'cwd'
447 # argument. For test runs in the build directory, see #7774.
448 python_dir = os.path.dirname(os.path.realpath(sys.executable))
Victor Stinner4a7e0c852010-03-11 12:34:39 +0000449 p = subprocess.Popen(
Victor Stinner6ecd85f2010-03-11 13:27:35 +0000450 ["nonexistent", "-c", 'import sys; print repr(sys.executable)'],
Victor Stinner44786622010-03-11 13:46:06 +0000451 executable=sys.executable, stdout=subprocess.PIPE, cwd=python_dir)
Victor Stinner4a7e0c852010-03-11 12:34:39 +0000452 executable = p.communicate()[0].strip()
453 p.wait()
Victor Stinner6ecd85f2010-03-11 13:27:35 +0000454 self.assertIn(executable, ["''", repr(sys.executable)])
Martin v. Löwis99815892008-06-01 07:20:46 +0000455
Robert Schuppenies51df0642008-06-01 16:16:17 +0000456class SizeofTest(unittest.TestCase):
457
Robert Schuppenies47629022008-07-10 17:13:55 +0000458 TPFLAGS_HAVE_GC = 1<<14
459 TPFLAGS_HEAPTYPE = 1L<<9
460
Robert Schuppenies51df0642008-06-01 16:16:17 +0000461 def setUp(self):
Robert Schuppenies41a7ce02008-06-25 09:20:03 +0000462 self.c = len(struct.pack('c', ' '))
463 self.H = len(struct.pack('H', 0))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000464 self.i = len(struct.pack('i', 0))
465 self.l = len(struct.pack('l', 0))
Robert Schuppenies41a7ce02008-06-25 09:20:03 +0000466 self.P = len(struct.pack('P', 0))
467 # due to missing size_t information from struct, it is assumed that
468 # sizeof(Py_ssize_t) = sizeof(void*)
Robert Schuppenies161b9212008-06-26 15:20:35 +0000469 self.header = 'PP'
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000470 self.vheader = self.header + 'P'
Robert Schuppenies51df0642008-06-01 16:16:17 +0000471 if hasattr(sys, "gettotalrefcount"):
Robert Schuppenies41a7ce02008-06-25 09:20:03 +0000472 self.header += '2P'
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000473 self.vheader += '2P'
Mark Dickinsonefc82f72009-03-20 15:51:55 +0000474 self.longdigit = sys.long_info.sizeof_digit
Robert Schuppenies47629022008-07-10 17:13:55 +0000475 import _testcapi
476 self.gc_headsize = _testcapi.SIZEOF_PYGC_HEAD
Robert Schuppenies51df0642008-06-01 16:16:17 +0000477 self.file = open(test.test_support.TESTFN, 'wb')
478
479 def tearDown(self):
480 self.file.close()
Georg Brandl7a6de8b2008-06-01 16:42:16 +0000481 test.test_support.unlink(test.test_support.TESTFN)
Robert Schuppenies51df0642008-06-01 16:16:17 +0000482
Robert Schuppenies9be2ec12008-07-10 15:24:04 +0000483 def check_sizeof(self, o, size):
Robert Schuppenies51df0642008-06-01 16:16:17 +0000484 result = sys.getsizeof(o)
Robert Schuppenies47629022008-07-10 17:13:55 +0000485 if ((type(o) == type) and (o.__flags__ & self.TPFLAGS_HEAPTYPE) or\
486 ((type(o) != type) and (type(o).__flags__ & self.TPFLAGS_HAVE_GC))):
487 size += self.gc_headsize
Robert Schuppenies9be2ec12008-07-10 15:24:04 +0000488 msg = 'wrong size for %s: got %d, expected %d' \
489 % (type(o), result, size)
490 self.assertEqual(result, size, msg)
Robert Schuppenies51df0642008-06-01 16:16:17 +0000491
Robert Schuppenies41a7ce02008-06-25 09:20:03 +0000492 def calcsize(self, fmt):
493 """Wrapper around struct.calcsize which enforces the alignment of the
494 end of a structure to the alignment requirement of pointer.
Robert Schuppenies51df0642008-06-01 16:16:17 +0000495
Robert Schuppenies41a7ce02008-06-25 09:20:03 +0000496 Note: This wrapper should only be used if a pointer member is included
497 and no member with a size larger than a pointer exists.
498 """
499 return struct.calcsize(fmt + '0P')
Robert Schuppenies51df0642008-06-01 16:16:17 +0000500
Robert Schuppenies47629022008-07-10 17:13:55 +0000501 def test_gc_head_size(self):
502 # Check that the gc header size is added to objects tracked by the gc.
503 h = self.header
504 size = self.calcsize
505 gc_header_size = self.gc_headsize
506 # bool objects are not gc tracked
507 self.assertEqual(sys.getsizeof(True), size(h + 'l'))
508 # but lists are
509 self.assertEqual(sys.getsizeof([]), size(h + 'P PP') + gc_header_size)
510
511 def test_default(self):
512 h = self.header
513 size = self.calcsize
514 self.assertEqual(sys.getsizeof(True, -1), size(h + 'l'))
515
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000516 def test_objecttypes(self):
517 # check all types defined in Objects/
Robert Schuppenies41a7ce02008-06-25 09:20:03 +0000518 h = self.header
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000519 vh = self.vheader
Robert Schuppenies41a7ce02008-06-25 09:20:03 +0000520 size = self.calcsize
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000521 check = self.check_sizeof
Robert Schuppenies51df0642008-06-01 16:16:17 +0000522 # bool
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000523 check(True, size(h + 'l'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000524 # buffer
Ezio Melottid80b4bf2010-03-17 13:52:48 +0000525 with test.test_support.check_py3k_warnings():
526 check(buffer(''), size(h + '2P2Pil'))
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000527 # builtin_function_or_method
528 check(len, size(h + '3P'))
Robert Schuppenies9be2ec12008-07-10 15:24:04 +0000529 # bytearray
530 samples = ['', 'u'*100000]
531 for sample in samples:
532 x = bytearray(sample)
533 check(x, size(vh + 'iPP') + x.__alloc__() * self.c)
534 # bytearray_iterator
535 check(iter(bytearray()), size(h + 'PP'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000536 # cell
537 def get_cell():
538 x = 42
539 def inner():
540 return x
541 return inner
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000542 check(get_cell().func_closure[0], size(h + 'P'))
543 # classobj (old-style class)
Robert Schuppenies51df0642008-06-01 16:16:17 +0000544 class class_oldstyle():
545 def method():
546 pass
Antoine Pitroua57df2c2010-03-31 21:32:15 +0000547 check(class_oldstyle, size(h + '7P'))
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000548 # instance (old-style class)
549 check(class_oldstyle(), size(h + '3P'))
550 # instancemethod (old-style class)
551 check(class_oldstyle().method, size(h + '4P'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000552 # complex
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000553 check(complex(0,1), size(h + '2d'))
554 # code
Collin Winter001a3952010-03-18 21:54:01 +0000555 check(get_cell().func_code, size(h + '4i8Pi3P'))
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000556 # BaseException
557 check(BaseException(), size(h + '3P'))
558 # UnicodeEncodeError
559 check(UnicodeEncodeError("", u"", 0, 0, ""), size(h + '5P2PP'))
560 # UnicodeDecodeError
561 check(UnicodeDecodeError("", "", 0, 0, ""), size(h + '5P2PP'))
562 # UnicodeTranslateError
563 check(UnicodeTranslateError(u"", 0, 1, ""), size(h + '5P2PP'))
564 # method_descriptor (descriptor object)
565 check(str.lower, size(h + '2PP'))
566 # classmethod_descriptor (descriptor object)
567 # XXX
568 # member_descriptor (descriptor object)
569 import datetime
570 check(datetime.timedelta.days, size(h + '2PP'))
571 # getset_descriptor (descriptor object)
572 import __builtin__
573 check(__builtin__.file.closed, size(h + '2PP'))
574 # wrapper_descriptor (descriptor object)
575 check(int.__add__, size(h + '2P2P'))
576 # dictproxy
577 class C(object): pass
578 check(C.__dict__, size(h + 'P'))
579 # method-wrapper (descriptor object)
580 check({}.__iter__, size(h + '2P'))
581 # dict
Robert Schuppenies2ee623b2008-07-14 08:42:18 +0000582 check({}, size(h + '3P2P' + 8*'P2P'))
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000583 x = {1:1, 2:2, 3:3, 4:4, 5:5, 6:6, 7:7, 8:8}
Robert Schuppenies2ee623b2008-07-14 08:42:18 +0000584 check(x, size(h + '3P2P' + 8*'P2P') + 16*size('P2P'))
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000585 # dictionary-keyiterator
586 check({}.iterkeys(), size(h + 'P2PPP'))
587 # dictionary-valueiterator
588 check({}.itervalues(), size(h + 'P2PPP'))
589 # dictionary-itemiterator
590 check({}.iteritems(), size(h + 'P2PPP'))
591 # ellipses
592 check(Ellipsis, size(h + ''))
593 # EncodingMap
594 import codecs, encodings.iso8859_3
595 x = codecs.charmap_build(encodings.iso8859_3.decoding_table)
596 check(x, size(h + '32B2iB'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000597 # enumerate
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000598 check(enumerate([]), size(h + 'l3P'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000599 # file
Antoine Pitroubb445a12010-02-05 17:05:54 +0000600 check(self.file, size(h + '4P2i4P3i3P3i'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000601 # float
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000602 check(float(0), size(h + 'd'))
603 # sys.floatinfo
604 check(sys.float_info, size(vh) + self.P * len(sys.float_info))
Robert Schuppenies9be2ec12008-07-10 15:24:04 +0000605 # frame
606 import inspect
607 CO_MAXBLOCKS = 20
608 x = inspect.currentframe()
609 ncells = len(x.f_code.co_cellvars)
610 nfrees = len(x.f_code.co_freevars)
611 extras = x.f_code.co_stacksize + x.f_code.co_nlocals +\
612 ncells + nfrees - 1
Robert Schuppenies2ee623b2008-07-14 08:42:18 +0000613 check(x, size(vh + '12P3i' + CO_MAXBLOCKS*'3i' + 'P' + extras*'P'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000614 # function
615 def func(): pass
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000616 check(func, size(h + '9P'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000617 class c():
618 @staticmethod
619 def foo():
620 pass
621 @classmethod
622 def bar(cls):
623 pass
624 # staticmethod
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000625 check(foo, size(h + 'P'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000626 # classmethod
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000627 check(bar, size(h + 'P'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000628 # generator
629 def get_gen(): yield 1
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000630 check(get_gen(), size(h + 'Pi2P'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000631 # integer
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000632 check(1, size(h + 'l'))
633 check(100, size(h + 'l'))
634 # iterator
635 check(iter('abc'), size(h + 'lP'))
636 # callable-iterator
637 import re
638 check(re.finditer('',''), size(h + '2P'))
639 # list
640 samples = [[], [1,2,3], ['1', '2', '3']]
641 for sample in samples:
642 check(sample, size(vh + 'PP') + len(sample)*self.P)
643 # sortwrapper (list)
644 # XXX
645 # cmpwrapper (list)
646 # XXX
647 # listiterator (list)
648 check(iter([]), size(h + 'lP'))
649 # listreverseiterator (list)
650 check(reversed([]), size(h + 'lP'))
651 # long
Mark Dickinson2ffb26f2009-02-15 10:13:41 +0000652 check(0L, size(vh))
Mark Dickinsonefc82f72009-03-20 15:51:55 +0000653 check(1L, size(vh) + self.longdigit)
654 check(-1L, size(vh) + self.longdigit)
655 PyLong_BASE = 2**sys.long_info.bits_per_digit
Mark Dickinson48e3fd22009-04-02 18:39:37 +0000656 check(long(PyLong_BASE), size(vh) + 2*self.longdigit)
657 check(long(PyLong_BASE**2-1), size(vh) + 2*self.longdigit)
658 check(long(PyLong_BASE**2), size(vh) + 3*self.longdigit)
Robert Schuppenies51df0642008-06-01 16:16:17 +0000659 # module
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000660 check(unittest, size(h + 'P'))
661 # None
662 check(None, size(h + ''))
663 # object
664 check(object(), size(h + ''))
665 # property (descriptor object)
666 class C(object):
667 def getx(self): return self.__x
668 def setx(self, value): self.__x = value
669 def delx(self): del self.__x
670 x = property(getx, setx, delx, "")
671 check(x, size(h + '4Pi'))
672 # PyCObject
Larry Hastings402b73f2010-03-25 00:54:54 +0000673 # PyCapsule
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000674 # XXX
675 # rangeiterator
676 check(iter(xrange(1)), size(h + '4l'))
677 # reverse
678 check(reversed(''), size(h + 'PP'))
Robert Schuppenies9be2ec12008-07-10 15:24:04 +0000679 # set
680 # frozenset
681 PySet_MINSIZE = 8
682 samples = [[], range(10), range(50)]
Robert Schuppenies2ee623b2008-07-14 08:42:18 +0000683 s = size(h + '3P2P' + PySet_MINSIZE*'lP' + 'lP')
Robert Schuppenies9be2ec12008-07-10 15:24:04 +0000684 for sample in samples:
685 minused = len(sample)
686 if minused == 0: tmp = 1
687 # the computation of minused is actually a bit more complicated
688 # but this suffices for the sizeof test
689 minused = minused*2
690 newsize = PySet_MINSIZE
691 while newsize <= minused:
692 newsize = newsize << 1
693 if newsize <= 8:
694 check(set(sample), s)
695 check(frozenset(sample), s)
696 else:
697 check(set(sample), s + newsize*struct.calcsize('lP'))
698 check(frozenset(sample), s + newsize*struct.calcsize('lP'))
699 # setiterator
700 check(iter(set()), size(h + 'P3P'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000701 # slice
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000702 check(slice(1), size(h + '3P'))
703 # str
Mark Dickinson826f3fe2008-12-05 21:55:28 +0000704 check('', struct.calcsize(vh + 'li') + 1)
705 check('abc', struct.calcsize(vh + 'li') + 1 + 3*self.c)
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000706 # super
707 check(super(int), size(h + '3P'))
708 # tuple
709 check((), size(vh))
710 check((1,2,3), size(vh) + 3*self.P)
711 # tupleiterator
712 check(iter(()), size(h + 'lP'))
713 # type
714 # (PyTypeObject + PyNumberMethods + PyMappingMethods +
715 # PySequenceMethods + PyBufferProcs)
Robert Schuppenies2ee623b2008-07-14 08:42:18 +0000716 s = size(vh + 'P2P15Pl4PP9PP11PI') + size('41P 10P 3P 6P')
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000717 class newstyleclass(object):
718 pass
719 check(newstyleclass, s)
720 # builtin type
721 check(int, s)
722 # NotImplementedType
723 import types
724 check(types.NotImplementedType, s)
Robert Schuppenies901c9972008-06-10 10:10:31 +0000725 # unicode
Robert Schuppenies59f3ade2008-06-17 08:42:15 +0000726 usize = len(u'\0'.encode('unicode-internal'))
Robert Schuppenies901c9972008-06-10 10:10:31 +0000727 samples = [u'', u'1'*100]
728 # we need to test for both sizes, because we don't know if the string
729 # has been cached
730 for s in samples:
Robert Schuppenies9be2ec12008-07-10 15:24:04 +0000731 check(s, size(h + 'PPlP') + usize * (len(s) + 1))
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000732 # weakref
733 import weakref
734 check(weakref.ref(int), size(h + '2Pl2P'))
735 # weakproxy
736 # XXX
737 # weakcallableproxy
738 check(weakref.proxy(int), size(h + '2Pl2P'))
739 # xrange
740 check(xrange(1), size(h + '3l'))
741 check(xrange(66000), size(h + '3l'))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000742
Robert Schuppeniesd2cd86d2008-07-10 13:43:26 +0000743 def test_pythontypes(self):
744 # check all types defined in Python/
745 h = self.header
746 vh = self.vheader
747 size = self.calcsize
748 check = self.check_sizeof
749 # _ast.AST
750 import _ast
751 check(_ast.AST(), size(h + ''))
752 # imp.NullImporter
753 import imp
754 check(imp.NullImporter(self.file.name), size(h + ''))
755 try:
756 raise TypeError
757 except TypeError:
758 tb = sys.exc_info()[2]
759 # traceback
760 if tb != None:
761 check(tb, size(h + '2P2i'))
762 # symtable entry
763 # XXX
764 # sys.flags
765 check(sys.flags, size(vh) + self.P * len(sys.flags))
Robert Schuppenies51df0642008-06-01 16:16:17 +0000766
767
Walter Dörwaldc3502462003-02-03 23:03:49 +0000768def test_main():
Robert Schuppenies51df0642008-06-01 16:16:17 +0000769 test_classes = (SysModuleTest, SizeofTest)
770
771 test.test_support.run_unittest(*test_classes)
Walter Dörwaldc3502462003-02-03 23:03:49 +0000772
773if __name__ == "__main__":
774 test_main()