From 73a4372bc0a146a6a000dd1a78ea4dceb7d6f6b1 Mon Sep 17 00:00:00 2001 From: Shuo <115667535+Szhenger@users.noreply.github.com> Date: Fri, 15 May 2026 22:19:04 -0400 Subject: [PATCH 1/7] Update README with details on CPython internals --- Python/README | 1 - Python/README.md | 3 +++ 2 files changed, 3 insertions(+), 1 deletion(-) delete mode 100644 Python/README create mode 100644 Python/README.md diff --git a/Python/README b/Python/README deleted file mode 100644 index 153b628bd5b42d6..000000000000000 --- a/Python/README +++ /dev/null @@ -1 +0,0 @@ -Miscellaneous source files for the main Python shared library diff --git a/Python/README.md b/Python/README.md new file mode 100644 index 000000000000000..8a08e10c35e68d2 --- /dev/null +++ b/Python/README.md @@ -0,0 +1,3 @@ +Miscellaneous source files for the compiler and runtime execution logic of the CPython interpreter. +* For high-level architecture, see the Python Developer's Guide on [CPython's internals](https://devguide.python.org/internals/). +* For technical deep-dives, see the `InternalDocs` directory and read the [InternalDocs/interpreter.md](../InternalDocs/interpreter.md) file. From 2462b524d4f6ff899f366d2f464f496ae42f28d0 Mon Sep 17 00:00:00 2001 From: "blurb-it[bot]" <43283697+blurb-it[bot]@users.noreply.github.com> Date: Sat, 16 May 2026 02:31:06 +0000 Subject: [PATCH 2/7] =?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 --- .../2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 Misc/NEWS.d/next/Documentation/2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst diff --git a/Misc/NEWS.d/next/Documentation/2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst b/Misc/NEWS.d/next/Documentation/2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst new file mode 100644 index 000000000000000..b81242a7e0da198 --- /dev/null +++ b/Misc/NEWS.d/next/Documentation/2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst @@ -0,0 +1,9 @@ +Technical Documentation: Extended Python/README and convert to Markdown +* Updated the Python/ directory README to provide more context on the compiler and runtime execution logic. +* Converted the file to README.md to support hyperlinking to the Python DevGuide and internal documentation. +* Added relative links to the InternalDocs directory. + + + +* Issue: gh-149906 + From 9b47ca692bde8435c3c8fc6b827806cd06fa4006 Mon Sep 17 00:00:00 2001 From: Shuo <115667535+Szhenger@users.noreply.github.com> Date: Fri, 15 May 2026 22:42:44 -0400 Subject: [PATCH 3/7] Fix formatting in README.md --- Python/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Python/README.md b/Python/README.md index 8a08e10c35e68d2..5f5a3b33a905593 100644 --- a/Python/README.md +++ b/Python/README.md @@ -1,3 +1,3 @@ -Miscellaneous source files for the compiler and runtime execution logic of the CPython interpreter. +Miscellaneous source files for the compiler and runtime execution logic of the CPython interpreter. * For high-level architecture, see the Python Developer's Guide on [CPython's internals](https://devguide.python.org/internals/). * For technical deep-dives, see the `InternalDocs` directory and read the [InternalDocs/interpreter.md](../InternalDocs/interpreter.md) file. From 59336904e20c6343706a60c1db0a65fce2dc32fa Mon Sep 17 00:00:00 2001 From: Shuo <115667535+Szhenger@users.noreply.github.com> Date: Fri, 15 May 2026 22:46:11 -0400 Subject: [PATCH 4/7] Enhance Python README and convert to Markdown Updated the Python README to enhance context and converted it to Markdown for better hyperlinking. --- .../2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst | 8 -------- 1 file changed, 8 deletions(-) diff --git a/Misc/NEWS.d/next/Documentation/2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst b/Misc/NEWS.d/next/Documentation/2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst index b81242a7e0da198..d3f5a12faa99758 100644 --- a/Misc/NEWS.d/next/Documentation/2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst +++ b/Misc/NEWS.d/next/Documentation/2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst @@ -1,9 +1 @@ -Technical Documentation: Extended Python/README and convert to Markdown -* Updated the Python/ directory README to provide more context on the compiler and runtime execution logic. -* Converted the file to README.md to support hyperlinking to the Python DevGuide and internal documentation. -* Added relative links to the InternalDocs directory. - - -* Issue: gh-149906 - From 35ac7e75155910c3d6d1f56e5948e2f779335d8f Mon Sep 17 00:00:00 2001 From: Shuo <115667535+Szhenger@users.noreply.github.com> Date: Fri, 15 May 2026 22:49:22 -0400 Subject: [PATCH 5/7] Update Python README to Markdown with additional links Updated the Python/ directory README to provide more context on the compiler and runtime execution logic. Converted the file to README.md to support hyperlinking to the Python DevGuide and internal documentation, and added relative links to the InternalDocs directory. --- .../2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/Misc/NEWS.d/next/Documentation/2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst b/Misc/NEWS.d/next/Documentation/2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst index d3f5a12faa99758..c880aadb829fd79 100644 --- a/Misc/NEWS.d/next/Documentation/2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst +++ b/Misc/NEWS.d/next/Documentation/2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst @@ -1 +1,7 @@ - +Technical Documentation: Extended Python/README and convert to Markdown +* Updated the Python/ directory README to provide more context on the compiler and runtime execution logic. +* Converted the file to README.md to support hyperlinking to the Python DevGuide and internal documentation. +* Added relative links to the InternalDocs directory. + +* Issue: gh-149906 + From c560002e75f94f5e3e3b397b0e6c047550ff03be Mon Sep 17 00:00:00 2001 From: Shuo <115667535+Szhenger@users.noreply.github.com> Date: Sat, 16 May 2026 01:32:30 -0400 Subject: [PATCH 6/7] Delete Misc/NEWS.d/next/Documentation/2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst --- .../2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst | 7 ------- 1 file changed, 7 deletions(-) delete mode 100644 Misc/NEWS.d/next/Documentation/2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst diff --git a/Misc/NEWS.d/next/Documentation/2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst b/Misc/NEWS.d/next/Documentation/2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst deleted file mode 100644 index c880aadb829fd79..000000000000000 --- a/Misc/NEWS.d/next/Documentation/2026-05-16-02-31-05.gh-issue-149906.8T5RhO.rst +++ /dev/null @@ -1,7 +0,0 @@ -Technical Documentation: Extended Python/README and convert to Markdown -* Updated the Python/ directory README to provide more context on the compiler and runtime execution logic. -* Converted the file to README.md to support hyperlinking to the Python DevGuide and internal documentation. -* Added relative links to the InternalDocs directory. - -* Issue: gh-149906 - From 5233b55c0343bcea612defc207dd9b6be9c32f09 Mon Sep 17 00:00:00 2001 From: Shuo <115667535+Szhenger@users.noreply.github.com> Date: Sat, 16 May 2026 01:47:56 -0400 Subject: [PATCH 7/7] Clarify README descriptions for compiler and interpreter Updated wording for clarity in README. --- Python/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/Python/README.md b/Python/README.md index 5f5a3b33a905593..ceafe8c4878c42c 100644 --- a/Python/README.md +++ b/Python/README.md @@ -1,3 +1,3 @@ Miscellaneous source files for the compiler and runtime execution logic of the CPython interpreter. -* For high-level architecture, see the Python Developer's Guide on [CPython's internals](https://devguide.python.org/internals/). -* For technical deep-dives, see the `InternalDocs` directory and read the [InternalDocs/interpreter.md](../InternalDocs/interpreter.md) file. +* For high-level compiler architecture, see the compiler design at [InternalDocs/compiler.md](../InternalDocs/compiler.md). +* For technical details on the interpreter, see the bytecode interpreter at [InternalDocs/interpreter.md](../InternalDocs/interpreter.md).