Skip to content

classmethod copy attrs #5831

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jun 24, 2025
Merged

classmethod copy attrs #5831

merged 1 commit into from
Jun 24, 2025

Conversation

youknowone
Copy link
Member

@youknowone youknowone commented Jun 24, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Bug Fixes
    • Updated class method handling to preserve key metadata attributes such as documentation, name, qualified name, module, and annotations, ensuring better compatibility with Python standards.
  • Tests
    • Changed a class method test from an expected failure to a normal test, reflecting improved functionality.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jun 24, 2025 •
edited
Loading

Walkthrough

The changes remove the @unittest.expectedFailure decorator from a test method in Lib/test/test_descr.py and update the PyClassMethod constructor in Rust to copy multiple metadata attributes from the callable to the classmethod object, enhancing metadata preservation.

Changes

File(s) Change Summary
Lib/test/test_descr.py Removed @unittest.expectedFailure decorator and related comment from test_classmethods.
vm/src/builtins/classmethod.rs Updated PyClassMethod constructor to copy __doc__, __name__, __qualname__, __module__, and __annotations__ attributes from the callable to the classmethod instance dictionary.

Sequence Diagram(s)

sequenceDiagram
    participant TestRunner
    participant test_classmethods
    participant PyClassMethod.py_new
    participant Callable

    TestRunner->>test_classmethods: Run test (no longer expected failure)
    test_classmethods->>PyClassMethod.py_new: Create classmethod with Callable
    PyClassMethod.py_new->>Callable: Retrieve __doc__, __name__, __qualname__, __module__, __annotations__
    PyClassMethod.py_new->>PyClassMethod.py_new: Populate instance dict with attributes
    PyClassMethod.py_new-->>test_classmethods: Return classmethod instance with metadata
Loading

Possibly related PRs

  • Unmark fixed tests #5818: Both PRs remove the @unittest.expectedFailure decorator from different test methods within the same test class ClassPropertiesAndMethods in Lib/test/test_descr.py, indicating related changes focused on unmarking fixed tests.

Poem

🐇
A decorator hops away,
As classmethods learn to play.
With docs and names they now appear,
Their metadata held so dear.
The tests now run, no need to fear—
Rust and Python, drawing near!

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 638d218 and dcb8fb4.

📒 Files selected for processing (2)
  • Lib/test/test_descr.py (0 hunks)
  • vm/src/builtins/classmethod.rs (1 hunks)
💤 Files with no reviewable changes (1)
  • Lib/test/test_descr.py
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.rs`: Follow the default rustfmt code style; use 'cargo fmt' to format Rust code. Always run clippy to lint Rust code ('cargo clippy') before completing tasks, and fix any war...

**/*.rs: Follow the default rustfmt code style; use 'cargo fmt' to format Rust code.
Always run clippy to lint Rust code ('cargo clippy') before completing tasks, and fix any warnings or lints introduced by your changes.

  • vm/src/builtins/classmethod.rs
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: Run tests under miri
  • GitHub Check: Check Rust code with rustfmt and clippy
  • GitHub Check: Check the WASM package and demo
  • GitHub Check: Run snippets and cpython tests on wasm-wasi
  • GitHub Check: Run rust tests (windows-latest)
  • GitHub Check: Run rust tests (macos-latest)
  • GitHub Check: Run rust tests (ubuntu-latest)
  • GitHub Check: Run snippets and cpython tests (ubuntu-latest)
  • GitHub Check: Run snippets and cpython tests (windows-latest)
  • GitHub Check: Ensure compilation on various targets
  • GitHub Check: Run snippets and cpython tests (macos-latest)
🔇 Additional comments (2)
vm/src/builtins/classmethod.rs (2)

70-89: LGTM! Proper implementation of metadata preservation.

The attribute copying logic correctly implements functools.wraps-like behavior for classmethods. The use of if let Ok(...) pattern gracefully handles missing attributes, and the ? operator ensures proper error propagation if dictionary operations fail.

The attributes being copied (__doc__, __name__, __qualname__, __module__, __annotations__) are the standard Python function metadata attributes that should be preserved on wrapper objects.

92-97: Instance creation properly uses the pre-populated dictionary.

The PyClassMethod instance is correctly created with the dictionary containing the copied attributes, ensuring the metadata is accessible directly on the classmethod object.

✨ Finishing Touches
  • 📝 Generate Docstrings

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.
    • @coderabbitai modularize this function.
  • 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.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

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

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

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 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.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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 youknowone merged commit a8c9703 into RustPython:main Jun 24, 2025
11 of 12 checks passed
@youknowone youknowone deleted the classmethod branch June 24, 2025 08:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@youknowone