Make the signature for get_git_url return an empty string rather than None if there is no remote for ease of type checking

Author: martinjm97

src/tap/tap.py

@@ -331,7 +331,7 @@ def add_subparser(self, flag: str, subparser_type: type, **kwargs) -> None:
         self._subparser_buffer.append((flag, subparser_type, kwargs))
 
     def _add_subparsers(self) -> None:
-        """Add each of the subparsers to the Tap object. """
+        """Add each of the subparsers to the Tap object."""
         # Initialize the _subparsers object if not already created
         if self._subparsers is None and len(self._subparser_buffer) > 0:
             self._subparsers = super(Tap, self).add_subparsers()
@@ -345,7 +345,7 @@ def add_subparsers(self, **kwargs) -> None:
         self._subparsers = super().add_subparsers(**kwargs)
 
     def _configure(self) -> None:
-        """Executes the user-defined configuration. """
+        """Executes the user-defined configuration."""
         # Call the user-defined configuration
         self.configure()
 
@@ -370,7 +370,7 @@ def configure(self) -> None:
         pass
 
     @staticmethod
-    def get_reproducibility_info(repo_path: Optional[PathLike] = None) -> Dict[str, Optional[str]]:
+    def get_reproducibility_info(repo_path: Optional[PathLike] = None) -> Dict[str, str]:
         """Gets a dictionary of reproducibility information.
 
         Reproducibility information always includes:
@@ -402,7 +402,7 @@ def get_reproducibility_info(repo_path: Optional[PathLike] = None) -> Dict[str,
         if git_info.has_git():
             reproducibility["git_root"] = git_info.get_git_root()
             reproducibility["git_url"] = git_info.get_git_url(commit_hash=True)
-            reproducibility["git_has_uncommitted_changes"] = git_info.has_uncommitted_changes()
+            reproducibility["git_has_uncommitted_changes"] = str(git_info.has_uncommitted_changes())
 
         return reproducibility
 
@@ -727,7 +727,7 @@ def __deepcopy__(self, memo: Dict[int, Any] = None) -> TapType:
 
         memo[id(self)] = copied
 
-        for (k, v) in self.__dict__.items():
+        for k, v in self.__dict__.items():
             copied.__dict__[k] = deepcopy(v, memo)
 
         return copied

src/tap/utils.py

@@ -83,12 +83,12 @@ def get_git_version(self) -> tuple:
         number_start_index = next(i for i, c in enumerate(raw) if c.isdigit())
         return tuple(int(num) for num in raw[number_start_index:].split("."))
 
-    def get_git_url(self, commit_hash: bool = True) -> Optional[str]:
+    def get_git_url(self, commit_hash: bool = True) -> str:
         """Gets the https url of the git repo where the command is run.
 
         :param commit_hash: If True, the url links to the latest local git commit hash.
         If False, the url links to the general git url.
-        :return: The https url of the current git repo.
+        :return: The https url of the current git repo or an empty string for a local repo.
         """
         # Get git url (either https or ssh)
         input_remote = (
@@ -102,7 +102,7 @@ def get_git_url(self, commit_hash: bool = True) -> Optional[str]:
             if e.returncode == 2:
                 # https://git-scm.com/docs/git-remote#_exit_status
                 # 2: The remote does not exist.
-                return None
+                return ""
             raise e
 
         # Remove .git at end
@@ -417,7 +417,7 @@ def default(self, obj: Any) -> Any:
 
 
 class UnpicklableObject:
-    """A class that serves as a placeholder for an object that could not be pickled. """
+    """A class that serves as a placeholder for an object that could not be pickled."""
 
     def __eq__(self, other):
         return isinstance(other, UnpicklableObject)

tests/test_utils.py

@@ -110,7 +110,7 @@ def test_get_git_url_ssh_hash_enterprise(self) -> None:
 
     def test_get_git_url_no_remote(self) -> None:
         subprocess.run(["git", "remote", "remove", "origin"])
-        self.assertIsNone(self.git_info.get_git_url())
+        self.assertEqual(self.git_info.get_git_url(), "")
 
     def test_get_git_version(self) -> None:
         git_version = self.git_info.get_git_version()