type: make code respect mypy strict mode (#290)

Fixes: #258

.pre-commit-config.yaml

@@ -72,7 +72,7 @@ repos:
           - types-botocore
           - types-mock
           - types-requests
-          - watchdog
+          - watchdog>=5.0.0
           - xxhash
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
@@ -113,7 +113,7 @@ repos:
           - pyyaml
           - requests
           - types-aiobotocore
-          - watchdog
+          - watchdog>=5.0.0
           - xxhash
   - repo: local
     hooks:

extensions/eda/plugins/event_filter/dashes_to_underscores.py

@@ -10,9 +10,12 @@
 """
 
 import multiprocessing as mp
+from typing import Any
 
 
-def main(event: dict, overwrite: bool = True) -> dict:  # noqa: FBT001, FBT002
+def main(
+    event: dict[str, Any], overwrite: bool = True
+) -> dict[str, Any]:  # noqa: FBT001, FBT002
     """Change dashes in keys to underscores."""
     logger = mp.get_logger()
     logger.info("dashes_to_underscores")

extensions/eda/plugins/event_filter/json_filter.py

@@ -16,21 +16,22 @@
 from __future__ import annotations
 
 import fnmatch
+from typing import Any, Optional
 
 
-def _matches_include_keys(include_keys: list, string: str) -> bool:
+def _matches_include_keys(include_keys: list[str], string: str) -> bool:
     return any(fnmatch.fnmatch(string, pattern) for pattern in include_keys)
 
 
-def _matches_exclude_keys(exclude_keys: list, string: str) -> bool:
+def _matches_exclude_keys(exclude_keys: list[str], string: str) -> bool:
     return any(fnmatch.fnmatch(string, pattern) for pattern in exclude_keys)
 
 
 def main(
-    event: dict,
-    exclude_keys: list | None = None,
-    include_keys: list | None = None,
-) -> dict:
+    event: dict[str, Any],
+    exclude_keys: Optional[list[str]] = None,
+    include_keys: Optional[list[str]] = None,
+) -> dict[str, Any]:
     """Filter keys out of events."""
     if exclude_keys is None:
         exclude_keys = []

extensions/eda/plugins/event_filter/noop.py

@@ -1,6 +1,8 @@
 """noop.py:   An event filter that does nothing to the input."""
 
+from typing import Any
 
-def main(event: dict) -> dict:
+
+def main(event: dict[str, Any]) -> dict[str, Any]:
     """Return the input."""
     return event

extensions/eda/plugins/event_filter/normalize_keys.py

@@ -40,22 +40,25 @@
 import logging
 import multiprocessing as mp
 import re
+from typing import Any
 
 normalize_regex = re.compile("[^0-9a-zA-Z_]+")
 
 
-def main(event: dict, overwrite: bool = True) -> dict:  # noqa: FBT001, FBT002
+def main(
+    event: dict[str, Any], overwrite: bool = True
+) -> dict[str, Any]:  # noqa: FBT001, FBT002
     """Change keys that contain non-alphanumeric characters to underscores."""
     logger = mp.get_logger()
     logger.info("normalize_keys")
     return _normalize_embedded_keys(event, overwrite, logger)
 
 
 def _normalize_embedded_keys(
-    obj: dict,
+    obj: dict[str, Any],
     overwrite: bool,  # noqa: FBT001
     logger: logging.Logger,
-) -> dict:
+) -> dict[str, Any]:
     if isinstance(obj, dict):
         new_dict = {}
         original_keys = list(obj.keys())

extensions/eda/plugins/event_source/alertmanager.py

@@ -114,7 +114,7 @@ def clean_host(host: str) -> str:
     return host
 
 
-async def main(queue: asyncio.Queue, args: dict[str, Any]) -> None:
+async def main(queue: asyncio.Queue[Any], args: dict[str, Any]) -> None:
     """Receive events via alertmanager webhook."""
     app = web.Application()
     app["queue"] = queue
@@ -144,7 +144,7 @@ async def main(queue: asyncio.Queue, args: dict[str, Any]) -> None:
     class MockQueue(asyncio.Queue[Any]):
         """A fake queue."""
 
-        async def put(self: "MockQueue", event: dict) -> None:
+        async def put(self: "MockQueue", event: dict[str, Any]) -> None:
             """Print the event."""
             print(event)  # noqa: T201
 

extensions/eda/plugins/event_source/aws_cloudtrail.py

@@ -40,13 +40,15 @@
 from botocore.client import BaseClient
 
 
-def _cloudtrail_event_to_dict(event: dict) -> dict:
+def _cloudtrail_event_to_dict(event: dict[str, Any]) -> dict[str, Any]:
     event["EventTime"] = event["EventTime"].isoformat()
     event["CloudTrailEvent"] = json.loads(event["CloudTrailEvent"])
     return event
 
 
-def _get_events(events: list[dict], last_event_ids: list[str]) -> list:
+def _get_events(
+    events: list[dict[str, Any]], last_event_ids: list[str]
+) -> tuple[list[dict[str, Any]], Any, list[str]]:
     event_time = None
     event_ids = []
     result = []
@@ -60,13 +62,22 @@ def _get_events(events: list[dict], last_event_ids: list[str]) -> list:
         elif event_time == event["EventTime"]:
             event_ids.append(event["EventId"])
         result.append(event)
-    return [result, event_time, event_ids]
+    return result, event_time, event_ids
 
 
-async def _get_cloudtrail_events(client: BaseClient, params: dict) -> list[dict]:
+async def _get_cloudtrail_events(
+    client: BaseClient, params: dict[str, Any]
+) -> list[dict[str, Any]]:
     paginator = client.get_paginator("lookup_events")
     results = await paginator.paginate(**params).build_full_result()
-    return results.get("Events", [])
+    events = results.get("Events", [])
+    # type guards:
+    if not isinstance(events, list):
+        raise ValueError("Events is not a list")
+    for event in events:
+        if not isinstance(event, dict):
+            raise ValueError("Event is not a dictionary")
+    return events
 
 
 ARGS_MAPPING = {
@@ -75,7 +86,7 @@ async def _get_cloudtrail_events(client: BaseClient, params: dict) -> list[dict]
 }
 
 
-async def main(queue: asyncio.Queue, args: dict[str, Any]) -> None:
+async def main(queue: asyncio.Queue[Any], args: dict[str, Any]) -> None:
     """Receive events via AWS CloudTrail."""
     delay = int(args.get("delay_seconds", 10))
 
@@ -131,7 +142,7 @@ def connection_args(args: dict[str, Any]) -> dict[str, Any]:
     class MockQueue(asyncio.Queue[Any]):
         """A fake queue."""
 
-        async def put(self: "MockQueue", event: dict) -> None:
+        async def put(self: "MockQueue", event: dict[str, Any]) -> None:
             """Print the event."""
             print(event)  # noqa: T201
 

extensions/eda/plugins/event_source/aws_sqs_queue.py

@@ -31,7 +31,7 @@
 
 
 # pylint: disable=too-many-locals
-async def main(queue: asyncio.Queue, args: dict[str, Any]) -> None:
+async def main(queue: asyncio.Queue[Any], args: dict[str, Any]) -> None:
     """Receive events via an AWS SQS queue."""
     logger = logging.getLogger()
 
@@ -117,7 +117,7 @@ def connection_args(args: dict[str, Any]) -> dict[str, Any]:
     class MockQueue(asyncio.Queue[Any]):
         """A fake queue."""
 
-        async def put(self: "MockQueue", event: dict) -> None:
+        async def put(self: "MockQueue", event: dict[str, Any]) -> None:
             """Print the event."""
             print(event)  # noqa: T201
 

extensions/eda/plugins/event_source/azure_service_bus.py

@@ -27,7 +27,7 @@
 
 def receive_events(
     loop: asyncio.events.AbstractEventLoop,
-    queue: asyncio.Queue,
+    queue: asyncio.Queue[Any],
     args: dict[str, Any],  # pylint: disable=W0621
 ) -> None:
     """Receive events from service bus."""
@@ -53,7 +53,7 @@ def receive_events(
 
 
 async def main(
-    queue: asyncio.Queue,
+    queue: asyncio.Queue[Any],
     args: dict[str, Any],  # pylint: disable=W0621
 ) -> None:
     """Receive events from service bus in a loop."""
@@ -69,7 +69,7 @@ async def main(
     class MockQueue(asyncio.Queue[Any]):
         """A fake queue."""
 
-        def put_nowait(self: "MockQueue", event: dict) -> None:
+        def put_nowait(self: "MockQueue", event: dict[str, Any]) -> None:
             """Print the event."""
             print(event)  # noqa: T201
 

extensions/eda/plugins/event_source/file.py

@@ -24,7 +24,7 @@
 from watchdog.observers import Observer
 
 
-def send_facts(queue: Queue, filename: Union[str, bytes]) -> None:
+def send_facts(queue: Queue[Any], filename: Union[str, bytes]) -> None:
     """Send facts to the queue."""
     if isinstance(filename, bytes):
         filename = str(filename, "utf-8")
@@ -50,7 +50,7 @@ def send_facts(queue: Queue, filename: Union[str, bytes]) -> None:
                 coroutine = queue.put(item)  # noqa: F841
 
 
-def main(queue: Queue, args: dict) -> None:
+def main(queue: Queue[Any], args: dict[str, Any]) -> None:
     """Load facts from YAML files initially and when the file changes."""
     files = [pathlib.Path(f).resolve().as_posix() for f in args.get("files", [])]
 
@@ -62,7 +62,7 @@ def main(queue: Queue, args: dict) -> None:
     _observe_files(queue, files)
 
 
-def _observe_files(queue: Queue, files: list[str]) -> None:
+def _observe_files(queue: Queue[Any], files: list[str]) -> None:
     class Handler(RegexMatchingEventHandler):
         """A handler for file events."""
 
@@ -104,7 +104,7 @@ def on_moved(self: "Handler", event: FileSystemEvent) -> None:
     class MockQueue(Queue[Any]):
         """A fake queue."""
 
-        async def put(self: "MockQueue", event: dict) -> None:
+        async def put(self: "MockQueue", event: dict[str, Any]) -> None:
             """Print the event."""
             print(event)  # noqa: T201
 

extensions/eda/plugins/event_source/file_watch.py

@@ -28,8 +28,8 @@
 
 def watch(
     loop: asyncio.events.AbstractEventLoop,
-    queue: asyncio.Queue,
-    args: dict,
+    queue: asyncio.Queue[Any],
+    args: dict[str, Any],
 ) -> None:
     """Watch for changes and put events on the queue."""
     root_path = args["path"]
@@ -96,7 +96,7 @@ def on_moved(self: "Handler", event: FileSystemEvent) -> None:
         observer.join()
 
 
-async def main(queue: asyncio.Queue, args: dict) -> None:
+async def main(queue: asyncio.Queue[Any], args: dict[str, Any]) -> None:
     """Watch for changes to a file and put events on the queue."""
     loop = asyncio.get_event_loop()
 
@@ -110,7 +110,7 @@ async def main(queue: asyncio.Queue, args: dict) -> None:
     class MockQueue(asyncio.Queue[Any]):
         """A fake queue."""
 
-        def put_nowait(self: "MockQueue", event: dict) -> None:
+        def put_nowait(self: "MockQueue", event: dict[str, Any]) -> None:
             """Print the event."""
             print(event)  # noqa: T201
 

extensions/eda/plugins/event_source/generic.py

@@ -100,7 +100,9 @@ class DelayArgs:
 class Generic:
     """Generic source plugin to generate different events."""
 
-    def __init__(self: Generic, queue: asyncio.Queue, args: dict[str, Any]) -> None:
+    def __init__(
+        self: Generic, queue: asyncio.Queue[Any], args: dict[str, Any]
+    ) -> None:
         """Insert event data into the queue."""
         self.queue = queue
         field_names = [f.name for f in fields(Args)]
@@ -164,7 +166,7 @@ async def __call__(self: Generic) -> None:
 
         await asyncio.sleep(self.delay_args.shutdown_after)
 
-    async def _post_event(self: Generic, event: dict, index: int) -> None:
+    async def _post_event(self: Generic, event: dict[str, Any], index: int) -> None:
         data = self._create_data(index)
 
         data.update(event)
@@ -189,7 +191,7 @@ async def _load_payload_from_file(self: Generic) -> None:
     def _create_data(
         self: Generic,
         index: int,
-    ) -> dict:
+    ) -> dict[str, Any]:
         data: dict[str, str | int] = {}
         if self.my_args.create_index:
             data[self.my_args.create_index] = index
@@ -206,7 +208,7 @@ def _create_data(
 
 
 async def main(  # pylint: disable=R0914
-    queue: asyncio.Queue,
+    queue: asyncio.Queue[Any],
     args: dict[str, Any],
 ) -> None:
     """Call the Generic Source Plugin."""
@@ -218,7 +220,7 @@ async def main(  # pylint: disable=R0914
     class MockQueue(asyncio.Queue[Any]):
         """A fake queue."""
 
-        async def put(self: MockQueue, event: dict) -> None:
+        async def put(self: MockQueue, event: dict[str, Any]) -> None:
             """Print the event."""
             print(event)  # noqa: T201
 

extensions/eda/plugins/event_source/journald.py

@@ -33,7 +33,7 @@
 from systemd import journal  # type: ignore
 
 
-async def main(queue: asyncio.Queue, args: dict[str, Any]) -> None:  # noqa: D417
+async def main(queue: asyncio.Queue[Any], args: dict[str, Any]) -> None:  # noqa: D417
     """Read journal entries and add them to the provided queue.
 
     Args:

extensions/eda/plugins/event_source/kafka.py

@@ -45,7 +45,7 @@
 
 
 async def main(  # pylint: disable=R0914
-    queue: asyncio.Queue,
+    queue: asyncio.Queue[Any],
     args: dict[str, Any],
 ) -> None:
     """Receive events via a kafka topic."""
@@ -116,7 +116,7 @@ async def main(  # pylint: disable=R0914
 
 
 async def receive_msg(
-    queue: asyncio.Queue,
+    queue: asyncio.Queue[Any],
     kafka_consumer: AIOKafkaConsumer,
     encoding: str,
 ) -> None:
@@ -161,7 +161,7 @@ async def receive_msg(
     class MockQueue(asyncio.Queue[Any]):
         """A fake queue."""
 
-        async def put(self: "MockQueue", event: dict) -> None:
+        async def put(self: "MockQueue", event: dict[str, Any]) -> None:
             """Print the event."""
             print(event)  # noqa: T201