Add ruff and fix lints (#1089)

* Add ruff and fix lints
* Silence snyk on test infrastructure
* Minor code clean-ups
* Add some to-dos for 6.0
* Fix error message missing formatting parameter
* Fix error message grammar

Author: robsdedude

.pre-commit-config.yaml

@@ -27,6 +27,13 @@ repos:
     rev: e83a1a42a73284d301c05baaffc176042ffbcf82
     hooks:
       - id: sphinx-lint
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.6.4
+    hooks:
+      - id: ruff-format
+      - id: ruff
+        args: [ --fix ]
+      - id: ruff-format
   - repo: local
     hooks:
       - id: unasync

.snyk

@@ -3,5 +3,6 @@
 exclude:
  code:
   - tests/**
+  - benchkit/**
   - testkitbackend/**
   - testkit/**

benchkit/__init__.py

@@ -1 +1,17 @@
+# Copyright (c) "Neo4j"
+# Neo4j Sweden AB [https://neo4j.com]
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 from __future__ import annotations

benchkit/__main__.py

@@ -1,3 +1,19 @@
+# Copyright (c) "Neo4j"
+# Neo4j Sweden AB [https://neo4j.com]
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 from __future__ import annotations
 
 from sanic import Sanic
@@ -7,7 +23,7 @@
 from .env import env
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     loader = AppLoader(factory=create_app)
     app = loader.load()
 

benchkit/app.py

@@ -1,16 +1,31 @@
+# Copyright (c) "Neo4j"
+# Neo4j Sweden AB [https://neo4j.com]
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 from __future__ import annotations
 
+import typing as t
 from contextlib import contextmanager
 from multiprocessing import Semaphore
 
 import typing_extensions as te
 from sanic import Sanic
-from sanic.config import Config
 from sanic.exceptions import (
     BadRequest,
     NotFound,
 )
-from sanic.request import Request
 from sanic.response import (
     empty,
     HTTPResponse,
@@ -19,7 +34,13 @@
 
 from .context import BenchKitContext
 from .env import env
-from .workloads import Workload
+
+
+if t.TYPE_CHECKING:
+    from sanic.config import Config
+    from sanic.request import Request
+
+    from .workloads import Workload
 
 
 T_App: te.TypeAlias = "Sanic[Config, BenchKitContext]"
@@ -29,13 +50,14 @@ def create_app() -> T_App:
     app: T_App = Sanic("Python_BenchKit", ctx=BenchKitContext())
 
     @app.main_process_start
-    async def main_process_start(app: T_App) -> None:
+    def main_process_start(app: T_App) -> None:
         app.shared_ctx.running = Semaphore(1)
 
     @app.before_server_start
-    async def before_server_start(app: T_App) -> None:
+    def before_server_start(app: T_App) -> None:
         if env.driver_debug:
             from neo4j.debug import watch
+
             watch("neo4j")
 
         running = app.shared_ctx.running
@@ -57,13 +79,13 @@ def _loading_workload():
             yield
         except (ValueError, TypeError) as e:
             print(e)
-            raise BadRequest(str(e))
+            raise BadRequest(str(e)) from None
 
     def _get_workload(app: T_App, name: str) -> Workload:
         try:
             workload = app.ctx.workloads[name]
         except KeyError:
-            raise NotFound(f"Workload {name} not found")
+            raise NotFound(f"Workload {name} not found") from None
         return workload
 
     @app.get("/ready")
@@ -72,14 +94,16 @@ async def ready(_: Request) -> HTTPResponse:
         return empty()
 
     @app.post("/workload")
-    async def post_workload(request: Request) -> HTTPResponse:
+    def post_workload(request: Request) -> HTTPResponse:
         data = request.json
         with _loading_workload():
             name = app.ctx.workloads.store_workload(data)
         location = f"/workload/{name}"
-        return text(f"created at {location}",
-                    status=204,
-                    headers={"location": location})
+        return text(
+            f"created at {location}",
+            status=204,
+            headers={"location": location},
+        )
 
     @app.put("/workload")
     async def put_workload(request: Request) -> HTTPResponse:
@@ -98,15 +122,15 @@ async def get_workload(_: Request, name: str) -> HTTPResponse:
         return empty()
 
     @app.patch("/workload/<name>")
-    async def patch_workload(request: Request, name: str) -> HTTPResponse:
+    def patch_workload(request: Request, name: str) -> HTTPResponse:
         data = request.json
         workload = _get_workload(app, name)
         with _loading_workload():
             workload.patch(data)
         return empty()
 
     @app.delete("/workload/<name>")
-    async def delete_workload(_: Request, name: str) -> HTTPResponse:
+    def delete_workload(_: Request, name: str) -> HTTPResponse:
         _get_workload(app, name)
         del app.ctx.workloads[name]
         return empty()

benchkit/context.py

@@ -1,8 +1,21 @@
-from __future__ import annotations
+# Copyright (c) "Neo4j"
+# Neo4j Sweden AB [https://neo4j.com]
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
 
-import typing as t
+from __future__ import annotations
 
-import neo4j
 from neo4j import (
     AsyncDriver,
     AsyncGraphDatabase,
@@ -18,7 +31,7 @@
 
 
 class BenchKitContext:
-    _db: t.Optional[AsyncDriver]
+    _db: AsyncDriver | None
     workloads: Workloads
 
     def __init__(self) -> None:

benchkit/env.py

@@ -1,3 +1,19 @@
+# Copyright (c) "Neo4j"
+# Neo4j Sweden AB [https://neo4j.com]
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
 from __future__ import annotations
 
 import os
@@ -27,7 +43,8 @@ class Env(t.NamedTuple):
     neo4j_scheme=os.environ.get("TEST_NEO4J_SCHEME", "neo4j"),
     neo4j_user=os.environ.get("TEST_NEO4J_USER", "neo4j"),
     neo4j_pass=os.environ.get("TEST_NEO4J_PASS", "password"),
-    driver_debug=os.environ.get("TEST_DRIVER_DEBUG", "").lower() in (
-        "y", "yes", "true", "1", "on"
-    )
+    driver_debug=(
+        os.environ.get("TEST_DRIVER_DEBUG", "").lower()
+        in {"y", "yes", "true", "1", "on"}
+    ),
 )