Merge pull request #9413 from jdufresne/type-vcs

Complete type annotations for the vcs package

Author: uranusjr

news/f8f0d057-9ed5-4d22-a877-50f2d5adcae0.trivial.rst

@@ -1,6 +1,3 @@
-# The following comment should be removed at some point in the future.
-# mypy: disallow-untyped-defs=False
-
 import logging
 import os
 
@@ -11,7 +8,7 @@
 from pip._internal.vcs.versioncontrol import RemoteNotFoundError, VersionControl, vcs
 
 if MYPY_CHECK_RUNNING:
-    from typing import Optional, Tuple
+    from typing import List, Optional, Tuple
 
     from pip._internal.utils.misc import HiddenText
     from pip._internal.vcs.versioncontrol import AuthInfo, RevOptions
@@ -31,6 +28,7 @@ class Bazaar(VersionControl):
 
     @staticmethod
     def get_base_rev_args(rev):
+        # type: (str) -> List[str]
         return ['-r', rev]
 
     def export(self, location, url):
@@ -107,6 +105,7 @@ def get_revision(cls, location):
 
     @classmethod
     def is_commit_id_equal(cls, dest, name):
+        # type: (str, Optional[str]) -> bool
         """Always assume the versions don't match"""
         return False
 

src/pip/_internal/vcs/bazaar.py

@@ -1,6 +1,3 @@
-# The following comment should be removed at some point in the future.
-# mypy: disallow-untyped-defs=False
-
 import logging
 import os.path
 import re
@@ -22,7 +19,9 @@
 )
 
 if MYPY_CHECK_RUNNING:
-    from typing import Optional, Tuple
+    from typing import List, Optional, Tuple
+
+    from pip._vendor.packaging.version import _BaseVersion
 
     from pip._internal.utils.misc import HiddenText
     from pip._internal.vcs.versioncontrol import AuthInfo, RevOptions
@@ -39,6 +38,7 @@
 
 
 def looks_like_hash(sha):
+    # type: (str) -> bool
     return bool(HASH_REGEX.match(sha))
 
 
@@ -56,6 +56,7 @@ class Git(VersionControl):
 
     @staticmethod
     def get_base_rev_args(rev):
+        # type: (str) -> List[str]
         return [rev]
 
     def is_immutable_rev_checkout(self, url, dest):
@@ -76,6 +77,7 @@ def is_immutable_rev_checkout(self, url, dest):
         return not is_tag_or_branch
 
     def get_git_version(self):
