Add types to Remote. iter_items() set_url() add_url() delete_url()

Author: Yobmod

git/remote.py

@@ -16,7 +16,7 @@
     Iterable,
     IterableList,
     RemoteProgress,
-    CallableRemoteProgress
+    CallableRemoteProgress,
 )
 from git.util import (
     join_path,
@@ -36,7 +36,7 @@
 
 # typing-------------------------------------------------------
 
-from typing import Any, Callable, Dict, Optional, TYPE_CHECKING, Union, cast, overload
+from typing import Any, Callable, Dict, Generator, Optional, TYPE_CHECKING, Union, cast, overload
 
 from git.types import PathLike, Literal
 
@@ -276,7 +276,8 @@ def refresh(cls) -> Literal[True]:
 
         return True
 
-    def __init__(self, ref: SymbolicReference, flags: int, note: str = '', old_commit: Optional['Commit'] = None,
+    def __init__(self, ref: SymbolicReference, flags: int, note: str = '',
+                 old_commit: Union[Commit, TagReference, Tree, Blob, None] = None,
                  remote_ref_path: Optional[PathLike] = None) -> None:
         """
         Initialize a new instance
@@ -341,7 +342,7 @@ def _from_line(cls, repo: 'Repo', line: str, fetch_line: str) -> 'FetchInfo':
         # END control char exception handling
 
         # parse operation string for more info - makes no sense for symbolic refs, but we parse it anyway
-        old_commit = None
+        old_commit = None  # type: Union[Commit, TagReference, Tree, Blob, None]
         is_tag_operation = False
         if 'rejected' in operation:
             flags |= cls.REJECTED
@@ -455,24 +456,24 @@ def __getattr__(self, attr: str) -> Any:
             return super(Remote, self).__getattr__(attr)
         # END handle exception
 
-    def _config_section_name(self):
+    def _config_section_name(self) -> str:
         return 'remote "%s"' % self.name
 
-    def _set_cache_(self, attr):
+    def _set_cache_(self, attr: str) -> Any:
         if attr == "_config_reader":
             # NOTE: This is cached as __getattr__ is overridden to return remote config values implicitly, such as
             # in print(r.pushurl)
             self._config_reader = SectionConstraint(self.repo.config_reader("repository"), self._config_section_name())
         else:
             super(Remote, self)._set_cache_(attr)
 
-    def __str__(self):
+    def __str__(self) -> str:
         return self.name
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return '<git.%s "%s">' % (self.__class__.__name__, self.name)
 
-    def __eq__(self, other):
+    def __eq__(self, other: object) -> bool:
         return isinstance(other, type(self)) and self.name == other.name
 
     def __ne__(self, other):
@@ -496,7 +497,7 @@ def exists(self) -> bool:
         # end
 
     @classmethod
-    def iter_items(cls, repo):
+    def iter_items(cls, repo: 'Repo') -> Generator['Remote', None, None]:
         """:return: Iterator yielding Remote objects of the given repository"""
         for section in repo.config_reader("repository").sections():
             if not section.startswith('remote '):
@@ -508,7 +509,7 @@ def iter_items(cls, repo):
             yield Remote(repo, section[lbound + 1:rbound])
         # END for each configuration section
 
-    def set_url(self, new_url, old_url=None, **kwargs):
+    def set_url(self, new_url: str, old_url: Optional[str] = None, **kwargs: Any) -> 'Remote':
         """Configure URLs on current remote (cf command git remote set_url)
 
         This command manages URLs on the remote.
@@ -525,7 +526,7 @@ def set_url(self, new_url, old_url=None, **kwargs):
             self.repo.git.remote(scmd, self.name, new_url, **kwargs)
         return self
 
-    def add_url(self, url, **kwargs):
+    def add_url(self, url: str, **kwargs: Any) -> 'Remote':
         """Adds a new url on current remote (special case of git remote set_url)
 
         This command adds new URLs to a given remote, making it possible to have
@@ -536,7 +537,7 @@ def add_url(self, url, **kwargs):
         """
         return self.set_url(url, add=True)
 
-    def delete_url(self, url, **kwargs):
+    def delete_url(self, url: str, **kwargs: Any) -> 'Remote':
         """Deletes a new url on current remote (special case of git remote set_url)
 
         This command deletes new URLs to a given remote, making it possible to have
@@ -551,7 +552,8 @@ def delete_url(self, url, **kwargs):
     def urls(self):
         """:return: Iterator yielding all configured URL targets on a remote as strings"""
         try:
-            remote_details = self.repo.git.remote("get-url", "--all", self.name)
+            # can replace cast with type assert? 
+            remote_details = cast(str, self.repo.git.remote("get-url", "--all", self.name))
             for line in remote_details.split('\n'):
                 yield line
         except GitCommandError as ex:
@@ -562,14 +564,14 @@ def urls(self):
             #
             if 'Unknown subcommand: get-url' in str(ex):
                 try:
-                    remote_details = self.repo.git.remote("show", self.name)
+                    remote_details = cast(str, self.repo.git.remote("show", self.name))
                     for line in remote_details.split('\n'):
                         if '  Push  URL:' in line:
                             yield line.split(': ')[-1]
                 except GitCommandError as ex:
                     if any(msg in str(ex) for msg in ['correct access rights', 'cannot run ssh']):
                         # If ssh is not setup to access this repository, see issue 694
-                        remote_details = self.repo.git.config('--get-all', 'remote.%s.url' % self.name)
+                        remote_details = cast(str, self.repo.git.config('--get-all', 'remote.%s.url' % self.name))
                         for line in remote_details.split('\n'):
                             yield line
                     else: