Merge pull request #331 from SigmaHQ:typechecking-hb

Fix some linting issues

sigma/backends/test/backend.py

@@ -1,14 +1,14 @@
 from collections import defaultdict
 import re
-from typing import Any, ClassVar, Dict, List, Optional, Pattern, Tuple, cast
+from typing import Any, ClassVar, Dict, List, Optional, Pattern, cast
 
 from sigma.conversion.base import TextQueryBackend
 from sigma.conversion.state import ConversionState
 from sigma.pipelines.test import dummy_test_pipeline
 from sigma.processing.pipeline import ProcessingItem, ProcessingPipeline
 from sigma.processing.transformations import FieldMappingTransformation
 from sigma.rule.rule import SigmaRule
-from sigma.types import CompareOperators, SigmaCompareExpression
+from sigma.types import CompareOperators
 
 
 class TextQueryTestBackend(TextQueryBackend):

sigma/collection.py

@@ -1,7 +1,7 @@
 from dataclasses import InitVar, dataclass, field
 from functools import reduce
 from pathlib import Path
-from typing import Any, Callable, Dict, Iterable, List, Optional, Union, IO, cast
+from typing import Any, Callable, Dict, Iterable, List, Optional, Union, IO
 from uuid import UUID
 
 import yaml
@@ -15,7 +15,6 @@
 )
 from sigma.rule import SigmaRule, SigmaRuleBase
 from sigma.filters import SigmaFilter
-from typing import TypeVar, Union
 
 NestedDict = Dict[str, Union[str, int, float, bool, None, "NestedDict"]]
 

sigma/conditions.py

@@ -11,7 +11,7 @@
     ParseResults,
     ParseException,
 )
-from typing import ClassVar, List, Literal, Optional, Union, Type, cast
+from typing import ClassVar, List, Optional, Union, Type, cast
 from sigma.types import SigmaType
 from sigma.exceptions import SigmaConditionError, SigmaRuleLocation
 import sigma

sigma/conversion/base.py

