Improve typing support

.github/workflows/python-package.yml

@@ -43,6 +43,10 @@ jobs:
       run: |
         uv run ruff check jenkinsapi/ --output-format full
 
+    - name: Lint with mypy
+      run: |
+        uv run mypy || true
+
   build:
     runs-on: ubuntu-latest
     strategy:

jenkinsapi/artifact.py

@@ -14,13 +14,17 @@
 import os
 import logging
 import hashlib
-from typing import Any, Literal
+from typing import Any, Literal, TYPE_CHECKING
 
 from jenkinsapi.fingerprint import Fingerprint
 from jenkinsapi.custom_exceptions import ArtifactBroken
 
 log = logging.getLogger(__name__)
 
+if TYPE_CHECKING:
+    from jenkinsapi.build import Build
+    from jenkinsapi.jenkins import Jenkins
+
 
 class Artifact(object):
     """

jenkinsapi/build.py

@@ -16,7 +16,7 @@
 import datetime
 
 from time import sleep
-from typing import Iterator, List, Dict, Any
+from typing import TYPE_CHECKING, Iterator, List, Dict, Any
 
 import pytz
 from jenkinsapi import config
@@ -35,6 +35,10 @@
 
 log = logging.getLogger(__name__)
 
+if TYPE_CHECKING:
+    from jenkinsapi.jenkins import Jenkins
+    from jenkinsapi.job import Job
+
 
 class Build(JenkinsBase):
     """
@@ -238,8 +242,8 @@ def get_upstream_job(self) -> Job | None:
         Get the upstream job object if it exist, None otherwise
         :return: Job or None
         """
-        if self.get_upstream_job_name():
-            return self.get_jenkins_obj().get_job(self.get_upstream_job_name())
+        if name := self.get_upstream_job_name():
+            return self.get_jenkins_obj().get_job(name)
         return None
 
     def get_upstream_build_number(self) -> int | None:
@@ -278,8 +282,8 @@ def get_master_job(self) -> Job | None:
         Get the master job object if it exist, None otherwise
         :return: Job or None
         """
-        if self.get_master_job_name():
-            return self.get_jenkins_obj().get_job(self.get_master_job_name())
+        if name := self.get_master_job_name():
+            return self.get_jenkins_obj().get_job(name)
 
         return None
 

jenkinsapi/credential.py

@@ -83,6 +83,9 @@ class UsernamePasswordCredential(Credential):
     dict
     """
 
+    username: str
+    password: str
+
     def __init__(self, cred_dict: dict) -> None:
         jenkins_class: str = (
             "com.cloudbees.plugins.credentials.impl."
@@ -92,12 +95,11 @@ def __init__(self, cred_dict: dict) -> None:
             cred_dict, jenkins_class
         )
         if "typeName" in cred_dict:
-            username: str = cred_dict["displayName"].split("/")[0]
+            self.username = cred_dict["displayName"].split("/")[0]
         else:
-            username: str = cred_dict["userName"]
+            self.username = cred_dict["userName"]
 
-        self.username: str = username
-        self.password: str = cred_dict.get("password", "")
+        self.password = cred_dict.get("password", "")
 
     def get_attributes(self):
         """
@@ -223,26 +225,31 @@ class SSHKeyCredential(Credential):
     dict
     """
 
+    username: str
+    passphrase: str
+    key_type: int
+    key_value: str
+
     def __init__(self, cred_dict: dict) -> None:
         jenkins_class: str = (
             "com.cloudbees.jenkins.plugins.sshcredentials.impl."
             "BasicSSHUserPrivateKey"
         )
         super(SSHKeyCredential, self).__init__(cred_dict, jenkins_class)
+
         if "typeName" in cred_dict:
-            username: str = cred_dict["displayName"].split(" ")[0]
+            self.username = cred_dict["displayName"].split(" ")[0]
         else:
-            username: str = cred_dict["userName"]
+            self.username = cred_dict["userName"]
 
-        self.username: str = username
-        self.passphrase: str = cred_dict.get("passphrase", "")
+        self.passphrase = cred_dict.get("passphrase", "")
 
         if "private_key" not in cred_dict or cred_dict["private_key"] is None:
-            self.key_type: int = -1
-            self.key_value: str = ""
+            self.key_type = -1
+            self.key_value = ""
         elif cred_dict["private_key"].startswith("-"):
-            self.key_type: int = 0
-            self.key_value: str = cred_dict["private_key"]
+            self.key_type = 0
+            self.key_value = cred_dict["private_key"]
         else:
             raise ValueError("Invalid private_key value")
 

jenkinsapi/credentials.py

@@ -6,7 +6,7 @@
 
 from __future__ import annotations
 
-from typing import Iterator
+from typing import TYPE_CHECKING, Iterator, Tuple
 
 import logging
 from urllib.parse import urlencode
@@ -20,6 +20,9 @@
 
 log: logging.Logger = logging.getLogger(__name__)
 
+if TYPE_CHECKING:
+    from jenkinsapi.jenkins import Jenkins
+
 
 class Credentials(JenkinsBase):
     """
