Typing support

.github/workflows/unit-test.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
 
     steps:
     - uses: actions/checkout@v3

.gitignore

@@ -20,6 +20,7 @@ Test.tar.gz
 Test_file.zip
 test_all_components.json
 test_all_releases.json
+real_instance_tests.py
 
 # test coverage
 htmlcov/

ChangeLog.md

@@ -5,6 +5,11 @@
 
 # SW360 Base Library for Python
 
+## V1.3.2
+
+* have type hints.
+* drop support for Python 3.7
+
 ## V1.3.1
 
 * dependency updates to fix security vulnerabilities.

check_project.py

@@ -37,10 +37,11 @@
 import argparse
 import os
 import sys
-from typing import Any, Dict, List, Optional
+from typing import Any, Dict, Optional
 
-from colorama import init, Fore, Style
 import requests
+from colorama import Fore, Style, init
+
 import sw360
 
 # Do you use an oauth flow? This is usually False if you get your SW360 token
@@ -54,10 +55,9 @@
 class CheckProject():
     """Check a project on SW360, display component clearing status"""
     def __init__(self) -> None:
-        self.client = None
-        self.project_id = ""
-        self.project = None
-        self.sw360_url = "https://sw360.siemens.com"
+        self.client: sw360.SW360
+        self.project_id: str = ""
+        self.sw360_url: str = "https://sw360.siemens.com"
 
     @classmethod
     def get_clearing_state(cls, proj: Dict[Any, Any], href: str) -> str | None:
@@ -75,6 +75,9 @@ def get_clearing_state(cls, proj: Dict[Any, Any], href: str) -> str | None:
     def has_source_code(self, href: str) -> bool:
         """Returns true if a source code attachment is available"""
         rel = self.client.get_release_by_url(href)
+        if not rel:
+            return False
+
         if "_embedded" not in rel:
             return False
 
@@ -136,6 +139,10 @@ def show_project_status(self, project_id: str) -> None:
             print(Fore.LIGHTRED_EX + "  ERROR: unable to access project!")
             sys.exit("  " + str(swex) + Style.RESET_ALL)
 
+        if not project:
+            print("  Project not found!")
+            return
+
         print("  Project name: " + project["name"] + ", " + project["version"])
         if "projectResponsible" in project:
             print("  Project responsible: " + project["projectResponsible"])
@@ -178,7 +185,7 @@ def login(self, token: Optional[str] = None, url: Optional[str] = None) -> bool
                     "  Error authorizing user!" +
                     Style.RESET_ALL)
 
-    def find_project(self, name: str, version: str) -> Optional[List[Dict[Any, Any]]]:
+    def find_project(self, name: str, version: str) -> str:
         """Find the project with the matching name and version on SW360"""
         projects = self.client.get_projects_by_name(name)
         if not projects:
@@ -207,7 +214,7 @@ def find_project(self, name: str, version: str) -> Optional[List[Dict[Any, Any]]
                 if project["version"].lower() == version:
                     return pid
 
-        return None
+        return ""
 
     @classmethod
     def parse_commandline(cls) -> Any:

docs-source/conf.py

@@ -15,6 +15,7 @@
 #
 import os
 import sys
+
 current_dir = os.path.dirname(__file__)
 target_dir = os.path.abspath(os.path.join(current_dir, "../sw360"))
 sys.path.insert(0, target_dir)
@@ -42,7 +43,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+exclude_patterns = []  # type: ignore
 
 
 # -- Options for HTML output -------------------------------------------------

pyproject.toml

@@ -41,3 +41,9 @@ types-urllib3 = "^1.26.25.14"
 [build-system]
 requires = ["poetry>=0.12"]
 build-backend = "poetry.masonry.api"
+
+[tool.mypy]
+mypy_path = "stubs"
+exclude = [
+    '/tests',
+]