typing: add type hints to parser helper functions (#938) - #1743
Open
DaBestCode wants to merge 1 commit into
Open
typing: add type hints to parser helper functions (#938)#1743DaBestCode wants to merge 1 commit into
DaBestCode wants to merge 1 commit into
Conversation
DaBestCode
requested review from
SashankBhamidi,
angatha,
niccokunzmann and
stevepiercy
as code owners
August 31, 2026 05:15
Contributor
|
This pull request did not pass quality checks and AI use is suspected. Please review Contribute and make any necessary amendments. |
Contributor
|
Profile summary: Full profile |
Member
|
CI fails == no review @DaBestCode please follow our contributing guidelines. Thank you! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Linked issue
Description
This pull request adds comprehensive type hints to parser helper functions in the icalendar library, contributing to issue #938's goal of adding type hints throughout the codebase.
Changes Made
src/icalendar/parser_tools.py:to_unicode()docstring with a "Returns" section to better document the function's return behaviorsrc/icalendar/parser/parameter.py:-> Callableto thesingle_string_parameter()decorator functionupper: bool = Falseto clarify theupperparameter's typedecorator():-> propertyfget():-> str | None(getter returns optional string)fset():-> None(setter returns None)fdel():-> None(deleter returns None)news/938.chore.2:Benefits
Checklist
Additional information
pytest src/icalendar/tests/test_unit_parser_tools.pyand parameter-related tests)|)