Skip to content
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

Architecture overview #2528

Merged
merged 6 commits into from Jun 11, 2023

Conversation

TheOnlyError
Copy link
Contributor

Adds the architecture document as proposed by #2524.

This PR serves as a place for discussion regarding updates, suggestions and improvements 😃.

@DimitrisJim
Copy link
Member

DimitrisJim commented Aug 2, 2021

Wouldn't this be a suitable document to be placed on the rustpython web page? The docs repo looks like it would be good candidate.

@youknowone
Copy link
Member

@DimitrisJim I agree. Would you please review it?

architecture/architecture.md Outdated Show resolved Hide resolved
Some things to note:

- The CLI is defined in `src/lib.rs@run`
- The interface and helper for the REPL are defined in this package, but the actual REPL can be found in `vm/rustyline.rs`
Copy link
Member

Choose a reason for hiding this comment

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

it's vm/src/readline.rs (now, at least).

architecture/architecture.md Outdated Show resolved Hide resolved
architecture/architecture.md Outdated Show resolved Hide resolved
Copy link
Member

@DimitrisJim DimitrisJim left a comment

Choose a reason for hiding this comment

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

finally got to this 😄 I think this does offer value in this repo, thanks (very belatedly!) for the PR!

Copy link
Contributor

@fanninpm fanninpm left a comment

Choose a reason for hiding this comment

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

A few nitpicks, mostly non-blocking.

architecture/architecture.md Outdated Show resolved Hide resolved
architecture/architecture.md Outdated Show resolved Hide resolved

A high-level overview of the workings of RustPython is visible in the figure below, showing how Python source files are interpreted.

![overview.png](overview.png)
Copy link
Contributor

Choose a reason for hiding this comment

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

You might want to consider rewriting this diagram in Mermaid.

Copy link
Member

Choose a reason for hiding this comment

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

that's wild. +1 but can probably leave this for a later point.

architecture/architecture.md Outdated Show resolved Hide resolved
Co-authored-by: fanninpm <fanninpm@miamioh.edu>
@DimitrisJim DimitrisJim merged commit 4721b7d into RustPython:main Jun 11, 2023
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants