Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork34k
gh-144223: Refactor compileall: improve docstrings, add type hints, comments, and tests#144224
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Conversation
Most changes to Pythonrequire a NEWS entry. Add one using theblurb_it web app or theblurb command-line tool. If this change has little impact on Python users, wait for a maintainer to apply the |
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.
Seemy comment.
I'm not a big fan of adjusting formatting and adding redundant comments here, but I do think adding one-line summaries as docstrings could be helpful.
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
Uh oh!
There was an error while loading.Please reload this page.
Proposal: Refactor compileall module
Related Issue:#144223
This proposal aims to improve the
compileallmodule with:The
compileallmodule is currently not very well documented, which makes it harder for both Python users and contributors to understand and maintain. Improving docstrings, comments, and typing will make the module more accessible and maintainable.No logic changes are intended; this is a pure refactoring and documentation improvement.
Feedback welcome — happy to iterate and split this into smaller PRs if needed.