refactor!: dir to pathlib, BaseRepo.path -> BaseRepo.dir

Author: tony

libvcs/conftest.py

@@ -163,7 +163,7 @@ def fn(
             remote_repos_path=remote_repos_path,
             remote_repo_name=remote_repo_name
             if remote_repo_name is not None
-            else faker.word(),
+            else faker.slug(),
             remote_repo_post_init=remote_repo_post_init,
         )
 

libvcs/states/base.py

@@ -1,9 +1,10 @@
 """Base class for Repository objects."""
 import logging
-import os
+import pathlib
 from typing import NamedTuple
 from urllib import parse as urlparse
 
+from libvcs.types import StrOrPath
 from libvcs.util import CmdLoggingAdapter, mkdir_p, run
 
 logger = logging.getLogger(__name__)
@@ -40,7 +41,7 @@ class BaseRepo:
     #: vcs app name, e.g. 'git'
     bin_name = ""
 
-    def __init__(self, url, dir, progress_callback=None, *args, **kwargs):
+    def __init__(self, url, dir: StrOrPath, progress_callback=None, *args, **kwargs):
         r"""
         Parameters
         ----------
@@ -58,7 +59,7 @@ def __init__(self, url, dir, progress_callback=None, *args, **kwargs):
             ...     def obtain(self, *args, **kwargs):
             ...         self.ensure_dir()
             ...         self.run(
-            ...             ['clone', '--progress', self.url, self.path],
+            ...             ['clone', '--progress', self.url, self.dir],
             ...             log_in_real_time=True
             ...         )
             >>> r = Repo(
@@ -72,22 +73,26 @@ def __init__(self, url, dir, progress_callback=None, *args, **kwargs):
             remote: Counting objects: 100% (...), done...
             remote: Total ... (delta 0), reused 0 (delta 0), pack-reused 0...
             Receiving objects: 100% (...), done...
-            >>> assert os.path.exists(r.path)
-            >>> assert os.path.exists(r.path + '/.git')
+            >>> assert r.dir.exists()
+            >>> assert pathlib.Path(r.dir / '.git').exists()
         """
         self.url = url
 
         #: Callback for run updates
         self.progress_callback = progress_callback
 
-        #: Parent directory
-        self.parent_dir = os.path.dirname(dir)
+        #: Directory to check out
+        self.dir: pathlib.Path
+        if isinstance(dir, pathlib.Path):
+            self.dir = dir
+        else:
+            self.dir = pathlib.Path(dir)
 
-        #: Checkout path
-        self.path = dir
+        #: Parent directory
+        self.parent_dir = self.dir.parent
 
         #: Base name of checkout
-        self.repo_name = os.path.basename(os.path.normpath(dir))
+        self.repo_name = self.dir.stem
 
         if "rev" in kwargs:
             self.rev = kwargs["rev"]
