chore(ruff): Manual fixes (27 errors)

scripts/generate_gitlab.py:45:8: PTH113 `os.path.isfile()` should be replaced by `Path.is_file()`
scripts/generate_gitlab.py:60:19: SIM115 Use context handler for opening files
scripts/generate_gitlab.py:60:19: PTH123 `open()` should be replaced by `Path.open()`
scripts/generate_gitlab.py:75:15: PTH109 `os.getcwd()` should be replaced by `Path.cwd()`
scripts/generate_gitlab.py:93:15: TRY002 Create your own exception
scripts/generate_gitlab.py:93:15: TRY003 Avoid specifying long messages outside the exception class
src/vcspull/_internal/config_reader.py:105:19: SIM115 Use context handler for opening files
src/vcspull/_internal/config_reader.py:105:19: PTH123 `open()` should be replaced by `Path.open()`
src/vcspull/cli/sync.py:95:9: PERF203 `try`-`except` within a loop incurs performance overhead
src/vcspull/cli/sync.py:107:21: B904 Within an `except` clause, raise exceptions with `raise ... from err` or `raise ... from None` to distinguish them from errors in exception handling
src/vcspull/cli/sync.py:107:21: TRY200 Use `raise from` to specify exception cause
src/vcspull/cli/sync.py:147:19: TRY002 Create your own exception
src/vcspull/cli/sync.py:147:19: TRY003 Avoid specifying long messages outside the exception class
src/vcspull/config.py:31:45: B008 Do not perform function call `pathlib.Path.cwd` in argument defaults
src/vcspull/config.py:47:25: PTH111 `os.path.expanduser()` should be replaced by `Path.expanduser()`
src/vcspull/config.py:55:50: B008 Do not perform function call `pathlib.Path.cwd` in argument defaults
src/vcspull/config.py:145:32: PTH111 `os.path.expanduser()` should be replaced by `Path.expanduser()`
src/vcspull/config.py:147:32: PTH111 `os.path.expanduser()` should be replaced by `Path.expanduser()`
src/vcspull/config.py:214:29: PTH111 `os.path.expanduser()` should be replaced by `Path.expanduser()`
src/vcspull/config.py:230:52: B008 Do not perform function call `pathlib.Path.cwd` in argument defaults
src/vcspull/config.py:336:13: PERF401 Use a list comprehension to create a transformed list
src/vcspull/util.py:12:21: PTH111 `os.path.expanduser()` should be replaced by `Path.expanduser()`
src/vcspull/util.py:34:22: PTH118 `os.path.join()` should be replaced by `Path` with `/` operator
src/vcspull/util.py:41:16: PTH111 `os.path.expanduser()` should be replaced by `Path.expanduser()`
src/vcspull/util.py:42:12: PTH112 `os.path.isdir()` should be replaced by `Path.is_dir()`
tests/test_config_file.py:96:13: PERF401 Use a list comprehension to create a transformed list
tests/test_config_file.py:393:10: B017 `pytest.raises(Exception)` should be considered evil
Found 27 errors.

Author: tony

scripts/generate_gitlab.py

@@ -2,13 +2,14 @@
 
 import argparse
 import os
+import pathlib
 import sys
 
 import requests
 import yaml
 from libvcs.sync.git import GitRemote
 
-from vcspull.cli.sync import guess_vcs
+from vcspull.cli.sync import CouldNotGuessVCSFromURL, guess_vcs
 from vcspull.types import RawConfig
 
 try:
@@ -39,10 +40,10 @@
 args = vars(parser.parse_args())
 gitlab_host = args["gitlab_host"]
 gitlab_namespace = args["gitlab_namespace"]
-config_filename = args["config_file_name"]
+config_filename = pathlib.Path(args["config_file_name"])
 
 try:
-    if os.path.isfile(config_filename):
+    if config_filename.is_file():
         result = input(
             "The target config file (%s) already exists, \
             do you want to overwrite it? [y/N] "
@@ -57,9 +58,9 @@
             )
             sys.exit(0)
 
-    config_file = open(config_filename, "w")
+    config_file = config_filename.open(mode="w")
 except OSError:
