Skip to content

Preserve Element state list subclasses - #9627

Merged
youknowone merged 1 commit into
RustPython:mainfrom
youknowdot:fix/element-setstate-exact-list-20261103
Nov 4, 2026
Merged

youknowone merged 1 commit into
RustPython:mainfrom
youknowdot:fix/element-setstate-exact-list-20261103

Conversation

@youknowdot

@youknowdot youknowdot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Treat only exact list objects as deferred text/tail fragments when restoring Element state. A list subclass remains the original text or tail object instead of being joined into a string. The separate _children list-subclass behavior and TreeBuilder fragment handling are unchanged.

Validation

Summary by CodeRabbit

  • Bug Fixes
    • Restored text and tail values are now handled as pending fragments only when they are plain lists; list subclasses retain their existing behavior.

Only exact lists restored as text or tail are pending fragments, matching CPython. List subclasses remain the original objects.

Assisted-by: OpenAI Codex:model version not exposed
@coderabbitai

coderabbitai Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

Walkthrough

PyElement.__setstate__ now marks restored text and tail as pending fragment lists only when each value has the exact type list. List subclasses no longer meet this check.

Changes: Element state restoration

Layer / File(s) Summary
Pending-join flag classification
crates/stdlib/src/elementtree.rs
__setstate__ now checks the exact types of text and tail when setting their pending-join flags. List subclasses are no longer classified as pending.

Estimated code review effort: 1 (Trivial) | ~4 minutes

Change: Bug fix

Possibly related PRs

  • RustPython/RustPython#9591: Changes the input contract and validation for PyElement.__setstate__, which is also modified by this PR.

Suggested reviewers: youknowone

Merge Risk: Low · up to 0a561

The change preserves list-subclass objects as intended. It is mergeable with follow-up to confirm regression coverage for restored text and tail identity.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat… Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks: 4 passed
Check name Status Explanation
Description Check Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check Passed The title "Preserve Element state list subclasses" matches the main change in the changeset. PyElement.setstate now marks restored text and tail as pending fragment lists only when their exact typ…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Title check

Explanation

The title "Preserve Element state list subclasses" matches the main change in the changeset. PyElement.setstate now marks restored text and tail as pending fragment lists only when their exact type is list. List subclasses keep their original objects, which the title describes. The title names the specific behavior change and does not cover the file-level details, which is acceptable.

Full details: Docstring Coverage

Explanation

Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 1 functions across 1 files.

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

Finishing Touches
Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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

@youknowone
youknowone marked this pull request as ready for review November 4, 2026 01:13
@youknowone
youknowone enabled auto-merge (squash) November 4, 2026 01:13
@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 4, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-04T01:15:59.810357Z 0a561b7 Draft marked ready
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Additional comments: 1
crates/stdlib/src/elementtree.rs-928-928: 1

928-928: Minor · Potential issue · Low value

Unverified finding
We couldn't verify this from the code. It is shown for review, not as a verified issue.

Test gap: no tests were added for the new exact-list classification, so an implementation that still joins a list subclass restored as text could pass the existing ElementTree tests.

The regression could go undetected even though reading element.text would replace the original subclass object with a joined string.

This can occur when: A regression changes the text check back to a subclass-inclusive check, and a caller restores a list subclass through Element.__setstate__.

Review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 18fc82b and 0a561b7.

Files selected for processing: 1
  • crates/stdlib/src/elementtree.rs

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 0 remain after this review.

@youknowone
youknowone merged commit 1b135ab into RustPython:main Nov 4, 2026
20 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