ruff: apply dvc/scmrepo rules

Author: pmrowla

pyproject.toml

@@ -135,8 +135,52 @@ ignore = [
     "SIM108", # if-else-block-instead-of-if-exp
     "D203", # one blank line before class
     "D213", # multi-line-summary-second-line
+    "RET501", # unnecessary-return-none
+    "RET502", # implicit-return-value
+    "RET503", # implicit-return
+    "SIM117", # multiple-with-statements
+    "N818", # error-suffix-on-exception-name
+]
+select = [
+    "A", # flake8-buitlins
+    "ASYNC", # flake8-async
+    "B", # flake8-bugbear
+    "BLE", # flake8-blind-except
+    "C4", # flake8-comprehensions
+    "C90", # mccabe
+    "DTZ", # flake8-datetimez
+    "E", # pycodestyle - Error
+    "EXE", # flake8-executable
+    "F", # pyflakes
+    "FLY", # flynt-rules
+    "G", # flake8-logging-format
+    "I", # isort
+    "ICN", # flake8-import-conventions
+    "INP", # flake8-no-pep420
+    "ISC", # flake8-implicit-str-concat
+    "N", # pep8-naming
+    "PERF101", # perflint
+    "PGH", # pygrep-hooks
+    "PIE", # flake8-pie
+    "PL", # pylint
+    "PT", # flake8-pytest-style
+    "PYI", # flake8-pyi
+    "Q", # flae8-quotes
+    "RET", # flake8-return
+    "RSE", # flake8-raise
+    "RUF", # ruff
+    "S", # flake8-bandit
+    "SIM", # flake8-simplify
+    "SLOT", # flake8-slots
+    "T10", # flake8-debugger
+    "T20", # flake8-print
+    "TCH", # flake8-type-checking
+    "TCH", # flake8-type-checking
+    "TID", # flake8-tidy-imports
+    "UP", # pyupgrade
+    "W", # pycodestyle - Warning
+    "YTT", # flake8-2020
 ]
-select = ["ALL"]
 show-source = true
 show-fixes = true
 
@@ -145,8 +189,16 @@ show-fixes = true
 "tests/**" = ["S", "ARG001", "ARG002", "ANN"]
 "docs/**" = ["INP"]
 
+[tool.ruff.lint.flake8-pytest-style]
+fixture-parentheses = false
+mark-parentheses = false
+parametrize-names-type = "csv"
+
 [tool.ruff.lint.flake8-type-checking]
 strict = true
 
 [tool.ruff.lint.isort]
 known-first-party = ["scmrepo"]
+
+[tool.ruff.pylint]
+max-args = 10

src/scmrepo/base.py

@@ -15,9 +15,7 @@ def root_dir(self) -> str:
         return self._root_dir
 
     def __repr__(self):
-        return "{class_name}: '{directory}'".format(
-            class_name=type(self).__name__, directory=self.dir
-        )
+        return f"{type(self).__name__}: '{self.dir}'"
 
     def __exit__(self, exc_type, exc_value, traceback):
         self.close()

src/scmrepo/fs.py

@@ -31,11 +31,11 @@ class GitFileSystem(AbstractFileSystem):
 
     def __init__(
         self,
-        path: str = None,
-        rev: str = None,
+        path: Optional[str] = None,
+        rev: Optional[str] = None,
         scm: "Git" = None,
         trie: "GitTrie" = None,
-        rev_resolver: Callable[["Git", str], str] = None,
+        rev_resolver: Optional[Callable[["Git", str], str]] = None,
         **kwargs,
     ):
         from scmrepo.git import Git
@@ -213,8 +213,10 @@ def info(self, path: str, **kwargs: Any) -> Dict[str, Any]:
             ret = self.trie.info(key)
             ret["name"] = path
             return ret
-        except KeyError:
-            raise FileNotFoundError(errno.ENOENT, os.strerror(errno.ENOENT), path)
+        except KeyError as exc:
+            raise FileNotFoundError(
+                errno.ENOENT, os.strerror(errno.ENOENT), path
+            ) from exc
 
     def exists(self, path: str, **kwargs: Any) -> bool:
         key = self._get_key(path)
