-
Notifications
You must be signed in to change notification settings - Fork 48
feat: add kw_only support for dataclass init generation #384
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
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @guan404ming, 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 significantly enhances 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. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces support for keyword-only arguments in the __init__ method generated by @c_class, aligning its functionality more closely with Python's standard library dataclasses. The implementation is robust, including a new kw_only parameter for both the @c_class decorator and the field() function, a KW_ONLY sentinel, refactoring of the __init__ generation logic for better clarity, and comprehensive docstring updates and tests. The changes are well-executed, and I have a couple of minor suggestions to improve code clarity and simplify some of the new logic.
| if origin in [ClassVar, InitVar]: | ||
| continue | ||
| # Detect KW_ONLY sentinel | ||
| if resolved_type is _KW_ONLY_TYPE or isinstance(resolved_type, _KW_ONLY_TYPE): |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The check for the KW_ONLY sentinel can be simplified. The class _KW_ONLY_TYPE is an internal detail, and users are expected to use the KW_ONLY instance, as shown in the documentation. Supporting annotations with the internal class _KW_ONLY_TYPE directly is likely unnecessary and could lead to confusion. A simpler check, isinstance(resolved_type, _KW_ONLY_TYPE), would correctly handle cases where the annotation is the KW_ONLY instance and aligns better with how the standard library dataclasses handles its KW_ONLY sentinel.
| if resolved_type is _KW_ONLY_TYPE or isinstance(resolved_type, _KW_ONLY_TYPE): | |
| if isinstance(resolved_type, _KW_ONLY_TYPE): |
python/tvm_ffi/dataclasses/field.py
Outdated
| if not isinstance(init, bool): | ||
| raise TypeError("`init` must be a bool") | ||
| if kw_only is not MISSING and not isinstance(kw_only, bool): | ||
| raise TypeError("`kw_only` must be a bool or MISSING") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The error message for the kw_only type check could be more precise for the user. The MISSING value is an internal sentinel for a non-provided argument and not a value a user can pass. The message could be simplified to state that kw_only must be a boolean, which is the expected type from a user's perspective.
| raise TypeError("`kw_only` must be a bool or MISSING") | |
| raise TypeError("`kw_only` must be a bool") |
Related Issue
#356
Why
Python's standard dataclasses support kw_only parameter to make fields keyword-only in init. This feature was missing from @c_class decorator.
How
KW_ONLYsentinel class for marking keyword-only fieldskw_onlyparameter to field() function and @c_class decoratormethod_init()to generate proper signature