Skip to content

Commit 01a49d1

Browse files
authored
gh-102110: Add all tools description missed (GH-102625)
Added missing descriptions of some tools. Automerge-Triggered-By: GH:hugovk
1 parent ecc5441 commit 01a49d1

File tree

2 files changed

+32
-3
lines changed

2 files changed

+32
-3
lines changed

Tools/README

+24-1
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
11
This directory contains a number of Python programs that are useful
22
while building or extending Python.
33

4+
build Automatically generated directory by the build system
5+
contain build artifacts and intermediate files.
6+
47
buildbot Batchfiles for running on Windows buildbot workers.
58

9+
c-analyzer Tools to check no new global variables have been added.
10+
11+
cases_generator Tooling to generate interpreters.
12+
613
ccbench A Python threads-based concurrency benchmark. (*)
714

15+
clinic A preprocessor for CPython C files in order to automate
16+
the boilerplate involved with writing argument parsing
17+
code for "builtins".
18+
819
freeze Create a stand-alone executable from a Python program.
920

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

29+
importbench A set of micro-benchmarks for various import scenarios.
30+
1831
iobench Benchmark for the new Python I/O system. (*)
1932

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

22-
parser Un-parsing tool to generate code from an AST.
35+
nuget Files for the NuGet package manager for .NET.
36+
37+
patchcheck Tools for checking and applying patches to the Python source code
38+
and verifying the integrity of patch files.
2339

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

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

47+
ssl Scripts to generate ssl_data.h from OpenSSL sources, and run
48+
tests against multiple installations of OpenSSL and LibreSSL.
49+
3150
stringbench A suite of micro-benchmarks for various operations on
3251
strings (both 8-bit and unicode). (*)
3352

53+
tz A script to dump timezone from /usr/share/zoneinfo.
54+
3455
unicode Tools for generating unicodedata and codecs from unicode.org
3556
and other mapping files (by Fredrik Lundh, Marc-Andre Lemburg
3657
and Martin von Loewis).
3758

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

62+
wasm Config and helpers to facilitate cross compilation of CPython
63+
to WebAssembly (WASM).
4164

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

Tools/scripts/README

+8-2
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,15 @@ This directory contains a collection of executable Python scripts that are
22
useful while building, extending or managing Python.
33

44
2to3 Main script for running the 2to3 conversion tool
5+
checkpip.py Checks the version of the projects bundled in ensurepip
6+
are the latest available
57
combinerefs.py A helper for analyzing PYTHONDUMPREFS output
8+
divmod_threshold.py Determine threshold for switching from longobject.c
9+
divmod to _pylong.int_divmod()
610
idle3 Main program to start IDLE
7-
parse_html5_entities.py Utility for parsing HTML5 entity definitions
811
pydoc3 Python documentation browser
912
run_tests.py Run the test suite with more sensible default options
10-
stable_abi.py Stable ABI checks and file generators.
13+
summarize_stats.py Summarize specialization stats for all files in the
14+
default stats folders
15+
var_access_benchmark.py Show relative speeds of local, nonlocal, global,
16+
and built-in access

0 commit comments

Comments
 (0)