From afa042512da2de2e9062c5ddc8209888c3887922 Mon Sep 17 00:00:00 2001 From: Tyler Burgee <37166272+TylerBurgee@users.noreply.github.com> Date: Wed, 29 Mar 2023 09:18:36 -0400 Subject: [PATCH 1/5] Update cpython/Tools/README Added all cpython/Tools modules to the README and included descriptions for the following modules: - c-analyzer - cases_generator - importbench - nuget - wasm *Question: Should we remove the parser module from README? I do not see it listed in cpython/Tools anymore. --- Tools/README | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/Tools/README b/Tools/README index 04612b8013db92..6d96be9f655cf4 100644 --- a/Tools/README +++ b/Tools/README @@ -1,10 +1,20 @@ This directory contains a number of Python programs that are useful while building or extending Python. +build ... + buildbot Batchfiles for running on Windows buildbot workers. +c-analyzer Converter functions for primitive type casting and creating + new docstrings. + +cases_generator Parses instruction definitions from Python/bytecodes.c, + writes each generated case to Python/generated_cases.c.h. + ccbench A Python threads-based concurrency benchmark. (*) +clinic ... + freeze Create a stand-alone executable from a Python program. gdb Python code to be run inside gdb, to make it easier to @@ -14,11 +24,20 @@ i18n Tools for internationalization. pygettext.py parses Python source code and generates .pot files, and msgfmt.py generates a binary message catalog from a catalog in text format. + +importbench A set of micro-benchmarks for various import scenarios. + Can be used to to measure impact of possible code changes. iobench Benchmark for the new Python I/O system. (*) msi Support for packaging Python as an MSI package on Windows. +nuget Runs Python tests against multiple installations of OpenSSL + and LibreSSL. Contains tools to download the + OpenSSL/LibreSSL tar bundle. + +patchcheck ... + parser Un-parsing tool to generate code from an AST. peg_generator PEG-based parser generator (pegen) used for new parser. @@ -27,9 +46,13 @@ scripts A number of useful single-file programs, e.g. tabnanny.py by Tim Peters, which checks for inconsistent mixing of tabs and spaces, and 2to3, which converts Python 2 code to Python 3 code. + +ssl ... stringbench A suite of micro-benchmarks for various operations on strings (both 8-bit and unicode). (*) + +tz ... unicode Tools for generating unicodedata and codecs from unicode.org and other mapping files (by Fredrik Lundh, Marc-Andre Lemburg @@ -37,6 +60,9 @@ unicode Tools for generating unicodedata and codecs from unicode.org unittestgui A Tkinter based GUI test runner for unittest, with test discovery. + +wasm Tools for facilitating cross-compilation of CPython to + WebAssmebly (WASM). (*) A generic benchmark suite is maintained separately at https://github.com/python/performance From 765868a11405604dff8ee6eeed5f8d2a094f469e Mon Sep 17 00:00:00 2001 From: "blurb-it[bot]" <43283697+blurb-it[bot]@users.noreply.github.com> Date: Wed, 29 Mar 2023 14:09:20 +0000 Subject: [PATCH 2/5] =?UTF-8?q?=F0=9F=93=9C=F0=9F=A4=96=20Added=20by=20blu?= =?UTF-8?q?rb=5Fit.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- ...23-03-29-14-09-19.gh-issue-102110.TrxywJ.rst | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) create mode 100644 Misc/NEWS.d/next/Documentation/2023-03-29-14-09-19.gh-issue-102110.TrxywJ.rst diff --git a/Misc/NEWS.d/next/Documentation/2023-03-29-14-09-19.gh-issue-102110.TrxywJ.rst b/Misc/NEWS.d/next/Documentation/2023-03-29-14-09-19.gh-issue-102110.TrxywJ.rst new file mode 100644 index 00000000000000..7bbf5a0fd286ce --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2023-03-29-14-09-19.gh-issue-102110.TrxywJ.rst @@ -0,0 +1,17 @@ +Added all cpython/Tools modules to the README and included descriptions for the following modules: +------------------- +- c-analyzer +- cases_generator +- importbench +- nuget +- wasm +------------------- + +Several modules still require descriptions. These modules include the following: +------------------- +- build +- clinic +- patchcheck +- ssl +- tz +------------------- From b21b51c1809a5ab8eb71657a264b4a9c90f70a0f Mon Sep 17 00:00:00 2001 From: Tyler Burgee <37166272+TylerBurgee@users.noreply.github.com> Date: Thu, 30 Mar 2023 09:25:03 -0400 Subject: [PATCH 3/5] Update README Provided descriptions for the remaining modules. Removed parser from README, as this module no longer exists in cpython/Tools. --- Tools/README | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/Tools/README b/Tools/README index 6d96be9f655cf4..66aada110c469c 100644 --- a/Tools/README +++ b/Tools/README @@ -1,7 +1,8 @@ This directory contains a number of Python programs that are useful while building or extending Python. -build ... +build Build-time toolkit for detecting, handling/avoiding + various file and formatting errors. buildbot Batchfiles for running on Windows buildbot workers. @@ -13,7 +14,10 @@ cases_generator Parses instruction definitions from Python/bytecodes.c, ccbench A Python threads-based concurrency benchmark. (*) -clinic ... +clinic Preprocessor for CPython C files. Automates all the + boilerplates involved with writing argument parsing + code for builtins and providing introspection signatures + ("docstrings") for CPython builtins. freeze Create a stand-alone executable from a Python program. @@ -32,13 +36,10 @@ iobench Benchmark for the new Python I/O system. (*) msi Support for packaging Python as an MSI package on Windows. -nuget Runs Python tests against multiple installations of OpenSSL - and LibreSSL. Contains tools to download the - OpenSSL/LibreSSL tar bundle. - -patchcheck ... +nuget Builds NuGet packages for CPython. -parser Un-parsing tool to generate code from an AST. +patchcheck Checks for common issues in the proposed changes of a + given code patch. peg_generator PEG-based parser generator (pegen) used for new parser. @@ -47,12 +48,15 @@ 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 ... +ssl Runs Python tests against multiple installations of OpenSSL + and LibreSSL. Contains tools to download the + OpenSSL/LibreSSL tar bundle. stringbench A suite of micro-benchmarks for various operations on strings (both 8-bit and unicode). (*) -tz ... +tz Time Zone Database (tz) dump module. Enables reading from + /usr/share/zoneinfo to obtain zone data. unicode Tools for generating unicodedata and codecs from unicode.org and other mapping files (by Fredrik Lundh, Marc-Andre Lemburg From 6d0b1534a1d763589819e54ed5e5adac2ff77304 Mon Sep 17 00:00:00 2001 From: Tyler Burgee <37166272+TylerBurgee@users.noreply.github.com> Date: Thu, 30 Mar 2023 10:24:16 -0400 Subject: [PATCH 4/5] Update README --- Tools/README | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Tools/README b/Tools/README index 66aada110c469c..447099dfb372f6 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 Build-time toolkit for detecting, handling/avoiding +build Build-time toolkit for detecting and handling/preventing various file and formatting errors. buildbot Batchfiles for running on Windows buildbot workers. From 761cf562b96b38093908947176d3098c8aa68096 Mon Sep 17 00:00:00 2001 From: Tyler Burgee <37166272+TylerBurgee@users.noreply.github.com> Date: Thu, 30 Mar 2023 10:32:13 -0400 Subject: [PATCH 5/5] Update 2023-03-29-14-09-19.gh-issue-102110.TrxywJ.rst --- ...23-03-29-14-09-19.gh-issue-102110.TrxywJ.rst | 17 ++++++++--------- 1 file changed, 8 insertions(+), 9 deletions(-) diff --git a/Misc/NEWS.d/next/Documentation/2023-03-29-14-09-19.gh-issue-102110.TrxywJ.rst b/Misc/NEWS.d/next/Documentation/2023-03-29-14-09-19.gh-issue-102110.TrxywJ.rst index 7bbf5a0fd286ce..db2fd4cb6c92cf 100644 --- a/Misc/NEWS.d/next/Documentation/2023-03-29-14-09-19.gh-issue-102110.TrxywJ.rst +++ b/Misc/NEWS.d/next/Documentation/2023-03-29-14-09-19.gh-issue-102110.TrxywJ.rst @@ -1,5 +1,11 @@ -Added all cpython/Tools modules to the README and included descriptions for the following modules: +Added descriptions for the folllowing cpython/Tools modules to cpython/Tools/README: + ------------------- +- build +- clinic +- patchcheck +- ssl +- tz - c-analyzer - cases_generator - importbench @@ -7,11 +13,4 @@ Added all cpython/Tools modules to the README and included descriptions for the - wasm ------------------- -Several modules still require descriptions. These modules include the following: -------------------- -- build -- clinic -- patchcheck -- ssl -- tz -------------------- +Removed parser from README, as this module no longer exists in cypthon/Tools.