@@ -6,7 +6,6 @@
 from sigma.correlations import (
     SigmaCorrelationCondition,
     SigmaCorrelationConditionOperator,
-    SigmaCorrelationFieldAlias,
     SigmaCorrelationFieldAliases,
     SigmaCorrelationRule,
     SigmaCorrelationTimespan,
@@ -18,7 +17,6 @@
 from sigma.exceptions import (
     ExceptionOnUsage,
     SigmaBackendError,
-    SigmaConfigurationError,
     SigmaConversionError,
     SigmaError,
     SigmaValueError,
@@ -47,7 +45,6 @@
     ConditionNOT,
     ConditionFieldEqualsValueExpression,
     ConditionValueExpression,
-    ConditionType,
 )
 from sigma.types import (
     CompareOperators,
@@ -1465,7 +1462,7 @@ def convert_condition_field_eq_val(
         def is_parent_not(
             cond: Union[
                 ConditionItem, ConditionFieldEqualsValueExpression, ConditionValueExpression
-            ]
+            ],
         ) -> bool:
             if cond.parent is None:
                 return False

sigma/correlations.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass, field
 from enum import Enum, auto
-from typing import Any, Dict, Iterator, List, Literal, Optional, Set, Union, Iterable
+from typing import Any, Dict, Iterator, List, Literal, Optional, Set, Union
 
 import sigma.exceptions as sigma_exceptions
 from sigma.exceptions import SigmaRuleLocation, SigmaTimespanError
@@ -72,7 +72,7 @@ def from_dict(
         ops = frozenset(SigmaCorrelationConditionOperator.operators())
         if len(d_keys.intersection(ops)) != 1:
             raise sigma_exceptions.SigmaCorrelationConditionError(
-                f"Sigma correlation condition must have exactly one condition item", source=source
+                "Sigma correlation condition must have exactly one condition item", source=source
             )
         unknown_keys = d_keys.difference(ops).difference({"field"})
         if unknown_keys:
@@ -268,7 +268,7 @@ def from_dict(
         else:  # no correlation type provided
             errors.append(
                 sigma_exceptions.SigmaCorrelationTypeError(
-                    f"Sigma correlation rule without type", source=source
+                    "Sigma correlation rule without type", source=source
                 )
             )
 
@@ -282,13 +282,13 @@ def from_dict(
             else:
                 errors.append(
                     sigma_exceptions.SigmaCorrelationRuleError(
-                        f"Rule reference must be plain string or list.", source=source
+                        "Rule reference must be plain string or list.", source=source
                     )
                 )
         else:
             errors.append(
                 sigma_exceptions.SigmaCorrelationRuleError(
-                    f"Sigma correlation rule without rule references", source=source
+                    "Sigma correlation rule without rule references", source=source
                 )
             )
 
@@ -298,7 +298,7 @@ def from_dict(
             if not isinstance(generate, bool):
                 errors.append(
                     sigma_exceptions.SigmaCorrelationRuleError(
-                        f"Sigma correlation generate definition must be a boolean", source=source
+                        "Sigma correlation generate definition must be a boolean", source=source
                     )
                 )
         else:
@@ -314,7 +314,7 @@ def from_dict(
             else:
                 errors.append(
                     sigma_exceptions.SigmaCorrelationRuleError(
-                        f"Sigma correlation group-by definition must be string or list",
+                        "Sigma correlation group-by definition must be string or list",
                         source=source,
                     )
                 )
@@ -329,7 +329,7 @@ def from_dict(
         else:
             errors.append(
                 sigma_exceptions.SigmaCorrelationRuleError(
-                    f"Sigma correlation rule without timespan", source=source
+                    "Sigma correlation rule without timespan", source=source
                 )
             )
 
@@ -341,7 +341,7 @@ def from_dict(
             else:
                 errors.append(
                     sigma_exceptions.SigmaCorrelationRuleError(
-                        f"Sigma correlation aliases definition must be a dict", source=source
+                        "Sigma correlation aliases definition must be a dict", source=source
                     )
                 )
         else:
@@ -355,7 +355,7 @@ def from_dict(
             else:
                 errors.append(
                     sigma_exceptions.SigmaCorrelationRuleError(
-                        f"Sigma correlation condition definition must be a dict", source=source
+                        "Sigma correlation condition definition must be a dict", source=source
                     )
                 )
         elif correlation_type not in (
@@ -364,7 +364,7 @@ def from_dict(
         ):
             errors.append(
                 sigma_exceptions.SigmaCorrelationRuleError(
-                    f"Non-temporal Sigma correlation rule without condition", source=source
+                    "Non-temporal Sigma correlation rule without condition", source=source
                 )
             )
         elif correlation_type in (

sigma/exceptions.py

@@ -288,12 +288,6 @@ def __str__(self):
         return f"{self.error} in expression '{self.expression}' at location {self.location}"
 
 
-class SigmaFeatureNotSupportedByBackendError(SigmaError):
-    """Sigma feature is not supported by the backend."""
-
-    pass
-
-
 class SigmaDescriptionError(SigmaError):
     """Error in Sigma rule description"""
 

sigma/filters.py

@@ -3,7 +3,6 @@
 import string
 from dataclasses import dataclass, field
 from typing import List, Optional, Union
-from uuid import UUID
 
 from sigma import exceptions as sigma_exceptions
 from sigma.correlations import SigmaCorrelationRule, SigmaRuleReference

sigma/pipelines/test/pipeline.py

@@ -4,7 +4,6 @@
 from sigma.processing.transformations import (
     AddConditionTransformation,
     FieldMappingTransformation,
-    FieldFunctionTransformation,
 )
 
 

sigma/plugins.py

@@ -333,7 +333,7 @@ def is_installed(self) -> bool:
         try:
             subprocess.check_call([sys.executable, "-m", "pip", "-qqq", "show", self.package])
             return True
-        except:
+        except Exception:
             return False
 
     def has_capability(self, capability: SigmaPluginCapability) -> bool:

sigma/processing/conditions/base.py

@@ -13,7 +13,6 @@
 from sigma.exceptions import (
     SigmaConfigurationError,
     SigmaProcessingItemError,
-    SigmaRegularExpressionError,
 )
 
 
@@ -29,7 +28,7 @@ def set_pipeline(self, pipeline: "sigma.processing.pipeline.ProcessingPipeline")
         if self._pipeline is None:
             self._pipeline = pipeline
         else:
-            raise SigmaProcessingItemError(f"Pipeline for condition was already set.")
+            raise SigmaProcessingItemError("Pipeline for condition was already set.")
 
     def _clear_pipeline(self) -> None:
         self._pipeline = None

sigma/processing/conditions/fields.py

@@ -1,6 +1,5 @@
 from dataclasses import dataclass, field
 
-import sigma
 from sigma.processing.conditions.base import FieldNameProcessingCondition
 from typing import List, Pattern, Literal, Optional
 import re

sigma/processing/conditions/rule.py

@@ -2,7 +2,6 @@
 from datetime import date
 from uuid import UUID
 
-import sigma
 from sigma.correlations import SigmaCorrelationRule
 from sigma.processing.conditions.base import (
     RuleDetectionItemCondition,
@@ -91,7 +90,7 @@ def find_detection_item(self, detection: Union[SigmaDetectionItem, SigmaDetectio
                 detection.field is not None
                 and detection.field == self.field
                 and self.sigma_value
-                in [v for v in detection.value if type(self.sigma_value) == type(v)]
+                in [v for v in detection.value if isinstance(self.sigma_value, type(v))]
             ):
                 return True
         else:

sigma/processing/conditions/state.py

@@ -1,6 +1,5 @@
 from dataclasses import dataclass, field
 
-import sigma
 from sigma.correlations import SigmaCorrelationRule
 from sigma.processing.conditions.base import (
     DetectionItemProcessingCondition,

sigma/processing/conditions/values.py

@@ -1,7 +1,6 @@
 from dataclasses import dataclass
 from typing import Union
 
-import sigma
 from sigma.processing.conditions.base import (
     ValueProcessingCondition,
 )

sigma/processing/finalization.py

@@ -1,7 +1,7 @@
 from abc import abstractmethod
 from dataclasses import dataclass, field
 import json
-from typing import Any, Dict, List, Literal, Optional
+from typing import Any, Dict, List, Optional
 
 import yaml
 import sigma
@@ -107,7 +107,7 @@ def __post_init__(self):
 
     @classmethod
     def from_dict(cls, d: Dict) -> "NestedFinalizer":
-        if not "finalizers" in d:
+        if "finalizers" not in d:
             raise SigmaConfigurationError("Nested finalizer requires a 'finalizers' key.")
         fs = []
         for finalizer in d["finalizers"]:

sigma/processing/pipeline.py

@@ -238,21 +238,6 @@ def _check_conditions(
                     f"{name} '{str(condition)}' is not a {expected_condition_class.__name__}"
                 )
 
-    def __post_init__(self):
-        self._check_conditions(
-            "rule_condition_expression",
-            "rule_condition_linking",
-            "rule_conditions",
-            RuleProcessingCondition,
-            "Rule condition",
-        )
-        self.transformation.set_processing_item(
-            self
-        )  # set processing item in transformation object after it is instantiated
-        self._resolve_condition_expression(
-            self.rule_condition_expression, self.rule_conditions, "Rule condition"
-        )
-
     def _resolve_condition_expression(
         self,
         expr: Optional[ConditionExpression],
@@ -352,21 +337,6 @@ def _check_conditions(
                     f"{name} '{str(condition)}' is not a {expected_condition_class.__name__}"
                 )
 
-    def __post_init__(self):
-        self._check_conditions(
-            "rule_condition_expression",
-            "rule_condition_linking",
-            "rule_conditions",
-            RuleProcessingCondition,
-            "Rule condition",
-        )
-        self.transformation.set_processing_item(
-            self
-        )  # set processing item in transformation object after it is instantiated
-        self._resolve_condition_expression(
-            self.rule_condition_expression, self.rule_conditions, "Rule condition"
-        )
-
     def _resolve_condition_expression(
         self,
         expr: Optional[ConditionExpression],
@@ -516,7 +486,7 @@ def set_pipeline(self, pipeline: "ProcessingPipeline") -> None:
         if self._pipeline is None:
             self._pipeline = pipeline
         else:
-            raise SigmaProcessingItemError(f"Pipeline for processing item was already set.")
+            raise SigmaProcessingItemError("Pipeline for processing item was already set.")
 
         self.transformation.set_pipeline(pipeline)
         for rule_condition in self.rule_conditions:
@@ -905,7 +875,7 @@ def from_yaml(cls, processing_pipeline: str) -> "ProcessingPipeline":
         try:
             parsed_pipeline = yaml.safe_load(processing_pipeline)
         except yaml.parser.ParserError as e:
-            raise SigmaPipelineParsingError(f"Error in parsing of a Sigma processing pipeline")
+            raise SigmaPipelineParsingError("Error in parsing of a Sigma processing pipeline")
         return cls.from_dict(parsed_pipeline)
 
     def apply(

sigma/processing/transformations/base.py

@@ -1,11 +1,8 @@
 from abc import ABC, abstractmethod
-from functools import partial
 from sigma.conditions import SigmaCondition
 from typing import (
-    Any,
     Iterable,
     List,
-    Dict,
     Optional,
     Union,
 )
@@ -58,7 +55,7 @@ def set_pipeline(self, pipeline: "sigma.processing.pipeline.ProcessingPipeline")
         if self._pipeline is None:
             self._pipeline = pipeline
         else:
-            raise SigmaTransformationError(f"Pipeline for transformation was already set.")
+            raise SigmaTransformationError("Pipeline for transformation was already set.")
 
     def _clear_pipeline(self) -> None:
         self._pipeline = None

sigma/processing/transformations/condition.py

@@ -1,7 +1,5 @@
-from abc import abstractmethod
 from sigma.conditions import SigmaCondition
 from typing import (
-    Any,
     List,
     Dict,
     Optional,
@@ -10,7 +8,6 @@
 from dataclasses import dataclass, field
 import random
 import string
-import sigma
 from sigma.processing.transformations.base import (
     ConditionTransformation,
 )

sigma/processing/transformations/failure.py

@@ -1,5 +1,4 @@
 from dataclasses import dataclass
-import sigma
 from sigma.processing.transformations.base import (
     DetectionItemTransformation,
     Transformation,

sigma/processing/transformations/fields.py

@@ -7,7 +7,6 @@
     Callable,
 )
 from dataclasses import dataclass, field
-import sigma
 from sigma.processing.transformations.base import (
     FieldMappingTransformationBase,
     Transformation,