-    print("File %s not accesible" % (config_filename))
+    print(f"File {config_filename} not accesible")
     sys.exit(1)
 
 response = requests.get(
@@ -72,9 +73,10 @@
     print("Error: ", response)
     sys.exit(1)
 
-path_prefix = os.getcwd()
+path_prefix = pathlib.Path().cwd()
 config: RawConfig = {}
 
+
 for group in response.json():
     url_to_repo = group["ssh_url_to_repo"].replace(":", "/")
     namespace_path = group["namespace"]["full_path"]
@@ -90,7 +92,7 @@
 
     vcs = guess_vcs(url_to_repo)
     if vcs is None:
-        raise Exception(f"Could not guess VCS for URL: {url_to_repo}")
+        raise CouldNotGuessVCSFromURL(url_to_repo)
 
     config[path][reponame] = {
         "name": reponame,

src/vcspull/_internal/config_reader.py

@@ -102,7 +102,7 @@ def _from_file(cls, path: pathlib.Path) -> dict[str, t.Any]:
         {'session_name': 'my session'}
         """
         assert isinstance(path, pathlib.Path)
-        content = open(path).read()
+        content = path.open().read()
 
         if path.suffix in [".yaml", ".yml"]:
             format: "FormatLiteral" = "yaml"

src/vcspull/cli/sync.py

@@ -92,8 +92,8 @@ def sync(
     for repo in found_repos:
         try:
             update_repo(repo)
-        except Exception:
-            print(
+        except Exception as e:  # noqa: PERF203
+            log.info(
                 f'Failed syncing {repo.get("name")}',
             )
             if log.isEnabledFor(logging.DEBUG):
@@ -103,8 +103,7 @@ def sync(
             if exit_on_error:
                 if parser is not None:
                     parser.exit(status=1, message=EXIT_ON_ERROR_MSG)
-                else:
-                    raise SystemExit(EXIT_ON_ERROR_MSG)
+                raise SystemExit(EXIT_ON_ERROR_MSG) from e
 
 
 def progress_cb(output: str, timestamp: datetime) -> None:
@@ -144,9 +143,7 @@ def update_repo(
     if repo_dict.get("vcs") is None:
         vcs = guess_vcs(url=repo_dict["url"])
         if vcs is None:
-            raise Exception(
-                f'Could not automatically determine VCS for {repo_dict["url"]}'
-            )
+            raise CouldNotGuessVCSFromURL(repo_url=repo_dict["url"])
 
         repo_dict["vcs"] = vcs
 

src/vcspull/config.py

@@ -28,7 +28,8 @@
 
 
 def expand_dir(
-    _dir: pathlib.Path, cwd: pathlib.Path = pathlib.Path.cwd()
+    _dir: pathlib.Path,
+    cwd: t.Union[pathlib.Path, t.Callable[[], pathlib.Path]] = pathlib.Path.cwd,
 ) -> pathlib.Path:
     """Return path with environmental variables and tilde ~ expanded.
 
@@ -44,15 +45,19 @@ def expand_dir(
     pathlib.Path :
         Absolute directory path
     """
-    _dir = pathlib.Path(os.path.expanduser(os.path.expandvars(str(_dir))))
+    _dir = pathlib.Path(os.path.expandvars(str(_dir))).expanduser()
+    if callable(cwd):
+        cwd = cwd()
+
     if not _dir.is_absolute():
         _dir = pathlib.Path(os.path.normpath(cwd / _dir))
         assert _dir == pathlib.Path(cwd, _dir).resolve(strict=False)
     return _dir
 
 
 def extract_repos(
-    config: "RawConfigDict", cwd: pathlib.Path = pathlib.Path.cwd()
+    config: "RawConfigDict",
+    cwd: t.Union[pathlib.Path, t.Callable[[], pathlib.Path]] = pathlib.Path.cwd,
 ) -> list["ConfigDict"]:
     """Return expanded configuration.
 
@@ -71,6 +76,9 @@ def extract_repos(
     list : List of normalized repository information
     """
     configs: list["ConfigDict"] = []
+    if callable(cwd):
+        cwd = cwd()
+
     for directory, repos in config.items():
         assert isinstance(repos, dict)
         for repo, repo_data in repos.items():
@@ -135,16 +143,16 @@ def is_valid_config_dict(val: t.Any) -> "TypeGuard[ConfigDict]":
 
 
 def find_home_config_files(
-    filetype: t.Optional[list[str]] = None
+    filetype: t.Optional[list[str]] = None,
 ) -> list[pathlib.Path]:
     """Return configs of ``.vcspull.{yaml,json}`` in user's home directory."""
     if filetype is None:
         filetype = ["json", "yaml"]
     configs: list[pathlib.Path] = []
 
-    yaml_config = pathlib.Path(os.path.expanduser("~/.vcspull.yaml"))
+    yaml_config = pathlib.Path("~/.vcspull.yaml").expanduser()
     has_yaml_config = yaml_config.exists()
-    json_config = pathlib.Path(os.path.expanduser("~/.vcspull.json"))
+    json_config = pathlib.Path("~/.vcspull.json").expanduser()
     has_json_config = json_config.exists()
 
     if not has_yaml_config and not has_json_config:
@@ -167,8 +175,8 @@ def find_home_config_files(
 def find_config_files(
     path: t.Optional[t.Union[list[pathlib.Path], pathlib.Path]] = None,
     match: t.Optional[t.Union[list[str], str]] = None,
-    filetype: t.Union[
-        t.Literal["json", "yaml", "*"], list[t.Literal["json", "yaml", "*"]]
+    filetype: t.Optional[
+        t.Union[t.Literal["json", "yaml", "*"], list[t.Literal["json", "yaml", "*"]]]
     ] = None,
     include_home: bool = False,
 ) -> list[pathlib.Path]:
@@ -211,7 +219,7 @@ def find_config_files(
             config_files.extend(find_config_files(p, match, filetype))
             return config_files
     else:
-        path = pathlib.Path(os.path.expanduser(path))
+        path = path.expanduser()
         if isinstance(match, list):
             for m in match:
                 config_files.extend(find_config_files(path, m, filetype))
@@ -227,7 +235,8 @@ def find_config_files(
 
 
 def load_configs(
-    files: list[pathlib.Path], cwd: pathlib.Path = pathlib.Path.cwd()
+    files: list[pathlib.Path],
+    cwd: t.Union[pathlib.Path, t.Callable[[], pathlib.Path]] = pathlib.Path.cwd,
 ) -> list["ConfigDict"]:
     """Return repos from a list of files.
 
@@ -248,6 +257,9 @@ def load_configs(
     Validate scheme, check for duplicate destinations, VCS urls
     """
     repos: list["ConfigDict"] = []
+    if callable(cwd):
+        cwd = cwd()
+
     for file in files:
         if isinstance(file, str):
             file = pathlib.Path(file)
@@ -329,11 +341,12 @@ def in_dir(
         extensions = [".yml", ".yaml", ".json"]
     if config_dir is not None:
         config_dir = get_config_dir()
-    configs = []
 
-    for filename in os.listdir(config_dir):
-        if is_config_file(filename, extensions) and not filename.startswith("."):
-            configs.append(filename)
+    configs = [
+        filename
+        for filename in os.listdir(config_dir)
+        if is_config_file(filename, extensions) and not filename.startswith(".")
+    ]
 
     return configs
 

src/vcspull/util.py

@@ -9,7 +9,7 @@
 import typing as t
 from collections.abc import Mapping
 
-LEGACY_CONFIG_DIR = os.path.expanduser("~/.vcspull/")  # remove dupes of this
+LEGACY_CONFIG_DIR = pathlib.Path("~/.vcspull/").expanduser()  # remove dupes of this
 
 
 def get_config_dir() -> pathlib.Path:
@@ -27,23 +27,23 @@ def get_config_dir() -> pathlib.Path:
         absolute path to tmuxp config directory
     """
 
-    paths = []
+    paths: list[pathlib.Path] = []
     if "VCSPULL_CONFIGDIR" in os.environ:
-        paths.append(os.environ["VCSPULL_CONFIGDIR"])
+        paths.append(pathlib.Path(os.environ["VCSPULL_CONFIGDIR"]))
     if "XDG_CONFIG_HOME" in os.environ:
-        paths.append(os.path.join(os.environ["XDG_CONFIG_HOME"], "vcspull"))
+        paths.append(pathlib.Path(os.environ["XDG_CONFIG_HOME"]) / "vcspull")
     else:
-        paths.append("~/.config/vcspull/")
+        paths.append(pathlib.Path("~/.config/vcspull/"))
     paths.append(LEGACY_CONFIG_DIR)
 
     path = None
     for path in paths:
-        path = os.path.expanduser(path)
-        if os.path.isdir(path):
-            return pathlib.Path(path)
+        path = path.expanduser()
+        if path.is_dir():
+            return path
 
     # Return last path as default if none of the previous ones matched
-    return pathlib.Path(path)
+    return path
 
 
 T = t.TypeVar("T", bound=dict[str, t.Any])

tests/test_config_file.py

@@ -83,17 +83,19 @@ def test_export_yaml(tmp_path: pathlib.Path) -> None:
 
 
 def test_scan_config(tmp_path: pathlib.Path) -> None:
-    config_files = []
+    config_files: list[str] = []
 
     exists = os.path.exists
     garbage_file = tmp_path / ".vcspull.psd"
     garbage_file.write_text("wat", encoding="utf-8")
 
-    for _r, _d, f in os.walk(str(tmp_path)):
-        for filela in (
-            x for x in f if x.endswith((".json", "yaml")) and x.startswith(".vcspull")
-        ):
-            config_files.append(str(tmp_path / filela))
+    for _r, _d, file in os.walk(str(tmp_path)):
+        config_files += [
+            str(tmp_path / scanned_file)
+            for scanned_file in file
+            if scanned_file.endswith((".json", "yaml"))
+            and scanned_file.startswith(".vcspull")
+        ]
 
     files = 0
     if exists(str(tmp_path / ".vcspull.json")):
@@ -390,5 +392,5 @@ def test_merge_nested_dict(tmp_path: pathlib.Path, config_path: pathlib.Path) ->
     )
     assert config1 in config_files
     assert config2 in config_files
-    with pytest.raises(Exception):
+    with pytest.raises(exc.VCSPullException):
         config.load_configs(config_files)