refactor(base,git,hg,svn): Decouple away pip url stuff

Author: tony

libvcs/base.py

@@ -4,13 +4,36 @@
 
 import logging
 import os
+from typing import NamedTuple
 
 from ._compat import implements_to_string, urlparse
 from .util import RepoLoggingAdapter, mkdir_p, run
 
 logger = logging.getLogger(__name__)
 
 
+class VCSLocation(NamedTuple):
+    url: str
+    rev: str
+
+
+def convert_pip_url(pip_url: str) -> VCSLocation:
+    """Return repo URL and revision by parsing `libvcs.base.BaseRepo.url`."""
+    error_message = (
+        "Sorry, '%s' is a malformed VCS url. "
+        "The format is <vcs>+<protocol>://<url>, "
+        "e.g. svn+http://myrepo/svn/MyApp#egg=MyApp"
+    )
+    assert '+' in pip_url, error_message % pip_url
+    url = pip_url.split('+', 1)[1]
+    scheme, netloc, path, query, frag = urlparse.urlsplit(url)
+    rev = None
+    if '@' in path:
+        path, rev = path.rsplit('@', 1)
+    url = urlparse.urlunsplit((scheme, netloc, path, query, ''))
+    return VCSLocation(url=url, rev=rev)
+
+
 @implements_to_string
 class BaseRepo(RepoLoggingAdapter, object):
 
@@ -56,7 +79,7 @@ def __init__(self, url, repo_dir, progress_callback=None, *args, **kwargs):
 
     @classmethod
     def from_pip_url(cls, pip_url, *args, **kwargs):
-        url, rev = cls.get_url_and_revision_from_pip_url(pip_url)
+        url, rev = convert_pip_url(pip_url)
         self = cls(url=url, rev=rev, *args, **kwargs)
 
         return self
@@ -122,22 +145,5 @@ def check_destination(self, *args, **kwargs):
 
         return True
 
-    @classmethod
-    def get_url_and_revision_from_pip_url(cls, pip_url):
-        """Return repo URL and revision by parsing `libvcs.base.BaseRepo.url`."""
-        error_message = (
-            "Sorry, '%s' is a malformed VCS url. "
-            "The format is <vcs>+<protocol>://<url>, "
-            "e.g. svn+http://myrepo/svn/MyApp#egg=MyApp"
-        )
-        assert '+' in pip_url, error_message % pip_url
-        url = pip_url.split('+', 1)[1]
-        scheme, netloc, path, query, frag = urlparse.urlsplit(url)
-        rev = None
-        if '@' in path:
-            path, rev = path.rsplit('@', 1)
-        url = urlparse.urlunsplit((scheme, netloc, path, query, ''))
-        return url, rev
-
     def __repr__(self):
         return "<{} {}>".format(self.__class__.__name__, self.repo_name)

libvcs/git.py

@@ -9,7 +9,7 @@
 From pip (MIT Licnese):
 
 - [`GitRepo.remote`](libvcs.git.GitRepo.remote_set) (renamed to ``set_remote``)
