Toughen ruff linting (#452)

## ruff linting

### flake8-commas (COM)

- https://docs.astral.sh/ruff/rules/#flake8-commas-com
- https://pypi.org/project/flake8-commas/

### flake8-builtins (A)

- https://docs.astral.sh/ruff/rules/#flake8-builtins-a
- https://pypi.org/project/flake8-builtins/

### flake8-errmsg (EM)

- https://docs.astral.sh/ruff/rules/#flake8-errmsg-em
- https://pypi.org/project/flake8-errmsg/

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()

docs/conf.py

@@ -53,7 +53,7 @@
 master_doc = "index"
 
 project = about["__title__"]
-copyright = about["__copyright__"]
+project_copyright = about["__copyright__"]
 
 version = "%s" % (".".join(about["__version__"].split("."))[:2])
 release = "%s" % (about["__version__"])
@@ -97,7 +97,7 @@
         "sidebar/navigation.html",
         "sidebar/projects.html",
         "sidebar/scroll-end.html",
-    ]
+    ],
 }
 
 # linkify_issues

pyproject.toml

@@ -141,8 +141,11 @@ select = [
   "F", # pyflakes
   "I", # isort
   "UP", # pyupgrade
+  "A", # flake8-builtins
   "B", # flake8-bugbear
   "C4", # flake8-comprehensions
+  "COM", # flake8-commas
+  "EM", # flake8-errmsg
   "Q", # flake8-quotes
   "PTH", # flake8-use-pathlib
   "SIM", # flake8-simplify
@@ -151,6 +154,9 @@ select = [
   "RUF", # Ruff-specific rules
   "D", # pydocstyle
 ]
+ignore = [
+  "COM812", # missing trailing comma, ruff format conflict
+]
 
 [tool.ruff.lint.isort]
 known-first-party = [

src/libvcs/_internal/module_loading.py

@@ -108,6 +108,6 @@ def import_string(import_name: str, silent: bool = False) -> t.Any:
     except ImportError as e:
         if not silent:
             raise ImportStringError(import_name, e).with_traceback(
-                sys.exc_info()[2]
+                sys.exc_info()[2],
             ) from None
     return None

src/libvcs/_internal/run.py

@@ -65,7 +65,9 @@ def __init__(self, bin_name: str, keyword: str, *args: Any, **kwargs: Any) -> No
         logging.LoggerAdapter.__init__(self, *args, **kwargs)
 
     def process(
-        self, msg: str, kwargs: MutableMapping[str, Any]
+        self,
+        msg: str,
+        kwargs: MutableMapping[str, Any],
     ) -> tuple[Any, MutableMapping[str, Any]]:
         """Add additional context information for loggers."""
         prefixed_dict = {}
@@ -89,7 +91,8 @@ def __call__(self, output: AnyStr, timestamp: datetime.datetime) -> None:
     _ENV: "TypeAlias" = Mapping[str, str]
 else:
     _ENV: "TypeAlias" = Union[
-        Mapping[bytes, StrOrBytesPath], Mapping[str, StrOrBytesPath]
+        Mapping[bytes, StrOrBytesPath],
+        Mapping[str, StrOrBytesPath],
     ]
 
 _CMD = Union[StrOrBytesPath, Sequence[StrOrBytesPath]]

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)

src/libvcs/_internal/subprocess.py

@@ -1,3 +1,4 @@
+# ruff: NOQA: A002
 r"""Invocable :mod:`subprocess` wrapper.
 
 Defer running a subprocess, such as by handing to an executor.
@@ -73,7 +74,8 @@ def __init__(self, output: str, *args: object):
     _ENV: "TypeAlias" = Mapping[str, str]
 else:
     _ENV: "TypeAlias" = Union[
-        Mapping[bytes, StrOrBytesPath], Mapping[str, StrOrBytesPath]
+        Mapping[bytes, StrOrBytesPath],
+        Mapping[str, StrOrBytesPath],
     ]
 _FILE: "TypeAlias" = Union[None, int, IO[Any]]
 _TXT: "TypeAlias" = Union[bytes, str]

src/libvcs/_internal/types.py

@@ -16,7 +16,10 @@
 """:class:`os.PathLike` or :class:`str`"""
 
 StrOrBytesPath: "TypeAlias" = Union[
-    str, bytes, PathLike[str], PathLike[bytes]  # stable
+    str,
+    bytes,
+    PathLike[str],
+    PathLike[bytes],  # stable
 ]
 """:class:`os.PathLike`, :class:`str` or :term:`bytes-like object`"""