refactor!: dir -> path to not shadow builtin

Author: tony

CHANGES

@@ -604,7 +604,7 @@ Temporarily add `Faker` as a dependency (due to pytest), track longterm fix on (
 
     Before: `project.parent_dir`
 
-    After: `project.parent.dir`.
+    After: `project.parent.path`.
 
   - `repo_name` switched from attribute to property
 
@@ -722,13 +722,13 @@ Temporarily add `Faker` as a dependency (due to pytest), track longterm fix on (
   `libvcs.sync.{module}.{Module}Project`
 - `repo_dir` param is renamed to `dir`:
 
-  Before: `GitSync(url='...', repo_dir='...')`
+  Before: `GitSync(url='...', repo_path='...')`
 
-  After: `GitSync(url='...', dir='...')`
+  After: `GitSync(url='...', path='...')`
 
   #324
 
-- `dir` to `pathlib`, `BaseSync.path` -> `BaseSync.dir`
+- `dir` to `pathlib`, `BaseSync.path` -> `BaseSync.path`
 - Logging functions moved to {attr}`libvcs.sync.base.BaseSync.log` (#322)
 - Rename `ProjectLoggingAdapter` to `CmdLoggingAdapter`
 - `CmdLoggingAdapter`: Rename `repo_name` param to `keyword`
@@ -768,7 +768,7 @@ Temporarily add `Faker` as a dependency (due to pytest), track longterm fix on (
   ```python
   repo = GitSync(
       url="https://github.com/vcs-python/libvcs",
-      repo_dir=checkout,
+      repo_path=checkout,
       remotes={
           'gitlab': 'https://gitlab.com/vcs-python/libvcs',
       }
@@ -778,7 +778,7 @@ Temporarily add `Faker` as a dependency (due to pytest), track longterm fix on (
   ```python
   repo = GitSync(
       url="https://github.com/vcs-python/libvcs",
-      repo_dir=checkout,
+      repo_path=checkout,
       remotes={
           'gitlab': {
               'fetch_url': 'https://gitlab.com/vcs-python/libvcs',

README.md

@@ -83,7 +83,7 @@ Simple [`subprocess`](https://docs.python.org/3/library/subprocess.html) wrapper
 import pathlib
 from libvcs.cmd.git import Git
 
-git = Git(dir=pathlib.Path.cwd() / 'my_git_repo')
+git = Git(path=pathlib.Path.cwd() / 'my_git_repo')
 git.clone(url='https://github.com/vcs-python/libvcs.git')
 ```
 
@@ -98,7 +98,7 @@ from libvcs.sync.git import GitSync
 
 repo = GitSync(
    url="https://github.com/vcs-python/libvcs",
-   dir=pathlib.Path().cwd() / "my_repo",
+   path=pathlib.Path().cwd() / "my_repo",
    remotes={
        'gitlab': 'https://gitlab.com/vcs-python/libvcs'
    }
@@ -136,7 +136,7 @@ def test_repo_git_remote_checkout(
 ) -> None:
     git_server = create_git_remote_repo()
     git_repo_checkout_dir = projects_path / "my_git_checkout"
-    git_repo = GitSync(dir=str(git_repo_checkout_dir), url=f"file://{git_server!s}")
+    git_repo = GitSync(path=str(git_repo_checkout_dir), url=f"file://{git_server!s}")
 
     git_repo.obtain()
     git_repo.update_repo()

src/libvcs/_internal/shortcuts.py

@@ -36,7 +36,7 @@ def __init__(self, url: str, vcs: str, *args: object):
 def create_project(
     *,
     url: str,
-    dir: StrPath,
+    path: StrPath,
     vcs: t.Literal["git"],
     progress_callback: t.Optional[ProgressCallbackProtocol] = None,
     **kwargs: dict[t.Any, t.Any],
@@ -48,7 +48,7 @@ def create_project(
 def create_project(
     *,
     url: str,
-    dir: StrPath,
+    path: StrPath,
     vcs: t.Literal["svn"],
     progress_callback: t.Optional[ProgressCallbackProtocol] = None,
     **kwargs: dict[t.Any, t.Any],
@@ -60,7 +60,7 @@ def create_project(
 def create_project(
     *,
     url: str,
-    dir: StrPath,
+    path: StrPath,
     vcs: t.Literal["hg"],
     progress_callback: t.Optional[ProgressCallbackProtocol] = ...,
     **kwargs: dict[t.Any, t.Any],
@@ -71,7 +71,7 @@ def create_project(
 def create_project(
     *,
     url: str,
-    dir: StrPath,
+    path: StrPath,
     vcs: t.Optional[VCSLiteral] = None,
     progress_callback: t.Optional[ProgressCallbackProtocol] = None,
     **kwargs: dict[t.Any, t.Any],
@@ -84,7 +84,7 @@ def create_project(
     >>> r = create_project(
     ...     url=f'file://{create_git_remote_repo()}',
     ...     vcs='git',
-    ...     dir=tmp_path
+    ...     path=tmp_path
     ... )
 
     >>> isinstance(r, GitSync)
@@ -95,7 +95,7 @@ def create_project(
     >>> r = create_project(
     ...     # Note the git+ before the URL
     ...     url=f'git+file://{create_git_remote_repo()}',
-    ...     dir=tmp_path
+    ...     path=tmp_path
     ... )
 
     >>> isinstance(r, GitSync)
@@ -120,10 +120,14 @@ def is_vcs(val: t.Any) -> "TypeGuard[VCSLiteral]":
             raise VCSNotSupported(url=url, vcs=vcs_matches[0].vcs)
 
     if vcs == "git":
-        return GitSync(url=url, dir=dir, progress_callback=progress_callback, **kwargs)
+        return GitSync(
+            url=url, path=path, progress_callback=progress_callback, **kwargs
+        )
     elif vcs == "hg":
-        return HgSync(url=url, dir=dir, progress_callback=progress_callback, **kwargs)
+        return HgSync(url=url, path=path, progress_callback=progress_callback, **kwargs)
     elif vcs == "svn":
-        return SvnSync(url=url, dir=dir, progress_callback=progress_callback, **kwargs)
+        return SvnSync(
+            url=url, path=path, progress_callback=progress_callback, **kwargs
+        )
     else:
         raise InvalidVCS("VCS %s is not a valid VCS" % vcs)