blob: 78c51b3cb61e86dac4cee110797df3aeb23dfa0b [file] [log] [blame]
Tim Petersd66595f2001-02-04 03:09:53 +00001# Run the _testcapi module tests (tests for the Python/C API): by defn,
Guido van Rossum361c5352001-04-13 17:03:04 +00002# these are all functions _testcapi exports whose name begins with 'test_'.
Tim Peters9ea17ac2001-02-02 05:57:15 +00003
Nick Coghlan39f0bb52017-11-28 08:11:51 +10004from collections import OrderedDict
Antoine Pitrou8e605772011-04-25 21:21:07 +02005import os
Antoine Pitrou2f828f22012-01-18 00:21:11 +01006import pickle
Jeffrey Yasskin8e0bdfd2010-05-13 18:31:05 +00007import random
Victor Stinnerb3adb1a2016-03-14 17:40:09 +01008import re
Jeffrey Yasskin8e0bdfd2010-05-13 18:31:05 +00009import subprocess
Martin v. Löwis6ce7ed22005-03-03 12:26:35 +000010import sys
Victor Stinnerefde1462015-03-21 15:04:43 +010011import textwrap
Antoine Pitroua6a4dc82017-09-07 18:56:24 +020012import threading
Benjamin Petersona54c9092009-01-13 02:11:23 +000013import time
Benjamin Peterson9b6df6a2008-10-16 23:56:29 +000014import unittest
Benjamin Petersonee8712c2008-05-20 21:35:26 +000015from test import support
Larry Hastingsfcafe432013-11-23 17:35:48 -080016from test.support import MISSING_C_DOCSTRINGS
xdegaye85f64302017-07-01 14:14:45 +020017from test.support.script_helper import assert_python_failure, assert_python_ok
Victor Stinner45df8202010-04-28 22:31:17 +000018try:
Stefan Krahfd24f9e2012-08-20 11:04:24 +020019 import _posixsubprocess
20except ImportError:
21 _posixsubprocess = None
Antoine Pitroua6a4dc82017-09-07 18:56:24 +020022
Serhiy Storchaka5cfc79d2014-02-07 10:06:39 +020023# Skip this test if the _testcapi module isn't available.
24_testcapi = support.import_module('_testcapi')
Tim Peters9ea17ac2001-02-02 05:57:15 +000025
Victor Stinnerefde1462015-03-21 15:04:43 +010026# Were we compiled --with-pydebug or with #define Py_DEBUG?
27Py_DEBUG = hasattr(sys, 'gettotalrefcount')
28
Benjamin Petersona54c9092009-01-13 02:11:23 +000029
Benjamin Peterson9b6df6a2008-10-16 23:56:29 +000030def testfunction(self):
31 """some doc"""
32 return self
33
Jeroen Demeyeraacc77f2019-05-29 20:31:52 +020034
Benjamin Peterson9b6df6a2008-10-16 23:56:29 +000035class InstanceMethod:
36 id = _testcapi.instancemethod(id)
37 testfunction = _testcapi.instancemethod(testfunction)
38
39class CAPITest(unittest.TestCase):
40
41 def test_instancemethod(self):
42 inst = InstanceMethod()
43 self.assertEqual(id(inst), inst.id())
Benjamin Petersonc9c0f202009-06-30 23:06:06 +000044 self.assertTrue(inst.testfunction() is inst)
Benjamin Peterson9b6df6a2008-10-16 23:56:29 +000045 self.assertEqual(inst.testfunction.__doc__, testfunction.__doc__)
46 self.assertEqual(InstanceMethod.testfunction.__doc__, testfunction.__doc__)
47
48 InstanceMethod.testfunction.attribute = "test"
49 self.assertEqual(testfunction.attribute, "test")
50 self.assertRaises(AttributeError, setattr, inst.testfunction, "attribute", "test")
51
Jeffrey Yasskin8e0bdfd2010-05-13 18:31:05 +000052 def test_no_FatalError_infinite_loop(self):
Antoine Pitrou77e904e2013-10-08 23:04:32 +020053 with support.SuppressCrashReport():
Ezio Melotti25a40452013-03-05 20:26:17 +020054 p = subprocess.Popen([sys.executable, "-c",
Ezio Melottie1857d92013-03-05 20:31:34 +020055 'import _testcapi;'
56 '_testcapi.crash_no_current_thread()'],
57 stdout=subprocess.PIPE,
58 stderr=subprocess.PIPE)
Jeffrey Yasskin8e0bdfd2010-05-13 18:31:05 +000059 (out, err) = p.communicate()
60 self.assertEqual(out, b'')
61 # This used to cause an infinite loop.
Vinay Sajip73954042012-05-06 11:34:50 +010062 self.assertTrue(err.rstrip().startswith(
Jeffrey Yasskin8e0bdfd2010-05-13 18:31:05 +000063 b'Fatal Python error:'
Vinay Sajip73954042012-05-06 11:34:50 +010064 b' PyThreadState_Get: no current thread'))
Jeffrey Yasskin8e0bdfd2010-05-13 18:31:05 +000065
Antoine Pitrou915605c2011-02-24 20:53:48 +000066 def test_memoryview_from_NULL_pointer(self):
67 self.assertRaises(ValueError, _testcapi.make_memoryview_from_NULL_pointer)
Benjamin Peterson9b6df6a2008-10-16 23:56:29 +000068
Martin v. Löwisaa2efcb2012-04-19 14:33:43 +020069 def test_exc_info(self):
70 raised_exception = ValueError("5")
71 new_exc = TypeError("TEST")
72 try:
73 raise raised_exception
74 except ValueError as e:
75 tb = e.__traceback__
76 orig_sys_exc_info = sys.exc_info()
77 orig_exc_info = _testcapi.set_exc_info(new_exc.__class__, new_exc, None)
78 new_sys_exc_info = sys.exc_info()
79 new_exc_info = _testcapi.set_exc_info(*orig_exc_info)
80 reset_sys_exc_info = sys.exc_info()
81
82 self.assertEqual(orig_exc_info[1], e)
83
84 self.assertSequenceEqual(orig_exc_info, (raised_exception.__class__, raised_exception, tb))
85 self.assertSequenceEqual(orig_sys_exc_info, orig_exc_info)
86 self.assertSequenceEqual(reset_sys_exc_info, orig_exc_info)
87 self.assertSequenceEqual(new_exc_info, (new_exc.__class__, new_exc, None))
88 self.assertSequenceEqual(new_sys_exc_info, new_exc_info)
89 else:
90 self.assertTrue(False)
91
Stefan Krahfd24f9e2012-08-20 11:04:24 +020092 @unittest.skipUnless(_posixsubprocess, '_posixsubprocess required for this test.')
93 def test_seq_bytes_to_charp_array(self):
94 # Issue #15732: crash in _PySequence_BytesToCharpArray()
95 class Z(object):
96 def __len__(self):
97 return 1
98 self.assertRaises(TypeError, _posixsubprocess.fork_exec,
Serhiy Storchaka66bffd12017-04-19 21:12:46 +030099 1,Z(),3,(1, 2),5,6,7,8,9,10,11,12,13,14,15,16,17)
Stefan Krah7cacd2e2012-08-21 08:16:09 +0200100 # Issue #15736: overflow in _PySequence_BytesToCharpArray()
101 class Z(object):
102 def __len__(self):
103 return sys.maxsize
104 def __getitem__(self, i):
105 return b'x'
106 self.assertRaises(MemoryError, _posixsubprocess.fork_exec,
Serhiy Storchaka66bffd12017-04-19 21:12:46 +0300107 1,Z(),3,(1, 2),5,6,7,8,9,10,11,12,13,14,15,16,17)
Stefan Krahfd24f9e2012-08-20 11:04:24 +0200108
Stefan Krahdb579d72012-08-20 14:36:47 +0200109 @unittest.skipUnless(_posixsubprocess, '_posixsubprocess required for this test.')
110 def test_subprocess_fork_exec(self):
111 class Z(object):
112 def __len__(self):
113 return 1
114
115 # Issue #15738: crash in subprocess_fork_exec()
116 self.assertRaises(TypeError, _posixsubprocess.fork_exec,
Serhiy Storchaka66bffd12017-04-19 21:12:46 +0300117 Z(),[b'1'],3,(1, 2),5,6,7,8,9,10,11,12,13,14,15,16,17)
Stefan Krahdb579d72012-08-20 14:36:47 +0200118
Larry Hastingsfcafe432013-11-23 17:35:48 -0800119 @unittest.skipIf(MISSING_C_DOCSTRINGS,
120 "Signature information for builtins requires docstrings")
Larry Hastings44e2eaa2013-11-23 15:37:55 -0800121 def test_docstring_signature_parsing(self):
122
123 self.assertEqual(_testcapi.no_docstring.__doc__, None)
124 self.assertEqual(_testcapi.no_docstring.__text_signature__, None)
125
Zachary Ware8ef887c2015-04-13 18:22:35 -0500126 self.assertEqual(_testcapi.docstring_empty.__doc__, None)
Larry Hastings44e2eaa2013-11-23 15:37:55 -0800127 self.assertEqual(_testcapi.docstring_empty.__text_signature__, None)
128
129 self.assertEqual(_testcapi.docstring_no_signature.__doc__,
130 "This docstring has no signature.")
131 self.assertEqual(_testcapi.docstring_no_signature.__text_signature__, None)
132
133 self.assertEqual(_testcapi.docstring_with_invalid_signature.__doc__,
Larry Hastings2623c8c2014-02-08 22:15:29 -0800134 "docstring_with_invalid_signature($module, /, boo)\n"
Larry Hastings44e2eaa2013-11-23 15:37:55 -0800135 "\n"
136 "This docstring has an invalid signature."
137 )
138 self.assertEqual(_testcapi.docstring_with_invalid_signature.__text_signature__, None)
139
Larry Hastings2623c8c2014-02-08 22:15:29 -0800140 self.assertEqual(_testcapi.docstring_with_invalid_signature2.__doc__,
141 "docstring_with_invalid_signature2($module, /, boo)\n"
142 "\n"
143 "--\n"
144 "\n"
145 "This docstring also has an invalid signature."
146 )
147 self.assertEqual(_testcapi.docstring_with_invalid_signature2.__text_signature__, None)
148
Larry Hastings44e2eaa2013-11-23 15:37:55 -0800149 self.assertEqual(_testcapi.docstring_with_signature.__doc__,
150 "This docstring has a valid signature.")
Larry Hastings2623c8c2014-02-08 22:15:29 -0800151 self.assertEqual(_testcapi.docstring_with_signature.__text_signature__, "($module, /, sig)")
Larry Hastings44e2eaa2013-11-23 15:37:55 -0800152
Zachary Ware8ef887c2015-04-13 18:22:35 -0500153 self.assertEqual(_testcapi.docstring_with_signature_but_no_doc.__doc__, None)
154 self.assertEqual(_testcapi.docstring_with_signature_but_no_doc.__text_signature__,
155 "($module, /, sig)")
156
Larry Hastings44e2eaa2013-11-23 15:37:55 -0800157 self.assertEqual(_testcapi.docstring_with_signature_and_extra_newlines.__doc__,
Larry Hastings2623c8c2014-02-08 22:15:29 -0800158 "\nThis docstring has a valid signature and some extra newlines.")
Larry Hastings44e2eaa2013-11-23 15:37:55 -0800159 self.assertEqual(_testcapi.docstring_with_signature_and_extra_newlines.__text_signature__,
Larry Hastings2623c8c2014-02-08 22:15:29 -0800160 "($module, /, parameter)")
Larry Hastings44e2eaa2013-11-23 15:37:55 -0800161
Benjamin Petersond51374e2014-04-09 23:55:56 -0400162 def test_c_type_with_matrix_multiplication(self):
163 M = _testcapi.matmulType
164 m1 = M()
165 m2 = M()
166 self.assertEqual(m1 @ m2, ("matmul", m1, m2))
167 self.assertEqual(m1 @ 42, ("matmul", m1, 42))
168 self.assertEqual(42 @ m1, ("matmul", 42, m1))
169 o = m1
170 o @= m2
171 self.assertEqual(o, ("imatmul", m1, m2))
172 o = m1
173 o @= 42
174 self.assertEqual(o, ("imatmul", m1, 42))
175 o = 42
176 o @= m1
177 self.assertEqual(o, ("matmul", 42, m1))
178
Zackery Spytzc7f803b2019-05-31 03:46:36 -0600179 def test_c_type_with_ipow(self):
180 # When the __ipow__ method of a type was implemented in C, using the
181 # modulo param would cause segfaults.
182 o = _testcapi.ipowType()
183 self.assertEqual(o.__ipow__(1), (1, None))
184 self.assertEqual(o.__ipow__(2, 2), (2, 2))
185
Victor Stinnerefde1462015-03-21 15:04:43 +0100186 def test_return_null_without_error(self):
187 # Issue #23571: A function must not return NULL without setting an
188 # error
189 if Py_DEBUG:
190 code = textwrap.dedent("""
191 import _testcapi
192 from test import support
193
194 with support.SuppressCrashReport():
195 _testcapi.return_null_without_error()
196 """)
197 rc, out, err = assert_python_failure('-c', code)
Victor Stinner381a9bc2015-03-24 14:01:32 +0100198 self.assertRegex(err.replace(b'\r', b''),
Victor Stinner944fbcc2015-03-24 16:28:52 +0100199 br'Fatal Python error: a function returned NULL '
200 br'without setting an error\n'
Victor Stinner47bbab92019-09-18 14:10:16 +0200201 br'Python runtime state: initialized\n'
Victor Stinner381a9bc2015-03-24 14:01:32 +0100202 br'SystemError: <built-in function '
203 br'return_null_without_error> returned NULL '
204 br'without setting an error\n'
205 br'\n'
206 br'Current thread.*:\n'
207 br' File .*", line 6 in <module>')
Victor Stinnerefde1462015-03-21 15:04:43 +0100208 else:
209 with self.assertRaises(SystemError) as cm:
210 _testcapi.return_null_without_error()
211 self.assertRegex(str(cm.exception),
212 'return_null_without_error.* '
213 'returned NULL without setting an error')
214
215 def test_return_result_with_error(self):
216 # Issue #23571: A function must not return a result with an error set
217 if Py_DEBUG:
218 code = textwrap.dedent("""
219 import _testcapi
220 from test import support
221
222 with support.SuppressCrashReport():
223 _testcapi.return_result_with_error()
224 """)
225 rc, out, err = assert_python_failure('-c', code)
Victor Stinner381a9bc2015-03-24 14:01:32 +0100226 self.assertRegex(err.replace(b'\r', b''),
Victor Stinner944fbcc2015-03-24 16:28:52 +0100227 br'Fatal Python error: a function returned a '
228 br'result with an error set\n'
Victor Stinner47bbab92019-09-18 14:10:16 +0200229 br'Python runtime state: initialized\n'
Victor Stinner381a9bc2015-03-24 14:01:32 +0100230 br'ValueError\n'
231 br'\n'
Serhiy Storchaka467ab192016-10-21 17:09:17 +0300232 br'The above exception was the direct cause '
233 br'of the following exception:\n'
Victor Stinner381a9bc2015-03-24 14:01:32 +0100234 br'\n'
235 br'SystemError: <built-in '
236 br'function return_result_with_error> '
237 br'returned a result with an error set\n'
238 br'\n'
239 br'Current thread.*:\n'
240 br' File .*, line 6 in <module>')
Victor Stinnerefde1462015-03-21 15:04:43 +0100241 else:
242 with self.assertRaises(SystemError) as cm:
243 _testcapi.return_result_with_error()
244 self.assertRegex(str(cm.exception),
245 'return_result_with_error.* '
246 'returned a result with an error set')
247
Serhiy Storchaka13e602e2016-05-20 22:31:14 +0300248 def test_buildvalue_N(self):
249 _testcapi.test_buildvalue_N()
250
xdegaye85f64302017-07-01 14:14:45 +0200251 def test_set_nomemory(self):
252 code = """if 1:
253 import _testcapi
254
255 class C(): pass
256
257 # The first loop tests both functions and that remove_mem_hooks()
258 # can be called twice in a row. The second loop checks a call to
259 # set_nomemory() after a call to remove_mem_hooks(). The third
260 # loop checks the start and stop arguments of set_nomemory().
261 for outer_cnt in range(1, 4):
262 start = 10 * outer_cnt
263 for j in range(100):
264 if j == 0:
265 if outer_cnt != 3:
266 _testcapi.set_nomemory(start)
267 else:
268 _testcapi.set_nomemory(start, start + 1)
269 try:
270 C()
271 except MemoryError as e:
272 if outer_cnt != 3:
273 _testcapi.remove_mem_hooks()
274 print('MemoryError', outer_cnt, j)
275 _testcapi.remove_mem_hooks()
276 break
277 """
278 rc, out, err = assert_python_ok('-c', code)
279 self.assertIn(b'MemoryError 1 10', out)
280 self.assertIn(b'MemoryError 2 20', out)
281 self.assertIn(b'MemoryError 3 30', out)
282
Oren Milman0ccc0f62017-10-08 11:17:46 +0300283 def test_mapping_keys_values_items(self):
284 class Mapping1(dict):
285 def keys(self):
286 return list(super().keys())
287 def values(self):
288 return list(super().values())
289 def items(self):
290 return list(super().items())
291 class Mapping2(dict):
292 def keys(self):
293 return tuple(super().keys())
294 def values(self):
295 return tuple(super().values())
296 def items(self):
297 return tuple(super().items())
298 dict_obj = {'foo': 1, 'bar': 2, 'spam': 3}
299
300 for mapping in [{}, OrderedDict(), Mapping1(), Mapping2(),
301 dict_obj, OrderedDict(dict_obj),
302 Mapping1(dict_obj), Mapping2(dict_obj)]:
303 self.assertListEqual(_testcapi.get_mapping_keys(mapping),
304 list(mapping.keys()))
305 self.assertListEqual(_testcapi.get_mapping_values(mapping),
306 list(mapping.values()))
307 self.assertListEqual(_testcapi.get_mapping_items(mapping),
308 list(mapping.items()))
309
310 def test_mapping_keys_values_items_bad_arg(self):
311 self.assertRaises(AttributeError, _testcapi.get_mapping_keys, None)
312 self.assertRaises(AttributeError, _testcapi.get_mapping_values, None)
313 self.assertRaises(AttributeError, _testcapi.get_mapping_items, None)
314
315 class BadMapping:
316 def keys(self):
317 return None
318 def values(self):
319 return None
320 def items(self):
321 return None
322 bad_mapping = BadMapping()
323 self.assertRaises(TypeError, _testcapi.get_mapping_keys, bad_mapping)
324 self.assertRaises(TypeError, _testcapi.get_mapping_values, bad_mapping)
325 self.assertRaises(TypeError, _testcapi.get_mapping_items, bad_mapping)
326
Victor Stinner18618e652018-10-25 17:28:11 +0200327 @unittest.skipUnless(hasattr(_testcapi, 'negative_refcount'),
328 'need _testcapi.negative_refcount')
329 def test_negative_refcount(self):
330 # bpo-35059: Check that Py_DECREF() reports the correct filename
331 # when calling _Py_NegativeRefcount() to abort Python.
332 code = textwrap.dedent("""
333 import _testcapi
334 from test import support
335
336 with support.SuppressCrashReport():
337 _testcapi.negative_refcount()
338 """)
339 rc, out, err = assert_python_failure('-c', code)
340 self.assertRegex(err,
Victor Stinner3ec9af72018-10-26 02:12:34 +0200341 br'_testcapimodule\.c:[0-9]+: '
Victor Stinnerf1d002c2018-11-21 23:53:44 +0100342 br'_Py_NegativeRefcount: Assertion failed: '
Victor Stinner3ec9af72018-10-26 02:12:34 +0200343 br'object has negative ref count')
Victor Stinner18618e652018-10-25 17:28:11 +0200344
Jeroen Demeyer351c6742019-05-10 19:21:11 +0200345 def test_trashcan_subclass(self):
346 # bpo-35983: Check that the trashcan mechanism for "list" is NOT
347 # activated when its tp_dealloc is being called by a subclass
348 from _testcapi import MyList
349 L = None
350 for i in range(1000):
351 L = MyList((L,))
352
353 def test_trashcan_python_class1(self):
354 self.do_test_trashcan_python_class(list)
355
356 def test_trashcan_python_class2(self):
357 from _testcapi import MyList
358 self.do_test_trashcan_python_class(MyList)
359
360 def do_test_trashcan_python_class(self, base):
361 # Check that the trashcan mechanism works properly for a Python
362 # subclass of a class using the trashcan (this specific test assumes
363 # that the base class "base" behaves like list)
364 class PyList(base):
365 # Count the number of PyList instances to verify that there is
366 # no memory leak
367 num = 0
368 def __init__(self, *args):
369 __class__.num += 1
370 super().__init__(*args)
371 def __del__(self):
372 __class__.num -= 1
373
374 for parity in (0, 1):
375 L = None
376 # We need in the order of 2**20 iterations here such that a
377 # typical 8MB stack would overflow without the trashcan.
378 for i in range(2**20):
379 L = PyList((L,))
380 L.attr = i
381 if parity:
382 # Add one additional nesting layer
383 L = (L,)
384 self.assertGreater(PyList.num, 0)
385 del L
386 self.assertEqual(PyList.num, 0)
387
Petr Viktorin3562ae22019-09-12 10:44:46 +0100388 def test_subclass_of_heap_gc_ctype_with_tpdealloc_decrefs_once(self):
389 class HeapGcCTypeSubclass(_testcapi.HeapGcCType):
390 def __init__(self):
391 self.value2 = 20
392 super().__init__()
393
394 subclass_instance = HeapGcCTypeSubclass()
395 type_refcnt = sys.getrefcount(HeapGcCTypeSubclass)
396
397 # Test that subclass instance was fully created
398 self.assertEqual(subclass_instance.value, 10)
399 self.assertEqual(subclass_instance.value2, 20)
400
401 # Test that the type reference count is only decremented once
402 del subclass_instance
403 self.assertEqual(type_refcnt - 1, sys.getrefcount(HeapGcCTypeSubclass))
404
405 def test_subclass_of_heap_gc_ctype_with_del_modifying_dunder_class_only_decrefs_once(self):
406 class A(_testcapi.HeapGcCType):
407 def __init__(self):
408 self.value2 = 20
409 super().__init__()
410
411 class B(A):
412 def __init__(self):
413 super().__init__()
414
415 def __del__(self):
416 self.__class__ = A
417 A.refcnt_in_del = sys.getrefcount(A)
418 B.refcnt_in_del = sys.getrefcount(B)
419
420 subclass_instance = B()
421 type_refcnt = sys.getrefcount(B)
422 new_type_refcnt = sys.getrefcount(A)
423
424 # Test that subclass instance was fully created
425 self.assertEqual(subclass_instance.value, 10)
426 self.assertEqual(subclass_instance.value2, 20)
427
428 del subclass_instance
429
430 # Test that setting __class__ modified the reference counts of the types
431 self.assertEqual(type_refcnt - 1, B.refcnt_in_del)
432 self.assertEqual(new_type_refcnt + 1, A.refcnt_in_del)
433
434 # Test that the original type already has decreased its refcnt
435 self.assertEqual(type_refcnt - 1, sys.getrefcount(B))
436
437 # Test that subtype_dealloc decref the newly assigned __class__ only once
438 self.assertEqual(new_type_refcnt, sys.getrefcount(A))
439
440 def test_c_subclass_of_heap_ctype_with_tpdealloc_decrefs_once(self):
441 subclass_instance = _testcapi.HeapCTypeSubclass()
442 type_refcnt = sys.getrefcount(_testcapi.HeapCTypeSubclass)
443
444 # Test that subclass instance was fully created
445 self.assertEqual(subclass_instance.value, 10)
446 self.assertEqual(subclass_instance.value2, 20)
447
448 # Test that the type reference count is only decremented once
449 del subclass_instance
450 self.assertEqual(type_refcnt - 1, sys.getrefcount(_testcapi.HeapCTypeSubclass))
451
452 def test_c_subclass_of_heap_ctype_with_del_modifying_dunder_class_only_decrefs_once(self):
453 subclass_instance = _testcapi.HeapCTypeSubclassWithFinalizer()
454 type_refcnt = sys.getrefcount(_testcapi.HeapCTypeSubclassWithFinalizer)
455 new_type_refcnt = sys.getrefcount(_testcapi.HeapCTypeSubclass)
456
457 # Test that subclass instance was fully created
458 self.assertEqual(subclass_instance.value, 10)
459 self.assertEqual(subclass_instance.value2, 20)
460
461 # The tp_finalize slot will set __class__ to HeapCTypeSubclass
462 del subclass_instance
463
464 # Test that setting __class__ modified the reference counts of the types
465 self.assertEqual(type_refcnt - 1, _testcapi.HeapCTypeSubclassWithFinalizer.refcnt_in_del)
466 self.assertEqual(new_type_refcnt + 1, _testcapi.HeapCTypeSubclass.refcnt_in_del)
467
468 # Test that the original type already has decreased its refcnt
469 self.assertEqual(type_refcnt - 1, sys.getrefcount(_testcapi.HeapCTypeSubclassWithFinalizer))
470
471 # Test that subtype_dealloc decref the newly assigned __class__ only once
472 self.assertEqual(new_type_refcnt, sys.getrefcount(_testcapi.HeapCTypeSubclass))
473
Larry Hastings44e2eaa2013-11-23 15:37:55 -0800474
Benjamin Petersona54c9092009-01-13 02:11:23 +0000475class TestPendingCalls(unittest.TestCase):
476
477 def pendingcalls_submit(self, l, n):
478 def callback():
479 #this function can be interrupted by thread switching so let's
480 #use an atomic operation
481 l.append(None)
482
483 for i in range(n):
484 time.sleep(random.random()*0.02) #0.01 secs on average
485 #try submitting callback until successful.
486 #rely on regular interrupt to flush queue if we are
487 #unsuccessful.
488 while True:
489 if _testcapi._pending_threadfunc(callback):
490 break;
491
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000492 def pendingcalls_wait(self, l, n, context = None):
Benjamin Petersona54c9092009-01-13 02:11:23 +0000493 #now, stick around until l[0] has grown to 10
494 count = 0;
495 while len(l) != n:
496 #this busy loop is where we expect to be interrupted to
497 #run our callbacks. Note that callbacks are only run on the
498 #main thread
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000499 if False and support.verbose:
Benjamin Petersona54c9092009-01-13 02:11:23 +0000500 print("(%i)"%(len(l),),)
501 for i in range(1000):
502 a = i*i
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000503 if context and not context.event.is_set():
504 continue
Benjamin Petersona54c9092009-01-13 02:11:23 +0000505 count += 1
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000506 self.assertTrue(count < 10000,
Benjamin Petersona54c9092009-01-13 02:11:23 +0000507 "timeout waiting for %i callbacks, got %i"%(n, len(l)))
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000508 if False and support.verbose:
Benjamin Petersona54c9092009-01-13 02:11:23 +0000509 print("(%i)"%(len(l),))
510
511 def test_pendingcalls_threaded(self):
Benjamin Petersona54c9092009-01-13 02:11:23 +0000512
513 #do every callback on a separate thread
Victor Stinnere225beb2019-06-03 18:14:24 +0200514 n = 32 #total callbacks
Benjamin Petersona54c9092009-01-13 02:11:23 +0000515 threads = []
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000516 class foo(object):pass
517 context = foo()
518 context.l = []
519 context.n = 2 #submits per thread
520 context.nThreads = n // context.n
521 context.nFinished = 0
522 context.lock = threading.Lock()
523 context.event = threading.Event()
524
Serhiy Storchaka263dcd22015-04-01 13:01:14 +0300525 threads = [threading.Thread(target=self.pendingcalls_thread,
526 args=(context,))
527 for i in range(context.nThreads)]
528 with support.start_threads(threads):
529 self.pendingcalls_wait(context.l, n, context)
Benjamin Petersona54c9092009-01-13 02:11:23 +0000530
Benjamin Petersone1cdfd72009-01-18 21:02:37 +0000531 def pendingcalls_thread(self, context):
532 try:
533 self.pendingcalls_submit(context.l, context.n)
534 finally:
535 with context.lock:
536 context.nFinished += 1
537 nFinished = context.nFinished
538 if False and support.verbose:
539 print("finished threads: ", nFinished)
540 if nFinished == context.nThreads:
541 context.event.set()
542
Benjamin Petersona54c9092009-01-13 02:11:23 +0000543 def test_pendingcalls_non_threaded(self):
Ezio Melotti13925002011-03-16 11:05:33 +0200544 #again, just using the main thread, likely they will all be dispatched at
Benjamin Petersona54c9092009-01-13 02:11:23 +0000545 #once. It is ok to ask for too many, because we loop until we find a slot.
546 #the loop can be interrupted to dispatch.
547 #there are only 32 dispatch slots, so we go for twice that!
548 l = []
549 n = 64
550 self.pendingcalls_submit(l, n)
551 self.pendingcalls_wait(l, n)
552
Antoine Pitrou7a2572c2013-08-01 20:43:26 +0200553
554class SubinterpreterTest(unittest.TestCase):
555
Antoine Pitrou2f828f22012-01-18 00:21:11 +0100556 def test_subinterps(self):
Antoine Pitrou2f828f22012-01-18 00:21:11 +0100557 import builtins
558 r, w = os.pipe()
559 code = """if 1:
560 import sys, builtins, pickle
561 with open({:d}, "wb") as f:
562 pickle.dump(id(sys.modules), f)
563 pickle.dump(id(builtins), f)
564 """.format(w)
565 with open(r, "rb") as f:
Victor Stinnered3b0bc2013-11-23 12:27:24 +0100566 ret = support.run_in_subinterp(code)
Antoine Pitrou2f828f22012-01-18 00:21:11 +0100567 self.assertEqual(ret, 0)
568 self.assertNotEqual(pickle.load(f), id(sys.modules))
569 self.assertNotEqual(pickle.load(f), id(builtins))
570
Marcel Plch33e71e02019-05-22 13:51:26 +0200571 def test_mutate_exception(self):
572 """
573 Exceptions saved in global module state get shared between
574 individual module instances. This test checks whether or not
575 a change in one interpreter's module gets reflected into the
576 other ones.
577 """
578 import binascii
579
580 support.run_in_subinterp("import binascii; binascii.Error.foobar = 'foobar'")
581
582 self.assertFalse(hasattr(binascii.Error, "foobar"))
583
Antoine Pitrou7a2572c2013-08-01 20:43:26 +0200584
Ezio Melotti29267c82013-02-23 05:52:46 +0200585class TestThreadState(unittest.TestCase):
586
587 @support.reap_threads
588 def test_thread_state(self):
589 # some extra thread-state tests driven via _testcapi
590 def target():
591 idents = []
592
593 def callback():
Ezio Melotti35246bd2013-02-23 05:58:38 +0200594 idents.append(threading.get_ident())
Ezio Melotti29267c82013-02-23 05:52:46 +0200595
596 _testcapi._test_thread_state(callback)
597 a = b = callback
598 time.sleep(1)
599 # Check our main thread is in the list exactly 3 times.
Ezio Melotti35246bd2013-02-23 05:58:38 +0200600 self.assertEqual(idents.count(threading.get_ident()), 3,
Ezio Melotti29267c82013-02-23 05:52:46 +0200601 "Couldn't find main thread correctly in the list")
602
603 target()
604 t = threading.Thread(target=target)
605 t.start()
606 t.join()
607
Victor Stinner34be8072016-03-14 12:04:26 +0100608
Zachary Warec12f09e2013-11-11 22:47:04 -0600609class Test_testcapi(unittest.TestCase):
Serhiy Storchaka8f7bb102018-08-06 16:50:19 +0300610 locals().update((name, getattr(_testcapi, name))
611 for name in dir(_testcapi)
612 if name.startswith('test_') and not name.endswith('_code'))
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000613
Victor Stinner34be8072016-03-14 12:04:26 +0100614
Victor Stinnerc4aec362016-03-14 22:26:53 +0100615class PyMemDebugTests(unittest.TestCase):
616 PYTHONMALLOC = 'debug'
Victor Stinnera1bc28a2016-03-14 17:10:36 +0100617 # '0x04c06e0' or '04C06E0'
Victor Stinner08572f62016-03-14 21:55:43 +0100618 PTR_REGEX = r'(?:0x)?[0-9a-fA-F]+'
Victor Stinner34be8072016-03-14 12:04:26 +0100619
620 def check(self, code):
621 with support.SuppressCrashReport():
Victor Stinnerc4aec362016-03-14 22:26:53 +0100622 out = assert_python_failure('-c', code,
623 PYTHONMALLOC=self.PYTHONMALLOC)
Victor Stinner34be8072016-03-14 12:04:26 +0100624 stderr = out.err
625 return stderr.decode('ascii', 'replace')
626
627 def test_buffer_overflow(self):
628 out = self.check('import _testcapi; _testcapi.pymem_buffer_overflow()')
Victor Stinnera1bc28a2016-03-14 17:10:36 +0100629 regex = (r"Debug memory block at address p={ptr}: API 'm'\n"
Victor Stinner34be8072016-03-14 12:04:26 +0100630 r" 16 bytes originally requested\n"
Victor Stinnerb3adb1a2016-03-14 17:40:09 +0100631 r" The [0-9] pad bytes at p-[0-9] are FORBIDDENBYTE, as expected.\n"
632 r" The [0-9] pad bytes at tail={ptr} are not all FORBIDDENBYTE \(0x[0-9a-f]{{2}}\):\n"
Victor Stinner34be8072016-03-14 12:04:26 +0100633 r" at tail\+0: 0x78 \*\*\* OUCH\n"
Victor Stinner4c409be2019-04-11 13:01:15 +0200634 r" at tail\+1: 0xfd\n"
635 r" at tail\+2: 0xfd\n"
Victor Stinnerb3adb1a2016-03-14 17:40:09 +0100636 r" .*\n"
Victor Stinnere8f9acf2019-04-12 21:54:06 +0200637 r"( The block was made by call #[0-9]+ to debug malloc/realloc.\n)?"
Victor Stinner4c409be2019-04-11 13:01:15 +0200638 r" Data at p: cd cd cd .*\n"
Victor Stinner6453e9e2016-03-15 23:36:28 +0100639 r"\n"
Victor Stinnerf966e532018-11-13 15:14:58 +0100640 r"Enable tracemalloc to get the memory block allocation traceback\n"
641 r"\n"
Victor Stinner34be8072016-03-14 12:04:26 +0100642 r"Fatal Python error: bad trailing pad byte")
Victor Stinnera1bc28a2016-03-14 17:10:36 +0100643 regex = regex.format(ptr=self.PTR_REGEX)
Victor Stinnerb3adb1a2016-03-14 17:40:09 +0100644 regex = re.compile(regex, flags=re.DOTALL)
Victor Stinner34be8072016-03-14 12:04:26 +0100645 self.assertRegex(out, regex)
646
647 def test_api_misuse(self):
648 out = self.check('import _testcapi; _testcapi.pymem_api_misuse()')
Victor Stinnera1bc28a2016-03-14 17:10:36 +0100649 regex = (r"Debug memory block at address p={ptr}: API 'm'\n"
Victor Stinner34be8072016-03-14 12:04:26 +0100650 r" 16 bytes originally requested\n"
Victor Stinnerb3adb1a2016-03-14 17:40:09 +0100651 r" The [0-9] pad bytes at p-[0-9] are FORBIDDENBYTE, as expected.\n"
652 r" The [0-9] pad bytes at tail={ptr} are FORBIDDENBYTE, as expected.\n"
Victor Stinnere8f9acf2019-04-12 21:54:06 +0200653 r"( The block was made by call #[0-9]+ to debug malloc/realloc.\n)?"
Victor Stinner4c409be2019-04-11 13:01:15 +0200654 r" Data at p: cd cd cd .*\n"
Victor Stinner6453e9e2016-03-15 23:36:28 +0100655 r"\n"
Victor Stinnerf966e532018-11-13 15:14:58 +0100656 r"Enable tracemalloc to get the memory block allocation traceback\n"
657 r"\n"
Victor Stinner34be8072016-03-14 12:04:26 +0100658 r"Fatal Python error: bad ID: Allocated using API 'm', verified using API 'r'\n")
Victor Stinnera1bc28a2016-03-14 17:10:36 +0100659 regex = regex.format(ptr=self.PTR_REGEX)
Victor Stinner34be8072016-03-14 12:04:26 +0100660 self.assertRegex(out, regex)
661
Victor Stinnerad524372016-03-16 12:12:53 +0100662 def check_malloc_without_gil(self, code):
Victor Stinnerc4aec362016-03-14 22:26:53 +0100663 out = self.check(code)
664 expected = ('Fatal Python error: Python memory allocator called '
665 'without holding the GIL')
666 self.assertIn(expected, out)
Victor Stinner34be8072016-03-14 12:04:26 +0100667
Victor Stinnerad524372016-03-16 12:12:53 +0100668 def test_pymem_malloc_without_gil(self):
669 # Debug hooks must raise an error if PyMem_Malloc() is called
670 # without holding the GIL
671 code = 'import _testcapi; _testcapi.pymem_malloc_without_gil()'
672 self.check_malloc_without_gil(code)
673
674 def test_pyobject_malloc_without_gil(self):
675 # Debug hooks must raise an error if PyObject_Malloc() is called
676 # without holding the GIL
677 code = 'import _testcapi; _testcapi.pyobject_malloc_without_gil()'
678 self.check_malloc_without_gil(code)
679
Victor Stinner35762662019-06-07 17:41:39 +0200680 def check_pyobject_is_freed(self, func_name):
681 code = textwrap.dedent(f'''
Victor Stinner2b00db62019-04-11 11:33:27 +0200682 import gc, os, sys, _testcapi
683 # Disable the GC to avoid crash on GC collection
684 gc.disable()
Victor Stinner35762662019-06-07 17:41:39 +0200685 try:
686 _testcapi.{func_name}()
687 # Exit immediately to avoid a crash while deallocating
688 # the invalid object
689 os._exit(0)
690 except _testcapi.error:
691 os._exit(1)
Victor Stinner2b00db62019-04-11 11:33:27 +0200692 ''')
Victor Stinner2b00db62019-04-11 11:33:27 +0200693 assert_python_ok('-c', code, PYTHONMALLOC=self.PYTHONMALLOC)
694
Victor Stinnerf82ce5b2019-10-15 03:06:16 +0200695 def test_pyobject_null_is_freed(self):
696 self.check_pyobject_is_freed('check_pyobject_null_is_freed')
697
Victor Stinner35762662019-06-07 17:41:39 +0200698 def test_pyobject_uninitialized_is_freed(self):
699 self.check_pyobject_is_freed('check_pyobject_uninitialized_is_freed')
Victor Stinner2b00db62019-04-11 11:33:27 +0200700
Victor Stinner35762662019-06-07 17:41:39 +0200701 def test_pyobject_forbidden_bytes_is_freed(self):
702 self.check_pyobject_is_freed('check_pyobject_forbidden_bytes_is_freed')
Victor Stinner2b00db62019-04-11 11:33:27 +0200703
Victor Stinner35762662019-06-07 17:41:39 +0200704 def test_pyobject_freed_is_freed(self):
705 self.check_pyobject_is_freed('check_pyobject_freed_is_freed')
Victor Stinner2b00db62019-04-11 11:33:27 +0200706
Victor Stinnerc4aec362016-03-14 22:26:53 +0100707
708class PyMemMallocDebugTests(PyMemDebugTests):
709 PYTHONMALLOC = 'malloc_debug'
Victor Stinner34be8072016-03-14 12:04:26 +0100710
711
Victor Stinner5d39e042017-11-29 17:20:38 +0100712@unittest.skipUnless(support.with_pymalloc(), 'need pymalloc')
Victor Stinnerc4aec362016-03-14 22:26:53 +0100713class PyMemPymallocDebugTests(PyMemDebugTests):
714 PYTHONMALLOC = 'pymalloc_debug'
Victor Stinner34be8072016-03-14 12:04:26 +0100715
716
717@unittest.skipUnless(Py_DEBUG, 'need Py_DEBUG')
Victor Stinnerc4aec362016-03-14 22:26:53 +0100718class PyMemDefaultTests(PyMemDebugTests):
719 # test default allocator of Python compiled in debug mode
720 PYTHONMALLOC = ''
Victor Stinner34be8072016-03-14 12:04:26 +0100721
722
Thomas Wouters49fd7fa2006-04-21 10:40:58 +0000723if __name__ == "__main__":
Zachary Warec12f09e2013-11-11 22:47:04 -0600724 unittest.main()