refactor(python)!: rename structure= to structural_eq=#509
refactor(python)!: rename structure= to structural_eq=#509junrushao merged 1 commit intoapache:mainfrom
structure= to structural_eq=#509Conversation
Rename the `structure=` parameter to `structural_eq=` in both `@py_class()` and `field()` to better communicate that the parameter controls structural equality/hashing behavior, not general structure. Affected APIs: - `py_class(structure=...)` → `py_class(structural_eq=...)` - `field(structure=...)` → `field(structural_eq=...)` Files changed: - python/tvm_ffi/dataclasses/field.py — Field class and field() function - python/tvm_ffi/dataclasses/py_class.py — py_class() decorator - python/tvm_ffi/cython/type_info.pxi — Cython getattr lookup - tests/python/test_structural_py_class.py — all test annotations - docs/concepts/structural_eq_hash.rst — tutorial documentation BREAKING CHANGE: The `structure=` parameter on `@py_class()` and `field()` has been renamed to `structural_eq=`. Update all call sites to use the new parameter name. Note: tests not run in this commit workflow — requires full C++ rebuild via `uv pip install --force-reinstall --verbose -e .`.
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request implements a significant refactoring by renaming the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request renames the structure= parameter to structural_eq= in @py_class() and field(). This is a breaking change, and the description includes a migration guide. The rename has been applied consistently across documentation, Python source code, Cython bindings, and tests. The review did not identify any issues with the changes.
Summary
structure=parameter tostructural_eq=in@py_class()andfield()to better convey that the parameter controls structural equality/hashing behaviortype_info.pxi) to read the new attribute nameBreaking Change
The
structure=parameter on@py_class()andfield()has been renamed tostructural_eq=.Migration: replace all occurrences of
structure=withstructural_eq=in your@py_class()andfield()calls:Test plan
uv pip install --force-reinstall --verbose -e .(full C++ rebuild required)uv run pytest -vvs tests/python/test_structural_py_class.py🤖 Generated with Claude Code