@@ -65,7 +68,7 @@ def iterkeys(self):
     def keys(self):
         return list(self.iterkeys())
 
-    def iteritems(self) -> Iterator[str, "Credential"]:
+    def iteritems(self) -> Iterator[Tuple[str, "Credential"]]:
         for cred in self.credentials.values():
             yield cred.description, cred
 

jenkinsapi/executor.py

@@ -3,12 +3,16 @@
 """
 
 from __future__ import annotations
+from typing import TYPE_CHECKING
 
 from jenkinsapi.jenkinsbase import JenkinsBase
 import logging
 
 log = logging.getLogger(__name__)
 
+if TYPE_CHECKING:
+    from jenkinsapi.jenkins import Jenkins
+
 
 class Executor(JenkinsBase):
     """

jenkinsapi/executors.py

@@ -7,13 +7,16 @@
 from __future__ import annotations
 
 import logging
-from typing import Iterator
+from typing import TYPE_CHECKING, Iterator
 
 from jenkinsapi.executor import Executor
 from jenkinsapi.jenkinsbase import JenkinsBase
 
 log: logging.Logger = logging.getLogger(__name__)
 
+if TYPE_CHECKING:
+    from jenkinsapi.jenkins import Jenkins
+
 
 class Executors(JenkinsBase):
     """
@@ -27,7 +30,7 @@ def __init__(
         self, baseurl: str, nodename: str, jenkins: "Jenkins"
     ) -> None:
         self.nodename: str = nodename
-        self.jenkins: str = jenkins
+        self.jenkins: "Jenkins" = jenkins
         JenkinsBase.__init__(self, baseurl)
         self.count: int = self._data["numExecutors"]
 

jenkinsapi/fingerprint.py

@@ -6,7 +6,7 @@
 
 import re
 import logging
-from typing import Any
+from typing import TYPE_CHECKING, Any
 
 import requests
 
@@ -15,6 +15,9 @@
 
 log: logging.Logger = logging.getLogger(__name__)
 
+if TYPE_CHECKING:
+    from jenkinsapi.jenkins import Jenkins
+
 
 class Fingerprint(JenkinsBase):
     """

jenkinsapi/jenkinsbase.py

@@ -20,6 +20,8 @@ class JenkinsBase(object):
     inherited from
     """
 
+    _data: dict
+
     def __repr__(self):
         return """<%s.%s %s>""" % (
             self.__class__.__module__,

jenkinsapi/job.py

@@ -6,6 +6,7 @@
 
 import json
 import logging
+from typing import TYPE_CHECKING
 import xml.etree.ElementTree as ET
 import urllib.parse as urlparse
 
@@ -34,6 +35,9 @@
 
 log = logging.getLogger(__name__)
 
+if TYPE_CHECKING:
+    from jenkinsapi.jenkins import Jenkins
+
 
 class Job(JenkinsBase, MutableJenkinsThing):
     """

jenkinsapi/jobs.py

@@ -5,7 +5,7 @@
 
 from __future__ import annotations
 
-from typing import Iterator
+from typing import TYPE_CHECKING, Iterator, Tuple
 import logging
 import time
 
@@ -14,6 +14,10 @@
 
 log = logging.getLogger(__name__)
 
+if TYPE_CHECKING:
+    from jenkinsapi.jenkins import Jenkins
+    from jenkinsapi.queue import QueueItem
+
 
 class Jobs(object):
     """
@@ -94,7 +98,7 @@ def __getitem__(self, job_name: str) -> "Job":
         else:
             raise UnknownJob(job_name)
 
-    def iteritems(self) -> Iterator[str, "Job"]:
+    def iteritems(self) -> Iterator[Tuple[str, "Job"]]:
         """
         Iterate over the names & objects for all jobs
         """