cpython/InternalDocs/README.md

43 lines
1.0 KiB
Markdown
Raw Normal View History

# CPython Internals Documentation
The documentation in this folder is intended for CPython maintainers.
It describes implementation details of CPython, which should not be
assumed to be part of the Python language specification. These details
can change between any two CPython versions and should not be assumed
to hold for other implementations of the Python language.
The core dev team attempts to keep this documentation up to date. If
it is not, please report that through the
[issue tracker](https://github.com/python/cpython/issues).
Compiling Python Source Code
---
- [Guide to the parser](parser.md)
gh-119786: copy compiler doc from devguide to InternalDocs and convert to markdown (#120134) * gh-119876: move compiler doc from devguide to InternalDocs Copy of https://github.com/python/devguide/commit/78fc0d7aa9fd0d6733d10c23b178b2a0e2799afc Co-Authored-By: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-Authored-By: Adam Turner <9087854+aa-turner@users.noreply.github.com> Co-Authored-By: Brett Cannon <brett@python.org> Co-Authored-By: Carol Willing <carolcode@willingconsulting.com> Co-Authored-By: Daniel Porteous <danielporteous1@gmail.com> Co-Authored-By: Dennis Sweeney <36520290+sweeneyde@users.noreply.github.com> Co-Authored-By: Éric Araujo <merwok@netwok.org> Co-Authored-By: Erlend Egeberg Aasland <erlend.aasland@innova.no> Co-Authored-By: Ezio Melotti <ezio.melotti@gmail.com> Co-Authored-By: Georg Brandl <georg@python.org> Co-Authored-By: Guido van Rossum <guido@python.org> Co-Authored-By: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-Authored-By: Irit Katriel <1055913+iritkatriel@users.noreply.github.com> Co-Authored-By: Jeff Allen <ja.py@farowl.co.uk> Co-Authored-By: Jim Fasarakis-Hilliard <d.f.hilliard@gmail.com> Co-Authored-By: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com> Co-Authored-By: Lincoln <71312724+Lincoln-developer@users.noreply.github.com> Co-Authored-By: Mariatta <Mariatta@users.noreply.github.com> Co-Authored-By: Muhammad Mahad <mahadpy@gmail.com> Co-Authored-By: Ned Deily <nad@acm.org> Co-Authored-By: Pablo Galindo Salgado <Pablogsal@gmail.com> Co-Authored-By: Serhiy Storchaka <storchaka@gmail.com> Co-Authored-By: Stéphane Wirtel <stephane@wirtel.be> Co-Authored-By: Suriyaa ✌️️ <isc.suriyaa@gmail.com> Co-Authored-By: Zachary Ware <zachary.ware@gmail.com> Co-Authored-By: psyker156 <242220+psyker156@users.noreply.github.com> Co-Authored-By: slateny <46876382+slateny@users.noreply.github.com> Co-Authored-By: svelankar <17737361+svelankar@users.noreply.github.com> Co-Authored-By: zikcheng <surfingbyte@gmail.com> * convert to markdown * add to index * update more of the out of date stuff --------- Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Brett Cannon <brett@python.org> Co-authored-by: Carol Willing <carolcode@willingconsulting.com> Co-authored-by: Daniel Porteous <danielporteous1@gmail.com> Co-authored-by: Dennis Sweeney <36520290+sweeneyde@users.noreply.github.com> Co-authored-by: Éric Araujo <merwok@netwok.org> Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no> Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com> Co-authored-by: Georg Brandl <georg@python.org> Co-authored-by: Guido van Rossum <guido@python.org> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Jeff Allen <ja.py@farowl.co.uk> Co-authored-by: Jim Fasarakis-Hilliard <d.f.hilliard@gmail.com> Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com> Co-authored-by: Lincoln <71312724+Lincoln-developer@users.noreply.github.com> Co-authored-by: Mariatta <Mariatta@users.noreply.github.com> Co-authored-by: Muhammad Mahad <mahadpy@gmail.com> Co-authored-by: Ned Deily <nad@acm.org> Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com> Co-authored-by: Serhiy Storchaka <storchaka@gmail.com> Co-authored-by: Stéphane Wirtel <stephane@wirtel.be> Co-authored-by: Suriyaa ✌️️ <isc.suriyaa@gmail.com> Co-authored-by: Zachary Ware <zachary.ware@gmail.com> Co-authored-by: psyker156 <242220+psyker156@users.noreply.github.com> Co-authored-by: slateny <46876382+slateny@users.noreply.github.com> Co-authored-by: svelankar <17737361+svelankar@users.noreply.github.com> Co-authored-by: zikcheng <surfingbyte@gmail.com>
2024-06-10 15:15:12 +00:00
- [Compiler Design](compiler.md)
Runtime Objects
---
- [Code Objects (coming soon)](code_objects.md)
- [The Source Code Locations Table](locations.md)
- [Generators (coming soon)](generators.md)
- [Frames](frames.md)
Program Execution
---
- [The Interpreter](interpreter.md)
- [Adaptive Instruction Families](adaptive.md)
- [Garbage Collector Design](garbage_collector.md)
- [Exception Handling](exception_handling.md)