Enforce strict Optional typing

Signed-off-by: František Nečas <[email protected]>

Author: František Nečas

.pre-commit-config.yaml

@@ -38,7 +38,7 @@ repos:
     rev: v0.961
     hooks:
       - id: mypy
-        args: [--no-strict-optional, --ignore-missing-imports]
+        args: [--ignore-missing-imports]
         additional_dependencies:
           [types-pkg_resources, types-requests, types-Deprecated]
   - repo: https://github.com/packit/pre-commit-hooks

ogr/abstract.py

@@ -217,7 +217,7 @@ def body(self, new_body: str) -> None:
         self._body = new_body
 
     @property
-    def id(self) -> int:
+    def id(self) -> Optional[int]:
         return self._id
 
     @property
@@ -226,12 +226,12 @@ def author(self) -> str:
         return self._author
 
     @property
-    def created(self) -> datetime.datetime:
+    def created(self) -> Optional[datetime.datetime]:
         """Datetime of creation of the comment."""
         return self._created
 
     @property
-    def edited(self) -> datetime.datetime:
+    def edited(self) -> Optional[datetime.datetime]:
         """Datetime of last edit of the comment."""
         return self._edited
 
@@ -256,7 +256,7 @@ def add_reaction(self, reaction: str) -> Reaction:
 
 class IssueComment(Comment):
     @property
-    def issue(self) -> "Issue":
+    def issue(self) -> Optional["Issue"]:
         """Issue of issue comment."""
         return self._parent
 
@@ -266,7 +266,7 @@ def __str__(self) -> str:
 
 class PRComment(Comment):
     @property
-    def pull_request(self) -> "PullRequest":
+    def pull_request(self) -> Optional["PullRequest"]:
         """Pull request of pull request comment."""
         return self._parent
 
@@ -642,12 +642,12 @@ def head_commit(self) -> str:
         raise NotImplementedError()
 
     @property
-    def target_branch_head_commit(self) -> str:
+    def target_branch_head_commit(self) -> Optional[str]:
         """Commit hash of the HEAD commit of the target branch."""
         raise NotImplementedError()
 
     @property
-    def merge_commit_sha(self) -> str:
+    def merge_commit_sha(self) -> Optional[str]:
         """
         Commit hash of the merge commit of the pull request.
 
@@ -1009,12 +1009,12 @@ def set(
         raise NotImplementedError()
 
     @property
-    def created(self) -> datetime.datetime:
+    def created(self) -> Optional[datetime.datetime]:
         """Datetime of creating the commit status."""
         raise NotImplementedError()
 
     @property
-    def edited(self) -> datetime.datetime:
+    def edited(self) -> Optional[datetime.datetime]:
         """Datetime of editing the commit status."""
         raise NotImplementedError()
 
@@ -1230,7 +1230,7 @@ class GitService(OgrAbstractClass):
         instance_url (str): URL of the git forge instance.
     """
 
-    instance_url: Optional[str] = None
+    instance_url: str
 
     def __init__(self, **_: Any) -> None:
         pass
