Fix pyright issues

Author: ben-edna

dfetch/manifest/manifest.py

@@ -27,11 +27,11 @@
 import yaml
 from typing_extensions import TypedDict
 
-import dfetch.manifest.validate
 from dfetch import DEFAULT_MANIFEST_NAME
 from dfetch.log import get_logger
 from dfetch.manifest.project import ProjectEntry, ProjectEntryDict
 from dfetch.manifest.remote import Remote, RemoteDict
+from dfetch.manifest.validate import validate
 from dfetch.util.util import find_file, prefix_runtime_exceptions
 
 logger = get_logger(__name__)
@@ -89,7 +89,7 @@ class ManifestDict(  # pylint: disable=too-many-ancestors
 ):  # When https://www.python.org/dev/peps/pep-0655/ is accepted, only make remotes optional
     """Serialized dict types."""
 
-    version: str
+    version: Union[int, str]
     remotes: Sequence[Union[RemoteDict, Remote]]
     projects: Sequence[Union[ProjectEntryDict, ProjectEntry, Dict[str, str]]]
 
@@ -104,7 +104,7 @@ class Manifest:
 
     def __init__(self, manifest: ManifestDict) -> None:
         """Create the manifest."""
-        self.__version: str = manifest.get("version", self.CURRENT_VERSION)
+        self.__version: str = str(manifest.get("version", self.CURRENT_VERSION))
 
         self._remotes, default_remotes = self._determine_remotes(
             manifest.get("remotes", [])
@@ -114,6 +114,9 @@ def __init__(self, manifest: ManifestDict) -> None:
             default_remotes = list(self._remotes.values())[0:1]
 
         self._default_remote = None if not default_remotes else default_remotes[0]
+
+        if "projects" not in manifest:
+            raise KeyError("No projects in manifest!")
         self._projects = self._init_projects(manifest["projects"])
 
     def _init_projects(
@@ -133,6 +136,8 @@ def _init_projects(
         _projects: Dict[str, ProjectEntry] = {}
         for project in projects:
             if isinstance(project, dict):
+                if "name" not in project:
+                    raise KeyError("Missing name!")
                 last_project = _projects[project["name"]] = ProjectEntry.from_yaml(
                     project, self._default_remote
                 )
@@ -306,11 +311,11 @@ def get_manifest() -> Tuple[Manifest, str]:
     """Get manifest and its path."""
     logger.debug("Looking for manifest")
     manifest_path = find_manifest()
-    dfetch.manifest.validate.validate(manifest_path)
+    validate(manifest_path)
 
     logger.debug(f"Using manifest {manifest_path}")
     return (
-        dfetch.manifest.manifest.Manifest.from_file(manifest_path),
+        Manifest.from_file(manifest_path),
         manifest_path,
     )
 
@@ -320,16 +325,16 @@ def get_childmanifests(skip: Optional[List[str]] = None) -> List[Tuple[Manifest,
     skip = skip or []
     logger.debug("Looking for sub-manifests")
 
-    childmanifests = []
+    childmanifests: List[Tuple[Manifest, str]] = []
     for path in find_file(DEFAULT_MANIFEST_NAME, "."):
         path = os.path.realpath(path)
         if path not in skip:
             logger.debug(f"Found sub-manifests {path}")
             with prefix_runtime_exceptions(
                 pathlib.Path(path).relative_to(os.path.dirname(os.getcwd())).as_posix()
             ):
-                dfetch.manifest.validate.validate(path)
-            childmanifest = dfetch.manifest.manifest.Manifest.from_file(path)
+                validate(path)
+            childmanifest = Manifest.from_file(path)
             childmanifests += [(childmanifest, path)]
 
     return childmanifests

dfetch/manifest/project.py

@@ -281,6 +281,8 @@ class ProjectEntry:  # pylint: disable=too-many-instance-attributes
 
     def __init__(self, kwargs: ProjectEntryDict) -> None:
         """Create the project entry."""
+        if "name" not in kwargs:
+            raise RuntimeError("Name missing from Project!")
         self._name: str = kwargs["name"]
         self._revision: str = kwargs.get("revision", "")
 

dfetch/project/metadata.py

@@ -6,7 +6,7 @@
 import yaml
 from typing_extensions import TypedDict
 
-import dfetch.manifest.manifest
+from dfetch.manifest.project import ProjectEntry
 from dfetch.manifest.version import Version
 
 DONT_EDIT_WARNING = """\
@@ -52,9 +52,7 @@ def __init__(self, kwargs: Options) -> None:
         self._patch: str = str(kwargs.get("patch", ""))
 
     @classmethod
-    def from_project_entry(
-        cls, project: dfetch.manifest.project.ProjectEntry
-    ) -> "Metadata":
+    def from_project_entry(cls, project: ProjectEntry) -> "Metadata":
         """Create a metadata object from a project entry."""
         data: Options = {
             "branch": project.branch,

dfetch/project/vcs.py

@@ -9,8 +9,8 @@
 from halo import Halo
 from patch_ng import fromfile
 
-import dfetch.manifest.manifest
 from dfetch.log import get_logger
+from dfetch.manifest.project import ProjectEntry
 from dfetch.manifest.version import Version
 from dfetch.project.abstract_check_reporter import AbstractCheckReporter
 from dfetch.project.metadata import Metadata
@@ -31,7 +31,7 @@ class VCS(ABC):
     DEFAULT_BRANCH = ""
     LICENSE_GLOBS = ["licen[cs]e*", "copying*", "copyright*"]
 
-    def __init__(self, project: dfetch.manifest.project.ProjectEntry) -> None:
+    def __init__(self, project: ProjectEntry) -> None:
         """Create the VCS."""
         self.__project = project
         self.__metadata = Metadata.from_project_entry(self.__project)
@@ -355,7 +355,7 @@ def current_revision(self) -> str:
         """Get the revision of the metadata file."""
 
     @abstractmethod
-    def get_diff(self, old_revision: str, new_revision: Optional[str]) -> str:
+    def get_diff(self, old_revision: str, new_revision: Optional[str]) -> str:  # noqa
         """Get the diff of two revisions."""
 
     @staticmethod

dfetch/reporting/check/sarif_reporter.py

@@ -70,6 +70,10 @@
 
 """
 
+# Underlying sarif-tools is generated with attr which pyright does not support
+# See https://github.com/microsoft/pyright/issues/146
+# pyright: reportCallIssue=false
+
 import json
 import os
 from enum import Enum
@@ -154,7 +158,7 @@ def __init__(self, manifest_path: str, report_path: str) -> None:
             )
         ]
         self._run.results = []
-        self._run.newline_sequences = None
+        self._run.newline_sequences = []
 
     @staticmethod
     def _severity_to_level(severity: IssueSeverity) -> SarifResultLevel:

dfetch/reporting/sbom_reporter.py

@@ -108,7 +108,7 @@ def _split_url(url: str) -> List[str]:
 
     def dump_to_file(self, outfile: str) -> bool:
         """Dump the SBoM to file."""
-        output_format = (
+        output_format = OutputFormat(
             OutputFormat.XML if outfile.endswith(".xml") else OutputFormat.JSON
         )
         outputter = cast(Json, get_instance(bom=self._bom, output_format=output_format))

doc/_ext/scenario_directive.py

@@ -23,7 +23,7 @@
 
 import os
 import re
-from typing import Iterable
+from typing import Tuple
 
 from docutils import nodes
 from docutils.parsers.rst import Directive
@@ -39,20 +39,20 @@ class ScenarioIncludeDirective(Directive):
         "scenario": str,
     }
 
-    def list_of_scenarios(self, feature_file_path: str) -> Iterable[str]:
+    def list_of_scenarios(self, feature_file_path: str) -> Tuple[str]:
         """Parse the list of scenarios from the feature file"""
         env = self.state.document.settings.env
         feature_path = os.path.abspath(os.path.join(env.app.srcdir, feature_file_path))
         if not os.path.exists(feature_path):
             raise self.error(f"Feature file not found: {feature_path}")
 
         with open(feature_path, encoding="utf-8") as f:
-            scenarios = [
+            scenarios = tuple(
                 m[1]
                 for m in re.findall(
                     r"^\s*(Scenario(?: Outline)?):\s*(.+)$", f.read(), re.MULTILINE
                 )
-            ]
+            )
         return scenarios
 
     def run(self):

features/steps/generic_steps.py

@@ -1,5 +1,6 @@
 """Steps for features tests."""
 
+# pyright: reportRedeclaration=false, reportAttributeAccessIssue=false
 # pylint: disable=function-redefined, missing-function-docstring
 
 import difflib

features/steps/git_steps.py

@@ -1,6 +1,7 @@
 """Steps for features tests."""
 
 # pylint: disable=function-redefined, missing-function-docstring, import-error
+# pyright: reportRedeclaration=false, reportAttributeAccessIssue=false
 
 import os
 import pathlib

features/steps/manifest_steps.py

@@ -1,7 +1,7 @@
 """Steps for features tests."""
 
 # pylint: disable=function-redefined, missing-function-docstring, import-error
-
+# pyright: reportRedeclaration=false, reportAttributeAccessIssue=false
 
 import os
 import pathlib