Add Python annotations to have type hints #97
Merged
Conversation
This file contains 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
… this syntax requires Python 3.9+)
gacarrillor
force-pushed
the
python_annotations
branch
from
291aac8 to
4770867
Compare
gacarrillor
changed the title
signedav
approved these changes
Jun 7, 2024
| @@ -41,3 +41,5 @@ repos: | |||
| rev: v3.3.1 | |||
| hooks: | |||
| - id: pyupgrade | |||
| args: | |||
| - "--keep-runtime-typing" | |||
There was a problem hiding this comment.
Without it, pyupgrade changes Optional/Union statements by new syntax "a | b" (Python v3.10+), which won't be completely backwards compatible (namely, there might be issues with runtime operations like isinstance(obj, str | int)).
Done in #99 |
|
@signedav, what do you think about bumping Python to (at least) 3.7? See note in the description. |
|
A yes. I wanted to ask you. Where we set this minimum requirement? On publishing to pypi? |
signedav
approved these changes
Jun 7, 2024
Yes, I've only seen it in setup.py |
|
Ok lets bump 👊 |
Merged
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.
Completed packages:
dataobjectsdb_factoryOther packages might have been touched but not completed due to lack of time.
Some considerations:
_prefix, e.g., `_layer, to indicate the parameter is unused.from future import annotations: Added to be able to use the classLegendGroupas a return type inLegendGroup'sgetitem()method.--keep-runtime-typingwas added to avoid that the aforementioned info enables pre-commit'spyupgradeto changeOptional/Unionstatements by new syntax "a | b" (which wouldn't be compatible with Python < 3.10)listis preferred overList.tupleis preferred overTuple.forms.pyto be able to use some of the classes (of the same module) in other classes' types.Note:
We may need to consider to bump Python to at least 3.7, since that version introduces the
from __future__ import annotations, which makes it possible to use modern typing syntax likelist[str]in old Python versions.