💚 Fix CI?

Author: acabarbaye

continuous_delivery_scripts/plugins/basic.py

@@ -6,11 +6,16 @@
 
 import logging
 from pathlib import Path
-from typing import Optional
+from typing import TYPE_CHECKING, Optional
 
-from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.definitions import CommitType
-from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
+from continuous_delivery_scripts.utils.language_specifics_base import (
+    BaseLanguage,
+    get_language_from_file_name,
+)
+
+if TYPE_CHECKING:
+    from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 
 logger = logging.getLogger(__name__)
 
@@ -46,6 +51,6 @@ def can_get_project_metadata(self) -> bool:
         """States whether project metadata can be retrieved."""
         return False
 
-    def get_current_spdx_project(self) -> Optional[SpdxProject]:
+    def get_current_spdx_project(self) -> Optional["SpdxProject"]:
         """Basic."""
         return None

continuous_delivery_scripts/plugins/ci.py

@@ -6,12 +6,20 @@
 
 import logging
 from pathlib import Path
-from typing import Optional
+from typing import TYPE_CHECKING, Optional
 
-from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
-from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
+from continuous_delivery_scripts.utils.configuration import (
+    configuration,
+    ConfigurationVariable,
+)
 from continuous_delivery_scripts.utils.definitions import CommitType
-from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
+from continuous_delivery_scripts.utils.language_specifics_base import (
+    BaseLanguage,
+    get_language_from_file_name,
+)
+
+if TYPE_CHECKING:
+    from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 
 logger = logging.getLogger(__name__)
 
@@ -53,7 +61,7 @@ def can_get_project_metadata(self) -> bool:
         """States whether project metadata can be retrieved."""
         return False
 
-    def get_current_spdx_project(self) -> Optional[SpdxProject]:
+    def get_current_spdx_project(self) -> Optional["SpdxProject"]:
         """Gets current SPDX description."""
         # TODO
         return None

continuous_delivery_scripts/plugins/docker.py

@@ -6,11 +6,16 @@
 
 import logging
 from pathlib import Path
-from typing import Optional
+from typing import TYPE_CHECKING, Optional
 
-from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.definitions import CommitType
-from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
+from continuous_delivery_scripts.utils.language_specifics_base import (
+    BaseLanguage,
+    get_language_from_file_name,
+)
+
+if TYPE_CHECKING:
+    from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 
 logger = logging.getLogger(__name__)
 
@@ -48,7 +53,7 @@ def can_get_project_metadata(self) -> bool:
         """States whether project metadata can be retrieved."""
         return False
 
-    def get_current_spdx_project(self) -> Optional[SpdxProject]:
+    def get_current_spdx_project(self) -> Optional["SpdxProject"]:
         """Gets current SPDX description."""
         # TODO
         return None

continuous_delivery_scripts/plugins/golang.py

@@ -8,13 +8,24 @@
 import os
 from pathlib import Path
 from subprocess import check_call
-from typing import Optional, List, Dict
+from typing import TYPE_CHECKING, Optional, List, Dict
 
-from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
-from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
+from continuous_delivery_scripts.utils.configuration import (
+    configuration,
+    ConfigurationVariable,
+)
 from continuous_delivery_scripts.utils.definitions import CommitType
-from continuous_delivery_scripts.utils.git_helpers import LocalProjectRepository, GitWrapper
-from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
+from continuous_delivery_scripts.utils.git_helpers import (
+    LocalProjectRepository,
+    GitWrapper,
+)
+from continuous_delivery_scripts.utils.language_specifics_base import (
+    BaseLanguage,
+    get_language_from_file_name,
+)
+
+if TYPE_CHECKING:
+    from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 
 logger = logging.getLogger(__name__)
 
@@ -160,7 +171,7 @@ def can_get_project_metadata(self) -> bool:
         """States whether project metadata can be retrieved."""
         return False
 
-    def get_current_spdx_project(self) -> Optional[SpdxProject]:
+    def get_current_spdx_project(self) -> Optional["SpdxProject"]:
         """Gets current SPDX description."""
         # TODO
         return None
