Add type hints (finally) #178
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
trag1c
suggested changes
Apr 20, 2024
src/interrogate/badge_gen.py
Outdated
| DEFAULT_FILENAME = "interrogate_badge" | ||
| COLORS = { | ||
|
|
||
| NumberType = int | float |
There was a problem hiding this comment.
This causes CI to fail as int | float is actually executed at runtime (since it's not an annotation). In this case you still have to use the <3.10 syntax:
Suggested change
| NumberType = int | float | |
| NumberType = Union[int, float] |
Or, better yet, don't introduce this type alias at all and simply use int | float everywhere (it's just one more character 😉)
src/interrogate/visit.py
Outdated
Comment on lines
13
to
15
| DocumentableFunc = ast.AsyncFunctionDef | ast.FunctionDef | ||
| DocumentableFuncOrClass = DocumentableFunc | ast.ClassDef | ||
| DocumentableNode = DocumentableFuncOrClass | ast.Module |
There was a problem hiding this comment.
Thanks so much for your review @trag1c - I am so behind on keeping up with the changes in typing 🙈
src/interrogate/config.py
Outdated
| import configparser | ||
| import os | ||
| import pathlib | ||
| import re | ||
|
|
||
| from typing import Any, Sequence |
There was a problem hiding this comment.
typing.Sequence and the like are deprecated as part of PEP 585, so it'd be better to use collections.abc.Sequence for annotations
src/interrogate/cli.py
Outdated
Comment on lines
316
to
344
| def main( | ||
| paths: Optional[List[str]], | ||
| verbose: int, | ||
| quiet: bool, | ||
| fail_under: Union[int, float], | ||
| exclude: Tuple[str], | ||
| ignore_init_method: bool, | ||
| ignore_init_module: bool, | ||
| ignore_magic: bool, | ||
| ignore_module: bool, | ||
| ignore_nested_classes: bool, | ||
| ignore_nested_functions: bool, | ||
| ignore_overloaded_functions: bool, | ||
| ignore_private: bool, | ||
| ignore_property_decorators: bool, | ||
| ignore_setters: bool, | ||
| ignore_semiprivate: bool, | ||
| ignore_regex: Optional[List[re.Pattern[str]]], | ||
| ext: Tuple[str], | ||
| whitelist_regex: Optional[List[re.Pattern[str]]], | ||
| style: str, | ||
| output: Optional[str], | ||
| color: bool, | ||
| omit_covered_files: bool, | ||
| generate_badge: Optional[str], | ||
| badge_format: Optional[str], | ||
| badge_style: Optional[str], | ||
| config: Optional[str], | ||
| ) -> None: |
There was a problem hiding this comment.
Curious: does click require these to be <3.9 annotations?
for more information, see https://pre-commit.ci
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.
Initial pass at type hinting - I probably didn't do everything correctly, but mypy passes 😅