-
-
Notifications
You must be signed in to change notification settings - Fork 33.5k
gh-140521: Added comprehensive c4 diagrams #140522
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
gh-140521: Added comprehensive c4 diagrams #140522
Conversation
|
|
||
| This document extends the original C4 model with detailed flowcharts showing the complete execution flow from Python source code to the lowest level, including specific file names and function calls. | ||
|
|
||
| ## Level 1: System Context with Execution Flow |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
|
|
||
| ### Complete Python Code Execution Flow | ||
|
|
||
| ```mermaid |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This also does not render?
StanFromIreland
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a very large PR, please split this up a bit.
| end | ||
|
|
||
| subgraph "CPython System" | ||
| CPY[CPython Interpreter<br/>Python 3.15] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This isn't future proof.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
noted
| CPY -->|"System Calls"| OS | ||
| CPY -->|"File I/O"| FS | ||
| CPY -->|"Network Operations"| NET | ||
| CPY -->|"Imports Modules"| LIB | ||
| CPY -->|"Loads Extensions"| EXT | ||
|
|
||
| OS -->|"Process Management"| CPY | ||
| FS -->|"File Access"| CPY | ||
| NET -->|"Network Data"| CPY | ||
| LIB -->|"Standard Library"| CPY | ||
| EXT -->|"Native Code"| CPY |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't really see what this adds, this is just general information?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The C4 model proposes starting from the top and working its way down to specific implementations Context, Component, Container, Code.
|
Were these generated by an LLM? Which tool? What's the audience for these? Why are they in a top-level c4 directory? |
ZeroIntensity
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is generated by ChatGPT, but anyways, I also agree with @StanFromIreland that this should go on our developer guide rather the CPython repository. Please open a new PR there.
|
It likely shouldn't go anywhere; we don't need this. |
|
This needed a reference to https://c4model.com/ and perhaps https://en.wikipedia.org/wiki/C4_model. Pehaps the model should be an interactive application that can drill down to code modules rather than a set of static images (which would become too large with code diagrams). Perhaps this could be something published on pypi. |

Uh oh!
There was an error while loading. Please reload this page.