@@ -195,4 +206,8 @@ def _call_goreleaser_release(self, version: str) -> None:
         changelogPath = configuration.get_value(ConfigurationVariable.CHANGELOG_FILE_PATH)
         env[ENVVAR_GORELEASER_CUSTOMISED_TAG] = tag
         env[ENVVAR_GORELEASER_GIT_TOKEN] = configuration.get_value(ConfigurationVariable.GIT_TOKEN)
-        check_call(_generate_goreleaser_release_command_list(changelogPath), cwd=ROOT_DIR, env=env)
+        check_call(
+            _generate_goreleaser_release_command_list(changelogPath),
+            cwd=ROOT_DIR,
+            env=env,
+        )

continuous_delivery_scripts/plugins/noop.py

@@ -6,12 +6,17 @@
 
 import logging
 from pathlib import Path
-from typing import Optional, Dict
+from typing import TYPE_CHECKING, Optional, Dict
 
-from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.definitions import CommitType
 from continuous_delivery_scripts.utils.git_helpers import GitWrapper
-from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
+from continuous_delivery_scripts.utils.language_specifics_base import (
+    BaseLanguage,
+    get_language_from_file_name,
+)
+
+if TYPE_CHECKING:
+    from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 
 logger = logging.getLogger(__name__)
 
@@ -48,7 +53,7 @@ def can_get_project_metadata(self) -> bool:
         """States whether project metadata can be retrieved."""
         return False
 
-    def get_current_spdx_project(self) -> Optional[SpdxProject]:
+    def get_current_spdx_project(self) -> Optional["SpdxProject"]:
         """No Op."""
         return None
 

continuous_delivery_scripts/plugins/python.py

@@ -9,20 +9,28 @@
 import sys
 from pathlib import Path
 from subprocess import check_call
-from typing import List, Optional
+from typing import TYPE_CHECKING, List, Optional
 
-from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
-from continuous_delivery_scripts.utils.configuration import configuration, ConfigurationVariable
+from continuous_delivery_scripts.utils.configuration import (
+    configuration,
+    ConfigurationVariable,
+)
 from continuous_delivery_scripts.utils.definitions import CommitType
 from continuous_delivery_scripts.utils.filesystem_helpers import TemporaryDirectory
 from continuous_delivery_scripts.utils.filesystem_helpers import cd
-from continuous_delivery_scripts.utils.language_specifics_base import BaseLanguage, get_language_from_file_name
+from continuous_delivery_scripts.utils.language_specifics_base import (
+    BaseLanguage,
+    get_language_from_file_name,
+)
 from continuous_delivery_scripts.utils.logging import log_exception
 from continuous_delivery_scripts.utils.python.package_helpers import (
     CurrentPythonProjectMetadataFetcher,
     generate_package_info,
 )
 
+if TYPE_CHECKING:
+    from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
+
 ENVVAR_TWINE_USERNAME = "TWINE_USERNAME"
 ENVVAR_TWINE_PASSWORD = "TWINE_PASSWORD"
 OUTPUT_DIRECTORY = "release-dist"
