Add infrastructure for type checking in Python code #68
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
Type annotations are provided in the project's Python code to indicate the types of objects. Previously no infrastructure was provided to leverage or validate these annotations. A task is added here to allow contributors to easily check for typing problems using the mypy tool. A new job is added to the "Check Python" GitHub Actions workflow to run the task on every push or pull request that modifies relevant files.
The annotation was invalid, resulting in mypy error: error: "dict" expects 2 type arguments, but 1 given [type-arg] The `headers` field of the dictionary returned by this function is a `http.client.HTTPMessage` class object, while the other field values are strings. I didn't find a way to specify this in a return type annotation and the current approach is to provide annotations on a "best effort" basis (vs making them universally mandatory) so I settled on removing the annotation entirely.
The type of the `data` parameter of `urllib.request.Request` is bytes. Previously the type annotations for the method parameters used to pass the data passed via this parameter were the incorrect type `str`.
Some of the code uses practice of reusing a variable through a chain of processing its contents in some cases the variable type was changed over the course of the processing. This caused the type checking via mypy to fail. The code is reworked to avoid any changing of variable type.
per1234
added
type: enhancement
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #68 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 2 2
Lines 732 729 -3
=========================================
- Hits 732 729 -3 ☔ View full report in Codecov by Sentry. |
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.
Type annotations are provided in the project's Python code to indicate the types of objects (#53). Previously no infrastructure was provided to leverage or validate these annotations.
A task is added here to allow contributors to easily check for typing problems using the mypy tool.
A new job is added to the "Check Python" GitHub Actions workflow to run the task on every push or pull request that modifies relevant files.