mirror of
https://github.com/RustPython/RustPython.git
synced 2026-10-29 11:14:38 +08:00
* Add deterministic profiler and canonical Python 3.15 tools
Use the merged operation critical sections with interpreter-bound profiler
entry checks and short payload borrows. Trace owned code references for GC.
Import the canonical tracing and offline profiling output closure via the
repository updater, retaining existing test markers.
Assisted-by: dot:GPT-6.1
* Clarify standalone profiling license cross-reference
Preserve license terms and copyright notices; point to the reproduced
Apache text below instead of CPython's original OpenSSL section above.
Assisted-by: dot:GPT-6.1
* Defer unsupported sampling package from profiler extraction
Keep the deterministic tracing profiler and its canonical tools together.
Defer the entirely new sampling production, tests, assets and their license
as one closure until native record and binary-collector support is ready.
Retain canonical pstats for deterministic empty-profile handling; its
upstream sampled-file sorting issue is not patched here.
Assisted-by: dot:GPT-6.1
* Stage profiling root as a namespace until sampling is available
Omit the whole newly added canonical package initializer rather than
advertise an absent sampling module or hand-edit canonical __all__.
Explicit profiling.tracing and cProfile imports remain available.
The namespace root intentionally lacks canonical metadata/automatic exports.
This addresses test___all__ failures in the prior Linux, macOS and Windows
CI runs. No test assertions, skips or canonical file contents are changed.
Assisted-by: dot:GPT-6.1
* Match canonical static builtin profiler labels and metadata
Normalize the raw builtin receiver instead of its call-argument accessor.
Snapshot static method module metadata at construction, matching CPython,
so explicit module mutation and deletion remain observable. Avoid a
profiler-time fallback that would obscure deleted metadata.
Correct float.__getformat__ to CPython's classmethod calling convention,
including subclass binding, rather than special-casing its profiler label.
Assisted-by: dot:GPT-6.1
* Support collision-safe frozen package containers
Generate empty frozen packages only for source namespace directories with
real frozen descendants. Preserve genuine modules and packages across
frozen-library registrations while retaining real-real replacement order.
Record the container marker in FrozenModule and its library envelope;
legacy module/package encodings remain unchanged. This is closed-tree
frozen packaging, not full PEP 420 namespace merging.
Add structural codec, mock generator, and registration-priority checks.
* Revert frozen package containers before restoring canonical profiling root
The container implementation changed filesystem namespace precedence.
Restore the existing importer and frozen envelope unchanged; the following
offline sampling closure restores the canonical regular package root.
This reverses d5a8049234.
Assisted-by: dot:GPT-6.1
* Restore canonical profiling package with offline sampling codec
Provide native records, status constants and genuine uncompressed binary
reader/writer APIs for canonical offline tools. Keep the unsupported live
process capability absent and preserve existing canonical test gates.
Restore the complete selected sampling production/test/assets closure via
update_lib, including its asyncio frame-schema dependency. The prior frozen
container extension is reverted separately; canonical packages work with
both filesystem and frozen imports without changing namespace semantics.
Assisted-by: dot:GPT-6.1
* Keep platform-dependent C long normalization explicit
Allow only the c_long-to-i32 conversion lint: Windows uses the same type,
while LP64 requires the existing truncation to match CPython normalization.
No runtime behavior or test assertions change.
Assisted-by: dot:GPT-6.1
* Include profiling notices in library and desktop packages
Bundle a byte-identical copy of the root profiling notice in rustpython-pylib
and include the root notice in configured desktop resources. Avoid a symlink
so Windows checkouts preserve the actual notice text. Terms are unchanged.
Assisted-by: dot:GPT-6.1
* Keep profiling asset license notice in pylib crate
* Serve frozen profiling assets through native resource readers
* Preserve canonical profiling asset line endings on checkout
---------
Co-authored-by: youknowdot <dot@youknowone.org>
309 lines
13 KiB
Python
Vendored
309 lines
13 KiB
Python
Vendored
"""Test suite for the cProfile module."""
|
|
import multiprocessing
|
|
import sys
|
|
import unittest
|
|
|
|
# rip off all interesting stuff from test_profile
|
|
import profiling.tracing as cProfile
|
|
import tempfile
|
|
import textwrap
|
|
from test.test_profile import ProfileTest, regenerate_expected_output
|
|
from test.support.script_helper import assert_python_failure, assert_python_ok
|
|
from test import support
|
|
|
|
|
|
class CProfileTest(ProfileTest):
|
|
profilerclass = cProfile.Profile
|
|
profilermodule = cProfile
|
|
expected_max_output = "{built-in method builtins.max}"
|
|
|
|
def get_expected_output(self):
|
|
return _ProfileOutput
|
|
|
|
def test_bad_counter_during_dealloc(self):
|
|
# bpo-3895
|
|
import _lsprof
|
|
|
|
with support.catch_unraisable_exception() as cm:
|
|
obj = _lsprof.Profiler(lambda: int)
|
|
obj.enable()
|
|
obj.disable()
|
|
obj.clear()
|
|
|
|
self.assertEqual(cm.unraisable.exc_type, TypeError)
|
|
|
|
def test_crash_with_not_enough_args(self):
|
|
# gh-126220
|
|
import _lsprof
|
|
|
|
for profile in [_lsprof.Profiler(), cProfile.Profile()]:
|
|
for method in [
|
|
"_pystart_callback",
|
|
"_pyreturn_callback",
|
|
"_ccall_callback",
|
|
"_creturn_callback",
|
|
]:
|
|
with self.subTest(profile=profile, method=method):
|
|
method_obj = getattr(profile, method)
|
|
with self.assertRaises(TypeError):
|
|
method_obj() # should not crash
|
|
|
|
def test_evil_external_timer(self):
|
|
# gh-120289
|
|
# Disabling profiler in external timer should not crash
|
|
import _lsprof
|
|
class EvilTimer():
|
|
def __init__(self, disable_count):
|
|
self.count = 0
|
|
self.disable_count = disable_count
|
|
|
|
def __call__(self):
|
|
self.count += 1
|
|
if self.count == self.disable_count:
|
|
profiler_with_evil_timer.disable()
|
|
return self.count
|
|
|
|
# this will trigger external timer to disable profiler at
|
|
# call event - in initContext in _lsprof.c
|
|
with support.catch_unraisable_exception() as cm:
|
|
profiler_with_evil_timer = _lsprof.Profiler(EvilTimer(1))
|
|
profiler_with_evil_timer.enable()
|
|
# Make a call to trigger timer
|
|
(lambda: None)()
|
|
profiler_with_evil_timer.disable()
|
|
profiler_with_evil_timer.clear()
|
|
self.assertEqual(cm.unraisable.exc_type, RuntimeError)
|
|
|
|
# this will trigger external timer to disable profiler at
|
|
# return event - in Stop in _lsprof.c
|
|
with support.catch_unraisable_exception() as cm:
|
|
profiler_with_evil_timer = _lsprof.Profiler(EvilTimer(2))
|
|
profiler_with_evil_timer.enable()
|
|
# Make a call to trigger timer
|
|
(lambda: None)()
|
|
profiler_with_evil_timer.disable()
|
|
profiler_with_evil_timer.clear()
|
|
self.assertEqual(cm.unraisable.exc_type, RuntimeError)
|
|
|
|
def test_enable_in_external_timer(self):
|
|
# gh-157639: Enabling the profiler from an external timer should not crash
|
|
import _lsprof
|
|
|
|
# the timer re-arms monitoring from inside disable(), so the tool
|
|
# id stays claimed once the profiler is torn down
|
|
self.addCleanup(sys.monitoring.free_tool_id, sys.monitoring.PROFILER_ID)
|
|
|
|
def timer():
|
|
try:
|
|
profiler.enable()
|
|
except Exception:
|
|
pass
|
|
return 0
|
|
|
|
profiler = _lsprof.Profiler(timer=timer)
|
|
profiler.enable()
|
|
(lambda: None)()
|
|
profiler.disable()
|
|
profiler.clear()
|
|
|
|
def test_profile_enable_disable(self):
|
|
prof = self.profilerclass()
|
|
# Make sure we clean ourselves up if the test fails for some reason.
|
|
self.addCleanup(prof.disable)
|
|
|
|
prof.enable()
|
|
self.assertEqual(
|
|
sys.monitoring.get_tool(sys.monitoring.PROFILER_ID), "cProfile")
|
|
|
|
prof.disable()
|
|
self.assertIs(sys.monitoring.get_tool(sys.monitoring.PROFILER_ID), None)
|
|
|
|
def test_profile_as_context_manager(self):
|
|
prof = self.profilerclass()
|
|
# Make sure we clean ourselves up if the test fails for some reason.
|
|
self.addCleanup(prof.disable)
|
|
|
|
with prof as __enter__return_value:
|
|
# profile.__enter__ should return itself.
|
|
self.assertIs(prof, __enter__return_value)
|
|
|
|
# profile should be set as the global profiler inside the
|
|
# with-block
|
|
self.assertEqual(
|
|
sys.monitoring.get_tool(sys.monitoring.PROFILER_ID), "cProfile")
|
|
|
|
# profile shouldn't be set once we leave the with-block.
|
|
self.assertIs(sys.monitoring.get_tool(sys.monitoring.PROFILER_ID), None)
|
|
|
|
def test_second_profiler(self):
|
|
pr = self.profilerclass()
|
|
pr2 = self.profilerclass()
|
|
pr.enable()
|
|
self.addCleanup(pr.disable)
|
|
msg = f"tool {sys.monitoring.PROFILER_ID} is already in use"
|
|
self.assertRaisesRegex(ValueError, msg, pr2.enable)
|
|
|
|
def test_throw(self):
|
|
"""
|
|
gh-106152
|
|
generator.throw() should trigger a call in cProfile
|
|
"""
|
|
|
|
def gen():
|
|
yield
|
|
|
|
pr = self.profilerclass()
|
|
pr.enable()
|
|
g = gen()
|
|
try:
|
|
g.throw(SyntaxError)
|
|
except SyntaxError:
|
|
pass
|
|
pr.disable()
|
|
pr.create_stats()
|
|
|
|
self.assertTrue(any("throw" in func[2] for func in pr.stats.keys())),
|
|
|
|
def test_clear_with_nested_calls(self):
|
|
# Calling clear() during nested profiled calls should not leak
|
|
# ProfilerContexts. clearEntries() must walk the entire linked list,
|
|
# not just free the top context.
|
|
import _lsprof
|
|
|
|
def level3(profiler):
|
|
profiler.clear()
|
|
|
|
def level2(profiler):
|
|
level3(profiler)
|
|
|
|
def level1(profiler):
|
|
level2(profiler)
|
|
|
|
profiler = _lsprof.Profiler()
|
|
profiler.enable()
|
|
for _ in range(100):
|
|
level1(profiler)
|
|
profiler.disable()
|
|
profiler.clear()
|
|
|
|
def test_bad_descriptor(self):
|
|
# gh-132250
|
|
# cProfile should not crash when the profiler callback fails to locate
|
|
# the actual function of a method.
|
|
with self.profilerclass() as prof:
|
|
with self.assertRaises(TypeError):
|
|
bytes.find(str())
|
|
|
|
|
|
class TestCommandLine(unittest.TestCase):
|
|
def test_sort(self):
|
|
rc, out, err = assert_python_failure('-m', 'cProfile', '-s', 'demo')
|
|
self.assertGreater(rc, 0)
|
|
self.assertIn(b"option -s: invalid choice: 'demo'", err)
|
|
|
|
def test_profile_script_importing_main(self):
|
|
"""Check that scripts that reference __main__ see their own namespace
|
|
when being profiled."""
|
|
with tempfile.NamedTemporaryFile("w+", delete_on_close=False) as f:
|
|
f.write(textwrap.dedent("""\
|
|
class Foo:
|
|
pass
|
|
import __main__
|
|
assert Foo == __main__.Foo
|
|
"""))
|
|
f.close()
|
|
assert_python_ok('-m', "cProfile", f.name)
|
|
|
|
def _test_process_run_pickle(self, start_method):
|
|
val = 10
|
|
with tempfile.NamedTemporaryFile("w+", delete_on_close=False) as f:
|
|
f.write(textwrap.dedent(
|
|
f'''\
|
|
import multiprocessing
|
|
|
|
def worker(x):
|
|
print(__name__)
|
|
exit(x ** 2)
|
|
|
|
if __name__ == "__main__":
|
|
multiprocessing.set_start_method('{start_method}')
|
|
p = multiprocessing.Process(target=worker, args=({val},))
|
|
p.start()
|
|
p.join()
|
|
print("p.exitcode =", p.exitcode)
|
|
'''))
|
|
f.close()
|
|
_, out, err = assert_python_ok('-m', "cProfile", f.name)
|
|
self.assertIn(b"__mp_main__", out)
|
|
self.assertIn(bytes(f"exitcode = {val**2}", encoding='utf8'), out)
|
|
self.assertNotIn(b"Can't pickle", err)
|
|
|
|
def test_process_spawn_pickle(self):
|
|
# gh-140729: test use Process in cProfile.
|
|
self._test_process_run_pickle('spawn')
|
|
|
|
@unittest.skipUnless("forkserver" in multiprocessing.get_all_start_methods(),
|
|
"forkserver start method is not available")
|
|
def test_process_forkserver_pickle(self):
|
|
# gh-140729: test use Process in cProfile.
|
|
self._test_process_run_pickle('forkserver')
|
|
|
|
|
|
def main():
|
|
if '-r' not in sys.argv:
|
|
unittest.main()
|
|
else:
|
|
regenerate_expected_output(__file__, CProfileTest)
|
|
|
|
|
|
# Don't remove this comment. Everything below it is auto-generated.
|
|
#--cut--------------------------------------------------------------------------
|
|
_ProfileOutput = {}
|
|
_ProfileOutput['print_stats'] = """\
|
|
28 0.028 0.001 0.028 0.001 profilee.py:110(__getattr__)
|
|
1 0.270 0.270 1.000 1.000 profilee.py:25(testfunc)
|
|
23/3 0.150 0.007 0.170 0.057 profilee.py:35(factorial)
|
|
20 0.020 0.001 0.020 0.001 profilee.py:48(mul)
|
|
2 0.040 0.020 0.600 0.300 profilee.py:55(helper)
|
|
4 0.116 0.029 0.120 0.030 profilee.py:73(helper1)
|
|
2 0.000 0.000 0.140 0.070 profilee.py:84(helper2_indirect)
|
|
8 0.312 0.039 0.400 0.050 profilee.py:88(helper2)
|
|
8 0.064 0.008 0.080 0.010 profilee.py:98(subhelper)"""
|
|
_ProfileOutput['print_callers'] = """\
|
|
profilee.py:110(__getattr__) <- 16 0.016 0.016 profilee.py:98(subhelper)
|
|
profilee.py:25(testfunc) <- 1 0.270 1.000 <string>:1(<module>)
|
|
profilee.py:35(factorial) <- 1 0.014 0.130 profilee.py:25(testfunc)
|
|
20/3 0.130 0.147 profilee.py:35(factorial)
|
|
2 0.006 0.040 profilee.py:84(helper2_indirect)
|
|
profilee.py:48(mul) <- 20 0.020 0.020 profilee.py:35(factorial)
|
|
profilee.py:55(helper) <- 2 0.040 0.600 profilee.py:25(testfunc)
|
|
profilee.py:73(helper1) <- 4 0.116 0.120 profilee.py:55(helper)
|
|
profilee.py:84(helper2_indirect) <- 2 0.000 0.140 profilee.py:55(helper)
|
|
profilee.py:88(helper2) <- 6 0.234 0.300 profilee.py:55(helper)
|
|
2 0.078 0.100 profilee.py:84(helper2_indirect)
|
|
profilee.py:98(subhelper) <- 8 0.064 0.080 profilee.py:88(helper2)
|
|
{built-in method builtins.hasattr} <- 4 0.000 0.004 profilee.py:73(helper1)
|
|
8 0.000 0.008 profilee.py:88(helper2)
|
|
{built-in method sys.exception} <- 4 0.000 0.000 profilee.py:73(helper1)
|
|
{method 'append' of 'list' objects} <- 4 0.000 0.000 profilee.py:73(helper1)"""
|
|
_ProfileOutput['print_callees'] = """\
|
|
<string>:1(<module>) -> 1 0.270 1.000 profilee.py:25(testfunc)
|
|
profilee.py:110(__getattr__) ->
|
|
profilee.py:25(testfunc) -> 1 0.014 0.130 profilee.py:35(factorial)
|
|
2 0.040 0.600 profilee.py:55(helper)
|
|
profilee.py:35(factorial) -> 20/3 0.130 0.147 profilee.py:35(factorial)
|
|
20 0.020 0.020 profilee.py:48(mul)
|
|
profilee.py:48(mul) ->
|
|
profilee.py:55(helper) -> 4 0.116 0.120 profilee.py:73(helper1)
|
|
2 0.000 0.140 profilee.py:84(helper2_indirect)
|
|
6 0.234 0.300 profilee.py:88(helper2)
|
|
profilee.py:73(helper1) -> 4 0.000 0.004 {built-in method builtins.hasattr}
|
|
profilee.py:84(helper2_indirect) -> 2 0.006 0.040 profilee.py:35(factorial)
|
|
2 0.078 0.100 profilee.py:88(helper2)
|
|
profilee.py:88(helper2) -> 8 0.064 0.080 profilee.py:98(subhelper)
|
|
profilee.py:98(subhelper) -> 16 0.016 0.016 profilee.py:110(__getattr__)
|
|
{built-in method builtins.hasattr} -> 12 0.012 0.012 profilee.py:110(__getattr__)"""
|
|
|
|
if __name__ == "__main__":
|
|
main()
|