@@ -255,7 +257,7 @@ def get_file(
 
         with self.open(rpath, "rb", **kwargs) as f1:
             if outfile is None:
-                outfile = open(lpath, "wb")
+                outfile = open(lpath, "wb")  # noqa: SIM115
 
             try:
                 callback.set_size(getattr(f1, "size", None))

src/scmrepo/git/__init__.py

@@ -8,7 +8,17 @@
 from collections.abc import Mapping
 from contextlib import contextmanager
 from functools import partialmethod
-from typing import TYPE_CHECKING, Callable, Dict, Iterable, Optional, Tuple, Type, Union
+from typing import (
+    TYPE_CHECKING,
+    Callable,
+    ClassVar,
+    Dict,
+    Iterable,
+    Optional,
+    Tuple,
+    Type,
+    Union,
+)
 
 from funcy import cached_property, first
 from pathspec.patterns import GitWildMatchPattern
@@ -41,7 +51,7 @@
 
 
 class GitBackends(Mapping):
-    DEFAULT: Dict[str, BackendCls] = {
+    DEFAULT: ClassVar[Dict[str, BackendCls]] = {
         "dulwich": DulwichBackend,
         "pygit2": Pygit2Backend,
         "gitpython": GitPythonBackend,
@@ -312,7 +322,9 @@ def get_fs(self, rev: str):
         return GitFileSystem(scm=self, rev=rev)
 
     @classmethod
-    def init(cls, path: str, bare: bool = False, _backend: str = None) -> "Git":
+    def init(
+        cls, path: str, bare: bool = False, _backend: Optional[str] = None
+    ) -> "Git":
         for name, backend in GitBackends.DEFAULT.items():
             if _backend and name != _backend:
                 continue

src/scmrepo/git/backend/base.py

@@ -4,15 +4,13 @@
 from typing import TYPE_CHECKING, Callable, Iterable, Mapping, Optional, Tuple, Union
 
 from scmrepo.exceptions import SCMError
-
-from ..objects import GitObject
+from scmrepo.git.objects import GitObject
 
 if TYPE_CHECKING:
+    from scmrepo.git.config import Config
+    from scmrepo.git.objects import GitCommit, GitTag
     from scmrepo.progress import GitProgressEvent
 
-    from ..config import Config
-    from ..objects import GitCommit, GitTag
-
 
 class NoGitBackendError(SCMError):
     def __init__(self, func):
@@ -50,7 +48,7 @@ def clone(
         url: str,
         to_path: str,
         shallow_branch: Optional[str] = None,
-        progress: Callable[["GitProgressEvent"], None] = None,
+        progress: Optional[Callable[["GitProgressEvent"], None]] = None,
         bare: bool = False,
         mirror: bool = False,
     ):
@@ -229,7 +227,7 @@ def push_refspecs(
         refspecs: Union[str, Iterable[str]],
         force: bool = False,
         on_diverged: Optional[Callable[[str, str], bool]] = None,
-        progress: Callable[["GitProgressEvent"], None] = None,
+        progress: Optional[Callable[["GitProgressEvent"], None]] = None,
         **kwargs,
     ) -> Mapping[str, SyncStatus]:
         """Push refspec to a remote Git repo.
@@ -253,7 +251,7 @@ def fetch_refspecs(
         refspecs: Union[str, Iterable[str]],
         force: bool = False,
         on_diverged: Optional[Callable[[str, str], bool]] = None,
-        progress: Callable[["GitProgressEvent"], None] = None,
+        progress: Optional[Callable[["GitProgressEvent"], None]] = None,
         **kwargs,
     ) -> Mapping[str, SyncStatus]:
         """Fetch refspecs from a remote Git repo.
@@ -333,7 +331,7 @@ def diff(self, rev_a: str, rev_b: str, binary=False) -> str:
         """Return the git diff for two commits."""
 
     @abstractmethod
-    def reset(self, hard: bool = False, paths: Iterable[str] = None):
+    def reset(self, hard: bool = False, paths: Optional[Iterable[str]] = None):
         """Reset current git HEAD."""
 
     @abstractmethod

src/scmrepo/git/backend/dulwich/__init__.py

@@ -24,22 +24,20 @@
 from funcy import cached_property, reraise
 
 from scmrepo.exceptions import AuthError, CloneError, InvalidRemote, RevError, SCMError
+from scmrepo.git.backend.base import BaseGitBackend, SyncStatus
+from scmrepo.git.config import Config
+from scmrepo.git.objects import GitObject, GitTag
 from scmrepo.progress import GitProgressReporter
 from scmrepo.utils import relpath
 
-from ...config import Config
-from ...objects import GitObject, GitTag
-from ..base import BaseGitBackend, SyncStatus
-
 if TYPE_CHECKING:
     from dulwich.client import SSHVendor
     from dulwich.config import ConfigFile, StackedConfig
     from dulwich.repo import Repo
 
+    from scmrepo.git.objects import GitCommit
     from scmrepo.progress import GitProgressEvent
 
-    from ...objects import GitCommit
-
 
 logger = logging.getLogger(__name__)
 
@@ -82,7 +80,7 @@ def mode(self) -> int:
 
     def scandir(self) -> Iterable["DulwichObject"]:
         tree = self.repo[self._sha]
-        for entry in tree.iteritems():  # noqa: B301
+        for entry in tree.iteritems():
             yield DulwichObject(self.repo, entry.path.decode(), entry.mode, entry.sha)
 
     @cached_property
@@ -232,7 +230,7 @@ def clone(
         url: str,
         to_path: str,
         shallow_branch: Optional[str] = None,
-        progress: Callable[["GitProgressEvent"], None] = None,
+        progress: Optional[Callable[["GitProgressEvent"], None]] = None,
         bare: bool = False,
         mirror: bool = False,
     ):
@@ -271,7 +269,7 @@ def clone(
                     cls._set_mirror(repo, progress=progress)
                 else:
                     cls._set_default_tracking_branch(repo)
-        except Exception as exc:
+        except Exception as exc:  # noqa: BLE001
             raise CloneError(url, to_path) from exc
 
     @staticmethod
@@ -291,7 +289,7 @@ def _set_default_tracking_branch(repo: "Repo"):
 
     @staticmethod
     def _set_mirror(
-        repo: "Repo", progress: Callable[["GitProgressEvent"], None] = None
+        repo: "Repo", progress: Optional[Callable[["GitProgressEvent"], None]] = None
     ):
         from dulwich.porcelain import NoneStream, fetch
 
@@ -458,10 +456,7 @@ def untracked_files(self) -> Iterable[str]:
     def is_tracked(self, path: str) -> bool:
         rel = relpath(path, self.root_dir).replace(os.path.sep, "/").encode()
         rel_dir = rel + b"/"
-        for p in self.repo.open_index():
-            if p == rel or p.startswith(rel_dir):
-                return True
-        return False
+        return any(p == rel or p.startswith(rel_dir) for p in self.repo.open_index())
 
     def is_dirty(self, untracked_files: bool = False) -> bool:
         kwargs: Dict[str, Any] = {} if untracked_files else {"untracked_files": "no"}
@@ -590,7 +585,7 @@ def iter_remote_refs(self, url: str, base: Optional[str] = None, **kwargs):
         try:
             _remote, location = get_remote_repo(self.repo, url)
             client, path = get_transport_and_path(location, **kwargs)
-        except Exception as exc:
+        except Exception as exc:  # noqa: BLE001
             raise InvalidRemote(url) from exc
 
         try:
@@ -616,7 +611,7 @@ def push_refspecs(  # noqa: C901
         refspecs: Union[str, Iterable[str]],
         force: bool = False,
         on_diverged: Optional[Callable[[str, str], bool]] = None,
-        progress: Callable[["GitProgressEvent"], None] = None,
+        progress: Optional[Callable[["GitProgressEvent"], None]] = None,
         **kwargs,
     ) -> Mapping[str, SyncStatus]:
         from dulwich.client import HTTPUnauthorized, get_transport_and_path
@@ -627,7 +622,7 @@ def push_refspecs(  # noqa: C901
         try:
             _remote, location = get_remote_repo(self.repo, url)
             client, path = get_transport_and_path(location, **kwargs)
-        except Exception as exc:
+        except Exception as exc:  # noqa: BLE001
             raise SCMError(f"'{url}' is not a valid Git remote or URL") from exc
 
         change_result = {}
@@ -700,7 +695,7 @@ def fetch_refspecs(
         refspecs: Union[str, Iterable[str]],
         force: bool = False,
         on_diverged: Optional[Callable[[str, str], bool]] = None,
-        progress: Callable[["GitProgressEvent"], None] = None,
+        progress: Optional[Callable[["GitProgressEvent"], None]] = None,
         **kwargs,
     ) -> Mapping[str, SyncStatus]:
         from dulwich.client import get_transport_and_path
@@ -868,7 +863,7 @@ def diff(self, rev_a: str, rev_b: str, binary=False) -> str:
         write_tree_diff(buf, self.repo.object_store, commit_a.tree, commit_b.tree)
         return buf.getvalue().decode("utf-8")
 
-    def reset(self, hard: bool = False, paths: Iterable[str] = None):
+    def reset(self, hard: bool = False, paths: Optional[Iterable[str]] = None):
         raise NotImplementedError
 
     def checkout_index(
@@ -920,7 +915,7 @@ def validate_git_remote(self, url: str, **kwargs):
         try:
             _, location = get_remote_repo(self.repo, url)
             client, path = get_transport_and_path(location, **kwargs)
-        except Exception as exc:
+        except Exception as exc:  # noqa: BLE001
             raise InvalidRemote(url) from exc
         if isinstance(client, LocalGitClient) and not os.path.exists(
             os.path.join("", path)

src/scmrepo/git/backend/dulwich/asyncssh_vendor.py

@@ -129,7 +129,7 @@ def _process_public_key_ok_gh(self, _pkttype, _pktid, packet):
                 b"rsa-sha2-512",
             )
         )
-        or (algorithm != b"ssh-rsa" and algorithm != self._keypair.algorithm)
+        or (algorithm not in (b"ssh-rsa", self._keypair.algorithm))
         or key_data != self._keypair.public_data
     ):
         raise ProtocolError("Key mismatch")
@@ -141,7 +141,11 @@ def _process_public_key_ok_gh(self, _pkttype, _pktid, packet):
 class InteractiveSSHClient(SSHClient):
     _conn: Optional["SSHClientConnection"] = None
     _keys_to_try: Optional[List["FilePath"]] = None
-    _passphrases: Dict[str, str] = {}
+    _passphrases: Dict[str, str]
+
+    def __init__(self, *args, **kwargs):
+        super(*args, **kwargs)
+        _passphrases: Dict[str, str] = {}
 
     def connection_made(self, conn: "SSHClientConnection") -> None:
         self._conn = conn
@@ -150,7 +154,7 @@ def connection_made(self, conn: "SSHClientConnection") -> None:
     def connection_lost(self, exc: Optional[Exception]) -> None:
         self._conn = None
 
-    async def public_key_auth_requested(  # pylint: disable=invalid-overridden-method
+    async def public_key_auth_requested(  # noqa: C901, PLR0912
         self,
     ) -> Optional["KeyPairListArg"]:
         from asyncssh.public_key import (
@@ -246,7 +250,7 @@ def _getpass(prompt: str) -> str:
             return getpass(prompt=prompt).rstrip()
 
         if instructions:
-            print(instructions)
+            pass
         loop = asyncio.get_running_loop()
         return [
             await loop.run_in_executor(