refactor!: Rename repo_dir to dir (#324)

Author: tony

CHANGES

@@ -17,6 +17,14 @@ $ pip install --user --upgrade --pre libvcs
 
 - `GitRepo`, `SVNRepo`, `MercurialRepo`, `BaseRepo` have been moved to
   `libvcs.states.{module}.{Module}Repo`
+- `repo_dir` param is renamed to `dir`:
+
+  Before: `GitRepo(url='...', repo_dir='...')`
+
+  After: `GitRepo(url='...', dir='...')`
+
+  {issue}`#324`
+
 - Logging functions moved to {attr}`libvcs.states.base.BaseRepo.log` ({issue}`#322`)
 - Rename `RepoLoggingAdapter` to `CmdLoggingAdapter`
 - `CmdLoggingAdapter`: Rename `repo_name` param to `keyword`

README.md

@@ -34,14 +34,17 @@ to inspect / checkout / update:
 >>> from libvcs.shortcuts import create_repo_from_pip_url, create_repo
 
 # repo is an object representation of a vcs repository.
->>> r = create_repo(url='https://www.github.com/vcs-python/libtmux',
-...                 vcs='git',
-...                 repo_dir='/tmp/libtmux')
+>>> r = create_repo(
+...     url='https://www.github.com/vcs-python/libtmux',
+...     vcs='git',
+...     dir='/tmp/libtmux'
+... )
 
 # or via pip-style URL
 >>> r = create_repo_from_pip_url(
-...         pip_url='git+https://www.github.com/vcs-python/libtmux',
-...         repo_dir='/tmp/libtmux')
+...     pip_url='git+https://www.github.com/vcs-python/libtmux',
+...     dir='/tmp/libtmux'
+... )
 ```
 
 Update / clone repo:

libvcs/conftest.py

@@ -301,7 +301,7 @@ def git_repo(projects_path: pathlib.Path, git_remote_repo: pathlib.Path):
     """Pre-made git clone of remote repo checked out to user's projects dir."""
     git_repo = GitRepo(
         url=f"file://{git_remote_repo}",
-        repo_dir=str(projects_path / "git_repo"),
+        dir=str(projects_path / "git_repo"),
         remotes={
             "origin": GitRemoteDict(
                 **{

libvcs/shortcuts.py

@@ -16,7 +16,7 @@ def create_repo(
     >>> r = create_repo(
     ...     url=f'file://{create_git_remote_repo()}',
     ...     vcs='git',
-    ...     repo_dir=tmp_path
+    ...     dir=tmp_path
     ... )
 
     >>> isinstance(r, GitRepo)
@@ -43,7 +43,7 @@ def create_repo_from_pip_url(
     >>> from libvcs.shortcuts import create_repo_from_pip_url
     >>> r = create_repo_from_pip_url(
     ...     pip_url=f'git+{create_git_remote_repo()}',
-    ...     repo_dir=tmp_path
+    ...     dir=tmp_path
     ... )
     >>> isinstance(r, GitRepo)
     True

libvcs/states/base.py

@@ -40,7 +40,7 @@ class BaseRepo:
     #: vcs app name, e.g. 'git'
     bin_name = ""
 
-    def __init__(self, url, repo_dir, progress_callback=None, *args, **kwargs):
+    def __init__(self, url, dir, progress_callback=None, *args, **kwargs):
         r"""
         Parameters
         ----------
@@ -63,7 +63,7 @@ def __init__(self, url, repo_dir, progress_callback=None, *args, **kwargs):
             ...         )
             >>> r = Repo(
             ...     url=f'file://{create_git_remote_repo()}',
-            ...     repo_dir=str(tmp_path),
+            ...     dir=str(tmp_path),
             ...     progress_callback=progress_cb
             ... )
             >>> r.obtain()  # doctest: +NORMALIZE_WHITESPACE +ELLIPSIS +REPORT_CDIFF
@@ -81,13 +81,13 @@ def __init__(self, url, repo_dir, progress_callback=None, *args, **kwargs):
         self.progress_callback = progress_callback
 
         #: Parent directory
-        self.parent_dir = os.path.dirname(repo_dir)
+        self.parent_dir = os.path.dirname(dir)
 
         #: Checkout path
-        self.path = repo_dir
+        self.path = dir
 
         #: Base name of checkout
-        self.repo_name = os.path.basename(os.path.normpath(repo_dir))
+        self.repo_name = os.path.basename(os.path.normpath(dir))
 
         if "rev" in kwargs:
             self.rev = kwargs["rev"]

libvcs/states/git.py

@@ -140,7 +140,7 @@ class GitRepo(BaseRepo):
     schemes = ("git", "git+http", "git+https", "git+ssh", "git+git", "git+file")
 
     def __init__(
-        self, url: str, repo_dir: str, remotes: GitRemotesArgs = None, *args, **kwargs
+        self, url: str, dir: str, remotes: GitRemotesArgs = None, *args, **kwargs
     ):
         """A git repository.
 
@@ -164,7 +164,7 @@ def __init__(
 
             repo = GitRepo(
                url="https://github.com/vcs-python/libvcs",
-               repo_dir=checkout,
+               dir=checkout,
                remotes={
                    'gitlab': 'https://gitlab.com/vcs-python/libvcs'
                }
@@ -179,7 +179,7 @@ def __init__(
 
             repo = GitRepo(
                url="https://github.com/vcs-python/libvcs",
-               repo_dir=checkout,
+               dir=checkout,
                remotes={
                    'gitlab': {
                        'fetch_url': 'https://gitlab.com/vcs-python/libvcs',
@@ -221,7 +221,7 @@ def __init__(
                 fetch_url=url,
                 push_url=url,
             )
-        BaseRepo.__init__(self, url, repo_dir, *args, **kwargs)
+        BaseRepo.__init__(self, url, dir, *args, **kwargs)
         self.url = self.chomp_protocol(
             (
                 self._remotes.get("origin")
@@ -592,7 +592,7 @@ def status(self) -> dict:
         --------
         >>> git_repo = GitRepo(
         ...     url=f'file://{create_git_remote_repo()}',
-        ...     repo_dir=tmp_path
+        ...     dir=tmp_path
         ... )
         >>> git_repo.obtain()
         >>> git_repo.status()

libvcs/states/hg.py

@@ -20,8 +20,8 @@ class MercurialRepo(BaseRepo):
     bin_name = "hg"
     schemes = ("hg", "hg+http", "hg+https", "hg+file")
 
-    def __init__(self, url, repo_dir, *args, **kwargs):
-        BaseRepo.__init__(self, url, repo_dir, *args, **kwargs)
+    def __init__(self, url, dir, *args, **kwargs):
+        BaseRepo.__init__(self, url, dir, *args, **kwargs)
 
     def obtain(self, *args, **kwargs):
         self.ensure_dir()

libvcs/states/svn.py

@@ -34,7 +34,7 @@ class SubversionRepo(BaseRepo):
     bin_name = "svn"
     schemes = ("svn", "svn+ssh", "svn+http", "svn+https", "svn+svn")
 
-    def __init__(self, url, repo_dir, *args, **kwargs):
+    def __init__(self, url, dir, *args, **kwargs):
         """A svn repository.
 
         Parameters
@@ -55,7 +55,7 @@ def __init__(self, url, repo_dir, *args, **kwargs):
             self.svn_trust_cert = False
 
         self.rev = kwargs.get("rev")
-        BaseRepo.__init__(self, url, repo_dir, *args, **kwargs)
+        BaseRepo.__init__(self, url, dir, *args, **kwargs)
 
     def _user_pw_args(self):
         args = []

tests/states/test_base.py

@@ -9,7 +9,7 @@
 
 
 def test_repr():
-    repo = create_repo(url="file://path/to/myrepo", repo_dir="/hello/", vcs="git")
+    repo = create_repo(url="file://path/to/myrepo", dir="/hello/", vcs="git")
 
     str_repo = str(repo)
     assert "GitRepo" in str_repo
@@ -18,7 +18,7 @@ def test_repr():
 
 
 def test_repr_base():
-    repo = BaseRepo(url="file://path/to/myrepo", repo_dir="/hello/")
+    repo = BaseRepo(url="file://path/to/myrepo", dir="/hello/")
 
     str_repo = str(repo)
     assert "Repo" in str_repo
@@ -28,8 +28,8 @@ def test_repr_base():
 
 def test_ensure_dir_creates_parent_if_not_exist(tmp_path: pathlib.Path):
     projects_path = tmp_path / "projects_path"  # doesn't exist yet
-    repo_dir = projects_path / "myrepo"
-    repo = BaseRepo(url="file://path/to/myrepo", repo_dir=repo_dir)
+    dir = projects_path / "myrepo"
+    repo = BaseRepo(url="file://path/to/myrepo", dir=dir)
 
     repo.ensure_dir()
     assert projects_path.is_dir()
@@ -62,7 +62,7 @@ def obtain(self, *args, **kwargs):
 
     r = Repo(
         url=f"file://{str(git_remote_repo)}",
-        repo_dir=str(tmp_path),
+        dir=str(tmp_path),
         progress_callback=progress_cb,
     )
     r.obtain()