Merge pull request #248 from Aiven-Open/aris-pre-commit-update

Migrate from pylint and flake8 to ruff

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v5.0.0
     hooks:
       - id: trailing-whitespace
         exclude: ^vendor/|^tests/.*/fixtures/.*
@@ -10,39 +10,14 @@ repos:
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
     # Ruff version.
-    rev: v0.6.4
+    rev: v0.7.0
     hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
       # Run the formatter.
       - id: ruff-format
 
-  - repo: https://github.com/timothycrosley/isort
-    rev: 5.12.0
-    hooks:
-      - id: isort
-        files: \.py$
-        exclude: ^vendor/
-
-  - repo: https://github.com/pycqa/flake8
-    rev: 7.0.0
-    hooks:
-      - id: flake8
-        files: \.py$
-        args:
-          - --config=.flake8
-
-  # https://pre-commit.com/#repository-local-hooks
-  - repo: local
-    hooks:
-      - id: pylint
-        name: pylint
-        entry: pylint
-        language: system
-        types: [python]
-        files: \.py$
-        exclude: ^vendor/
-        args:
-          - --rcfile=.pylintrc
-
   - repo: local
     hooks:
       - id: mypy

Makefile

@@ -19,6 +19,7 @@ default: $(GENERATED)
 venv: default
 	python3 -m venv venv && source venv/bin/activate && pip install -U pip && pip install . ".[dev]"
 
+.PHONY: clean
 clean:
 	rm -rf rpm/ $(GENERATED) venv/ .mypy_cache/ astacus.egg-info/
 