+        # type: () -> _BaseVersion
         VERSION_PFX = 'git version '
         version = self.run_command(
             ['version'], show_stdout=False, stdout_only=True
@@ -92,6 +94,7 @@ def get_git_version(self):
 
     @classmethod
     def get_current_branch(cls, location):
+        # type: (str) -> Optional[str]
         """
         Return the current branch, or None if HEAD isn't at a branch
         (e.g. detached HEAD).
@@ -130,6 +133,7 @@ def export(self, location, url):
 
     @classmethod
     def get_revision_sha(cls, dest, rev):
+        # type: (str, str) -> Tuple[Optional[str], bool]
         """
         Return (sha_or_none, is_branch), where sha_or_none is a commit hash
         if the revision names a remote branch or tag, otherwise None.
@@ -149,13 +153,13 @@ def get_revision_sha(cls, dest, rev):
         refs = {}
         for line in output.strip().splitlines():
             try:
-                sha, ref = line.split()
+                ref_sha, ref_name = line.split()
             except ValueError:
                 # Include the offending line to simplify troubleshooting if
                 # this error ever occurs.
                 raise ValueError(f'unexpected show-ref line: {line!r}')
 
-            refs[ref] = sha
+            refs[ref_name] = ref_sha
 
         branch_ref = f'refs/remotes/origin/{rev}'
         tag_ref = f'refs/tags/{rev}'
@@ -170,6 +174,7 @@ def get_revision_sha(cls, dest, rev):
 
     @classmethod
     def _should_fetch(cls, dest, rev):
+        # type: (str, str) -> bool
         """
         Return true if rev is a ref or is a commit that we don't have locally.
 
@@ -238,6 +243,7 @@ def resolve_revision(cls, dest, url, rev_options):
 
     @classmethod
     def is_commit_id_equal(cls, dest, name):
+        # type: (str, Optional[str]) -> bool
         """
         Return whether the current commit hash equals the given name.
 
@@ -340,6 +346,7 @@ def get_remote_url(cls, location):
 
     @classmethod
     def has_commit(cls, location, rev):
+        # type: (str, str) -> bool
         """
         Check if rev is a commit that is available in the local repository.
         """
@@ -369,6 +376,7 @@ def get_revision(cls, location, rev=None):
 
     @classmethod
     def get_subdirectory(cls, location):
+        # type: (str) -> Optional[str]
         """
         Return the path to setup.py, relative to the repo root.
         Return None if setup.py is in the repo root.
@@ -421,6 +429,7 @@ def get_url_rev_and_auth(cls, url):
 
     @classmethod
     def update_submodules(cls, location):
+        # type: (str) -> None
         if not os.path.exists(os.path.join(location, '.gitmodules')):
             return
         cls.run_command(
@@ -430,6 +439,7 @@ def update_submodules(cls, location):
 
     @classmethod
     def get_repository_root(cls, location):
+        # type: (str) -> Optional[str]
         loc = super().get_repository_root(location)
         if loc:
             return loc

src/pip/_internal/vcs/git.py

@@ -1,6 +1,3 @@
-# The following comment should be removed at some point in the future.
-# mypy: disallow-untyped-defs=False
-
 import configparser
 import logging
 import os
@@ -18,6 +15,8 @@
 )
 
 if MYPY_CHECK_RUNNING:
+    from typing import List, Optional
+
     from pip._internal.utils.misc import HiddenText
     from pip._internal.vcs.versioncontrol import RevOptions
 
@@ -35,6 +34,7 @@ class Mercurial(VersionControl):
 
     @staticmethod
     def get_base_rev_args(rev):
+        # type: (str) -> List[str]
         return [rev]
 
     def export(self, location, url):
@@ -114,6 +114,7 @@ def get_revision(cls, location):
 
     @classmethod
     def get_requirement_revision(cls, location):
+        # type: (str) -> str
         """
         Return the changeset identification hash, as a 40-character
         hexadecimal string
@@ -128,11 +129,13 @@ def get_requirement_revision(cls, location):
 
     @classmethod
     def is_commit_id_equal(cls, dest, name):
+        # type: (str, Optional[str]) -> bool
         """Always assume the versions don't match"""
         return False
 
     @classmethod
     def get_subdirectory(cls, location):
+        # type: (str) -> Optional[str]
         """
         Return the path to setup.py, relative to the repo root.
         Return None if setup.py is in the repo root.
@@ -147,6 +150,7 @@ def get_subdirectory(cls, location):
 
     @classmethod
     def get_repository_root(cls, location):
+        # type: (str) -> Optional[str]
         loc = super().get_repository_root(location)
         if loc:
             return loc

src/pip/_internal/vcs/mercurial.py

@@ -1,6 +1,3 @@
-# The following comment should be removed at some point in the future.
-# mypy: disallow-untyped-defs=False
-
 import logging
 import os
 import re
@@ -23,7 +20,7 @@
 
 
 if MYPY_CHECK_RUNNING:
-    from typing import Optional, Tuple
+    from typing import List, Optional, Tuple
 
     from pip._internal.utils.misc import HiddenText
     from pip._internal.utils.subprocess import CommandArgs
@@ -43,10 +40,12 @@ class Subversion(VersionControl):
 
     @classmethod
     def should_add_vcs_url_prefix(cls, remote_url):
+        # type: (str) -> bool
         return True
 
     @staticmethod
     def get_base_rev_args(rev):
+        # type: (str) -> List[str]
         return ['-r', rev]
 
     @classmethod
@@ -71,6 +70,7 @@ def get_revision(cls, location):
             dirurl, localrev = cls._get_svn_url_rev(base)
 
             if base == location:
+                assert dirurl is not None
                 base = dirurl + '/'   # save the root url
             elif not dirurl or not dirurl.startswith(base):
                 dirs[:] = []
@@ -80,6 +80,7 @@ def get_revision(cls, location):
 
     @classmethod
     def get_netloc_and_auth(cls, netloc, scheme):
+        # type: (str, str) -> Tuple[str, Tuple[Optional[str], Optional[str]]]
         """
         This override allows the auth information to be passed to svn via the
         --username and --password options instead of via the URL.
@@ -139,6 +140,7 @@ def get_remote_url(cls, location):
 
     @classmethod
     def _get_svn_url_rev(cls, location):
+        # type: (str) -> Tuple[Optional[str], int]
         from pip._internal.exceptions import InstallationError
 
         entries_path = os.path.join(location, cls.dirname, 'entries')
@@ -148,13 +150,14 @@ def _get_svn_url_rev(cls, location):
         else:  # subversion >= 1.7 does not have the 'entries' file
             data = ''
 
+        url = None
         if (data.startswith('8') or
                 data.startswith('9') or
                 data.startswith('10')):
-            data = list(map(str.splitlines, data.split('\n\x0c\n')))
-            del data[0][0]  # get rid of the '8'
-            url = data[0][3]
-            revs = [int(d[9]) for d in data if len(d) > 9 and d[9]] + [0]
+            entries = list(map(str.splitlines, data.split('\n\x0c\n')))
+            del entries[0][0]  # get rid of the '8'
+            url = entries[0][3]
+            revs = [int(d[9]) for d in entries if len(d) > 9 and d[9]] + [0]
         elif data.startswith('<?xml'):
             match = _svn_xml_url_re.search(data)
             if not match:
@@ -175,7 +178,9 @@ def _get_svn_url_rev(cls, location):
                     show_stdout=False,
                     stdout_only=True,
                 )
-                url = _svn_info_xml_url_re.search(xml).group(1)
+                match = _svn_info_xml_url_re.search(xml)
+                assert match is not None
+                url = match.group(1)
                 revs = [
                     int(m.group(1)) for m in _svn_info_xml_rev_re.finditer(xml)
                 ]
@@ -191,6 +196,7 @@ def _get_svn_url_rev(cls, location):
 
     @classmethod
     def is_commit_id_equal(cls, dest, name):
+        # type: (str, Optional[str]) -> bool
         """Always assume the versions don't match"""
         return False