Skip to content

Fix struct tests #5813

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

Fix struct tests #5813

merged 1 commit into from
Jun 22, 2025

Conversation

youknowone
Copy link
Member

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

Summary by CodeRabbit

  • Bug Fixes
    • Resolved an issue where embedded null characters could be incorrectly accepted as valid format specifiers, improving input validation.
  • New Features
    • Enhanced the string representation of structured objects to display their internal format string.
  • Tests
    • Updated tests to reflect that certain cases are no longer expected to fail.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jun 22, 2025 •
edited
Loading

Walkthrough

The changes update the PyStruct class to implement the Representable trait for string representation, add a validation in format code parsing to reject embedded null characters, and remove expected failure markers from several struct-related Python tests, reflecting improved functionality and error handling.

Changes

File(s) Change Summary
Lib/test/test_struct.py Removed @unittest.expectedFailure and related comments from three test methods.
stdlib/src/pystruct.rs Added Representable trait to PyStruct, implemented repr_str for string representation.
vm/src/buffer.rs Added validation in FormatCode::parse to reject embedded null characters in format specifiers.

Sequence Diagram(s)

sequenceDiagram
    participant PythonTest as Python Test Suite
    participant PyStruct as PyStruct (Rust)
    participant VM as VirtualMachine

    PythonTest->>PyStruct: Call repr(PyStruct)
    PyStruct->>VM: Use format string from self
    PyStruct-->>PythonTest: Return "Struct('<format>')"
Loading 
sequenceDiagram
    participant User as User
    participant Buffer as FormatCode::parse

    User->>Buffer: Parse format string
    Buffer->>Buffer: Check for null character
    alt Null character present
        Buffer-->>User: Error "embedded null character"
    else
        Buffer-->>User: Continue parsing
    end
Loading

Poem

In the fields of code, a struct now shines bright,
With stringy reprs that read just right.
No nulls may sneak in, the buffer stands guard—
Tests once expected to fail now pass unmarred.
🐇 Hopping forward, Rust and Python unite!

📜 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 efc6b5d and 073007c.

📒 Files selected for processing (3)
  • Lib/test/test_struct.py (0 hunks)
  • stdlib/src/pystruct.rs (3 hunks)
  • vm/src/buffer.rs (1 hunks)
💤 Files with no reviewable changes (1)
  • Lib/test/test_struct.py
⏰ Context from checks skipped due to timeout of 90000ms (11)
  • GitHub Check: Run tests under miri
  • GitHub Check: Run snippets and cpython tests (ubuntu-latest)
  • GitHub Check: Run snippets and cpython tests (macos-latest)
  • 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 on wasm-wasi
  • GitHub Check: Check the WASM package and demo
  • GitHub Check: Run rust tests (windows-latest)
  • GitHub Check: Ensure compilation on various targets
  • GitHub Check: Run rust tests (macos-latest)
  • GitHub Check: Run rust tests (ubuntu-latest)
🔇 Additional comments (4)
vm/src/buffer.rs (1)

245-249: LGTM! Good security validation.

The null character validation correctly prevents invalid format specifiers from being processed, improving robustness of the format parsing logic.

stdlib/src/pystruct.rs (3)

19-19: LGTM! Import addition for trait implementation.

The Representable trait import is correctly added to support the PyStruct representation functionality.

254-254: LGTM! Trait attribute correctly added.

The Representable trait is properly added to the #[pyclass] attribute alongside the existing Constructor trait.

309-314: LGTM! Well-implemented string representation.

The Representable trait implementation provides a clear and pythonic string representation in the format Struct('<format>'), which matches standard Python struct module behavior.

✨ 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 3a54105 into RustPython:main Jun 22, 2025
12 checks passed
@youknowone youknowone deleted the struct branch June 22, 2025 00:58
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