mirrors/cpython
1
0
Fork 0
mirror of https://github.com/python/cpython.git synced 2025-09-05 00:11:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

gh-102110: Add all tools description missed (GH-102625)

Browse source 
Added missing descriptions of some tools.

Automerge-Triggered-By: GH:hugovk
This commit is contained in:
Missoupro 2023-03-30 21:49:07 +01:00 • committed by GitHub
parent ecc5441505
commit 01a49d1745
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 32 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

25
Tools/README
View file

@ -1,10 +1,21 @@
This directory contains a number of Python programs that are useful This directory contains a number of Python programs that are useful
while building or extending Python. 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. 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. (*) 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. freeze Create a stand-alone executable from a Python program.
gdb Python code to be run inside gdb, to make it easier to gdb Python code to be run inside gdb, to make it easier to
@ -15,11 +26,16 @@ i18n Tools for internationalization. pygettext.py
and msgfmt.py generates a binary message catalog and msgfmt.py generates a binary message catalog
from a catalog in text format. 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. (*) iobench Benchmark for the new Python I/O system. (*)
msi Support for packaging Python as an MSI package on Windows. 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. peg_generator PEG-based parser generator (pegen) used for new parser.
@ -28,9 +44,14 @@ scripts A number of useful single-file programs, e.g. tabnanny.py
tabs and spaces, and 2to3, which converts Python 2 code tabs and spaces, and 2to3, which converts Python 2 code
to Python 3 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 stringbench A suite of micro-benchmarks for various operations on
strings (both 8-bit and unicode). (*) 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 unicode Tools for generating unicodedata and codecs from unicode.org
and other mapping files (by Fredrik Lundh, Marc-Andre Lemburg and other mapping files (by Fredrik Lundh, Marc-Andre Lemburg
and Martin von Loewis). and Martin von Loewis).
@ -38,6 +59,8 @@ unicode Tools for generating unicodedata and codecs from unicode.org
unittestgui A Tkinter based GUI test runner for unittest, with test unittestgui A Tkinter based GUI test runner for unittest, with test
discovery. 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 (*) A generic benchmark suite is maintained separately at https://github.com/python/performance

10
Tools/scripts/README
View file

@ -2,9 +2,15 @@ This directory contains a collection of executable Python scripts that are
useful while building, extending or managing Python. useful while building, extending or managing Python.
2to3 Main script for running the 2to3 conversion tool 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 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 idle3 Main program to start IDLE
parse_html5_entities.py Utility for parsing HTML5 entity definitions
pydoc3 Python documentation browser pydoc3 Python documentation browser
run_tests.py Run the test suite with more sensible default options 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