Skip to content

type.__type_params__ #5882

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
merged 2 commits into from
Jul 1, 2025
Merged

type.__type_params__ #5882

merged 2 commits into from
Jul 1, 2025

Conversation

youknowone
Copy link
Member

@youknowone youknowone commented Jul 1, 2025

Summary by CodeRabbit

  • New Features

    • Added a new managed property __type_params__ to types, allowing controlled access and assignment of type parameters.
  • Improvements

    • Enhanced handling of starred expressions in type annotations to better support advanced typing features.
  • Chores

    • Updated spell checker configuration to ignore all files and directories under any target directory.

Copy link

coderabbitai bot commented Jul 1, 2025

Walkthrough

The changes introduce a new property __type_params__ with getter and setter methods to the PyType class, add logic to handle starred expressions in type annotations within the compiler, and update the spell checker configuration to ignore files in target directories. No changes were made to public APIs.

Changes

File(s) Change Summary
.cspell.json Added "target/**" to ignorePaths to exclude target directories from spell checking.
compiler/codegen/src/compile.rs Updated compile_annotation to handle starred expressions in type annotations, emitting UnpackSequence.
vm/src/builtins/type.rs, vm/src/vm/context.rs Added __type_params__ property with getter and setter to PyType, enforcing tuple type and disallowing delete; added __type_params__ constant name to VM context.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Compiler
    participant Bytecode

    User->>Compiler: Provide annotation (possibly starred)
    Compiler->>Compiler: Check if annotation is starred
    alt Starred Expression
        Compiler->>Compiler: Compile inner value
        Compiler->>Bytecode: Emit UnpackSequence(1)
    else Non-starred
        Compiler->>Bytecode: Compile annotation directly
    end
Loading
sequenceDiagram
    participant User
    participant PyType

    User->>PyType: Get __type_params__
    PyType->>PyType: Return tuple if exists, else empty tuple

    User->>PyType: Set __type_params__ (to tuple)
    PyType->>PyType: Store tuple

    User->>PyType: Delete __type_params__
    PyType->>User: Raise TypeError
Loading

Poem

In the warren, code hops anew,
Type params guarded, as rabbits do.
Starred annotations now unpack with flair,
While spell-checkers skip targets with care.
A tuple of changes, neat and bright—
The code hops forward, light and right!
🐇✨


📜 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 ba8730d and be60fe9.