@@ -124,12 +129,12 @@ def run(
         """Return combined stderr/stdout from a command.
 
         This method will also prefix the VCS command bin_name. By default runs
-        using the cwd `libvcs.base.BaseRepo.path` of the repo.
+        using the cwd `libvcs.base.BaseRepo.dir` of the repo.
 
         Parameters
         ----------
         cwd : str
-            dir command is run from, defaults to `libvcs.base.BaseRepo.path`.
+            dir command is run from, defaults to `libvcs.base.BaseRepo.dir`.
 
         check_returncode : bool
             Indicate whether a :exc:`~exc.CommandError` should be raised if return code
@@ -142,7 +147,7 @@ def run(
         """
 
         if cwd is None:
-            cwd = getattr(self, "path", None)
+            cwd = getattr(self, "dir", None)
 
         cmd = [self.bin_name] + cmd
 
@@ -158,18 +163,17 @@ def run(
 
     def ensure_dir(self, *args, **kwargs):
         """Assure destination path exists. If not, create directories."""
-        if os.path.exists(self.path):
+        if self.dir.exists():
             return True
 
-        if not os.path.exists(self.parent_dir):
+        if not self.parent_dir.exists():
             mkdir_p(self.parent_dir)
 
-        if not os.path.exists(self.path):
+        if not self.dir.exists():
             self.log.debug(
-                "Repo directory for %s does not exist @ %s"
-                % (self.repo_name, self.path)
+                "Repo directory for %s does not exist @ %s" % (self.repo_name, self.dir)
             )
-            mkdir_p(self.path)
+            mkdir_p(self.dir)
 
         return True
 

libvcs/states/git.py

@@ -15,7 +15,7 @@
     - [`GitRepo.get_git_version`](libvcs.git.GitRepo.get_git_version)
 """  # NOQA: E501
 import logging
-import os
+import pathlib
 import re
 from typing import Dict, NamedTuple, Optional, TypedDict, Union
 from urllib import parse as urlparse
@@ -160,7 +160,7 @@ def __init__(
             import os
             from libvcs.git import GitRepo
 
-            checkout = os.path.dirname(os.path.abspath(__name__)) + '/' + 'my_libvcs'
+            checkout = pathlib.Path(__name__) + '/' + 'my_libvcs'
 
             repo = GitRepo(
                url="https://github.com/vcs-python/libvcs",
@@ -175,7 +175,7 @@ def __init__(
             import os
             from libvcs.git import GitRepo
 
-            checkout = os.path.dirname(os.path.abspath(__name__)) + '/' + 'my_libvcs'
+            checkout = pathlib.Path(__name__) + '/' + 'my_libvcs'
 
             repo = GitRepo(
                url="https://github.com/vcs-python/libvcs",
@@ -295,7 +295,7 @@ def obtain(self, *args, **kwargs):
             cmd.extend(["--depth", "1"])
         if self.tls_verify:
             cmd.extend(["-c", "http.sslVerify=false"])
-        cmd.extend([url, self.path])
+        cmd.extend([url, self.dir])
 
         self.log.info("Cloning.")
         self.run(cmd, log_in_real_time=True)
@@ -310,7 +310,7 @@ def obtain(self, *args, **kwargs):
     def update_repo(self, set_remotes: bool = False, *args, **kwargs):
         self.ensure_dir()
 
-        if not os.path.isdir(os.path.join(self.path, ".git")):
+        if not pathlib.Path(self.dir / ".git").is_dir():
             self.obtain()
             self.update_repo(set_remotes=set_remotes)
             return
@@ -433,7 +433,7 @@ def update_repo(self, set_remotes: bool = False, *args, **kwargs):
 
                     self.log.error(
                         "\nFailed to rebase in: '%s'.\n"
-                        "You will have to resolve the conflicts manually" % self.path
+                        "You will have to resolve the conflicts manually" % self.dir
                     )
                     return
 
@@ -452,7 +452,7 @@ def update_repo(self, set_remotes: bool = False, *args, **kwargs):
                         self.log.error(
                             "\nFailed to rebase in: '%s'.\n"
                             "You will have to resolve the "
-                            "conflicts manually" % self.path
+                            "conflicts manually" % self.dir
                         )
                         return
 

libvcs/states/hg.py

@@ -9,7 +9,7 @@
    - [`MercurialRepo.get_revision`](libvcs.hg.MercurialRepo.get_revision)
 """  # NOQA E5
 import logging
-import os
+import pathlib
 
 from .base import BaseRepo
 
@@ -28,15 +28,15 @@ def obtain(self, *args, **kwargs):
 
         # Double hyphens between [OPTION]... -- SOURCE [DEST] prevent command injections
         # via aliases
-        self.run(["clone", "--noupdate", "-q", "--", self.url, self.path])
+        self.run(["clone", "--noupdate", "-q", "--", self.url, self.dir])
         self.run(["update", "-q"])
 
     def get_revision(self):
         return self.run(["parents", "--template={rev}"])
 
     def update_repo(self, *args, **kwargs):
         self.ensure_dir()
-        if not os.path.isdir(os.path.join(self.path, ".hg")):
+        if not pathlib.Path(self.dir / ".hg").exists():
             self.obtain()
             self.update_repo()
         else:

libvcs/states/svn.py

@@ -14,6 +14,7 @@
 """  # NOQA: E5
 import logging
 import os
+import pathlib
 import re
 from urllib import parse as urlparse
 
@@ -74,7 +75,7 @@ def obtain(self, quiet=None):
             cmd.append("--trust-server-cert")
         cmd.extend(self._user_pw_args())
         cmd.extend(get_rev_options(url, rev))
-        cmd.append(self.path)
+        cmd.append(self.dir)
 
         self.run(cmd)
 
@@ -122,8 +123,8 @@ def get_revision(self, location=None):
 
     def update_repo(self, dest=None, *args, **kwargs):
         self.ensure_dir()
-        if os.path.isdir(os.path.join(self.path, ".svn")):
-            dest = self.path if not dest else dest
+        if pathlib.Path(self.dir / ".svn").exists():
+            dest = self.dir if not dest else dest
 
             url, rev = self.url, self.rev
 

tests/states/test_base.py

@@ -56,9 +56,7 @@ class Repo(BaseRepo):
 
         def obtain(self, *args, **kwargs):
             self.ensure_dir()
-            self.run(
-                ["clone", "--progress", self.url, self.path], log_in_real_time=True
-            )
+            self.run(["clone", "--progress", self.url, self.dir], log_in_real_time=True)
 
     r = Repo(
         url=f"file://{str(git_remote_repo)}",

tests/states/test_git.py

@@ -589,7 +589,7 @@ def test_get_current_remote_name(git_repo: GitRepo):
 
     new_remote_name = "new_remote_name"
     git_repo.set_remote(
-        name=new_remote_name, url=f"file://{git_repo.path}", overwrite=True
+        name=new_remote_name, url=f"file://{git_repo.dir}", overwrite=True
     )
     git_repo.run(["fetch", new_remote_name])
     git_repo.run(["branch", "--set-upstream-to", f"{new_remote_name}/{new_branch}"])