@@ -40,13 +41,6 @@ test-dep-ubuntu:
 	tar vxf apache-zookeeper-$(ZOOKEEPER_VERSION)-bin.tar.gz --wildcards apache-zookeeper-$(ZOOKEEPER_VERSION)-bin/lib/*.jar
 	sudo cp -r apache-zookeeper-$(ZOOKEEPER_VERSION)-bin/lib /usr/share/zookeeper
 
-.PHONY: pylint
-pylint: $(GENERATED)
-	pre-commit run pylint --all-files
-
-.PHONY: flake8
-flake8: $(GENERATED)
-	pre-commit run flake8 --all-files
 
 .PHONY: copyright
 copyright:
@@ -68,21 +62,14 @@ unittest: $(GENERATED)
 .PHONY: test
 test: lint copyright unittest
 
-.PHONY: isort
-isort:
-	pre-commit run isort --all-files
-
 .PHONY: ruff
-ruff:
+ruff: $(GENERATED)
 	pre-commit run ruff-format --all-files
 
 .PHONY: mypy
-mypy:
+mypy: $(GENERATED)
 	pre-commit run mypy --all-files
 
-.PHONY: reformat
-reformat: isort ruff
-
 .PHONY: pre-commit
 pre-commit: $(GENERATED)
 	pre-commit run --all-files

astacus/client.py

@@ -1,6 +1,5 @@
-"""
-Copyright (c) 2020 Aiven Ltd
-See LICENSE for details
+"""Copyright (c) 2020 Aiven Ltd
+See LICENSE for details.
 
 Client commands for Astacus tool
 

astacus/common/access_log.py

@@ -1,6 +1,5 @@
-"""
-Copyright (c) 2024 Aiven Ltd
-See LICENSE for details
+"""Copyright (c) 2024 Aiven Ltd
+See LICENSE for details.
 """
 
 from collections.abc import Sequence

astacus/common/asyncstorage.py

@@ -1,7 +1,5 @@
-"""
-
-Copyright (c) 2020 Aiven Ltd
-See LICENSE for details
+"""Copyright (c) 2020 Aiven Ltd
+See LICENSE for details.
 
 """
 
@@ -10,7 +8,7 @@
 
 
 class AsyncHexDigestStorage:
-    """Subset of the HexDigestStorage API proxied async -> sync via starlette threadpool
+    """Subset of the HexDigestStorage API proxied async -> sync via starlette threadpool.
 
     Note that the access is not intentionally locked; therefore even
     synchronous API can be used in parallel (at least if it is safe to
@@ -29,7 +27,7 @@ async def list_hexdigests(self) -> list[str]:
 
 
 class AsyncJsonStorage:
-    """Subset of the JsonStorage API proxied async -> sync via starlette threadpool
+    """Subset of the JsonStorage API proxied async -> sync via starlette threadpool.
 
     Note that the access is not intentionally locked; therefore even
     synchronous API can be used in parallel (at least if it is safe to

astacus/common/cachingjsonstorage.py

@@ -1,7 +1,5 @@
-"""
-
-Copyright (c) 2020 Aiven Ltd
-See LICENSE for details
+"""Copyright (c) 2020 Aiven Ltd
+See LICENSE for details.
 
 Caching layer on top of storage.
 

astacus/common/cassandra/client.py

@@ -1,6 +1,5 @@
-"""
-Copyright (c) 2021 Aiven Ltd
-See LICENSE for details
+"""Copyright (c) 2021 Aiven Ltd
+See LICENSE for details.
 
 This client code is originally from Cashew
 

astacus/common/cassandra/config.py

@@ -1,5 +1,5 @@
 """Copyright (c) 2021 Aiven Ltd
-See LICENSE for details
+See LICENSE for details.
 
 Client configuration data model
 

astacus/common/cassandra/schema.py

@@ -1,6 +1,5 @@
-"""
-Copyright (c) 2021 Aiven Ltd
-See LICENSE for details
+"""Copyright (c) 2021 Aiven Ltd
+See LICENSE for details.
 
 Schema-related parts are based on basebackup_schema.py of Cashew
 
@@ -106,10 +105,9 @@ def __lt__(self, o: CassandraNamed) -> bool:
 
     @classmethod
     def get_create_statement(cls, metadata: cm.Function) -> str:
-        """
-        Based on Function.as_cql_query, but doesn't strip `frozen` from arguments as they need to be specified on restoration
+        """Based on Function.as_cql_query, but doesn't strip `frozen` from arguments as they need to be specified on restoration
         With default cassandra-driver the function fails to create with an error message like "Non-frozen UDTs are not
-        allowed inside collections: ..."
+        allowed inside collections: ...".
         """
         sep = " "
         keyspace = cm.protect_name(metadata.keyspace)
@@ -306,7 +304,7 @@ class CassandraSchema(AstacusModel):
 
     @classmethod
     def from_cassandra_session(cls, cas: CassandraSession) -> "CassandraSchema":
-        """Retrieve the schema using CassandraSession"""
+        """Retrieve the schema using CassandraSession."""
         # Cassandra driver updates the schema in the background. Right after connect it's possible the schema hasn't been
         # retrieved yet, and it appears to be empty. This call should block until the schema has been retrieved, and raise
         # an exception if the nodes aren't in sync
@@ -346,7 +344,6 @@ def restore_pre_data(self, cas: CassandraSession) -> None:
         - restore_post_data is done after the restore_pre_data, and
           actual snapshot restoration + moving of files has been done
         """
-
         for keyspace in self.keyspaces:
             # These may be version dependant, and in general should be recreated
             # during restore (and-or other configuration applying)

astacus/common/cassandra/utils.py

@@ -1,6 +1,5 @@
-"""
-Copyright (c) 2021 Aiven Ltd
-See LICENSE for details
+"""Copyright (c) 2021 Aiven Ltd
+See LICENSE for details.
 
 Miscellaneous utilities related to CassandraSession
 

astacus/common/dependencies.py

@@ -1,7 +1,5 @@
-"""
-
-Copyright (c) 2021 Aiven Ltd
-See LICENSE for details
+"""Copyright (c) 2021 Aiven Ltd
+See LICENSE for details.
 
 Dependency injection helper functions.
 """

astacus/common/etcd.py

@@ -1,7 +1,5 @@
-"""
-
-Copyright (c) 2020 Aiven Ltd
-See LICENSE for details
+"""Copyright (c) 2020 Aiven Ltd
+See LICENSE for details.
 
 Minimal etcdv3 client library on top of httpx
 

astacus/common/exceptions.py

@@ -1,6 +1,5 @@
-"""
-Copyright (c) 2020 Aiven Ltd
-See LICENSE for details
+"""Copyright (c) 2020 Aiven Ltd
+See LICENSE for details.
 """
 
 

astacus/common/ipc.py

@@ -1,6 +1,5 @@
-"""
-Copyright (c) 2020 Aiven Ltd
-See LICENSE for details
+"""Copyright (c) 2020 Aiven Ltd
+See LICENSE for details.
 """
 
 from .magic import DEFAULT_EMBEDDED_FILE_SIZE, StrEnum
@@ -18,7 +17,6 @@
 import socket
 
 # pydantic validators are class methods in disguise
-# pylint: disable=no-self-argument
 
 
 # These are the database plugins we support; list is intentionally
@@ -146,8 +144,7 @@ def create_snapshot_request(
 
 
 class SnapshotHash(msgspec.Struct, kw_only=True, frozen=True):
-    """
-    This class represents something that is to be stored in the object storage.
+    """This class represents something that is to be stored in the object storage.
 
     size is provided mainly to allow for even loading of nodes in case
     same hexdigest is available from multiple nodes.

astacus/common/limiter.py

@@ -1,6 +1,5 @@
-"""
-Copyright (c) 2021 Aiven Ltd
-See LICENSE for details
+"""Copyright (c) 2021 Aiven Ltd
+See LICENSE for details.
 """
 
 from collections.abc import Awaitable, Iterable

astacus/common/m3placement.py

@@ -1,7 +1,5 @@
-"""
-
-Copyright (c) 2020 Aiven Ltd
-See LICENSE for details
+"""Copyright (c) 2020 Aiven Ltd
+See LICENSE for details.
 
 M3 placement handling code
 
@@ -55,7 +53,7 @@ class M3PlacementNodeReplacement(AstacusModel):
 def rewrite_single_m3_placement_node(
     placement, *, src_pnode: M3PlacementNode, dst_pnode: M3PlacementNode, dst_isolation_group=""
 ):
-    """rewrite single m3 placement entry in-place in protobuf
+    """Rewrite single m3 placement entry in-place in protobuf.
 
     Relevant places ( see m3db
     src/cluster/generated/proto/placementpb/placement.proto which is
@@ -85,7 +83,7 @@ def rewrite_single_m3_placement_node(
 
 
 def rewrite_m3_placement_bytes(value: bytes, replacements: Sequence[M3PlacementNodeReplacement]):
-    """rewrite whole binary m3 placement, with the set of node replacements"""
+    """Rewrite whole binary m3 placement, with the set of node replacements."""
     placement = m3_placement_pb2.Placement()
     placement.ParseFromString(value)
     for replacement in replacements:

astacus/common/magic.py

@@ -1,6 +1,5 @@
-"""
-Copyright (c) 2020 Aiven Ltd
-See LICENSE for details
+"""Copyright (c) 2020 Aiven Ltd
+See LICENSE for details.
 """
 
 from enum import Enum

astacus/common/msgspec_glue.py

@@ -1,6 +1,5 @@
-"""
-Copyright (c) 2024 Aiven Ltd
-See LICENSE for details
+"""Copyright (c) 2024 Aiven Ltd
+See LICENSE for details.
 """
 
 from pydantic import PydanticValueError