8000 gh-102110: Add all tools description missed by Missoupro · Pull Request #102625 · python/cpython · GitHub
[go: up one dir, main page]

Skip to content

gh-102110: Add all tools description missed #102625

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Mar 30, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion Tools/README
Original file line number Diff line number Diff line change
@@ -1,10 +1,21 @@
This directory contains a number of Python programs that are useful
while building or extending Python.

build Automatically generated directory by the build system
contain build artifacts and intermediate files.

buildbot Batchfiles for running on Windows buildbot workers.

c-analyzer Tools to check no new global variables have been added.

cases_generator Tooling to generate interpreters.

ccbench A Python threads-based concurrency benchmark. (*)

clinic A preprocessor for CPython C files in order to automate
the boilerplate involved with writing argument parsing
code for "builtins".

freeze Create a stand-alone executable from a Python program.

gdb Python code to be run inside gdb, to make it easier to
Expand All @@ -15,11 +26,16 @@ i18n Tools for internationalization. pygettext.py
and msgfmt.py generates a binary message catalog
from a catalog in text format.

importbench A set of micro-benchmarks for various import scenarios.

iobench Benchmark for the new Python I/O system. (*)

msi Support for packaging Python as an MSI package on Windows.

parser Un-parsing tool to generate code from an AST.
nuget Files for the NuGet package manager for .NET.

patchcheck Tools for checking and applying patches to the Python source code
and verifying the integrity of patch files.

peg_generator PEG-based parser generator (pegen) used for new parser.

Expand All @@ -28,16 +44,23 @@ scripts A number of useful single-file programs, e.g. tabnanny.py
tabs and spaces, and 2to3, which converts Python 2 code
to Python 3 code.

ssl Scripts to generate ssl_data.h from OpenSSL sources, and run
tests against multiple installations of OpenSSL and LibreSSL.

stringbench A suite of micro-benchmarks for various operations on
strings (both 8-bit and unicode). (*)

tz A script to dump timezone from /usr/share/zoneinfo.

unicode Tools for generating unicodedata and codecs from unicode.org
and other mapping files (by Fredrik Lundh, Marc-Andre Lemburg
and Martin von Loewis).

unittestgui A Tkinter based GUI test runner for unittest, with test
discovery.

wasm Config and helpers to facilitate cross compilation of CPython
to WebAssembly (WASM).

(*) A generic benchmark suite is maintained separately at https://github.com/python/performance

Expand Down
10 changes: 8 additions & 2 deletions Tools/scripts/README
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,15 @@ This directory contains a collection of executable Python scripts that are
useful while building, extending or managing Python.

2to3 Main script for running the 2to3 conversion tool
checkpip.py Checks the version of the projects bundled in ensurepip
are the latest available
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
parse_html5_entities.py Utility for parsing HTML5 entity definitions
pydoc3 Python documentation browser
run_tests.py Run the test suite with more sensible default options
stable_abi.py Stable ABI checks and file generators.
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
0