Skip to content

Add return annotation to __annotations__ last #6071

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

Merged

Conversation

jackoconnordev
Copy link
Contributor

@jackoconnordev jackoconnordev commented Aug 5, 2025

Description

Functions like functools.singledispatch are sensitive to the order of items in the __annotations__ map. CPython puts return types last.

Resolves #6068

Note: I'd prefer to include automated tests from CPython alongside this, but struggled. There are tests from Python 3.13.5's test_importlib/ which will fail without commit, as they make use of singledispatch that would serve to test this code change on every release.

Test script

def func(s: str) -> int:
    return int(s)


print(func.__annotations__)

RustPython before

{'return': <class 'int'>, 's': <class 'str'>, }

## CPython

{'s': <class 'str'>, 'return': <class 'int'>}

RustPython after

{'s': <class 'str'>, 'return': <class 'int'>}

Summary by CodeRabbit

  • New Features
    • Added a Python snippet demonstrating function type annotations and their retrieval, highlighting the importance of annotation order for certain use cases.
  • Refactor
    • Adjusted the processing order of return and parameter annotations during compilation to improve internal handling without affecting functionality.

Functions like `functools.singledispatch` are sensitive to the order of
items in the `__annotations__` map.

CPython puts returns last.
Copy link
Contributor

coderabbitai bot commented Aug 5, 2025

Walkthrough

The change updates the visit_annotations method in the RustPython compiler so that parameter annotations are processed before the return annotation. The method's logic is otherwise unchanged, and its signature remains the same. This change affects only the order in which annotations are compiled and emitted.

Changes

Cohort / File(s) Change Summary
Annotation Order Logic
compiler/codegen/src/compile.rs
Adjusted order in visit_annotations to process parameter annotations before the return annotation. No other logic or signature changes.
Annotation Order Test Snippet
extra_tests/snippets/syntax_annotations.py
Added Python snippet defining a function with parameter and return type annotations; asserts correct order of type hints matching CPython behavior.

Sequence Diagram(s)

sequenceDiagram
    participant Compiler
    participant Parameters
    participant Expr (Return Annotation)

    Compiler->>Parameters: Iterate parameter annotations
    loop For each parameter
        Compiler->>Parameters: Compile annotation
    end
    alt If return annotation exists
        Compiler->>Expr: Compile return annotation
    end
    Compiler-->>Compiler: Return total annotation count
Loading

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Assessment against linked issues

Objective Addressed Explanation
Ensure function __annotations__ item order matches CPython: parameters first, then return (#6068)

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Poem

A hop and a skip, the order is new,
Parameters first, as Python would do.
Return comes last, just as it should,
Now singledispatch will work as it could.
🐇✨
Rust and Python, in harmony,
Annotations aligned—code jubilee!

Note

🔌 MCP (Model Context Protocol) integration is now available in Early Access!

Pro users can now connect to remote MCP servers under the Integrations page to get reviews and chat conversations that understand additional development context.


📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between f51bdab and a04f2f4.

📒 Files selected for processing (1)
  • extra_tests/snippets/syntax_annotations.py (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • extra_tests/snippets/syntax_annotations.py
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (10)
  • GitHub Check: Run snippets and cpython tests on wasm-wasi
  • GitHub Check: Check the WASM package and demo
  • GitHub Check: Run rust tests (ubuntu-latest)
  • GitHub Check: Run rust tests (macos-latest)
  • GitHub Check: Check Rust code with rustfmt and clippy
  • GitHub Check: Run rust tests (windows-latest)
  • GitHub Check: Run snippets and cpython tests (ubuntu-latest)
  • GitHub Check: Ensure compilation on various targets
  • GitHub Check: Run snippets and cpython tests (windows-latest)
  • GitHub Check: Run snippets and cpython tests (macos-latest)
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@youknowone
Copy link
Member

Thank you so much! To prevent regression, could you add a test about this? Adding the code described in the issue to snippets/extra_tests/syntax_annotations.py will be one of the ways.

@jackoconnordev
Copy link
Contributor Author

Can do 🫡

@jackoconnordev jackoconnordev force-pushed the return-type-at-end-of-annotations branch from f51bdab to a04f2f4 Compare August 8, 2025 11:58
Copy link
Member

@youknowone youknowone left a comment

Choose a reason for hiding this comment

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

Thank you!

@youknowone youknowone merged commit 33ea50c into RustPython:main Aug 8, 2025
12 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.

Function __annotations__ item order does not match CPython
2 participants