Add missing return type hint for resources.py #1906
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.
What?
jira/resources.py::Issue::permalink
is an untyped function, it should be typed.Why?
The
jira
module advertises itself as supporting type hints viapy.typed
. When used in a typed context and with mypy's strict mode it will complain about the current implementation.How?
Adding return type hints to
jira/resources.py
would mitigate the issue.Testing?
Has not been tested in runtime. With PEP 563 it is impossible for this PR to break anything under normal conditions. Worst case is that tools used during development show incorrect information, such as an LSP or linter.
Anything Else?
While adding type hints everywhere would be ideal, the PR scope is limited for easier reviewability.
Changes can be summarized as; all methods return
None
, except for:jira/resources.py::Attachment::get
, which returnsbytes | None
jira/resources.py::Issue::permalink
, which returnsstr
Closes #1900.