Linting: Aggressive ruff pass (ruff v0.3.4, #458)

Author: tony

CHANGES

@@ -17,6 +17,23 @@ $ pip install --user --upgrade --pre libvcs
 
 ### Development
 
+- Aggressive automated lint fixes via `ruff` (#458)
+
+  via ruff v0.3.4, all automated lint fixes, including unsafe and previews were applied:
+
+  ```sh
+  ruff check --select ALL . --fix --unsafe-fixes --preview --show-fixes; ruff format .
+  ```
+
+  Branches were treated with:
+
+  ```sh
+  git rebase \
+      --strategy-option=theirs \
+      --exec 'poetry run ruff check --select ALL . --fix --unsafe-fixes --preview --show-fixes; poetry run ruff format .; git add src tests; git commit --amend --no-edit' \
+      origin/master
+  ```
+
 - poetry: 1.7.1 -> 1.8.1
 
   See also: https://github.com/python-poetry/poetry/blob/1.8.1/CHANGELOG.md

conftest.py

@@ -42,4 +42,3 @@ def setup(
     set_home: pathlib.Path,
 ) -> None:
     """Configure test fixtures for pytest."""
-    pass

docs/conf.py

@@ -209,15 +209,14 @@ def linkcode_resolve(domain: str, info: dict[str, str]) -> t.Union[None, str]:
             fn,
             linespec,
         )
-    else:
-        return "{}/blob/v{}/{}/{}/{}{}".format(
-            about["__github__"],
-            about["__version__"],
-            "src",
-            about["__package_name__"],
-            fn,
-            linespec,
-        )
+    return "{}/blob/v{}/{}/{}/{}{}".format(
+        about["__github__"],
+        about["__version__"],
+        "src",
+        about["__package_name__"],
+        fn,
+        linespec,
+    )
 
 
 def remove_tabs_js(app: "Sphinx", exc: Exception) -> None:

src/libvcs/__init__.py

@@ -9,11 +9,11 @@
 from .sync.svn import SvnSync
 
 __all__ = [
+    "BaseSync",
+    "CmdLoggingAdapter",
     "GitSync",
     "HgSync",
     "SvnSync",
-    "BaseSync",
-    "CmdLoggingAdapter",
 ]
 
 logger = logging.getLogger(__name__)

src/libvcs/_internal/query_list.py

@@ -5,11 +5,14 @@
 This is an internal API not covered by versioning policy.
 """
 
+import logging
 import re
 import traceback
 import typing as t
 from collections.abc import Iterable, Mapping, Sequence
 
+logger = logging.getLogger(__name__)
+
 T = t.TypeVar("T")
 no_arg = object()
 
@@ -86,7 +89,7 @@ def keygetter(
                 dct = getattr(dct, sub_field)
     except Exception as e:
         traceback.print_stack()
-        print(f"Above error was {e}")
+        logger.debug(f"The above error was {e}")
         return None
     return dct
 
@@ -120,8 +123,9 @@ def parse_lookup(obj: Mapping[str, t.Any], path: str, lookup: str) -> t.Optional
             field_name = path.rsplit(lookup)[0]
             if field_name is not None:
                 return keygetter(obj, field_name)
-    except Exception:
+    except Exception as e:
         traceback.print_stack()
+        logger.debug(f"The above error was {e}")
     return None
 
 
@@ -304,12 +308,12 @@ def lookup_iregex(
 
 
 class PKRequiredException(Exception):
-    def __init__(self, *args: object):
+    def __init__(self, *args: object) -> None:
         return super().__init__("items() require a pk_key exists")
 
 
 class OpNotFound(ValueError):
-    def __init__(self, op: str, *args: object):
+    def __init__(self, op: str, *args: object) -> None:
         return super().__init__(f"{op} not in LOOKUP_NAME_MAP")
 
 
@@ -470,7 +474,7 @@ def __init__(self, items: t.Optional["Iterable[T]"] = None) -> None:
 
     def items(self) -> list[tuple[str, T]]:
         if self.pk_key is None:
-            raise PKRequiredException()
+            raise PKRequiredException
         return [(getattr(item, self.pk_key), item) for item in self]
 
     def __eq__(
@@ -490,9 +494,8 @@ def __eq__(
                         for key in a_keys:
                             if abs(a[key] - b[key]) > 1:
                                 return False
-                else:
-                    if a != b:
-                        return False
+                elif a != b:
+                    return False
 
             return True
         return False
@@ -529,8 +532,7 @@ def filter_lookup(obj: t.Any) -> bool:
             def val_match(obj: t.Union[str, list[t.Any], T]) -> bool:
                 if isinstance(matcher, list):
                     return obj in matcher
-                else:
-                    return bool(obj == matcher)
+                return bool(obj == matcher)
 
             _filter = val_match
         else:
@@ -546,9 +548,9 @@ def get(
     ) -> t.Optional[T]:
         objs = self.filter(matcher=matcher, **kwargs)
         if len(objs) > 1:
-            raise MultipleObjectsReturned()
-        elif len(objs) == 0:
+            raise MultipleObjectsReturned
+        if len(objs) == 0:
             if default == no_arg:
-                raise ObjectDoesNotExist()
+                raise ObjectDoesNotExist
             return default
         return objs[0]

src/libvcs/_internal/run.py

@@ -15,10 +15,9 @@
 from collections.abc import Iterable, Mapping, MutableMapping, Sequence
 from typing import IO, TYPE_CHECKING, Any, AnyStr, Callable, Optional, Protocol, Union
 
+from libvcs import exc
 from libvcs._internal.types import StrOrBytesPath
 
-from .. import exc
-
 logger = logging.getLogger(__name__)
 
 console_encoding = sys.__stdout__.encoding

src/libvcs/_internal/shortcuts.py

@@ -19,17 +19,17 @@
 
 
 class VCSNoMatchFoundForUrl(exc.LibVCSException):
-    def __init__(self, url: str, *args: object):
+    def __init__(self, url: str, *args: object) -> None:
         return super().__init__(f"No VCS found for url: {url}")
 
 
 class VCSMultipleMatchFoundForUrl(exc.LibVCSException):
-    def __init__(self, url: str, *args: object):
+    def __init__(self, url: str, *args: object) -> None:
         return super().__init__(f"Multiple VCS found for url: {url}")
 
 
 class VCSNotSupported(exc.LibVCSException):
-    def __init__(self, url: str, vcs: str, *args: object):
+    def __init__(self, url: str, vcs: str, *args: object) -> None:
         return super().__init__(f"VCS '{vcs}' not supported, based on URL: {url}")
 
 
@@ -110,7 +110,7 @@ def create_project(
         assert vcs_matches[0].vcs is not None
 
         def is_vcs(val: t.Any) -> "TypeGuard[VCSLiteral]":
-            return isinstance(val, str) and val in ["git", "hg", "svn"]
+            return isinstance(val, str) and val in {"git", "hg", "svn"}
 
         if is_vcs(vcs_matches[0].vcs):
             vcs = vcs_matches[0].vcs
@@ -119,13 +119,18 @@ def is_vcs(val: t.Any) -> "TypeGuard[VCSLiteral]":
 
     if vcs == "git":
         return GitSync(
-            url=url, path=path, progress_callback=progress_callback, **kwargs
+            url=url,
+            path=path,
+            progress_callback=progress_callback,
+            **kwargs,
         )
-    elif vcs == "hg":
+    if vcs == "hg":
         return HgSync(url=url, path=path, progress_callback=progress_callback, **kwargs)
-    elif vcs == "svn":
+    if vcs == "svn":
         return SvnSync(
-            url=url, path=path, progress_callback=progress_callback, **kwargs
+            url=url,
+            path=path,
+            progress_callback=progress_callback,
+            **kwargs,
         )
-    else:
-        raise InvalidVCS("VCS %s is not a valid VCS" % vcs)
+    raise InvalidVCS("VCS %s is not a valid VCS" % vcs)

src/libvcs/_internal/subprocess.py

@@ -67,7 +67,7 @@
 
 
 class SubprocessCheckOutputError(Exception):
-    def __init__(self, output: str, *args: object):
+    def __init__(self, output: str, *args: object) -> None:
         return super().__init__(f"output is not str or bytes: {output}")
 
 

src/libvcs/cmd/git.py

@@ -206,7 +206,7 @@ def run(
             def stringify(v: Any) -> str:
                 if isinstance(v, bool):
                     return "true" if True else "false"
-                elif not isinstance(v, str):
+                if not isinstance(v, str):
                     return str(v)
                 return v
 
@@ -398,7 +398,6 @@ def fetch(
             Union[bool, Literal["yes", "on-demand"]]
         ] = None,
         submodule_prefix: Optional[StrOrBytesPath] = None,
-        #
         _all: Optional[bool] = None,
         force: Optional[bool] = None,
         keep: Optional[bool] = None,
@@ -1821,9 +1820,8 @@ def rev_parse(
         if parseopt is True:
             if args is not None:
                 local_flags.extend(["--", args])
-        else:
-            if args is not None:
-                local_flags.append(args)
+        elif args is not None:
+            local_flags.append(args)
 
         return self.run(
             ["rev-parse", *local_flags],

src/libvcs/cmd/svn.py

@@ -25,7 +25,7 @@
 class SvnPropsetValueOrValuePathRequired(exc.LibVCSException, TypeError):
     """Raised when required parameters are not passed."""
 
-    def __init__(self, *args: object):
+    def __init__(self, *args: object) -> None:
         return super().__init__("Must enter a value or value_path")
 
 
@@ -783,7 +783,7 @@ def propset(
         elif isinstance(value_path, pathlib.Path):
             local_flags.extend(["--file", str(pathlib.Path(value_path).absolute())])
         else:
-            raise SvnPropsetValueOrValuePathRequired()
+            raise SvnPropsetValueOrValuePathRequired
 
         if path is not None:
             if isinstance(path, (str, pathlib.Path)):