tmp

Author: mhoff

logprep/util/helper.py

@@ -244,14 +244,14 @@ def _get_item(container: FieldValue, key: str) -> FieldValue:
 
     Parameters
     ----------
-    container : Union[dict, list, str, None]
+    container : FieldValue
         Container object where data is read from
     key : str
         Dictionary key, index or slice spec refering to the container
 
     Returns
     -------
-    Union[dict, list, str, None]
+    FieldValue
         The container value which is referenced by the key
 
     Raises
@@ -284,13 +284,10 @@ def get_dotted_field_value(event: dict[str, FieldValue], dotted_field: str) -> F
 
     Parameters
     ----------
-    event: dict
+    event: dict[str, FieldValue]
         The event from which the dotted field value should be extracted
     dotted_field: str
         The dotted field name which identifies the requested value
-    silent_fail: bool, optional
-        Controls output behavior for missing fields. When set to true (which is the default),
-        None will be returned, otherwise an error will be raised.
 
     Returns
     -------
@@ -314,14 +311,14 @@ def get_dotted_field_value(event: dict[str, FieldValue], dotted_field: str) -> F
 
 def get_dotted_field_value_with_explicit_missing(
     event: dict[str, FieldValue], dotted_field: str
-) -> Union[FieldValue, Missing]:
+) -> FieldValue | Missing:
     """
     Returns the value of a requested dotted_field by iterating over the event dictionary until the
     field was found. In case the field could not be found None is returned.
 
     Parameters
     ----------
-    event: dict
+    event: dict[str, FieldValue]
         The event from which the dotted field value should be extracted
     dotted_field: str
         The dotted field name which identifies the requested value
@@ -349,7 +346,7 @@ def get_dotted_field_value_with_explicit_missing(
 def get_dotted_field_values(
     event: dict,
     dotted_fields: Iterable[str],
-    on_missing: Callable[[str], Union[FieldValue, Skip]] = lambda _: None,
+    on_missing: Callable[[str], FieldValue | Skip] = lambda _: None,
 ) -> dict[str, FieldValue]:
     """
     Extract the subset of fields from the dict by using the list of (potentially dotted)
@@ -366,7 +363,7 @@ def get_dotted_field_values(
         The (potentially nested) dict where the values are sourced from
     dotted_fields : Iterable[str]
         The (potentially dotted) list of field names to extract
-    on_missing : _type_, optional
+    on_missing : Callable[[str], FieldValue | Skip], optional
         The callback to control the behavior for missing fields, by default
         `lambda _: None` which returns missing fields with `None` value