-- [`GitRepo.get_url_and_revision_from_pip_url`](libvcs.git.GitRepo.get_url_and_revision_from_pip_url`) (``get_url_rev``)
+- [`GitRepo.convert_pip_url`](libvcs.git.GitRepo.convert_pip_url`) (``get_url_rev``)
 - [`GitRepo.get_revision`](libvcs.git.GitRepo.get_revision)
 - [`GitRepo.get_git_version`](libvcs.git.GitRepo.get_git_version)
 """  # NOQA: E501
@@ -22,7 +22,7 @@
 
 from . import exc
 from ._compat import urlparse
-from .base import BaseRepo
+from .base import BaseRepo, VCSLocation, convert_pip_url as base_convert_pip_url
 
 logger = logging.getLogger(__name__)
 
@@ -102,6 +102,31 @@ def extract_status(value) -> GitStatus:
     return GitStatus(**matches.groupdict())
 
 
+def convert_pip_url(pip_url: str) -> VCSLocation:
+    """
+    Prefixes stub URLs like 'user@hostname:user/repo.git' with 'ssh://'.
+    That's required because although they use SSH they sometimes doesn't
+    work with a ssh:// scheme (e.g. Github). But we need a scheme for
+    parsing. Hence we remove it again afterwards and return it as a stub.
+    The manpage for git-clone(1) refers to this as the "scp-like styntax".
+    """
+    if '://' not in pip_url:
+        assert 'file:' not in pip_url
+        pip_url = pip_url.replace('git+', 'git+ssh://')
+        url, rev = base_convert_pip_url(pip_url)
+        url = url.replace('ssh://', '')
+    elif 'github.com:' in pip_url:
+        raise exc.LibVCSException(
+            "Repo %s is malformatted, please use the convention %s for"
+            "ssh / private GitHub repositories."
+            % (pip_url, "git+https://github.com/username/repo.git")
+        )
+    else:
+        url, rev = base_convert_pip_url(pip_url)
+
+    return VCSLocation(url=url, rev=rev)
+
+
 class GitRepo(BaseRepo):
     bin_name = 'git'
     schemes = ('git', 'git+http', 'git+https', 'git+ssh', 'git+git', 'git+file')
@@ -126,38 +151,20 @@ def __init__(self, url, **kwargs):
 
         BaseRepo.__init__(self, url, **kwargs)
 
+    @classmethod
+    def from_pip_url(cls, pip_url, *args, **kwargs):
+        url, rev = convert_pip_url(pip_url)
+        self = cls(url=url, rev=rev, *args, **kwargs)
+
+        return self
+
     def get_revision(self):
         """Return current revision. Initial repositories return 'initial'."""
         try:
             return self.run(['rev-parse', '--verify', 'HEAD'])
         except exc.CommandError:
             return 'initial'
 
-    @classmethod
-    def get_url_and_revision_from_pip_url(cls, pip_url):
-        """
-        Prefixes stub URLs like 'user@hostname:user/repo.git' with 'ssh://'.
-        That's required because although they use SSH they sometimes doesn't
-        work with a ssh:// scheme (e.g. Github). But we need a scheme for
-        parsing. Hence we remove it again afterwards and return it as a stub.
-        The manpage for git-clone(1) refers to this as the "scp-like styntax".
-        """
-        if '://' not in pip_url:
-            assert 'file:' not in pip_url
-            pip_url = pip_url.replace('git+', 'git+ssh://')
-            url, rev = super(GitRepo, cls).get_url_and_revision_from_pip_url(pip_url)
-            url = url.replace('ssh://', '')
-        elif 'github.com:' in pip_url:
-            raise exc.LibVCSException(
-                "Repo %s is malformatted, please use the convention %s for"
-                "ssh / private GitHub repositories."
-                % (pip_url, "git+https://github.com/username/repo.git")
-            )
-        else:
-            url, rev = super(GitRepo, cls).get_url_and_revision_from_pip_url(pip_url)
-
-        return url, rev
-
     def obtain(self):
         """Retrieve the repository, clone if doesn't exist."""
         self.check_destination()

libvcs/hg.py

@@ -3,7 +3,7 @@
 
 The following is from pypa/pip (MIT license):
 
