From 550be8bf5536e8520e4f137e94c97b2cc94f1320 Mon Sep 17 00:00:00 2001 From: MissouPro Date: Sun, 12 Mar 2023 17:26:57 +0100 Subject: [PATCH 1/9] Add all tools description missed --- Tools/README | 25 ++++++++++++++++++++++++- Tools/scripts/README | 8 ++++++-- 2 files changed, 30 insertions(+), 3 deletions(-) diff --git a/Tools/README b/Tools/README index 04612b8013db92..f40b263a84ebb1 100644 --- a/Tools/README +++ b/Tools/README @@ -3,8 +3,14 @@ while building or extending Python. buildbot Batchfiles for running on Windows buildbot workers. +c-analyzer CPython's C code makes extensive use of global variables. + +cases_generator A Python tool for generating C codes that interfaces with Python's C API. + ccbench A Python threads-based concurrency benchmark. (*) +clinic A Python generator of clinic code. + freeze Create a stand-alone executable from a Python program. gdb Python code to be run inside gdb, to make it easier to @@ -15,11 +21,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 A package manager for Microsoft . NET applications. + +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. @@ -28,9 +39,19 @@ 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 Tools permit for working with with SSL/TLS encryption in Python, + generating SSL/TLS certificates and keys and testing SSL/TLS + connections and protocols. + + stringbench A suite of micro-benchmarks for various operations on strings (both 8-bit and unicode). (*) +tz A Python tools offers timezone implementations, generating + timezone information files,converting between different + tz formats, and managing timezone data. + + unicode Tools for generating unicodedata and codecs from unicode.org and other mapping files (by Fredrik Lundh, Marc-Andre Lemburg 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 discovery. +wasm A Configuration and helpers to facilitate cross compilation + of CPython to WebAssembly (WASM) (*) A generic benchmark suite is maintained separately at https://github.com/python/performance diff --git a/Tools/scripts/README b/Tools/scripts/README index b9522681595901..9e91db6ca9e052 100644 --- a/Tools/scripts/README +++ b/Tools/scripts/README @@ -2,9 +2,13 @@ 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 A script that checks if the pip package manager is installed + and available on the system. combinerefs.py A helper for analyzing PYTHONDUMPREFS output +divmod_threshold.py Determine the optimal value for the threshold parameter used + by the built-in divmod function 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 A script that summarizes the stat generated by the Python profiler. +var_access_benchmark.py A script that benchmarks the performance of accessing variables in different scopes. From d1a62d1c573051f85d590c04856a09672edab9e3 Mon Sep 17 00:00:00 2001 From: Missoupro <80458944+Missoupro@users.noreply.github.com> Date: Sun, 12 Mar 2023 19:17:03 +0100 Subject: [PATCH 2/9] Update README Add some clarifications --- Tools/README | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Tools/README b/Tools/README index f40b263a84ebb1..2d8dc9ef1c2a85 100644 --- a/Tools/README +++ b/Tools/README @@ -5,11 +5,12 @@ buildbot Batchfiles for running on Windows buildbot workers. c-analyzer CPython's C code makes extensive use of global variables. -cases_generator A Python tool for generating C codes that interfaces with Python's C API. +cases_generator A Python tool for providing test cases for Python's parser module. ccbench A Python threads-based concurrency benchmark. (*) -clinic A Python generator of clinic code. +clinic Tool for generating C code that interfaces with Python's + C API. freeze Create a stand-alone executable from a Python program. From 3f59ca686366d72ea3d82e35b2657f4b98d0b969 Mon Sep 17 00:00:00 2001 From: Missoupro <80458944+Missoupro@users.noreply.github.com> Date: Thu, 16 Mar 2023 15:49:22 +0100 Subject: [PATCH 3/9] Add .build description --- Tools/README | 3 +++ 1 file changed, 3 insertions(+) diff --git a/Tools/README b/Tools/README index 2d8dc9ef1c2a85..33bb4f796d69ce 100644 --- a/Tools/README +++ b/Tools/README @@ -1,6 +1,9 @@ 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 CPython's C code makes extensive use of global variables. From 16cb5020ae9c6deb73650d956d312b293cce9aaa Mon Sep 17 00:00:00 2001 From: Missoupro <80458944+Missoupro@users.noreply.github.com> Date: Fri, 17 Mar 2023 12:10:40 +0100 Subject: [PATCH 4/9] added the suggestions changes --- Tools/README | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/Tools/README b/Tools/README index 33bb4f796d69ce..bff7229db7e0b5 100644 --- a/Tools/README +++ b/Tools/README @@ -2,7 +2,7 @@ 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. + contain build artifacts and intermediate files. buildbot Batchfiles for running on Windows buildbot workers. @@ -13,7 +13,7 @@ cases_generator A Python tool for providing test cases for Python's parser modul ccbench A Python threads-based concurrency benchmark. (*) clinic Tool for generating C code that interfaces with Python's - C API. + C API. freeze Create a stand-alone executable from a Python program. @@ -34,7 +34,7 @@ msi Support for packaging Python as an MSI package on Windows. nuget A package manager for Microsoft . NET applications. patchcheck Tools for checking and applying patches to the Python source code - and verifying the integrity of patch files. + and verifying the integrity of patch files. peg_generator PEG-based parser generator (pegen) used for new parser. @@ -43,17 +43,14 @@ 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 Tools permit for working with with SSL/TLS encryption in Python, - generating SSL/TLS certificates and keys and testing SSL/TLS - connections and protocols. +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 Python tools offers timezone implementations, generating - timezone information files,converting between different - tz formats, and managing timezone data. +tz A script to dump timezone from /usr/share/zoneinfo. unicode Tools for generating unicodedata and codecs from unicode.org @@ -63,8 +60,8 @@ unicode Tools for generating unicodedata and codecs from unicode.org unittestgui A Tkinter based GUI test runner for unittest, with test discovery. -wasm A Configuration and helpers to facilitate cross compilation - of CPython to WebAssembly (WASM) +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 From f9bf701e9dbac1f01e6337539a064287ca2ddadd Mon Sep 17 00:00:00 2001 From: Missoupro <80458944+Missoupro@users.noreply.github.com> Date: Fri, 17 Mar 2023 12:14:29 +0100 Subject: [PATCH 5/9] Added the suggested changes --- Tools/scripts/README | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/Tools/scripts/README b/Tools/scripts/README index 9e91db6ca9e052..9dbb89a8dae633 100644 --- a/Tools/scripts/README +++ b/Tools/scripts/README @@ -2,13 +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 A script that checks if the pip package manager is installed - and available on the system. +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 the optimal value for the threshold parameter used - by the built-in divmod function +divmod_threshold.py Determine threshold for switching from longobject.c + divmod to _pylong.int_divmod() idle3 Main program to start IDLE pydoc3 Python documentation browser run_tests.py Run the test suite with more sensible default options -summarize_stats.py A script that summarizes the stat generated by the Python profiler. -var_access_benchmark.py A script that benchmarks the performance of accessing variables in different scopes. +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 From 6ccb511630244a700d46fac62a9a1d2d166ba3d5 Mon Sep 17 00:00:00 2001 From: Missoupro <80458944+Missoupro@users.noreply.github.com> Date: Fri, 17 Mar 2023 12:53:47 +0100 Subject: [PATCH 6/9] added all changes suggested --- Tools/README | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Tools/README b/Tools/README index bff7229db7e0b5..09c81e014ce637 100644 --- a/Tools/README +++ b/Tools/README @@ -1,7 +1,7 @@ This directory contains a number of Python programs that are useful while building or extending Python. -.build Automatically generated directory by the build system +build Automatically generated directory by the build system contain build artifacts and intermediate files. buildbot Batchfiles for running on Windows buildbot workers. @@ -12,7 +12,7 @@ cases_generator A Python tool for providing test cases for Python's parser modul ccbench A Python threads-based concurrency benchmark. (*) -clinic Tool for generating C code that interfaces with Python's +clinic Tool for generating C code that interfaces with Python's C API. freeze Create a stand-alone executable from a Python program. From 28e571773e672c81be167b98a92b36e2290e947e Mon Sep 17 00:00:00 2001 From: Missoupro <80458944+Missoupro@users.noreply.github.com> Date: Sun, 26 Mar 2023 12:17:48 +0200 Subject: [PATCH 7/9] Added the new suggestions changes somes descriptions. --- Tools/README | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/Tools/README b/Tools/README index 09c81e014ce637..72d2032f79e55a 100644 --- a/Tools/README +++ b/Tools/README @@ -6,14 +6,15 @@ build Automatically generated directory by the build system buildbot Batchfiles for running on Windows buildbot workers. -c-analyzer CPython's C code makes extensive use of global variables. +c-analyzer Tools to check no new global variables have been added. -cases_generator A Python tool for providing test cases for Python's parser module. +cases_generator Tooling to generate interpreters. ccbench A Python threads-based concurrency benchmark. (*) -clinic Tool for generating C code that interfaces with Python's - C API. +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. @@ -31,7 +32,7 @@ iobench Benchmark for the new Python I/O system. (*) msi Support for packaging Python as an MSI package on Windows. -nuget A package manager for Microsoft . NET applications. +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. From a42027d575bb2ae79e3cb9c963a585f132866730 Mon Sep 17 00:00:00 2001 From: Missoupro <80458944+Missoupro@users.noreply.github.com> Date: Sun, 26 Mar 2023 12:51:07 +0200 Subject: [PATCH 8/9] remove extra blank spaces --- Tools/README | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/Tools/README b/Tools/README index 72d2032f79e55a..9d9845cba8cdc7 100644 --- a/Tools/README +++ b/Tools/README @@ -45,15 +45,13 @@ scripts A number of useful single-file programs, e.g. tabnanny.py to Python 3 code. ssl Scripts to generate ssl_data.h from OpenSSL sources, and run - tests against multiple installations of OpenSSL and LibreSSL. - + 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). From 5a5125b128665aa4f902a71f73a4de0165c43fb7 Mon Sep 17 00:00:00 2001 From: Hugo van Kemenade Date: Thu, 30 Mar 2023 23:18:51 +0300 Subject: [PATCH 9/9] Remove whitespace --- Tools/README | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Tools/README b/Tools/README index 9d9845cba8cdc7..e51624f453c5bb 100644 --- a/Tools/README +++ b/Tools/README @@ -2,7 +2,7 @@ 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. + contain build artifacts and intermediate files. buildbot Batchfiles for running on Windows buildbot workers. @@ -45,7 +45,7 @@ scripts A number of useful single-file programs, e.g. tabnanny.py to Python 3 code. ssl Scripts to generate ssl_data.h from OpenSSL sources, and run - tests against multiple installations of OpenSSL and LibreSSL. + tests against multiple installations of OpenSSL and LibreSSL. stringbench A suite of micro-benchmarks for various operations on strings (both 8-bit and unicode). (*)