Remove 0.14.x deprecations (#377)

Author: tony

CHANGES

@@ -16,6 +16,13 @@ $ pip install --user --upgrade --pre libvcs
 ### Breaking changes
 
 - {issue}`372` Typings moved from `libvcs.types` -> {mod}`libvcs._internal.types`
+- {issue}`377` Remove deprecated functions and exceptions
+
+  - Removed `libvcs.shortcuts`
+    - Removed `libvcs.shortcuts.create_project_from_pip_url()`: This will be replaced in future
+      versions by {issue}`376` / parsing utilities
+    - Moved `libvcs.shortcuts.create_project()` to {func}`libvcs._internal.shortcuts.create_project`
+  - Removed {exc}`libvcs.exc.InvalidPipURL`
 
 ### Fixes
 
@@ -59,7 +66,7 @@ $ pip install --user --upgrade --pre libvcs
 
 ### Typings
 
-- {func}`~libvcs.shortcuts.create_project`: Add overloads that return the typed project (e.g.
+- `create_project()`: Add overloads that return the typed project (e.g.
   {class}`~libvcs.projects.git.GitProject`)
 
 ## libvcs 0.13.2 (2022-06-12)

libvcs/_internal/shortcuts.py

@@ -57,7 +57,7 @@ def create_project(
 
     Examples
     --------
-    >>> from libvcs.shortcuts import create_project
+    >>> from libvcs._internal.shortcuts import create_project
     >>> r = create_project(
     ...     url=f'file://{create_git_remote_repo()}',
     ...     vcs='git',

libvcs/exc.py

@@ -33,21 +33,5 @@ class CommandTimeoutError(CommandError):
     """CommandError which gets raised when a subprocess exceeds its timeout."""
 
 
-class InvalidPipURL(LibVCSException):
-    """Invalid pip-style URL."""
-
-    def __init__(self, url):
-        self.url = url
-        super().__init__()
-
-    def __str__(self):
-        return self.message
-
-    message = (
-        "Repo URL %s requires a vcs scheme. Prepend the vcs (hg+, git+, svn+)"
-        "to the repo URL. e.g: git+https://github.com/freebsd/freebsd.git"
-    )
-
-
 class InvalidVCS(LibVCSException):
     """Invalid VCS."""

libvcs/shortcuts.py

@@ -11,6 +11,7 @@
 
 from libvcs import exc
 from libvcs._internal.run import run, which
+from libvcs._internal.shortcuts import create_project
 from libvcs.conftest import CreateProjectCallbackFixtureProtocol
 from libvcs.projects.git import (
     GitFullRemoteDict,
@@ -19,7 +20,6 @@
     GitStatus,
     convert_pip_url as git_convert_pip_url,
 )
-from libvcs.shortcuts import create_project_from_pip_url
 
 if not which("git"):
     pytestmark = pytest.mark.skip(reason="git is not available")
@@ -39,13 +39,15 @@
             lambda bare_dir, tmp_path, **kwargs: {
                 "url": f"file://{bare_dir}",
                 "dir": tmp_path / "obtaining a bare repo",
+                "vcs": "git",
             },
         ],
         [
-            create_project_from_pip_url,
+            create_project,
             lambda bare_dir, tmp_path, **kwargs: {
-                "pip_url": f"git+file://{bare_dir}",
+                "url": f"git+file://{bare_dir}",
                 "dir": tmp_path / "obtaining a bare repo",
+                "vcs": "git",
             },
         ],
     ],
@@ -80,13 +82,15 @@ def test_repo_git_obtain_initial_commit_repo(
             lambda git_remote_repo, tmp_path, **kwargs: {
                 "url": f"file://{git_remote_repo}",
                 "dir": tmp_path / "myrepo",
+                "vcs": "git",
             },
         ],
         [
-            create_project_from_pip_url,
+            create_project,
             lambda git_remote_repo, tmp_path, **kwargs: {
-                "pip_url": f"git+file://{git_remote_repo}",
+                "url": f"git+file://{git_remote_repo}",
                 "dir": tmp_path / "myrepo",
+                "vcs": "git",
             },
         ],
     ],
@@ -115,13 +119,15 @@ def test_repo_git_obtain_full(
             lambda git_remote_repo, tmp_path, **kwargs: {
                 "url": f"file://{git_remote_repo}",
                 "dir": tmp_path / "myrepo",
+                "vcs": "git",
             },
         ],
         [
-            create_project_from_pip_url,
+            create_project,
             lambda git_remote_repo, tmp_path, **kwargs: {
-                "pip_url": f"git+file://{git_remote_repo}",
+                "url": f"git+file://{git_remote_repo}",
                 "dir": tmp_path / "myrepo",
+                "vcs": "git",
             },
         ],
     ],
@@ -158,14 +164,16 @@ def test_repo_update_handle_cases(
                 "url": f"file://{git_remote_repo}",
                 "dir": tmp_path / "myrepo",
                 "progress_callback": progress_callback,
+                "vcs": "git",
             },
         ],
         [
-            create_project_from_pip_url,
+            create_project,
             lambda git_remote_repo, tmp_path, progress_callback, **kwargs: {
-                "pip_url": f"git+file://{git_remote_repo}",
+                "url": f"git+file://{git_remote_repo}",
                 "dir": tmp_path / "myrepo",
                 "progress_callback": progress_callback,
+                "vcs": "git",
             },
         ],
     ],
@@ -272,6 +280,7 @@ def progress_callback_spy(output, timestamp):
             lambda git_remote_repo, projects_path, repo_name, **kwargs: {
                 "url": f"file://{git_remote_repo}",
                 "dir": projects_path / repo_name,
+                "vcs": "git",
                 "remotes": {
                     "second_remote": GitRemote(
                         name="second_remote",
@@ -285,10 +294,11 @@ def progress_callback_spy(output, timestamp):
             },
         ],
         [
-            create_project_from_pip_url,
+            create_project,
             lambda git_remote_repo, projects_path, repo_name, **kwargs: {
-                "pip_url": f"git+file://{git_remote_repo}",
+                "url": f"git+file://{git_remote_repo}",
                 "dir": projects_path / repo_name,
+                "vcs": "git",
             },
             lambda git_remote_repo, **kwargs: {"origin": f"file://{git_remote_repo}"},
         ],
@@ -472,13 +482,15 @@ def test_git_get_url_and_rev_from_pip_url():
             lambda git_remote_repo, dir, **kwargs: {
                 "url": f"file://{git_remote_repo}",
                 "dir": str(dir),
+                "vcs": "git",
             },
         ],
         [
-            create_project_from_pip_url,
+            create_project,
             lambda git_remote_repo, dir, **kwargs: {
-                "pip_url": f"git+file://{git_remote_repo}",
+                "url": f"git+file://{git_remote_repo}",
                 "dir": dir,
+                "vcs": "git",
             },
         ],
     ],
@@ -514,13 +526,15 @@ def test_remotes_preserves_git_ssh(
             lambda bare_dir, tmp_path, **kwargs: {
                 "url": f"file://{bare_dir}",
                 "dir": tmp_path / "obtaining a bare repo",
+                "vcs": "git",
             },
         ],
         [
-            create_project_from_pip_url,
+            create_project,
             lambda bare_dir, tmp_path, **kwargs: {
-                "pip_url": f"git+file://{bare_dir}",
+                "url": f"git+file://{bare_dir}",
                 "dir": tmp_path / "obtaining a bare repo",
+                "vcs": "git",
             },
         ],
     ],
@@ -530,14 +544,15 @@ def test_private_ssh_format(
     constructor: ProjectTestFactory,
     lazy_constructor_options: ProjectTestFactoryLazyKwargs,
 ):
-    pip_url_kwargs = {
-        "pip_url": "git+ssh://github.com:/tmp/omg/private_ssh_repo",
-        "dir": tmpdir,
-    }
-
     with pytest.raises(exc.LibVCSException) as excinfo:
-        create_project_from_pip_url(**pip_url_kwargs)
-    excinfo.match(r"is malformatted")
+        create_project(
+            url=git_convert_pip_url(
+                "git+ssh://github.com:/tmp/omg/private_ssh_repo"
+            ).url,
+            dir=tmpdir,
+            vcs="git",
+        )
+        excinfo.match(r".*is a malformed.*")
 
 
 def test_ls_remotes(git_repo: GitProject):

tests/projects/test_git.py

@@ -5,7 +5,6 @@
 
 from libvcs._internal.run import run, which
 from libvcs._internal.shortcuts import create_project
-from libvcs.shortcuts import create_project_from_pip_url
 
 if not which("hg"):
     pytestmark = pytest.mark.skip(reason="hg is not available")
@@ -14,11 +13,10 @@
 def test_repo_mercurial(tmp_path: pathlib.Path, projects_path, hg_remote_repo):
     repo_name = "my_mercurial_project"
 
-    mercurial_repo = create_project_from_pip_url(
-        **{
-            "pip_url": f"hg+file://{hg_remote_repo}",
-            "dir": projects_path / repo_name,
-        }
+    mercurial_repo = create_project(
+        url=f"file://{hg_remote_repo}",
+        dir=projects_path / repo_name,
+        vcs="hg",
     )
 
     run(["hg", "init", mercurial_repo.repo_name], cwd=tmp_path)

tests/projects/test_hg.py

@@ -31,9 +31,3 @@ def test_command_error():
         command = "command arg"
         raise exc.CommandError("this is output", 0, command)
     assert e.value.cmd == command
-
-
-def test_invalid_pip_url():
-    with pytest.raises(exc.InvalidPipURL) as e:
-        raise exc.InvalidPipURL("http://github.com/wrong/format")
-    assert str(e.value) == e.value.message

tests/test_exc.py

@@ -4,43 +4,7 @@
 
 from libvcs import GitProject, MercurialProject, SubversionProject
 from libvcs._internal.shortcuts import create_project
-from libvcs.exc import InvalidPipURL, InvalidVCS
-from libvcs.shortcuts import create_project_from_pip_url
-
-
-@pytest.mark.parametrize(
-    "repo_dict,repo_class,raises_exception",
-    [
-        ({"pip_url": "git+https://github.com/freebsd/freebsd.git"}, GitProject, False),
-        (
-            {"pip_url": "hg+https://bitbucket.org/birkenfeld/sphinx"},
-            MercurialProject,
-            False,
-        ),
-        (
-            {"pip_url": "svn+http://svn.code.sf.net/p/docutils/code/trunk"},
-            SubversionProject,
-            False,
-        ),
-        (
-            {"pip_url": "sv+http://svn.code.sf.net/p/docutils/code/trunk"},
-            None,
-            InvalidPipURL,
-        ),
-    ],
-)
-def test_create_project_from_pip_url(
-    tmp_path: pathlib.Path, repo_dict, repo_class, raises_exception
-):
-    # add parent_dir via fixture
-    repo_dict["dir"] = tmp_path / "repo_name"
-
-    if raises_exception:
-        with pytest.raises(raises_exception):
-            create_project_from_pip_url(**repo_dict)
-    else:
-        repo = create_project_from_pip_url(**repo_dict)
-        assert isinstance(repo, repo_class)
+from libvcs.exc import InvalidVCS
 
 
 @pytest.mark.parametrize(