-- [`MercurialRepo.get_url_and_revision_from_pip_url`](libvcs.hg.get_url_and_revision_from_pip_url)
+- [`MercurialRepo.convert_pip_url`](libvcs.hg.convert_pip_url)
 - [`MercurialRepo.get_url`](libvcs.hg.MercurialRepo.get_url)
 - [`MercurialRepo.get_revision`](libvcs.hg.MercurialRepo.get_revision)
 """  # NOQA E5

libvcs/svn.py

@@ -8,7 +8,7 @@
 
 The following are pypa/pip (MIT license):
 
-- [`SubversionRepo.get_url_and_revision_from_pip_url`](libvcs.svn.SubversionRepo.get_url_and_revision_from_pip_url)
+- [`SubversionRepo.convert_pip_url`](libvcs.svn.SubversionRepo.convert_pip_url)
 - [`SubversionRepo.get_url`](libvcs.svn.SubversionRepo.get_url)
 - [`SubversionRepo.get_revision`](libvcs.svn.SubversionRepo.get_revision)
 - [`get_rev_options`](libvcs.svn.get_rev_options)
@@ -20,11 +20,19 @@
 import re
 
 from ._compat import urlparse
-from .base import BaseRepo
+from .base import BaseRepo, VCSLocation, convert_pip_url as base_convert_pip_url
 
 logger = logging.getLogger(__name__)
 
 
+def convert_pip_url(pip_url: str) -> VCSLocation:
+    # hotfix the URL scheme after removing svn+ from svn+ssh:// re-add it
+    url, rev = base_convert_pip_url(pip_url)
+    if url.startswith('ssh://'):
+        url = 'svn+' + url
+    return VCSLocation(url=url, rev=rev)
+
+
 class SubversionRepo(BaseRepo):
     bin_name = 'svn'
     schemes = ('svn', 'svn+ssh', 'svn+http', 'svn+https', 'svn+svn')
@@ -115,14 +123,6 @@ def get_revision(self, location=None):
             revision = max(revision, localrev)
         return revision
 
-    @classmethod
-    def get_url_and_revision_from_pip_url(cls, pip_url):
-        # hotfix the URL scheme after removing svn+ from svn+ssh:// re-add it
-        url, rev = super(SubversionRepo, cls).get_url_and_revision_from_pip_url(pip_url)
-        if url.startswith('ssh://'):
-            url = 'svn+' + url
-        return url, rev
-
     def update_repo(self, dest=None):
         self.check_destination()
         if os.path.isdir(os.path.join(self.path, '.svn')):

tests/test_base.py

@@ -3,7 +3,7 @@
 from __future__ import absolute_import, print_function, unicode_literals
 
 from libvcs._compat import text_type
-from libvcs.base import BaseRepo
+from libvcs.base import BaseRepo, convert_pip_url
 from libvcs.shortcuts import create_repo
 
 
@@ -34,10 +34,8 @@ def test_check_destination_creates_parent_if_not_exist(tmpdir):
     assert parentdir.check()
 
 
-def test_get_url_and_revision_from_pip_url():
-    url, rev = BaseRepo.get_url_and_revision_from_pip_url(
-        pip_url='git+file://path/to/myrepo@therev'
-    )
+def test_convert_pip_url():
+    url, rev = convert_pip_url(pip_url='git+file://path/to/myrepo@therev')
 
     assert url, rev == 'therev'
     assert url, rev == 'file://path/to/myrepo'

tests/test_git.py

@@ -10,7 +10,7 @@
 
 from libvcs import exc
 from libvcs._compat import PY2, string_types
-from libvcs.git import GitRemote, GitRepo, extract_status
+from libvcs.git import GitRemote, convert_pip_url as git_convert_pip_url, extract_status
 from libvcs.shortcuts import create_repo_from_pip_url
 from libvcs.util import run, which
 
@@ -120,22 +120,23 @@ def test_remotes(parentdir, git_remote):
 
 def test_git_get_url_and_rev_from_pip_url():
     pip_url = 'git+ssh://git@bitbucket.example.com:7999/PROJ/repo.git'
-    url, rev = GitRepo.get_url_and_revision_from_pip_url(pip_url)
+
+    url, rev = git_convert_pip_url(pip_url)
     assert 'ssh://git@bitbucket.example.com:7999/PROJ/repo.git' == url
     assert rev is None
 
     pip_url = '%s@%s' % (
         'git+ssh://git@bitbucket.example.com:7999/PROJ/repo.git',
         'eucalyptus',
     )
-    url, rev = GitRepo.get_url_and_revision_from_pip_url(pip_url)
+    url, rev = git_convert_pip_url(pip_url)
     assert 'ssh://git@bitbucket.example.com:7999/PROJ/repo.git' == url
     assert rev == 'eucalyptus'
 
     # the git manual refers to this as "scp-like syntax"
     # https://git-scm.com/docs/git-clone
     pip_url = '%s@%s' % ('git+user@hostname:user/repo.git', 'eucalyptus')
-    url, rev = GitRepo.get_url_and_revision_from_pip_url(pip_url)
+    url, rev = git_convert_pip_url(pip_url)
     assert 'user@hostname:user/repo.git' == url
     assert rev == 'eucalyptus'