Fix module docstring global name resolution by teddygood · Pull Request #9095 · RustPython/RustPython

teddygood · 2026-10-13T12:15:34Z

Closes #xxxx

One of checkbox below must be checked.

I did not use AI to write the code of this patch.
This PR follows our AI policy

Summary

compile_program stored the module docstring with a hard-coded StoreName, so a global __doc__ declaration in a nested function was ignored. Any other name in the same position follows the declaration.

src = '"module doc"\nx = 1\ndef f():\n    global __doc__, x\n'
g, loc = {}, {}
exec(compile(src, "<demo>", "exec"), g, loc)
print("x:", "x" in g, "x" in loc)
print("__doc__:", "__doc__" in g, "__doc__" in loc)

Before:

x: True False
__doc__: False True

After (same as CPython 3.15):

x: True False
__doc__: True False

The docstring is now stored through store_name, like every other module-level assignment. Without such a declaration the emitted instruction is unchanged.

AI assistance

Written with Claude (Opus 5.5), reviewed by a human before submission.

Summary by CodeRabbit

Bug Fixes
- Fixed module docstrings being stored in the wrong namespace when a nested function declares global __doc__.
- Module docstrings now follow normal name-resolution behavior, including when compilation uses optimization.

coderabbitai · 2026-10-13T12:16:21Z

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository: RustPython/RustPython/.coderabbit.yml
Review profile: CHILL
Plan: Advanced
Run ID: 8f2e6f95-b1fb-4d62-ad33-b4cfad4a239e

📥 Commits

Reviewing files that changed from the base of the PR and between 11b9773 and d9998e3.

📒 Files selected for processing: 1

extra_tests/snippets/syntax_doc.py

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 9 remain after this review.

📝 Walkthrough

Module docstring storage now uses normal name resolution. Compiler and snippet tests cover global and local storage, nested declarations, optimization levels, and class docstrings.

Changes: Module docstring name resolution

Layer / File(s)	Summary
Resolve module docstring stores `crates/codegen/src/compile.rs`, `extra_tests/snippets/syntax_doc.py`	The compiler resolves the module `__doc__` store through `store_name`. Tests check global versus local storage, nested `global __doc__` declarations, optimization levels, and class docstrings.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Bug fix

Suggested reviewers: youknowone

Merge Risk: ⚪ Minimal · up to d9998

The change makes module docstrings honor a nested global doc declaration, and the added tests cover the expected cases. No merge-blocking issues were found.

Pre-merge checks: 4 · 1

Failed checks: 1 warning

Check name	Status	Explanation	Resolution
Docstring Coverage		Docstring coverage is 20.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 5 functions across 2 files.	Write docstrings for the functions missing them to satisfy the coverage threshold.

Passed checks: 4 passed

Check name	Status	Explanation
Description Check		Check skipped - CodeRabbit’s high-level summary is enabled.
Title check		The title clearly and concisely describes the main change: correcting module docstring global name resolution.
Linked Issues check		Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check		Check skipped because no linked issues were found for this pull request.

Fix all pre-merge checks with AI

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create a new PR

Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands.}

chatgpt-codex-connector · 2026-10-13T12:19:55Z

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review	Status	Commit	Review trigger
📝 Code Review	✅ Completed 2026-10-15T11:39:44.670343Z	`d9998e3`	New commits

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

teddygood · 2026-10-14T02:12:56Z

oh I just saw the pr you mentioned. Sorry if you were already working on this. Please let me know if there's any overlap with your work.

youknowone · 2026-10-15T01:25:58Z

@teddygood This PR is mentioned as seperated independent patch. Please go ahead, thanks!

Assisted-by: Claude Code:claude-opus-5-5

chatgpt-codex-connector · 2026-10-15T04:27:36Z

Codex usage limits have been reached for code reviews. Please check with the admins of this repo to increase the limits by adding credits.
Credits must be used to enable repository wide code reviews.

youknowone

thanks!

youknowone · 2026-10-15T06:08:08Z

let's add this test to extra_tests/snippets/syntax_doc.py

Moved it into syntax_doc.py, thanks!

Assisted-by: Claude Code:claude-opus-5-5

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: d9998e3369

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector · 2026-10-15T11:39:42Z

+src_global = '"module doc"\ndef f():\n    global __doc__\n'
+code, g, loc = run_split(src_global)
+ops = opnames(code)
+assert "STORE_GLOBAL" in ops, ops


Remove the prohibited test-logic additions

This adds a new assertion, and the surrounding regression block adds new test logic and data, to extra_tests/snippets/syntax_doc.py. The repository rules explicitly forbid modifying test assertions, logic, or data and state that only expectedFailure decorator changes are acceptable, so this test block must be removed rather than landed with the Rust fix.

AGENTS.md reference: AGENTS.md:L275-L279

Useful? React with 👍 / 👎.

github-actions Bot added the z-ca-2026 Tag to track Contribution Academy 2026 label Oct 13, 2026

github-actions Bot assigned teddygood Oct 13, 2026

youknowone mentioned this pull request Oct 13, 2026

Align compiler and VM bytecode contracts with CPython 3.15 #9088

Closed

1 task done

Fix module docstring global name resolution

11b9773

Assisted-by: Claude Code:claude-opus-5-5

teddygood force-pushed the fix-module-docstring-global branch from b3ea04e to 11b9773 Compare October 15, 2026 04:27

youknowone requested changes Oct 15, 2026

View reviewed changes

Move module docstring test into syntax_doc.py

d9998e3

Assisted-by: Claude Code:claude-opus-5-5

chatgpt-codex-connector Bot reviewed Oct 15, 2026

View reviewed changes

youknowone approved these changes Oct 15, 2026

View reviewed changes

youknowone merged commit e01021b into RustPython:main Oct 15, 2026
8 checks passed

Navigation Menu

Repository navigation

Fix module docstring global name resolution - #9095

Fix module docstring global name resolution#9095
youknowone merged 2 commits into
RustPython:mainfrom
teddygood:fix-module-docstring-global

teddygood commented Oct 13, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

coderabbitai Bot commented Oct 13, 2026 •

edited

Loading

Uh oh!

chatgpt-codex-connector Bot commented Oct 13, 2026 •

edited

Loading

Uh oh!

teddygood commented Oct 14, 2026

Uh oh!

youknowone commented Oct 15, 2026

Uh oh!

chatgpt-codex-connector Bot commented Oct 15, 2026

Uh oh!

youknowone left a comment

Uh oh!

youknowone Oct 15, 2026

Uh oh!

teddygood Oct 15, 2026

Uh oh!

chatgpt-codex-connector Bot left a comment

Uh oh!

chatgpt-codex-connector Bot Oct 15, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

teddygood commented Oct 13, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

AI assistance

Summary by CodeRabbit

Uh oh!

coderabbitai Bot commented Oct 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chatgpt-codex-connector Bot commented Oct 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codex Review Summary

Uh oh!

teddygood commented Oct 14, 2026

Uh oh!

youknowone commented Oct 15, 2026

Uh oh!

chatgpt-codex-connector Bot commented Oct 15, 2026

Uh oh!

youknowone left a comment

Choose a reason for hiding this comment

Uh oh!

youknowone Oct 15, 2026

Choose a reason for hiding this comment

Uh oh!

teddygood Oct 15, 2026

Choose a reason for hiding this comment

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

chatgpt-codex-connector Bot Oct 15, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

teddygood commented Oct 13, 2026 •

edited by coderabbitai Bot

Loading

coderabbitai Bot commented Oct 13, 2026 •

edited

Loading

chatgpt-codex-connector Bot commented Oct 13, 2026 •

edited

Loading