Merge pull request #474 from TheHive-Project/473-experiment-with-ruff-as-an-alternative-linterformatter

#473 - Introduce ruff to replace flake8 and black

Author: Kamforka

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 StrangeBee 
+Copyright (c) 2025 StrangeBee 
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

examples/alert/observable_from_file.py

@@ -8,7 +8,6 @@
 hive = TheHiveApi(url="http://localhost:9000", apikey="h1v3b33")
 
 with tempfile.TemporaryDirectory() as tmpdir:
-
     observable_filepath = os.path.join(tmpdir, "my-observable.txt")
     with open(observable_filepath, "w") as observable_file:
         observable_file.write("some observable content")

examples/case/observable_file.py

@@ -13,7 +13,6 @@
 )
 
 with tempfile.TemporaryDirectory() as tmpdir:
-
     observable_filepath = os.path.join(tmpdir, "my-observable.txt")
     with open(observable_filepath) as observable_file:
         observable_file.write("some observable content")

noxfile.py

@@ -5,21 +5,24 @@
 PROJECT_DIR = os.path.dirname(__file__)
 THEHIVE4PY_DIR = os.path.join(PROJECT_DIR, "thehive4py/")
 TESTS_DIR = os.path.join(PROJECT_DIR, "tests/")
+EXAMPLES_DIR = os.path.join(PROJECT_DIR, "examples/")
 
 nox.options.default_venv_backend = "none"
 nox.options.tags = ["audit", "lint"]
 
 
 @nox.session(tags=["ci", "lint"])
 def style(session: nox.Session):
-    """Run style checks with flake8."""
-    session.run("flake8", THEHIVE4PY_DIR, TESTS_DIR)
+    """Run style checks with ruff."""
+    session.run("ruff", "check", THEHIVE4PY_DIR, TESTS_DIR, EXAMPLES_DIR, __file__)
 
 
 @nox.session(tags=["ci", "lint"])
 def format(session: nox.Session):
-    """Run format checks with black."""
-    session.run("black", "--check", THEHIVE4PY_DIR, TESTS_DIR)
+    """Run format checks with ruff."""
+    session.run(
+        "ruff", "format", "--check", THEHIVE4PY_DIR, TESTS_DIR, EXAMPLES_DIR, __file__
+    )
 
 
 @nox.session(tags=["ci", "lint"])

pyproject.toml

@@ -28,7 +28,7 @@ authors = [{ name = "Szabolcs Antal", email = "antalszabolcs01@gmail.com" }]
 audit = ["bandit", "pip-audit"]
 build = ["build", "twine"]
 docs = ["mkdocs", "mkdocs-material", "mkdocstrings-python", "mike"]
-lint = ["black", "flake8-pyproject", "mypy", "pre-commit"]
+lint = ["mypy", "ruff", "pre-commit"]
 test = ["pytest", "pytest-cov"]
 dev = ["thehive4py[audit, lint, test, build, docs]", "nox"]
 
@@ -41,10 +41,7 @@ thehive4py = ["py.typed"]
 [tool.coverage.run]
 omit = ["tests/*", "thehive4py/types/*"]
 
-[tool.flake8]
-max-line-length = 88
-per-file-ignores = [
-    "thehive4py/__init__.py:F401",
-    "thehive4py/endpoints/__init__.py:F401",
-    "thehive4py/query/__init__.py:F401",
-]
+[tool.ruff.lint.per-file-ignores]
+"thehive4py/__init__.py" = ["F401"]
+"thehive4py/endpoints/__init__.py" = ["F401"]
+"thehive4py/query/__init__.py" = ["F401"]

scripts/linkify_release_notes.py

@@ -98,7 +98,6 @@ def parse_arguments():
 
 
 def main():
-
     args = parse_arguments()
 
     release_notes_path = "docs/release-notes.md"

tests/test_alert_endpoint.py

