Skip to content

Conversation

@savagemechanic
Copy link

@savagemechanic savagemechanic commented Oct 24, 2025

@bedevere-app bedevere-app bot added the docs Documentation in the Doc dir label Oct 24, 2025
@python-cla-bot
Copy link

python-cla-bot bot commented Oct 24, 2025

All commit authors signed the Contributor License Agreement.

CLA signed

@github-project-automation github-project-automation bot moved this to Todo in Docs PRs Oct 24, 2025
@StanFromIreland StanFromIreland changed the title added comprehensive c4 diagrams gh-140521: Added comprehensive c4 diagrams Oct 24, 2025

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This errors?

Image


### Complete Python Code Execution Flow

```mermaid
Copy link
Member

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?

Copy link
Member

@StanFromIreland StanFromIreland left a 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]
Copy link
Member

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.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

noted

Comment on lines +31 to +41
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
Copy link
Member

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?

Copy link
Author

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.

@hugovk
Copy link
Member

hugovk commented Oct 24, 2025

Were these generated by an LLM? Which tool?

What's the audience for these?

Why are they in a top-level c4 directory?

Copy link
Member

@ZeroIntensity ZeroIntensity left a 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.

@ZeroIntensity ZeroIntensity added the pending The issue will be closed if no feedback is provided label Oct 24, 2025
@JelleZijlstra
Copy link
Member

It likely shouldn't go anywhere; we don't need this.

@terryjreedy
Copy link
Member

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting review docs Documentation in the Doc dir pending The issue will be closed if no feedback is provided skip news

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

6 participants