switch to ruff and upgrade bandit (#16)

* switch to ruff and upgrade bandit

* fix ruff errors

---------

Co-authored-by: Jens Kürten <[email protected]>

Author: jens-kuerten

.gitignore

@@ -9,3 +9,4 @@ venv/
 dist/
 .pytest_cache
 site/
+.ruff_cache

.pre-commit-config.yaml

@@ -2,25 +2,15 @@
 # See https://pre-commit.com/hooks.html for more hooks
 exclude: ^.*migrations/versions
 repos:
-  - repo: https://github.com/timothycrosley/isort
-    rev: 5.12.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.7.0
     hooks:
-      - id: isort
-        exclude: ^.*migrations/versions
-        args: [
-          "--line-length=120","--profile=black"
-        ]
-  - repo: https://github.com/ambv/black
-    rev: 23.7.0
-    hooks:
-      - id: black
-
-
-  - repo: https://github.com/PyCQA/flake8
-    rev: 6.1.0
-    hooks:
-      - id: flake8
-        args: [  "--max-line-length=120", "--per-file-ignores=*/__init__.py: F401"]
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format
 
   - repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.4.0
@@ -39,13 +29,7 @@ repos:
       - id: end-of-file-fixer
       - id: mixed-line-ending
       - id: trailing-whitespace
-  - repo: https://github.com/pycqa/pylint
-    rev: v2.15.7
-    hooks:
-      - id: pylint
-        args: ["--output-format", "parseable", "-d", "W0511", "-j", "4"]
-
   - repo: https://github.com/PyCQA/bandit
-    rev: 1.7.5
+    rev: 1.7.10
     hooks:
       - id: bandit

csfunctions/__init__.py

@@ -7,3 +7,14 @@
 from .request import Request
 from .response import DataResponse, ErrorResponse, Response, WorkloadResponse
 from .service import Service
+
+__all__ = [
+    "Event",
+    "MetaData",
+    "Request",
+    "Response",
+    "DataResponse",
+    "ErrorResponse",
+    "WorkloadResponse",
+    "Service",
+]

csfunctions/actions/__init__.py

@@ -8,3 +8,11 @@
 
 ActionUnion = Union[AbortAndShowErrorAction, DummyAction]
 Action = Annotated[ActionUnion, Field(discriminator="name")]
+
+__all__ = [
+    "Action",
+    "ActionNames",
+    "DummyAction",
+    "AbortAndShowErrorAction",
+    "ActionUnion",
+]

csfunctions/events/__init__.py

@@ -38,3 +38,26 @@
     EngineeringChangeReleaseCheckData,
     WorkflowTaskTriggerEventData,
 ]
+
+__all__ = [
+    "DocumentReleaseEvent",
+    "DocumentReleaseCheckEvent",
+    "PartReleaseEvent",
+    "PartReleaseCheckEvent",
+    "FieldValueCalculationEvent",
+    "DummyEvent",
+    "EngineeringChangeRelease",
+    "EngineeringChangeReleaseCheck",
+    "WorkflowTaskTriggerEvent",
+    "DocumentReleaseData",
+    "DocumentReleaseCheckData",
+    "PartReleaseData",
+    "PartReleaseCheckData",
+    "FieldValueCalculationData",
+    "DummyEventData",
+    "EngineeringChangeReleaseData",
+    "EngineeringChangeReleaseCheckData",
+    "WorkflowTaskTriggerEventData",
+    "DocumentReleaseDialogData",
+    "PartReleaseDialogData",
+]

csfunctions/metadata.py

@@ -13,7 +13,7 @@ def __init__(
         transaction_id: str,
         instance_url: str,
         db_service_url: str | None = None,
-        **kwargs
+        **kwargs,
     ):
         super().__init__(
             app_lang=app_lang,
@@ -23,7 +23,7 @@ def __init__(
             request_datetime=request_datetime,
             transaction_id=transaction_id,
             instance_url=instance_url,
-            **kwargs
+            **kwargs,
         )
 
     app_lang: str = Field(..., description="ISO code of the session language that triggered the webhook.")

csfunctions/objects/__init__.py

@@ -26,3 +26,18 @@
     ],
     Field(discriminator="object_type"),
 ]
+
+
+__all__ = [
+    "Document",
+    "CADDocument",
+    "Part",
+    "File",
+    "EngineeringChange",
+    "Material",
+    "BOMItem",
+    "ObjectPropertyValue",
+    "Briefcase",
+    "Workflow",
+    "BaseObject",
+]

csfunctions/objects/briefcase.py

@@ -33,7 +33,7 @@ class Briefcase(BaseObject):
     def link_objects(self, data: "EventData"):
         parts = getattr(data, "parts", None)
         documents = getattr(data, "documents", None)
-        engineering_changes = getattr(data, "engineering_changes")
+        engineering_changes = getattr(data, "engineering_changes", None)
 
         if parts and self.part_ids:
             self._link_parts(parts)

csfunctions/objects/document.py

@@ -1,3 +1,4 @@
+from contextlib import suppress
 from datetime import date, datetime
 from typing import TYPE_CHECKING, Literal, Optional
 
@@ -8,10 +9,8 @@
 from .base import BaseObject, ObjectType
 from .file import File
 
-try:
+with suppress(ImportError):
     from .part import Part
-except ImportError:
-    pass
 
 if TYPE_CHECKING:
     from csfunctions.events import EventData
@@ -81,6 +80,8 @@ class Document(BaseObject):
     part: Optional["Part"] = Field(None, exclude=True)
 
     def link_objects(self, data: "EventData"):
+        from .part import Part
+
         if self.teilenummer:
             parts = get_items_of_type(data, Part)
             self._link_part(parts)

csfunctions/objects/part.py

@@ -1,3 +1,4 @@
+from contextlib import suppress
 from datetime import date, datetime
 from typing import TYPE_CHECKING, Literal, Optional
 
@@ -10,10 +11,8 @@
 if TYPE_CHECKING:
     from csfunctions.events import EventData
 
-try:
+with suppress(ImportError):
     from .document import Document
-except ImportError:
-    pass
 
 
 class Part(BaseObject):
@@ -82,6 +81,8 @@ class Part(BaseObject):
     documents: list["Document"] = Field([], exclude=True)
 
     def link_objects(self, data: "EventData"):
+        from .document import Document
+
         if self.document_ids:
             documents = get_items_of_type(data, Document)
             self._link_documents(documents)