cruft: update template (#50)

* cruft: update template

* gha: temporarily disable tests on py3.12

Author: efiop

.cruft.json

@@ -1,6 +1,6 @@
 {
   "template": "https://github.com/iterative/cookiecutter-dvc-plugin",
-  "commit": "91159828cdce86290b97bf4985732651805523c4",
+  "commit": "da6f5faa767006bd66ed6164e9c573bc098cb346",
   "checkout": null,
   "context": {
     "cookiecutter": {

.github/workflows/release.yaml

@@ -20,7 +20,7 @@ jobs:
         fetch-depth: 0
     - uses: actions/setup-python@v3
       with:
-        python-version: 3.8
+        python-version: 3.9
     - name: Install
       run: |
         pip install --upgrade pip wheel

.github/workflows/tests.yaml

@@ -23,7 +23,9 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu-20.04, windows-latest, macos-latest]
-        pyv: ["3.8", "3.9", "3.10", "3.11"]
+        # NOTE: 3.12 is temporarily disabled waiting for
+        # https://github.com/fsspec/universal_pathlib/pull/152
+        pyv: ["3.9", "3.10", "3.11"]
     steps:
     - uses: actions/checkout@v3
       with:

.pre-commit-config.yaml

@@ -9,11 +9,12 @@ repos:
         language: fail
         files: \.rej$
     repo: local
-  - hooks:
-      - id: black
-        language_version: python3
-    repo: https://github.com/ambv/black
-    rev: 22.3.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: 'v0.2.0'
+    hooks:
+      - id: ruff
+        args: [--fix, --exit-non-zero-on-fix]
+      - id: ruff-format
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.0.1
     hooks:
@@ -26,21 +27,6 @@ repos:
           - ba,datas,fo,uptodate
     repo: https://github.com/codespell-project/codespell
     rev: v2.1.0
-  - hooks:
-      - id: isort
-        language_version: python3
-    repo: https://github.com/timothycrosley/isort
-    rev: 5.12.0
-  - hooks:
-      - id: flake8
-        language_version: python3
-        additional_dependencies:
-          - flake8-bugbear
-          - flake8-comprehensions
-          - flake8-debugger
-          - flake8-string-format
-    repo: https://github.com/pycqa/flake8
-    rev: 3.9.2
   - repo: local
     hooks:
     - id: mypy
@@ -49,11 +35,6 @@ repos:
       files: ^dvc_gs/
       language: system
       types: [python]
-    - id: pylint
-      name: pylint
-      entry: pylint
-      language: system
-      types: [python]
   - hooks:
       - args:
           - -i

dvc_gs/__init__.py

@@ -1,23 +1,25 @@
 import threading
-from typing import Iterator, List, Optional, Tuple, Union
+from collections.abc import Iterator
+from typing import ClassVar, Optional, Union
 from urllib.parse import urlsplit, urlunsplit
 
+from funcy import wrap_prop
+
 # pylint:disable=abstract-method
 from dvc.utils.objects import cached_property
 from dvc_objects.fs.base import AnyFSPath, ObjectFileSystem
-from funcy import wrap_prop
 
 
 class GSFileSystem(ObjectFileSystem):
     protocol = "gs"
-    REQUIRES = {"gcsfs": "gcsfs"}
+    REQUIRES: ClassVar[dict[str, str]] = {"gcsfs": "gcsfs"}
     PARAM_CHECKSUM = "etag"
 
     def getcwd(self):
         return self.fs.root_marker
 
     @classmethod
-    def split_version(cls, path: AnyFSPath) -> Tuple[str, Optional[str]]:
+    def split_version(cls, path: AnyFSPath) -> tuple[str, Optional[str]]:
         from gcsfs import GCSFileSystem
 
         parts = list(urlsplit(path))
@@ -49,13 +51,11 @@ def version_path(cls, path: AnyFSPath, version_id: Optional[str]) -> str:
     @classmethod
     def coalesce_version(
         cls, path: AnyFSPath, version_id: Optional[str]
-    ) -> Tuple[AnyFSPath, Optional[str]]:
+    ) -> tuple[AnyFSPath, Optional[str]]:
         path, path_version_id = cls.split_version(path)
         versions = {ver for ver in (version_id, path_version_id) if ver}
         if len(versions) > 1:
-            raise ValueError(
-                f"Path version mismatch: '{path}', '{version_id}'"
-            )
+            raise ValueError(f"Path version mismatch: '{path}', '{version_id}'")
         return path, (versions.pop() if versions else None)
 
     def _prepare_credentials(self, **config):
@@ -99,7 +99,7 @@ def _get_kwargs_from_urls(urlpath: str):
 
     def find(
         self,
-        path: Union[AnyFSPath, List[AnyFSPath]],
+        path: Union[AnyFSPath, list[AnyFSPath]],
         prefix: bool = False,
         batch_size: Optional[int] = None,  # pylint: disable=unused-argument
         **kwargs,
@@ -115,6 +115,4 @@ def _add_dir_sep(path: str) -> str:
                 path = _add_dir_sep(path)
             else:
                 path = [_add_dir_sep(p) for p in path]
-        return super().find(
-            path, prefix=prefix, batch_size=batch_size, **kwargs
-        )
+        return super().find(path, prefix=prefix, batch_size=batch_size, **kwargs)

dvc_gs/tests/benchmarks.py

@@ -1,5 +1 @@
 # pylint: disable=unused-import
-# noqa
-from dvc.testing.benchmarks.cli.stories.use_cases.test_sharing import (  # noqa
-    test_sharing as test_sharing_gs,
-)

dvc_gs/tests/cloud.py

@@ -6,7 +6,6 @@
 
 
 class GCP(Cloud, CloudURLInfo):
-
     IS_OBJECT_STORAGE = True
 
     def __init__(self, url, credentialpath):
@@ -101,7 +100,8 @@ class FakeGCP(GCP):
 
     def __init__(self, url, endpoint_url: str):
         super().__init__(
-            url, ""  # no need to provide credentials for a mock server
+            url,
+            "",  # no need to provide credentials for a mock server
         )
         self.endpoint_url = endpoint_url
 

dvc_gs/tests/conftest.py

@@ -1,3 +1,3 @@
-from dvc.testing.fixtures import *  # noqa, pylint: disable=wildcard-import,unused-import
+from dvc.testing.fixtures import *  # noqa: F403
 
-from .fixtures import *  # noqa, pylint: disable=wildcard-import,unused-import
+from .fixtures import *  # noqa: F403

dvc_gs/tests/fixtures.py

@@ -42,4 +42,4 @@ def gs(make_gs):  # pylint: disable=redefined-outer-name
 
 @pytest.fixture
 def real_gs():
-    yield GCP(GCP.get_url(), "")
+    return GCP(GCP.get_url(), "")

dvc_gs/tests/test_dvc.py

@@ -1,44 +1,31 @@
 import pytest
-from dvc.testing.api_tests import (  # noqa, pylint: disable=unused-import
-    TestAPI,
-)
-from dvc.testing.remote_tests import (  # noqa, pylint: disable=unused-import
-    TestRemote,
-    TestRemoteVersionAware,
-)
-from dvc.testing.workspace_tests import (  # noqa, pylint: disable=unused-import
-    TestGetUrl,
-)
+
 from dvc.testing.workspace_tests import TestImport as _TestImport
-from dvc.testing.workspace_tests import (  # noqa, pylint: disable=unused-import
-    TestImportURLVersionAware,
-    TestLsUrl,
-)
 
 
 @pytest.fixture
 def cloud(make_cloud):
-    yield make_cloud(typ="gs")
+    return make_cloud(typ="gs")
 
 
 @pytest.fixture
 def remote(make_remote):
-    yield make_remote(name="upstream", typ="gs")
+    return make_remote(name="upstream", typ="gs")
 
 
 @pytest.fixture
 def remote_version_aware(make_remote_version_aware):
-    yield make_remote_version_aware(name="upstream", typ="gs")
+    return make_remote_version_aware(name="upstream", typ="gs")
 
 
 @pytest.fixture
 def remote_worktree(make_remote_worktree):
-    yield make_remote_worktree(name="upstream", typ="gs")
+    return make_remote_worktree(name="upstream", typ="gs")
 
 
 @pytest.fixture
 def workspace(make_workspace):
-    yield make_workspace(name="workspace", typ="gs")
+    return make_workspace(name="workspace", typ="gs")
 
 
 class TestImport(_TestImport):
@@ -66,6 +53,4 @@ def test_import_empty_dir(
         workspace,  # pylint: disable=redefined-outer-name
         is_object_storage,
     ):
-        return super().test_import_empty_dir(
-            tmp_dir, dvc, workspace, is_object_storage
-        )
+        return super().test_import_empty_dir(tmp_dir, dvc, workspace, is_object_storage)

pyproject.toml

@@ -5,28 +5,65 @@ build-backend = "setuptools.build_meta"
 [tool.setuptools_scm]
 write_to = "dvc_gs/_dvc_gs_version.py"
 
-[tool.black]
-line-length = 79
-include = '\.pyi?$'
-exclude = '''
-/(
-    \.eggs
-  | \.git
-  | \.hg
-  | \.mypy_cache
-  | \.tox
-  | \.venv
-  | _build
-  | buck-out
-  | build
-  | dist
-)/
-'''
-
-[tool.isort]
-profile = "black"
-known_first_party = ["dvc_gs"]
-line_length = 79
+[project]
+name = "dvc-gs"
+description = "gs plugin for dvc"
+readme = "README.rst"
+keywords = [
+    "dvc",
+    "gs",
+]
+license = { text = "Apache License 2.0" }
+maintainers = [{ name = "Iterative", email = "[email protected]" }]
+authors = [{ name = "Iterative", email = "[email protected]" }]
+requires-python = ">=3.9"
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dynamic = ["version"]
+dependencies = [
+    "dvc",
+    "gcsfs>=2022.11.0",
+]
+
+[project.optional-dependencies]
+tests = [
+    "wheel==0.37.0",
+    "dvc[testing]",
+    # Test requirements
+    "pytest==7.1.2",
+    "pytest-cov==3.0.0",
+    "pytest-xdist==2.4.0",
+    "pytest-mock==3.6.1",
+    "pytest-lazy-fixture==0.6.3",
+    "pytest-servers[gcs]>=0.3.0",
+    "flaky==3.7.0",
+    "mock==4.0.3",
+    "wget==3.2",
+    "filelock==3.3.2",
+    "xmltodict==0.12.0",
+    # required by collective.checkdocs
+    "Pygments==2.10.0",
+    "collective.checkdocs==0.2",
+    "pydocstyle==6.1.1",
+    # type-checking
+    "mypy==0.981",
+    "types-requests==2.25.11",
+    "types-tabulate==0.8.3",
+    "types-toml==0.10.1",
+    # optional dependencies
+    'pywin32>=225; sys_platform == "win32"',
+    "google-cloud-storage>=2.7.0",
+]
+
+[project.urls]
+Documentation = "https://dvc.org/doc"
+Source = "https://github.com/iterative/dvc-gs"
 
 [tool.pytest.ini_options]
 log_level = "debug"
@@ -51,28 +88,46 @@ warn_redundant_casts = true
 warn_unreachable = true
 files = ["dvc_gs"]
 
-[tool.pylint.master]
-extension-pkg-whitelist = ["pygit2"]
-init-hook = "import sys; sys.path.append(str('tests'))"
-
-[tool.pylint.message_control]
-disable = [
-    "format", "refactoring", "spelling", "design",
-    "invalid-name", "duplicate-code", "fixme",
-    "unused-wildcard-import", "cyclic-import", "wrong-import-order",
-    "wrong-import-position", "ungrouped-imports", "multiple-imports",
-    "logging-format-interpolation", "logging-fstring-interpolation",
-    "missing-function-docstring", "missing-module-docstring",
-    "missing-class-docstring", "raise-missing-from", "import-outside-toplevel",
+[tool.ruff]
+output-format = "full"
+show-fixes = true
+
+[tool.ruff.lint]
+ignore = [
+    "N818", "S101", "ISC001", "PT004", "PT007", "RET502", "RET503", "SIM105", "SIM108", "SIM117",
+    "TRY003", "TRY300", "PLR2004", "PLW2901", "LOG007",
 ]
-enable = ["c-extension-no-member", "no-else-return"]
+select = [
+    "F", "E", "W", "C90", "I", "N", "UP", "YTT", "ASYNC", "S", "BLE", "B", "A", "C4", "T10",
+    "EXE", "ISC", "ICN", "G", "INP", "PIE", "T20", "PYI", "PT", "Q", "RSE", "RET",
+    "SLOT", "SIM", "TID", "TCH", "ARG", "PGH", "PLC", "PLE", "PLR", "PLW", "TRY",
+    "FLY", "PERF101", "LOG", "RUF", "RUF022", "RUF023", "RUF024", "RUF025", "RUF026",
+]
+preview = true
+explicit-preview-rules = true
+
+[tool.ruff.lint.flake8-pytest-style]
+fixture-parentheses = false
+mark-parentheses = false
+parametrize-names-type = "csv"
+raises-extend-require-match-for = ["dvc.exceptions.DvcException"]
+
+[tool.ruff.lint.flake8-tidy-imports]
+
+[tool.ruff.lint.flake8-type-checking]
+strict = true
+
+[tool.ruff.lint.flake8-unused-arguments]
+ignore-variadic-names = true
+
+[tool.ruff.lint.isort]
+known-first-party = ["dvc", "dvc_data", "dvc_objects"]
+
+[tool.ruff.lint.pep8-naming]
+extend-ignore-names = ["M", "SCM"]
 
-[tool.pylint.typecheck]
-generated-members = ["pytest.lazy_fixture", "logging.TRACE", "logger.trace", "sys.getwindowsversion", "argparse.Namespace"]
-ignored-classes = ["Dvcfile"]
-ignored-modules = ["azure"]
-signature-mutators = ["funcy.decorators.decorator"]
+[tool.ruff.lint.pylint]
+max-args = 10
 
-[tool.pylint.variables]
-dummy-variables-rgx = "_+$|(_[a-zA-Z0-9_]*[a-zA-Z0-9]+?$)|dummy|^ignored_|^unused_"
-ignored-argument-names = "_.*|^ignored_|^unused_|args|kwargs"
+[tool.ruff.lint.per-file-ignores]
+"dvc_gs/tests/**" = ["S", "ARG001", "ARG002", "TRY002", "TRY301"]