@@ -152,7 +152,6 @@ def test_bulk_delete(self, thehive: TheHiveApi, test_alerts: List[OutputAlert]):
     def test_get_similar_observables(
         self, thehive: TheHiveApi, test_alerts: List[OutputAlert]
     ):
-
         similar_observables = thehive.alert.get_similar_observables(
             alert_id=test_alerts[0]["_id"], alert_or_case_id=test_alerts[1]["_id"]
         )

tests/test_case_endpoint.py

@@ -179,7 +179,6 @@ def test_apply_case_template(
         test_case: OutputCase,
         test_case_template: OutputCaseTemplate,
     ):
-
         assert (
             set(test_case_template.get("tags", [])).issubset(
                 set(test_case.get("tags", []))
@@ -212,7 +211,6 @@ def test_change_owner_organisation(
         )
 
     def test_manage_access(self, thehive: TheHiveApi, test_case: OutputCase):
-
         assert test_case["access"]["_kind"] == "OrganisationAccessKind"
         thehive.case.manage_access(
             case_id=test_case["_id"],
@@ -226,7 +224,6 @@ def test_manage_access(self, thehive: TheHiveApi, test_case: OutputCase):
     def test_get_similar_observables(
         self, thehive: TheHiveApi, test_cases: List[OutputCase]
     ):
-
         similar_observables = thehive.case.get_similar_observables(
             case_id=test_cases[0]["_id"], alert_or_case_id=test_cases[1]["_id"]
         )
@@ -236,7 +233,6 @@ def test_get_similar_observables(
     def test_link_and_unlink_case_with_case(
         self, thehive: TheHiveApi, test_cases: List[OutputCase]
     ):
-
         case_link: InputCaseLink = {"type": "whatever", "caseId": test_cases[1]["_id"]}
 
         thehive.case.link_case(
@@ -262,7 +258,6 @@ def test_link_and_unlink_case_with_case(
     def test_link_and_unlink_case_with_url(
         self, thehive: TheHiveApi, test_case: OutputCase
     ):
-
         external_url = "https://example.com"
         url_link: InputURLLink = {"type": "whatever", "url": external_url}
 
@@ -283,7 +278,6 @@ def test_link_and_unlink_case_with_url(
         assert unlinked_case["extraData"]["links"]["externalLinks"] == []
 
     def test_link_types(self, thehive: TheHiveApi):
-
         assert thehive.case.get_link_types() == []
 
     def test_add_and_download_attachment(

tests/test_observable_endpoint.py

@@ -38,7 +38,6 @@ def test_create_single_in_alert_and_get(
     def test_create_multiple_in_alert(
         self, thehive: TheHiveApi, test_alert: OutputAlert
     ):
-
         observable_count = 3
         created_observables = thehive.observable.create_in_alert(
             alert_id=test_alert["_id"],
@@ -105,7 +104,6 @@ def test_create_single_in_case_and_get(
         assert created_observable == fetched_observable
 
     def test_create_multiple_in_case(self, thehive: TheHiveApi, test_case: OutputCase):
-
         observable_count = 3
         created_observables = thehive.observable.create_in_case(
             case_id=test_case["_id"],
@@ -199,7 +197,6 @@ def test_share_and_unshare(
         test_observable: OutputObservable,
         test_config: TestConfig,
     ):
-
         thehive.observable.share(
             observable_id=test_observable["_id"], organisations=[test_config.main_org]
         )

tests/test_organisation_endpoint.py

@@ -6,7 +6,6 @@
 
 
 class TestOrganisationEndpoint:
-
     def test_add_and_download_attachment_to_main_org(
         self, thehive: TheHiveApi, tmp_path: Path
     ):
@@ -57,7 +56,6 @@ def test_get_organisation(self, thehive_admin: TheHiveApi, test_config: TestConf
     def test_find_organisations(
         self, thehive_admin: TheHiveApi, test_config: TestConfig
     ):
-
         organisations = thehive_admin.organisation.find(
             filters=Eq("name", test_config.main_org)
         )