Update tomllib from 3.13.5 #5902
Conversation
|
Important Review skippedReview was skipped due to path filters ⛔ Files ignored due to path filters (5)
CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including You can disable this status message by setting the 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @ShaharNaveh, 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 updating and improving the tomllib module within the standard library. The primary goal is to enhance the module's type annotations for better static analysis and maintainability, alongside refining its test suite to be more reliable and robust across different Python environments.
Highlights
- Type Hinting Enhancements: I've refined numerous type annotations across
Lib/tomllib/_parser.pyandLib/tomllib/_re.py. This includes making dictionary and list types more explicit (e.g.,dict[str, Any],list[Any]) and specifying the string type forre.Matchobjects (e.g.,re.Match[str]). These changes improve code clarity and enable more precise static analysis. - Stricter Type Checking Configuration: A new
mypy.iniconfiguration file has been added toLib/tomllib/, enabling strict type checking for thetomllibmodule. This includes settingstrict = Trueand other rigorous MyPy options, formalizing the commitment to high type correctness standards. - Improved Recursion Limit Tests: The recursion limit tests in
Lib/test/test_tomllib/test_misc.pyhave been made more robust. They now utilizetest.support.infinite_recursionand dynamically calculatenest_countbased on available recursion depth, making them less brittle and providing better diagnostic information on test failures. - Test Suite Consistency: A minor adjustment was made to relative imports in
Lib/test/test_tomllib/__main__.pyto ensure consistency within the test suite's module resolution.
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 is currently in preview and 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 to provide feedback.
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. ↩
There was a problem hiding this comment.
Code Review
The pull request updates the tomllib library, focusing on type safety and test robustness. Type hints have been improved, and a mypy.ini file has been added for strict checking. The recursion limit tests have been refactored for better reliability. The changes enhance the overall quality and maintainability of the code.
| @@ -142,7 +142,7 @@ class Flags: | |||
| EXPLICIT_NEST = 1 | |||
|
|
|||
| def __init__(self) -> None: | |||
| self._flags: dict[str, dict] = {} | |||
| self._flags: dict[str, dict[Any, Any]] = {} | |||
There was a problem hiding this comment.
Consider using typing.TypedDict for more explicit type safety, especially since the keys in this dictionary are known and fixed. This can help catch errors during development.[^1]
from typing import Any, TypedDict
class FlagsDict(TypedDict):
flags: set[int]
recursive_flags: set[int]
nested: dict[str, Any]
_flags: dict[str, FlagsDict] = {}| @@ -210,7 +210,7 @@ def get_or_create_nest( | |||
| cont = cont[-1] | |||
| if not isinstance(cont, dict): | |||
| raise KeyError("There is no nest behind this key") | |||
| return cont | |||
| return cont # type: ignore[no-any-return] | |||
There was a problem hiding this comment.
The type ignore here might hide potential type errors. It would be better to ensure that the return type is always a dict[str, Any] or refactor the code to handle other return types explicitly. Consider adding a check to ensure that cont is indeed a dictionary before returning it, and raise a more informative error if it is not.[^1]
if not isinstance(cont, dict):
raise TypeError("Expected a dictionary, but got {type(cont)}")
return cont
No description provided.