Adding Typehints for jira.py #1418
Conversation
| @@ -61,7 +61,7 @@ def each(self, q=None, sort=None): | |||
|
|
|||
| return | |||
|
|
|||
| def get(self, uuid): | |||
| def get(self, uuid: str): # type: ignore[override] | |||
There was a problem hiding this comment.
The signature for get in AtlassianRestAPI doesn't match here. So we need to override.
There was a problem hiding this comment.
Since I created the PR it would appear that Codacy also fails a code check
https://app.codacy.com/gh/atlassian-api/atlassian-python-api/pull-requests/1418/issues#issue-997875664eb936e64c346233afbf428c
requirements.txt
Outdated
| requests>=2.8.1 | ||
| six | ||
| oauthlib | ||
| requests_oauthlib | ||
| requests-oauthlib |
There was a problem hiding this comment.
not sure why this wasn't included as it's used in the library.
| types-Deprecated | ||
| types-requests | ||
| types-six | ||
| types-beautifulsoup4 |
There was a problem hiding this comment.
All of the above get used in tox so it only made sense to include them in the dev reqs.
| absolute=False, | ||
| advanced_mode=False, | ||
| ): | ||
| path: str, |
There was a problem hiding this comment.
Not adding the override variations here since patch doesn't get used in jira.py.
pyproject.toml
Outdated
| @@ -7,7 +7,6 @@ | |||
| [tool.black] | |||
| target-version = ['py36', 'py37', 'py38', 'py39'] | |||
| line-length = 120 | |||
| include_trailing_comma = false | |||
There was a problem hiding this comment.
This isn't a valid configuration parameter.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #1418 +/- ##
==========================================
+ Coverage 33.85% 34.15% +0.30%
==========================================
Files 46 47 +1
Lines 8897 8974 +77
Branches 1215 1217 +2
==========================================
+ Hits 3012 3065 +53
- Misses 5762 5786 +24
Partials 123 123 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@bandophahita once you're ready feel free to update the status of PR |
|
I'm about to give up and abandon this PR. There are just too many hurdles in the codebase to deal with that are outside my purview. I'll leave it here for now in case someone wants to pick up where I left off. |
…ed into main/master.
|
@bandophahita could you double check everything is expected from typehints perspective ? |
Since adding typehints to the entire repo would make for a VERY large PR, I'm breaking up the changes mostly by module. This PR focuses on adding hints to jira.py