@@ -110,22 +118,34 @@ def _generate_pdoc_in_correct_structure(module_to_document: str, output_director
     Pdoc nests its docs output in a folder with the module's name.
     This process removes this unwanted folder.
     """
-    with TemporaryDirectory() as temp_dir:
-        _call_pdoc(temp_dir, module_to_document)
-        docs_contents_dir = temp_dir.joinpath(module_to_document)
-        if docs_contents_dir.exists() and docs_contents_dir.is_dir():
-            for element in docs_contents_dir.iterdir():
-                shutil.move(str(element), str(output_directory))
+    temp_directory = TemporaryDirectory()
+    if hasattr(temp_directory, "__enter__") and hasattr(temp_directory, "__exit__"):
+        with temp_directory as temp_dir:
+            _call_pdoc(temp_dir, module_to_document)
+            docs_contents_dir = temp_dir.joinpath(module_to_document)
+            if docs_contents_dir.exists() and docs_contents_dir.is_dir():
+                for element in docs_contents_dir.iterdir():
+                    shutil.move(str(element), str(output_directory))
+        return
+
+    temp_dir = Path(str(temp_directory))
+    _call_pdoc(temp_dir, module_to_document)
+    docs_contents_dir = temp_dir.joinpath(module_to_document)
+    if docs_contents_dir.exists() and docs_contents_dir.is_dir():
+        for element in docs_contents_dir.iterdir():
+            shutil.move(str(element), str(output_directory))
 
 
-def _get_current_spdx_project() -> SpdxProject:
+def _get_current_spdx_project() -> "SpdxProject":
     """Gets information about the current project/package."""
     logger.info("Generating package information.")
     try:
         # Trying to generate the egg for the package but this may fail. If so, continue.
         generate_package_info()
     except Exception as e:
         log_exception(logger, e)
+    from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
+
     return SpdxProject(CurrentPythonProjectMetadataFetcher())
 
 
@@ -174,6 +194,6 @@ def should_include_spdx_in_package(self) -> bool:
         # FIXME Comment out SPDX package as no longer working
         return False
 
-    def get_current_spdx_project(self) -> Optional[SpdxProject]:
+    def get_current_spdx_project(self) -> Optional["SpdxProject"]:
         """Gets the current SPDX description."""
         return _get_current_spdx_project()

continuous_delivery_scripts/report_third_party_ip.py

@@ -16,16 +16,18 @@
 import logging
 import sys
 from pathlib import Path
-from typing import Any, Optional
+from typing import TYPE_CHECKING, Any, Optional
 
 from continuous_delivery_scripts.language_specifics import get_language_specifics
-from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
 from continuous_delivery_scripts.utils.logging import set_log_level, log_exception
 
+if TYPE_CHECKING:
+    from continuous_delivery_scripts.spdx_report.spdx_project import SpdxProject
+
 logger = logging.getLogger(__name__)
 
 
-def generate_spdx_project_reports(project: SpdxProject, output_directory: Path) -> SpdxProject:
+def generate_spdx_project_reports(project: "SpdxProject", output_directory: Path) -> "SpdxProject":
     """Generates all the SPDX reports for a given project."""
     logger.info("Generating SPDX report.")
     project.generate_tag_value_files(output_directory)
@@ -34,7 +36,7 @@ def generate_spdx_project_reports(project: SpdxProject, output_directory: Path)
     return project
 
 
-def generate_spdx_reports(output_directory: Path) -> Optional[SpdxProject]:
+def generate_spdx_reports(output_directory: Path) -> Optional["SpdxProject"]:
     """Generates all the SPDX reports for the current project."""
     project = get_language_specifics().get_current_spdx_project()
     if not project:
@@ -51,10 +53,20 @@ def convert_to_path(arg: Any) -> Path:
         return Path(arg)
 
     parser.add_argument(
-        "-o", "--output-dir", help="Output directory where the files are generated", required=True, type=convert_to_path
+        "-o",
+        "--output-dir",
+        help="Output directory where the files are generated",
+        required=True,
+        type=convert_to_path,
     )
 
-    parser.add_argument("-v", "--verbose", action="count", default=0, help="Verbosity, by default errors are reported.")
+    parser.add_argument(
+        "-v",
+        "--verbose",
+        action="count",
+        default=0,
+        help="Verbosity, by default errors are reported.",
+    )
     args = parser.parse_args()
     set_log_level(args.verbose)
 

continuous_delivery_scripts/spdx_report/spdx_dependency.py

@@ -4,8 +4,10 @@
 #
 """Definition of dependency SPDX Document."""
 
-from spdx.checksum import Algorithm
-from spdx.document import ExternalDocumentRef
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from spdx.document import ExternalDocumentRef
 
 
 class DependencySpdxDocumentRef:
@@ -24,7 +26,7 @@ def __init__(self, name: str, namespace: str, checksum: str) -> None:
         self._document_namespace = namespace
         self._document_checksum = checksum
 
-    def generate_external_reference(self) -> ExternalDocumentRef:
+    def generate_external_reference(self) -> "ExternalDocumentRef":
         """Generates the external SPDX reference.
 
         e.g.
@@ -34,6 +36,9 @@ def generate_external_reference(self) -> ExternalDocumentRef:
         Returns:
             corresponding reference
         """
+        from spdx.checksum import Algorithm
+        from spdx.document import ExternalDocumentRef
+
         return ExternalDocumentRef(
             external_document_id=self._document_name,
             spdx_document_uri=self._document_namespace,