Adding Typehints for jira.py (#1418)

* adding type hints

* avoiding errors about override signature

* adding various types packages to requirements-dev.txt

* adding type hints

* using alias for json response type

* allowing test action to be run manually to help troubleshoot failures

* cannot utilize the workflow_dispatch on branches until it's been merged into main/master.

* black formatting is different in 3.7

* urllib3 is imported directly, thus should be in the reqs

* cannot use new style annotations with older versions of python

* future annotations aren't available in 3.6

* looks like bandit is not able to be installed in python3.6

* ignoring the list return vs the typical dictionary

* avoiding black formatter inconsistencies between 23.3 and 24.x

* minor cleanup after rebase

* enforcing flake8 TC006 rule

* fixing black formatting

* mypy fixes

* adding types-jmespath to requirements-dev.txt

* adding types-oauthlib to reqs dev

* mypy fixes - incompatible return types

* rebased from master and updated missing annotations for arguments

* adjust for mypy

---------

Co-authored-by: Gonchik Tsymzhitov <[email protected]>

Author: bandophahita

atlassian/bitbucket/__init__.py

@@ -1,13 +1,15 @@
 # coding=utf-8
 import logging
 from enum import Enum
+from typing import Optional
 
 from deprecated import deprecated
 from requests import HTTPError
 
-from .base import BitbucketBase
 from atlassian.bitbucket.cloud import Cloud
 
+from .base import BitbucketBase
+
 log = logging.getLogger(__name__)
 
 
@@ -1891,7 +1893,7 @@ def get_pull_requests_participants(
 
     def assign_pull_request_participant_role(
         self, project_key: str, repository_slug: str, pull_request_id: int, role: str, user: str
-    ) -> dict:
+    ) -> Optional[dict]:
         """
         Assign a role to a user for a pull request
         :param project_key: The project key
@@ -2117,7 +2119,9 @@ def add_pull_request_blocker_comment(
         data = {"text": text, "severity": severity}
         return self.post(url, data=data)
 
-    def search_pull_request_blocker_comment(self, project_key: str, repository_slug: str, pull_request_id: int) -> dict:
+    def search_pull_request_blocker_comment(
+        self, project_key: str, repository_slug: str, pull_request_id: int
+    ) -> Optional[dict]:
         """
         Get all comments that block the merge of a pull request
         :param project_key: The project key

atlassian/bitbucket/cloud/repositories/repositoryVariables.py

@@ -1,13 +1,12 @@
 # coding=utf-8
-
 from ..base import BitbucketCloudBase
 
 
 class RepositoryVariables(BitbucketCloudBase):
     def __init__(self, url, *args, **kwargs):
         super(RepositoryVariables, self).__init__(url, *args, **kwargs)
 
-    def __get_object(self, data):
+    def __get_object(self, data) -> "RepositoryVariable":
         return RepositoryVariable(
             self.url_joiner(self.url, data["uuid"]),
             data,
@@ -61,7 +60,7 @@ def each(self, q=None, sort=None):
 
         return
 
-    def get(self, uuid):
+    def get(self, uuid: str):  # type: ignore[override]
         """
         Returns the pipeline with the uuid in this repository.
 

atlassian/confluence.py

@@ -5,13 +5,15 @@
 import os
 import re
 import time
+from typing import cast
 
+import requests
 from bs4 import BeautifulSoup
 from deprecated import deprecated
-import requests
 from requests import HTTPError
 
 from atlassian import utils
+
 from .errors import (
     ApiConflictError,
     ApiError,
@@ -1644,7 +1646,7 @@ def set_page_label(self, page_id, label):
 
         return response
 
-    def remove_page_label(self, page_id, label):
+    def remove_page_label(self, page_id: str, label: str):
         """
         Delete Confluence page label
         :param page_id: content_id format
@@ -2740,13 +2742,13 @@ def get_space_export(self, space_key: str, export_type: str) -> str:
         :return: The URL to download the exported file.
         """
 
-        def get_atl_request(url: str):
+        def get_atl_request(link: str):
             # Nested function  used to get atl_token used for XSRF protection.
             # This is only applicable to html/csv/xml space exports
             try:
-                response = self.get(url, advanced_mode=True)
+                response = self.get(link, advanced_mode=True)
                 parsed_html = BeautifulSoup(response.text, "html.parser")
-                atl_token = parsed_html.find("input", {"name": "atl_token"}).get("value")
+                atl_token = parsed_html.find("input", {"name": "atl_token"}).get("value")  # type: ignore[union-attr]
                 return atl_token
             except Exception as e:
                 raise ApiError("Problems with getting the atl_token for get_space_export method :", reason=e)
@@ -2798,17 +2800,17 @@ def get_atl_request(url: str):
             parsed_html = BeautifulSoup(response.text, "html.parser")
             # Getting the poll URL to get the export progress status
             try:
-                poll_url = parsed_html.find("meta", {"name": "ajs-pollURI"}).get("content")
+                poll_url = cast("str", parsed_html.find("meta", {"name": "ajs-pollURI"}).get("content"))  # type: ignore[union-attr]
             except Exception as e:
                 raise ApiError("Problems with getting the poll_url for get_space_export method :", reason=e)
             running_task = True
             while running_task:
                 try:
-                    progress_response = self.get(poll_url)
-                    log.info("Space" + space_key + " export status: " + progress_response["message"])
-                    if progress_response["complete"]:
-                        parsed_html = BeautifulSoup(progress_response["message"], "html.parser")
-                        download_url = parsed_html.find("a", {"class": "space-export-download-path"}).get("href")
+                    progress_response = self.get(poll_url) or {}
+                    log.info(f"Space {space_key} export status: {progress_response.get('message', 'None')}")
+                    if progress_response is not {} and progress_response.get("complete"):
+                        parsed_html = BeautifulSoup(progress_response.get("message"), "html.parser")
+                        download_url = cast("str", parsed_html.find("a", {"class": "space-export-download-path"}).get("href"))  # type: ignore
                         if self.url in download_url:
                             return download_url
                         else: