Skip to content

fix(sqlite): align adaptation protocol with CPython #5964

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 1 commit into from
Jul 14, 2025

Conversation

ever0de
Copy link
Contributor

@ever0de ever0de commented Jul 13, 2025

Reference

Summary by CodeRabbit

  • Bug Fixes
    • Improved handling of custom adaptation methods to ensure only non-None values are accepted, preventing unintended behavior when adaptation methods return None.

Copy link
Contributor

coderabbitai bot commented Jul 13, 2025

Walkthrough

The _adapt function in stdlib/src/sqlite.rs was updated to check if the return values from __adapt__ and __conform__ methods are not None before returning them. If these methods return None, the function proceeds to the next step instead of returning immediately. No public API signatures were changed.

Changes

File(s) Change Summary
stdlib/src/sqlite.rs Modified _adapt to check for non-None return values from __adapt__ and __conform__.

Suggested reviewers

  • youknowone

Poem

In the warren of code, a check was spun,
Now None returns don’t end the run.
Adapt and conform, but only if true,
If nothing is found, we hop to the new.
A rabbit’s delight in logic refined,
Hopping through branches, leaving None behind! 🐇

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

@ever0de ever0de force-pushed the fix/sqlite-adapt-none-handling branch from fed2316 to 084eda7 Compare July 13, 2025 15:14
@ever0de ever0de changed the title fix(sqlite): correctly handle None from __adapt__ method fix(sqlite): align adaptation protocol with CPython Jul 13, 2025
@ever0de ever0de marked this pull request as ready for review July 13, 2025 15:14
Copy link
Contributor

@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

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8ab7aa2 and 084eda7.

⛔ Files ignored due to path filters (1)
  • Lib/test/test_sqlite3/test_types.py is excluded by !Lib/**
📒 Files selected for processing (1)
  • stdlib/src/sqlite.rs (2 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*.rs

Instructions used from:

Sources:
📄 CodeRabbit Inference Engine

  • .github/copilot-instructions.md
⏰ 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 snippets and cpython tests (ubuntu-latest)
  • GitHub Check: Run tests under miri
  • GitHub Check: Run snippets and cpython tests (windows-latest)
  • GitHub Check: Check Rust code with rustfmt and clippy
  • 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: Ensure compilation on various targets
  • GitHub Check: Run rust tests (macos-latest)
🔇 Additional comments (2)
stdlib/src/sqlite.rs (2)

684-726: LGTM: Correctly implements CPython's SQLite adaptation protocol behavior.

The changes properly handle the case where __adapt__ and __conform__ methods return None, which in Python's adaptation protocol means "I don't know how to adapt this object." By continuing the adaptation process when None is returned instead of immediately returning it, this aligns with CPython's behavior.

The implementation correctly:

  • Preserves error handling for non-TypeError exceptions
  • Only adds minimal overhead with the vm.is_none(&val) check
  • Maintains the logical flow of the adaptation protocol
  • Follows the principle of trying multiple adaptation methods before falling back

712-716: Consistent implementation with __adapt__ method handling.

The None check for __conform__ return values mirrors the implementation for __adapt__, ensuring consistent behavior across both adaptation methods in the protocol.

Comment on lines +698 to +702
Ok(val) => {
if !vm.is_none(&val) {
return Ok(val);
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Verification agent

🧩 Analysis chain

Verify CPython compatibility with test coverage.

The None check for __adapt__ return values correctly implements the adaptation protocol, but comprehensive test coverage would help ensure this change doesn't introduce regressions.


🏁 Script executed:

#!/bin/bash
# Description: Check for existing tests related to the adaptation protocol and None handling

# Search for test files related to sqlite adaptation
fd -e py -e rs | xargs rg -l "adapt.*None|__adapt__|__conform__" | head -10

# Look for specific test cases that might cover this behavior
rg -A 5 -B 5 "__adapt__.*None|__conform__.*None" --type py --type rs

# Check for existing sqlite adaptation tests
rg -A 10 -B 5 "test.*adapt|adapt.*test" stdlib/src/sqlite.rs || echo "No adaptation tests found in this file"

Length of output: 893


Add missing adaptation protocol tests for None handling in sqlite

There are currently no tests covering the case where __adapt__ (or __conform__) returns None in the SQLite module. Please add targeted test cases to prevent regressions:

• Location: stdlib/src/sqlite.rs (around lines 698–702)
• What to add:

  • A Rust unit test (e.g. in a #[cfg(test)] mod tests) that calls the adapter on a type which returns None, asserts that vm.is_none(&val) is true and that the function short-circuits by returning Ok(None).
  • If your test harness supports Python‐level tests, add a snippet in the Python testsuite that registers a dummy adapter returning None, runs a query binding it, and verifies the value comes back as None.

Example sketch in Rust:

 #[cfg(test)]
 mod tests {
     use super::*;
     use crate::vm::VirtualMachine;

     #[test]
     fn sqlite_adapt_returns_none() {
         let vm = VirtualMachine::new();
         // Define or fetch a value whose __adapt__ returns None
         let dummy = DummyAdapterReturningNone::new();
         let val = dummy.__adapt__(&vm).unwrap();
         assert!(vm.is_none(&val), "Expected None from __adapt__");
         // Confirm the sqlite path respects that None short-circuit
         match sqlite_bind(&vm, val) {
             Ok(v) => assert!(vm.is_none(&v)),
             Err(e) => panic!("Binding failed: {}", e),
         }
     }
 }

Committable suggestion skipped: line range outside the PR's diff.

🤖 Prompt for AI Agents
In stdlib/src/sqlite.rs around lines 698 to 702, add missing tests for the case
when __adapt__ or __conform__ returns None. Create a Rust unit test in the
#[cfg(test)] mod tests that defines a dummy adapter returning None, calls the
adapter, asserts vm.is_none(&val) is true, and verifies the function returns
Ok(None) to ensure proper short-circuiting. Additionally, if possible, add a
Python-level test in the testsuite that registers a dummy adapter returning
None, executes a query binding it, and confirms the returned value is None to
prevent regressions.

@youknowone youknowone merged commit 5ab64b7 into RustPython:main Jul 14, 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.

2 participants