-
Notifications
You must be signed in to change notification settings - Fork 28
chore: replace deprecated typing aliases #537
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
Conversation
Signed-off-by: gruebel <[email protected]>
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.
Summary of Changes
Hello @gruebel, 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 focuses on enhancing the codebase's type hinting consistency and maintainability. It systematically replaces older, deprecated typing
aliases with their modern collections.abc
equivalents across various files. To ensure adherence to these new standards, two new Ruff linting rules have been integrated, which will help prevent the reintroduction of these deprecated aliases in the future. These changes contribute to a more robust and future-proof type-checking environment.
Highlights
- Type Hint Modernization: Replaced deprecated
typing
aliases (such astyping.Mapping
,typing.Callable
,typing.Sequence
,typing.Optional
,typing.Union
, andtyping.TYPE_CHECKING
) with their more explicitcollections.abc
counterparts or directtyping
module access where appropriate across the codebase. - Ruff Rule Enforcement: Introduced two new Ruff rules (
ICN003
andTID251
) inpyproject.toml
to prevent future use of these deprecatedtyping
aliases and enforce the use ofcollections.abc
for common abstract base classes, ensuring consistent type-hinting practices. - Minor Code Refinements: Included small improvements such as using
.copy()
for list duplication instead of slicing[:]
and employing thein
operator for string containment checks, enhancing code clarity and Pythonic style.
Using Gemini Code Assist
The 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 /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands on the current page.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in pull request comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
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 .gemini/
folder in the base of the repository. Detailed instructions can be found here.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #537 +/- ##
=======================================
Coverage 97.86% 97.86%
=======================================
Files 39 39
Lines 1823 1823
=======================================
Hits 1784 1784
Misses 39 39
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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 replaces deprecated typing aliases with their collections.abc
counterparts, which is a great improvement for future Python compatibility. The addition of ruff rules to enforce this is also a good step towards maintaining code quality.
My review includes a few suggestions:
- In
openfeature/event.py
, I've pointed out some redundant field definitions in a dataclass that can be simplified. - In
pyproject.toml
, I've found a couple of issues with the new ruff configuration that would prevent the new linting rules from working as intended.
The rest of the changes look good and are applied consistently across the codebase.
This PR