Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Fix PyFunction doc behavior #5827

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 23, 2025
Merged

Fix PyFunction doc behavior #5827

merged 1 commit into from
Jun 23, 2025
+100 −14

Conversation

youknowone
Copy link
Member

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

Summary by CodeRabbit

  • New Features

    • Improved handling and customization of class and function documentation strings (__doc__), including support for dynamic docstring retrieval and setting on classes and functions.
    • Enhanced compatibility with standard Python behavior when accessing or modifying __doc__ attributes.

  • Bug Fixes

    • Prevented overwriting of existing class __doc__ attributes during class extension, ensuring correct documentation display.
    • Fixed behavior when accessing member descriptors and function docstrings from classes, returning appropriate values or None as expected.

  • Tests

    • Added an assertion to verify the correct format of lambda function type documentation.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jun 23, 2025 •
edited
Loading

Walkthrough

The updates introduce refined handling of the __doc__ attribute for functions, types, and member descriptors within the Python VM implementation. Conditional logic now distinguishes between class and instance attribute access, prevents overwriting existing docs, and processes internal documentation strings to remove function signatures. A new test assertion checks lambda docstring formatting. Additionally, some test methods previously marked as expected failures are now enabled.

Changes

File(s) Change Summary
extra_tests/snippets/syntax_function2.py Added assertion to verify lambda function's type docstring format.
vm/src/builtins/descriptor.rs Enhanced PyMemberDescriptor's descr_get to return class attribute matching descriptor name when accessed on class. Renamed parameter _cls to cls.
vm/src/builtins/function.rs Modified PyFunction's doc to return Python None when accessed from class instead of panicking.
vm/src/builtins/type.rs Added helper to strip signatures from internal docs; implemented __doc__ getter and setter for PyType.
vm/src/class.rs Changed class extension logic to avoid overwriting an existing __doc__ attribute during class creation.
Lib/test/test_funcattrs.py Removed @unittest.expectedFailure decorators from two test methods, enabling them.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant VM
    participant PyType
    participant PyFunction
    participant PyMemberDescriptor

    User->>VM: Access obj.__doc__
    alt obj is PyFunction (instance)
        VM->>PyFunction: Attempt downcast to PyFunction
        PyFunction-->>VM: Return cloned doc string
    else obj is PyFunction (class) or other
        VM->>PyFunction: Downcast fails
        VM-->>User: Return None
    else obj is PyMemberDescriptor with obj=None
        VM->>PyMemberDescriptor: Check cls attribute dictionary for member name
        alt attribute found
            PyMemberDescriptor-->>VM: Return class attribute
        else
            PyMemberDescriptor-->>VM: Return descriptor itself
        end
    else obj is PyMemberDescriptor with obj=Some
        PyMemberDescriptor-->>VM: Return member value
    else obj is PyType
        VM->>PyType: Get __doc__ property
        alt internal doc with signature
            PyType->>VM: Return stripped doc string
        else
            PyType->>VM: Lookup __doc__ in attributes
        end
    end
    VM-->>User: Return doc string or None
Loading

Poem

In the land where docstrings dwell,
A rabbit hops to check them well.
From functions, types, and classes too,
The docs are fresher, clear, and true!
No more overwrites—just gentle care,
With signatures trimmed, they're light as air.
🐇✨

📜 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 8d8e85b and 5c10d4f.

📒 Files selected for processing (6)
  • Lib/test/test_funcattrs.py (0 hunks)
  • extra_tests/snippets/syntax_function2.py (1 hunks)
  • vm/src/builtins/descriptor.rs (1 hunks)
  • vm/src/builtins/function.rs (1 hunks)
  • vm/src/builtins/type.rs (2 hunks)
  • vm/src/class.rs (1 hunks)
💤 Files with no reviewable changes (1)
  • Lib/test/test_funcattrs.py
🚧 Files skipped from review as they are similar to previous changes (5)
  • extra_tests/snippets/syntax_function2.py
  • vm/src/class.rs
  • vm/src/builtins/descriptor.rs
  • vm/src/builtins/type.rs
  • vm/src/builtins/function.rs
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: Run snippets and cpython tests on wasm-wasi
  • GitHub Check: Run tests under miri
  • GitHub Check: Check the WASM package and demo
  • GitHub Check: Run snippets and cpython tests (ubuntu-latest)
  • GitHub Check: Check Rust code with rustfmt and clippy
  • GitHub Check: Run snippets and cpython tests (windows-latest)
  • GitHub Check: Run snippets and cpython tests (macos-latest)
  • GitHub Check: Run rust tests (windows-latest)
  • GitHub Check: Run rust tests (macos-latest)
  • GitHub Check: Run rust tests (ubuntu-latest)
  • GitHub Check: Ensure compilation on various targets
✨ 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 52301dd into RustPython:main Jun 23, 2025
12 checks passed
@youknowone youknowone deleted the function-docs branch June 23, 2025 13:37
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