⛔ Files ignored due to path filters (2)
  • Lib/test/test_dataclasses.py is excluded by !Lib/**
  • Lib/test/test_typing.py is excluded by !Lib/**
📒 Files selected for processing (3)
  • compiler/codegen/src/compile.rs (1 hunks)
  • vm/src/builtins/type.rs (1 hunks)
  • vm/src/vm/context.rs (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • vm/src/vm/context.rs
🚧 Files skipped from review as they are similar to previous changes (2)
  • compiler/codegen/src/compile.rs
  • vm/src/builtins/type.rs
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: Ensure compilation on various targets
  • GitHub Check: Run rust tests (windows-latest)
  • GitHub Check: Run rust tests (macos-latest)
  • GitHub Check: Run snippets and cpython tests (ubuntu-latest)
  • GitHub Check: Run snippets and cpython tests (windows-latest)
  • GitHub Check: Run rust tests (ubuntu-latest)
  • 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 (macos-latest)
  • GitHub Check: Check Rust code with rustfmt and clippy
✨ 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.

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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
vm/src/builtins/type.rs (1)

853-864: Consider improving type validation in the getter.

The getter implementation has a potential inconsistency: if __type_params__ is manually set to a non-tuple value, the downcast will fail silently and return an empty tuple. This could be confusing for users.

Consider adding explicit validation or error handling:

 #[pygetset]
 fn __type_params__(&self, vm: &VirtualMachine) -> PyTupleRef {
     let attrs = self.attributes.read();
     let key = vm.ctx.intern_str("__type_params__");
     if let Some(params) = attrs.get(&key) {
         if let Ok(tuple) = params.clone().downcast::<PyTuple>() {
             return tuple;
         }
+        // Log or handle case where __type_params__ exists but isn't a tuple
+        vm_trace!("__type_params__ exists but is not a tuple, returning empty tuple");
     }
     // Return empty tuple if not found or not a tuple
     vm.ctx.empty_tuple.clone()
 }
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 3d951a8 and ba8730d.

⛔ Files ignored due to path filters (1)
  • Lib/test/test_typing.py is excluded by !Lib/**
📒 Files selected for processing (3)
  • .cspell.json (1 hunks)
  • compiler/codegen/src/compile.rs (1 hunks)
  • vm/src/builtins/type.rs (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
`**/*.rs`: Follow the default rustfmt code style (`cargo fmt` to format) Always ...

**/*.rs: Follow the default rustfmt code style (cargo fmt to format)
Always run clippy to lint code (cargo clippy) before completing tasks. Fix any warnings or lints that are introduced by your changes
Follow Rust best practices for error handling and memory management
Use the macro system (pyclass, pymodule, pyfunction, etc.) when implementing Python functionality in Rust

📄 Source: CodeRabbit Inference Engine (.github/copilot-instructions.md)

List of files the instruction was applied to:

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

45-45: LGTM - Appropriate spell checker exclusion.

Adding target/** to ignore paths is a sensible change since target directories contain build artifacts and compiled files that don't require spell checking.

compiler/codegen/src/compile.rs (1)

2904-2918: LGTM! Well-implemented PEP 646 support for starred type annotations.

The special handling for starred expressions in type annotations is correctly implemented:

  • Proper state management by preserving and restoring in_annotation flag
  • Correct unpacking logic using UnpackSequence { size: 1 } to handle *Ts TypeVarTuple expressions
  • Clean fallback to normal expression compilation for non-starred annotations
  • Consistent error handling with the ? operator

The implementation aligns well with CPython's approach for handling starred type annotations as mentioned in the comment.

Comment on lines 866 to 893
#[pygetset(setter)]
fn set___type_params__(
&self,
value: PySetterValue<PyTupleRef>,
vm: &VirtualMachine,
) -> PyResult<()> {
match value {
PySetterValue::Assign(value) => {
let mut attrs = self.attributes.write();
let key = vm.ctx.intern_str("__type_params__");
attrs.insert(key, value.into());
}
PySetterValue::Delete => {
return Err(vm.new_type_error("__type_params__ must be set to a tuple object"));
}
}
Ok(())
}
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider adding immutability check in the setter.

The setter correctly enforces tuple types and provides appropriate error messages for deletion attempts. However, it doesn't check if the type is immutable before allowing modifications.

Add immutability check consistent with other setters in this file:

 #[pygetset(setter)]
 fn set___type_params__(
     &self,
     value: PySetterValue<PyTupleRef>,
     vm: &VirtualMachine,
 ) -> PyResult<()> {
+    // Check if this is an immutable type
+    if self.slots.flags.has_feature(PyTypeFlags::IMMUTABLETYPE) {
+        return Err(vm.new_type_error(format!(
+            "cannot set '__type_params__' attribute of immutable type '{}'",
+            self.name()
+        )));
+    }
+
     match value {
         PySetterValue::Assign(value) => {
             let mut attrs = self.attributes.write();
             let key = vm.ctx.intern_str("__type_params__");
             attrs.insert(key, value.into());
         }
         PySetterValue::Delete => {
             return Err(vm.new_type_error("__type_params__ must be set to a tuple object"));
         }
     }
     Ok(())
 }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
#[pygetset(setter)]
fn set___type_params__(
&self,
value: PySetterValue<PyTupleRef>,
vm: &VirtualMachine,
) -> PyResult<()> {
match value {
PySetterValue::Assign(value) => {
let mut attrs = self.attributes.write();
let key = vm.ctx.intern_str("__type_params__");
attrs.insert(key, value.into());
}
PySetterValue::Delete => {
return Err(vm.new_type_error("__type_params__ must be set to a tuple object"));
}
}
Ok(())
}
#[pygetset(setter)]
fn set___type_params__(
&self,
value: PySetterValue<PyTupleRef>,
vm: &VirtualMachine,
) -> PyResult<()> {
// Check if this is an immutable type
if self.slots.flags.has_feature(PyTypeFlags::IMMUTABLETYPE) {
return Err(vm.new_type_error(format!(
"cannot set '__type_params__' attribute of immutable type '{}'",
self.name()
)));
}
match value {
PySetterValue::Assign(value) => {
let mut attrs = self.attributes.write();
let key = vm.ctx.intern_str("__type_params__");
attrs.insert(key, value.into());
}
PySetterValue::Delete => {
return Err(vm.new_type_error("__type_params__ must be set to a tuple object"));
}
}
Ok(())
}
🤖 Prompt for AI Agents
In vm/src/builtins/type.rs around lines 866 to 883, the setter for
__type_params__ lacks a check for immutability before modifying the attribute.
To fix this, add a check at the start of the setter that verifies if the type is
immutable, similar to other setters in this file, and return an error if it is
immutable to prevent modification. This ensures consistency and enforces
immutability constraints properly.

@youknowone youknowone merged commit fa7af0e into RustPython:main Jul 1, 2025
12 checks passed
@youknowone youknowone deleted the type-params branch July 1, 2025 10:05
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.

1 participant