-
Notifications
You must be signed in to change notification settings - Fork 30
fix: fix type hints of EvaluationContext and HookHints #535
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 type safety and maintainability of the codebase by refining the type definitions for EvaluationContext and HookHints. The changes ensure that these critical components adhere strictly to their specified structures, and a new suite of typechecking tests has been added to prevent future type-related issues and validate the current improvements.
Highlights
- Type Hint Refinement: The type hints for
EvaluationContextandHookHintshave been updated to accurately reflect the OpenFeature specification, improving type safety and clarity for these core data structures. - New Typechecking Tests: A new dedicated
tests/typecheckingdirectory has been introduced, containing comprehensive static analysis tests for both positive and negative scenarios to validate the correctness of the updated type hints forEvaluationContextandHookHints.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 #535 +/- ##
=======================================
Coverage 97.85% 97.86%
=======================================
Files 39 39
Lines 1822 1823 +1
=======================================
+ Hits 1783 1784 +1
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 correctly fixes the recursive type hints for EvaluationContext and HookHints to be more accurate and align better with standard practices for defining such structures. The addition of type-checking tests is an excellent way to validate these complex types and prevent future regressions. My review includes a suggestion to deduplicate the now-identical type definitions to improve maintainability. I also noticed that HookData has a similar type-hint issue and have provided feedback on how to address that, although it might be best handled as a separate breaking change.
This PR
EvaluationContextandHookHintsRelated Issues
Relates #534