Skip to content

Use Unconstructible trait for internal types #6052

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

ever0de
Copy link
Contributor

@ever0de ever0de commented Aug 1, 2025

ref

Summary by CodeRabbit

Summary by CodeRabbit

  • Bug Fixes
    • Prevented direct creation of Blob and Statement objects in the sqlite3 module from Python, ensuring a clear error is raised if attempted.
    • Improved error messages by adding quotes around class names when instantiation is disallowed.

Copy link
Contributor

coderabbitai bot commented Aug 1, 2025

Walkthrough

The changes update the Blob and Statement classes in the sqlite3 module to explicitly specify their module and class names and mark them as unconstructible from Python by implementing the Unconstructible trait. Additionally, the error message for unconstructible class instantiation is refined by adding quotes around the class name in the error text.

Changes

Cohort / File(s) Change Summary
sqlite3 Blob & Statement class unconstructibility
stdlib/src/sqlite.rs
Added Unconstructible trait implementation for Blob and Statement classes; updated #[pyclass] attributes to specify module = "sqlite3" and include Unconstructible, preventing direct instantiation from Python.
Unconstructible error message formatting
vm/src/types/slot.rs
Modified error message in slot_new function to add single quotes around the class slot name in the unconstructible instantiation error message.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~7 minutes

Suggested reviewers

  • youknowone

Poem

In sqlite’s burrow, classes hide,
Blob and Statement, side by side.
“You can’t make us!” they now shout,
Unconstructible blocks your route.
A rabbit hops by, gives a wink—
“Direct creation? Not what you think!”
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 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 b2d6594 and ec0a232.

📒 Files selected for processing (2)
  • stdlib/src/sqlite.rs (5 hunks)
  • vm/src/types/slot.rs (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • vm/src/types/slot.rs
🚧 Files skipped from review as they are similar to previous changes (1)
  • stdlib/src/sqlite.rs
⏰ 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). (11)
  • GitHub Check: Check the WASM package and demo
  • GitHub Check: Run snippets and cpython tests on wasm-wasi
  • GitHub Check: Run tests under miri
  • GitHub Check: Run snippets and cpython tests (macos-latest)
  • GitHub Check: Run rust tests (windows-latest)
  • GitHub Check: Run rust tests (ubuntu-latest)
  • GitHub Check: Run rust tests (macos-latest)
  • GitHub Check: Run snippets and cpython tests (windows-latest)
  • GitHub Check: Run snippets and cpython tests (ubuntu-latest)
  • GitHub Check: Ensure compilation on various targets
  • GitHub Check: Check Rust code with rustfmt and clippy
✨ 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.
    • @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 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.

@ever0de ever0de marked this pull request as draft August 1, 2025 04:44
@ever0de ever0de marked this pull request as ready for review August 1, 2025 05:08
#[derive(Debug, PyPayload)]
struct Blob {
connection: PyRef<Connection>,
#[pytraverse(skip)]
inner: PyMutex<Option<BlobInner>>,
}

impl Constructor for Blob {
Copy link
Member

Choose a reason for hiding this comment

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

Could you check if Unconstructible works?

Suggested change
impl Constructor for Blob {
impl Unconstructible for Blob {

Copy link
Contributor Author

@ever0de ever0de Aug 1, 2025

Choose a reason for hiding this comment

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

We can proceed with this fix by adding single quotes to the error message. I will apply the patch for now.

https://github.com/ever0de/RustPython/blob/b2d6594bd9cc7a91b85cfe107d0e4ce7916bae62/vm/src/types/slot.rs#L801-L808

- Err(vm.new_type_error(format!("cannot create {} instances", cls.slot_name())))
+ Err(vm.new_type_error(format!("cannot create '{}' instances", cls.slot_name())))

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.

👍

@youknowone youknowone merged commit 92fdfc4 into RustPython:main Aug 1, 2025
12 checks passed
@ever0de ever0de changed the title Prevent direct instantiation of sqlite3.{Statement,Blob} Use Unconstructible trait for internal types Aug 3, 2025
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.

2 participants