@@ -1326,7 +1326,9 @@ def list_projects(
 
 
 class GitProject(OgrAbstractClass):
-    def __init__(self, repo: str, service: GitService, namespace: str) -> None:
+    def __init__(
+        self, repo: str, service: GitService, namespace: Optional[str]
+    ) -> None:
         """
         Args:
             repo: Name of the project.
@@ -1335,7 +1337,7 @@ def __init__(self, repo: str, service: GitService, namespace: str) -> None:
 
                 - GitHub: username or org name.
                 - GitLab: username or org name.
-                - Pagure: namespace (e.g. `"rpms"`).
+                - Pagure: namespace (e.g. `"rpms"`). May be none.
 
                   In case of forks: `"fork/{username}/{namespace}"`.
         """
@@ -1916,7 +1918,7 @@ def get_username(self) -> str:
         """
         raise NotImplementedError()
 
-    def get_email(self) -> str:
+    def get_email(self) -> Optional[str]:
         """
         Returns:
             Email of the user.

ogr/factory.py

@@ -80,6 +80,11 @@ def get_project(
 
     Returns:
         `GitProject` using the matching implementation.
+
+    Raises:
+        OgrException, if the url failed to be parsed or no matching
+            project type was found.
+
     """
     mapping = service_mapping_update.copy() if service_mapping_update else {}
     custom_instances = custom_instances or []
@@ -88,6 +93,8 @@ def get_project(
 
     kls = get_service_class(url=url, service_mapping_update=mapping)
     parsed_repo_url = parse_git_repo(url)
+    if not parsed_repo_url:
+        raise OgrException(f"Failed to parse url '{url}', invalid format.")
 
     service = None
     if custom_instances:
@@ -131,8 +138,11 @@ def get_service_class_or_none(
         mapping.update(service_mapping_update)
 
     parsed_url = parse_git_repo(url)
+    if not parsed_url:
+        return None
+
     for service, service_kls in mapping.items():
-        if service in parsed_url.hostname:
+        if parsed_url.hostname and service in parsed_url.hostname:
             return service_kls
 
     return None

ogr/parsing.py

@@ -10,7 +10,7 @@ class RepoUrl:
     Class that represents repo URL.
 
     Attributes:
-        repo (str): Name of the repository.
+        repo (Optional[str]): Name of the repository. Can be None if parsing is being done.
         namespace (Optional[str]): Namespace of the repository, if has any.
         username (Optional[str]): Username of the repository owner, if can be
             specified.
@@ -22,7 +22,7 @@ class RepoUrl:
 
     def __init__(
         self,
-        repo: str,
+        repo: Optional[str],
         namespace: Optional[str] = None,
         username: Optional[str] = None,
         is_fork: bool = False,

ogr/services/base.py

@@ -49,7 +49,7 @@ def full_repo_name(self) -> str:
 
 class BasePullRequest(PullRequest):
     @property
-    def target_branch_head_commit(self) -> str:
+    def target_branch_head_commit(self) -> Optional[str]:
         return self.target_project.get_sha_from_branch(self.target_branch)
 
     def get_comments(

ogr/services/github/auth_providers/abstract.py

@@ -11,7 +11,7 @@ class GithubAuthentication:
     Represents a token manager for authentication via GitHub App.
     """
 
-    def get_token(self, namespace: str, repo: str) -> str:
+    def get_token(self, namespace: str, repo: str) -> Optional[str]:
         """
         Get a GitHub token for requested repository.
 
@@ -20,7 +20,8 @@ def get_token(self, namespace: str, repo: str) -> str:
             repo: Name of the repository.
 
         Returns:
-            A token that can be used in PyGithub instance for authentication.
+            A token that can be used in PyGithub instance for authentication if it
+            can be obtained, None otherwise.
         """
         raise NotImplementedError()
 

ogr/services/github/auth_providers/github_app.py

@@ -11,7 +11,9 @@
 
 
 class GithubApp(GithubAuthentication):
-    def __init__(self, id: str, private_key: str, private_key_path: str) -> None:
+    def __init__(
+        self, id: str, private_key: Optional[str], private_key_path: Optional[str]
+    ) -> None:
         self.id = id
         self._private_key = private_key
         self._private_key_path = private_key_path
@@ -45,7 +47,7 @@ def __str__(self) -> str:
         return f"GithubApp({censored_id}{censored_private_key}{private_key_path})"
 
     @property
-    def private_key(self) -> str:
+    def private_key(self) -> Optional[str]:
         if self._private_key:
             return self._private_key
 
@@ -71,7 +73,7 @@ def integration(self) -> github.GithubIntegration:
             self._integration = github.GithubIntegration(self.id, self.private_key)
         return self._integration
 
-    def get_token(self, namespace: str, repo: str) -> str:
+    def get_token(self, namespace: str, repo: str) -> Optional[str]:
         if not self.private_key:
             return None
 

ogr/services/github/auth_providers/token.py

@@ -10,7 +10,9 @@
 
 
 class TokenAuthentication(GithubAuthentication):
-    def __init__(self, token: str, max_retries: Union[int, Retry] = 0, **_) -> None:
+    def __init__(
+        self, token: Optional[str], max_retries: Union[int, Retry] = 0, **_
+    ) -> None:
         self._token = token
         self._pygithub_instance = github.Github(login_or_token=token, retry=max_retries)
 
@@ -29,11 +31,11 @@ def __str__(self) -> str:
     def pygithub_instance(self) -> github.Github:
         return self._pygithub_instance
 
-    def get_token(self, namespace: str, repo: str) -> str:
+    def get_token(self, namespace: str, repo: str) -> Optional[str]:
         return self._token
 
     @staticmethod
     def try_create(
-        token: str = None, max_retries: Union[int, Retry] = 0, **_
+        token: Optional[str] = None, max_retries: Union[int, Retry] = 0, **_
     ) -> Optional["TokenAuthentication"]:
         return TokenAuthentication(token, max_retries=max_retries)

ogr/services/github/flag.py

@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: MIT
 
 import datetime
-from typing import List
+from typing import List, Optional
 
 from github import UnknownObjectException
 
@@ -64,9 +64,13 @@ def set(
         return GithubCommitFlag(project=project, raw_commit_flag=status, commit=commit)
 
     @property
-    def created(self) -> datetime.datetime:
-        return self._raw_commit_flag.created_at
+    def created(self) -> Optional[datetime.datetime]:
+        if self._raw_commit_flag:
+            return self._raw_commit_flag.created_at
+        return None
 
     @property
-    def edited(self) -> datetime.datetime:
-        return self._raw_commit_flag.updated_at
+    def edited(self) -> Optional[datetime.datetime]:
+        if self._raw_commit_flag:
+            return self._raw_commit_flag.updated_at
+        return None

ogr/services/github/pull_request.py

@@ -27,7 +27,7 @@
 class GithubPullRequest(BasePullRequest):
     _raw_pr: _GithubPullRequest
     _target_project: "ogr_github.GithubProject"
-    _source_project: "ogr_github.GithubProject" = None
+    _source_project: Optional["ogr_github.GithubProject"] = None
 
     @property
     def title(self) -> str:
@@ -148,17 +148,18 @@ def create(
         github_repo = project.github_repo
 
         target_project = project
-        if project.is_fork and fork_username is None:
-            logger.warning(f"{project.full_repo_name} is fork, ignoring fork_repo.")
-            source_branch = f"{project.namespace}:{source_branch}"
-            github_repo = project.parent.github_repo
-            target_project = project.parent
-        elif fork_username:
-            source_branch = f"{fork_username}:{source_branch}"
-            if fork_username != project.namespace and project.parent is not None:
-                github_repo = GithubPullRequest.__get_fork(
-                    fork_username, project.parent.github_repo
-                )
+        if project.parent:
+            if project.is_fork and fork_username is None:
+                logger.warning(f"{project.full_repo_name} is fork, ignoring fork_repo.")
+                source_branch = f"{project.namespace}:{source_branch}"
+                github_repo = project.parent.github_repo
+                target_project = project.parent
+            elif fork_username:
+                source_branch = f"{fork_username}:{source_branch}"
+                if fork_username != project.namespace and project.parent is not None:
+                    github_repo = GithubPullRequest.__get_fork(
+                        fork_username, project.parent.github_repo
+                    )
 
         created_pr = github_repo.create_pull(
             title=title, body=body, base=target_branch, head=source_branch

ogr/services/github/release.py

@@ -7,7 +7,7 @@
 from github.GitRelease import GitRelease as PyGithubRelease
 
 from ogr.abstract import Release, GitTag
-from ogr.exceptions import GithubAPIException
+from ogr.exceptions import GithubAPIException, OgrException
 from ogr.services import github as ogr_github
 
 
@@ -45,7 +45,10 @@ def body(self):
 
     @property
     def git_tag(self) -> GitTag:
-        return self.project.get_tag_from_tag_name(self.tag_name)
+        tag = self.project.get_tag_from_tag_name(self.tag_name)
+        if not tag:
+            raise OgrException(f"No tag with name '{self.tag_name}' found.")
+        return tag
 
     @property
     def tag_name(self) -> str:

ogr/services/github/service.py

@@ -183,7 +183,9 @@ def project_create(
         )
 
     def get_pygithub_instance(self, namespace: str, repo: str) -> PyGithubInstance:
-        token = self.authentication.get_token(namespace, repo)
+        token = None
+        if self.authentication:
+            token = self.authentication.get_token(namespace, repo)
         return PyGithubInstance(login_or_token=token, retry=self._max_retries)
 
     def list_projects(

ogr/services/gitlab/flag.py

@@ -3,7 +3,7 @@
 
 import logging
 import datetime
-from typing import List
+from typing import List, Optional
 
 import gitlab
 
@@ -93,9 +93,13 @@ def set(
         return GitlabCommitFlag(raw_commit_flag=raw_status, project=project)
 
     @property
-    def created(self) -> datetime.datetime:
-        return datetime.datetime.strptime(
-            self._raw_commit_flag.created_at, "%Y-%m-%dT%H:%M:%S.%fZ"
+    def created(self) -> Optional[datetime.datetime]:
+        return (
+            datetime.datetime.strptime(
+                self._raw_commit_flag.created_at, "%Y-%m-%dT%H:%M:%S.%fZ"
+            )
+            if self._raw_commit_flag
+            else None
         )
 
     @property

ogr/services/gitlab/issue.py

@@ -47,7 +47,7 @@ def url(self) -> str:
         return self._raw_issue.web_url
 
     @property
-    def assignees(self) -> list:
+    def assignees(self) -> Optional[list]:
         try:
             return self._raw_issue.assignees
         except AttributeError:

ogr/services/gitlab/project.py

@@ -75,8 +75,8 @@ def parent(self) -> Optional["GitlabProject"]:
         return None
 
     @property
-    def default_branch(self) -> Optional[str]:
-        return self.gitlab_repo.attributes.get("default_branch")
+    def default_branch(self) -> str:
+        return self.gitlab_repo.attributes["default_branch"]
 
     def __str__(self) -> str:
         return f'GitlabProject(namespace="{self.namespace}", repo="{self.repo}")'