diff --git a/Tools/README b/Tools/README index 22d76dfdbcf4a4..8f00defe7d122a 100644 --- a/Tools/README +++ b/Tools/README @@ -16,7 +16,8 @@ clinic A preprocessor for CPython C files in order to automate freeze Create a stand-alone executable from a Python program. -ftscalingbench Benchmarks for free-threading and finding bottlenecks. +ftscalingbench Runs a set of small benchmarks to help identify scaling + bottlenecks in the free-threaded interpreter. gdb Python code to be run inside gdb, to make it easier to debug Python itself (by David Malcolm). @@ -28,11 +29,13 @@ i18n Tools for internationalization. pygettext.py importbench A set of micro-benchmarks for various import scenarios. -inspection Tooling for PEP-678 "Safe external debugger interface for CPython". +inspection A set of benchmarks to measure get_stack_trace() performance. -jit Tooling for building the JIT. +jit Documentation and tools for building the JIT compiler. See + jit/README.md for more information. -lockbench Benchmarks for PyMutex and critical sections. +lockbench Benchmarks to measure the performance of PyMutex and + PyThread_type_lock locks with short critical sections. msi Support for packaging Python as an MSI package on Windows. @@ -43,8 +46,8 @@ patchcheck Tools for checking and applying patches to the Python source cod peg_generator PEG-based parser generator (pegen) used for new parser. -scripts A number of useful single-file programs, e.g. run_tests.py - which runs the Python test suite. +scripts A number of useful single-file programs. See scripts/README for + more information. ssl Scripts to generate ssl_data.h from OpenSSL sources, and run tests against multiple installations of OpenSSL and LibreSSL. diff --git a/Tools/scripts/README b/Tools/scripts/README index 4e52cda38e8d88..ab2815fe41dc8e 100644 --- a/Tools/scripts/README +++ b/Tools/scripts/README @@ -2,12 +2,20 @@ This directory contains a collection of executable Python scripts that are useful while building, extending or managing Python. combinerefs.py A helper for analyzing PYTHONDUMPREFS output + divmod_threshold.py Determine threshold for switching from longobject.c divmod to _pylong.int_divmod() + idle3 Main program to start IDLE + +long_conv_tables.py Compute tables for longobject.c long_from_non_binary_base() + pydoc3 Python documentation browser -run_tests.py Run the test suite with more sensible default options + +sortperf.py List sort performance test, requires the pyperf module. + summarize_stats.py Summarize specialization stats for all files in the default stats folders + var_access_benchmark.py Show relative speeds of local, nonlocal, global, and built-in access diff --git a/Tools/scripts/sortperf.py b/Tools/scripts/sortperf.py index 1978a6c83dbe2b..117be9a950b1dc 100644 --- a/Tools/scripts/sortperf.py +++ b/Tools/scripts/sortperf.py @@ -7,7 +7,7 @@ To run: - python3 Tools/scripts/sortperf + python3 Tools/scripts/sortperf.py Options: