refactor! create_repo -> create_project

Author: tony

libvcs/shortcuts.py

@@ -5,15 +5,15 @@
 from libvcs.exc import InvalidPipURL, InvalidVCS
 
 
-def create_repo(
+def create_project(
     url, vcs, progress_callback=None, *args, **kwargs
 ) -> Union[GitProject, MercurialProject, SubversionProject]:
     r"""Return an object representation of a VCS repository.
 
     Examples
     --------
-    >>> from libvcs.shortcuts import create_repo
-    >>> r = create_repo(
+    >>> from libvcs.shortcuts import create_project
+    >>> r = create_project(
     ...     url=f'file://{create_git_remote_repo()}',
     ...     vcs='git',
     ...     dir=tmp_path
@@ -36,16 +36,16 @@ def create_repo(
         raise InvalidVCS("VCS %s is not a valid VCS" % vcs)
 
 
-def create_repo_from_pip_url(
+def create_project_from_pip_url(
     pip_url, **kwargs
 ) -> Union[GitProject, MercurialProject, SubversionProject]:
     r"""Return an object representation of a VCS repository via pip-style url.
 
     Examples
     --------
 
-    >>> from libvcs.shortcuts import create_repo_from_pip_url
-    >>> r = create_repo_from_pip_url(
+    >>> from libvcs.shortcuts import create_project_from_pip_url
+    >>> r = create_project_from_pip_url(
     ...     pip_url=f'git+{create_git_remote_repo()}',
     ...     dir=tmp_path
     ... )

tests/projects/test_base.py

@@ -5,11 +5,11 @@
 import pytest
 
 from libvcs.projects.base import BaseProject, convert_pip_url
-from libvcs.shortcuts import create_repo
+from libvcs.shortcuts import create_project
 
 
 def test_repr():
-    repo = create_repo(url="file://path/to/myrepo", dir="/hello/", vcs="git")
+    repo = create_project(url="file://path/to/myrepo", dir="/hello/", vcs="git")
 
     str_repo = str(repo)
     assert "GitProject" in str_repo

tests/projects/test_git.py

@@ -19,7 +19,7 @@
     convert_pip_url as git_convert_pip_url,
     extract_status,
 )
-from libvcs.shortcuts import create_repo_from_pip_url
+from libvcs.shortcuts import create_project_from_pip_url
 
 if not which("git"):
     pytestmark = pytest.mark.skip(reason="git is not available")
@@ -42,7 +42,7 @@
             },
         ],
         [
-            create_repo_from_pip_url,
+            create_project_from_pip_url,
             lambda bare_dir, tmp_path, **kwargs: {
                 "pip_url": f"git+file://{bare_dir}",
                 "dir": tmp_path / "obtaining a bare repo",
@@ -83,7 +83,7 @@ def test_repo_git_obtain_initial_commit_repo(
             },
         ],
         [
-            create_repo_from_pip_url,
+            create_project_from_pip_url,
             lambda git_remote_repo, tmp_path, **kwargs: {
                 "pip_url": f"git+file://{git_remote_repo}",
                 "dir": tmp_path / "myrepo",
@@ -118,7 +118,7 @@ def test_repo_git_obtain_full(
             },
         ],
         [
-            create_repo_from_pip_url,
+            create_project_from_pip_url,
             lambda git_remote_repo, tmp_path, **kwargs: {
                 "pip_url": f"git+file://{git_remote_repo}",
                 "dir": tmp_path / "myrepo",
@@ -161,7 +161,7 @@ def test_repo_update_handle_cases(
             },
         ],
         [
-            create_repo_from_pip_url,
+            create_project_from_pip_url,
             lambda git_remote_repo, tmp_path, progress_callback, **kwargs: {
                 "pip_url": f"git+file://{git_remote_repo}",
                 "dir": tmp_path / "myrepo",
@@ -285,7 +285,7 @@ def progress_callback_spy(output, timestamp):
             },
         ],
         [
-            create_repo_from_pip_url,
+            create_project_from_pip_url,
             lambda git_remote_repo, projects_path, repo_name, **kwargs: {
                 "pip_url": f"git+file://{git_remote_repo}",
                 "dir": projects_path / repo_name,
@@ -468,7 +468,7 @@ def test_git_get_url_and_rev_from_pip_url():
             },
         ],
         [
-            create_repo_from_pip_url,
+            create_project_from_pip_url,
             lambda git_remote_repo, dir, **kwargs: {
                 "pip_url": f"git+file://{git_remote_repo}",
                 "dir": dir,
@@ -510,7 +510,7 @@ def test_remotes_preserves_git_ssh(
             },
         ],
         [
-            create_repo_from_pip_url,
+            create_project_from_pip_url,
             lambda bare_dir, tmp_path, **kwargs: {
                 "pip_url": f"git+file://{bare_dir}",
                 "dir": tmp_path / "obtaining a bare repo",
@@ -529,7 +529,7 @@ def test_private_ssh_format(
     }
 
     with pytest.raises(exc.LibVCSException) as excinfo:
-        create_repo_from_pip_url(**pip_url_kwargs)
+        create_project_from_pip_url(**pip_url_kwargs)
     excinfo.match(r"is malformatted")
 
 

tests/projects/test_hg.py

@@ -4,7 +4,7 @@
 import pytest
 
 from libvcs.cmd.core import run, which
-from libvcs.shortcuts import create_repo, create_repo_from_pip_url
+from libvcs.shortcuts import create_project, create_project_from_pip_url
 
 if not which("hg"):
     pytestmark = pytest.mark.skip(reason="hg is not available")
@@ -13,7 +13,7 @@
 def test_repo_mercurial(tmp_path: pathlib.Path, projects_path, hg_remote_repo):
     repo_name = "my_mercurial_project"
 
-    mercurial_repo = create_repo_from_pip_url(
+    mercurial_repo = create_project_from_pip_url(
         **{
             "pip_url": f"hg+file://{hg_remote_repo}",
             "dir": projects_path / repo_name,
@@ -45,7 +45,7 @@ def test_vulnerability_2022_03_12_command_injection(
     random_dir = tmp_path / "random"
     random_dir.mkdir()
     monkeypatch.chdir(str(random_dir))
-    mercurial_repo = create_repo(
+    mercurial_repo = create_project(
         url="--config=alias.clone=!touch ./HELLO", vcs="hg", dir="./"
     )
     with pytest.raises(Exception):

tests/projects/test_svn.py

@@ -7,7 +7,7 @@
 from libvcs.cmd.core import which
 from libvcs.conftest import CreateProjectCallbackFixtureProtocol
 from libvcs.projects.svn import SubversionProject
-from libvcs.shortcuts import create_repo_from_pip_url
+from libvcs.shortcuts import create_project_from_pip_url
 
 if not which("svn"):
     pytestmark = pytest.mark.skip(reason="svn is not available")
@@ -16,7 +16,7 @@
 def test_repo_svn(tmp_path: pathlib.Path, svn_remote_repo):
     repo_name = "my_svn_project"
 
-    svn_repo = create_repo_from_pip_url(
+    svn_repo = create_project_from_pip_url(
         **{
             "pip_url": f"svn+file://{svn_remote_repo}",
             "dir": tmp_path / repo_name,

tests/test_shortcuts.py

@@ -4,7 +4,7 @@
 
 from libvcs import GitProject, MercurialProject, SubversionProject
 from libvcs.exc import InvalidPipURL, InvalidVCS
-from libvcs.shortcuts import create_repo, create_repo_from_pip_url
+from libvcs.shortcuts import create_project, create_project_from_pip_url
 
 
 @pytest.mark.parametrize(
@@ -28,17 +28,17 @@
         ),
     ],
 )
-def test_create_repo_from_pip_url(
+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_repo_from_pip_url(**repo_dict)
+            create_project_from_pip_url(**repo_dict)
     else:
-        repo = create_repo_from_pip_url(**repo_dict)
+        repo = create_project_from_pip_url(**repo_dict)
         assert isinstance(repo, repo_class)
 
 
@@ -67,13 +67,15 @@ def test_create_repo_from_pip_url(
         ),
     ],
 )
-def test_create_repo(tmp_path: pathlib.Path, repo_dict, repo_class, raises_exception):
+def test_create_project(
+    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_repo(**repo_dict)
+            create_project(**repo_dict)
     else:
-        repo = create_repo(**repo_dict)
+        repo = create_project(**repo_dict)
         assert isinstance(repo, repo_class)