Folder monitor

.gitignore

@@ -31,3 +31,4 @@ examples/TrivialDiscordBot/secrets.json
 /reports/
 /.pytest_cache/
 /junit.xml
+.coverage*

dev-docs/developer-notes/README.md

@@ -0,0 +1 @@
+Catch all place for individual developers to store notes they don't mind being public

dev-docs/developer-notes/cameron-general-notes.md

@@ -0,0 +1,11 @@
+
+https://github.com/topics/fediverse?l=python
+
+Standardization and upgrade run - next step
+
+ - standardize all setter values to value
+ - There's a few places - e.g. in FileSystem - where strings could be enums for clarity
+ - And type(self).__name__ could be used in a bunch of different places to save on changes after a class rename
+ - Consistent and present docstrings everywhere
+
+

dev-docs/io-dev-notes/README.md

@@ -0,0 +1,6 @@
+The aim of this folder is to include notes written by the developers as they were working.
+These will - probably - eventually - end up on some kind of wiki.
+
+Feel free to write as much (or as little) as you like.
+
+Personally, these are my working notes. So expect some digressions and random other useful stuff.

examples/file_system_bots/dir_input_monitor_bot.py

@@ -0,0 +1,110 @@
+#!/usr/bin/env python3
+# pylint: disable=duplicate-code
+# this is an example - duplication for emphasis is desirable
+
+from __future__ import annotations
+
+from typing import Any, Dict, Set, Type
+
+import logging
+
+from mewbot.api.v1 import Trigger, Action
+from mewbot.core import InputEvent, OutputEvent, OutputQueue
+from mewbot.io.file_system import (
+    CreatedDirFSInputEvent,
+    UpdatedDirFSInputEvent,
+    MovedDirFSInputEvent,
+    DeletedDirFSInputEvent,
+    CreatedFileFSInputEvent,
+    UpdatedFileFSInputEvent,
+    MovedFileFSInputEvent,
+    DeletedFileFSInputEvent,
+    InputFileDirCreationInputEvent,
+    InputFileDirDeletionInputEvent,
+)
+
+
+class DirSystemAllCommandTrigger(Trigger):
+    """
+    Nothing fancy - just fires whenever there is a dir related FSInputEvent
+    """
+
+    @staticmethod
+    def consumes_inputs() -> Set[Type[InputEvent]]:
+        return {
+            CreatedDirFSInputEvent,
+            UpdatedDirFSInputEvent,
+            MovedDirFSInputEvent,
+            DeletedDirFSInputEvent,
+            CreatedFileFSInputEvent,
+            UpdatedFileFSInputEvent,
+            MovedFileFSInputEvent,
+            DeletedFileFSInputEvent,
+            InputFileDirCreationInputEvent,
+            InputFileDirDeletionInputEvent,
+        }
+
+    def matches(self, event: InputEvent) -> bool:
+
+        print("-------\n", "event seen by matches - ", event, "\n-------")
+
+        if not isinstance(
+            event,
+            (
+                CreatedDirFSInputEvent,
+                UpdatedDirFSInputEvent,
+                MovedDirFSInputEvent,
+                DeletedDirFSInputEvent,
+                CreatedFileFSInputEvent,
+                MovedFileFSInputEvent,
+                UpdatedFileFSInputEvent,
+                DeletedFileFSInputEvent,
+                InputFileDirCreationInputEvent,
+                InputFileDirDeletionInputEvent,
+            ),
+        ):
+            return False
+
+        return True
+
+
+class DirSystemInputPrintResponse(Action):
+    """
+    Print every DirSystem Dir related InputEvent.
+    """
+
+    _logger: logging.Logger
+    _queue: OutputQueue
+
+    def __init__(self) -> None:
+        super().__init__()
+        self._logger = logging.getLogger(__name__ + type(self).__name__)
+
+    @staticmethod
+    def consumes_inputs() -> Set[Type[InputEvent]]:
+        return {
+            CreatedDirFSInputEvent,
+            UpdatedDirFSInputEvent,
+            MovedDirFSInputEvent,
+            DeletedDirFSInputEvent,
+            CreatedFileFSInputEvent,
+            UpdatedFileFSInputEvent,
+            MovedFileFSInputEvent,
+            DeletedFileFSInputEvent,
+            InputFileDirCreationInputEvent,
+            InputFileDirDeletionInputEvent,
+        }
+
+    @staticmethod
+    def produces_outputs() -> Set[Type[OutputEvent]]:
+        return set()
+
+    async def act(self, event: InputEvent, state: Dict[str, Any]) -> None:
+        """
+        Construct a DiscordOutputEvent with the result of performing the calculation.
+        """
+        if not isinstance(event, InputEvent):
+            self._logger.warning("Received wrong event type %s", type(event))
+            return
+
+        print("-------\n", "event seen by action - ", event, "\n-------")

examples/file_system_bots/dir_input_monitor_bot.yaml

@@ -0,0 +1,24 @@
+kind: IOConfig
+implementation: mewbot.io.file_system.FileSystemIO
+uuid: aaaaaaaa-aaaa-4aaa-0001-aaaaaaaaaa00
+properties:
+  input_path: C:\mewbot_dev\new_dir
+  input_path_type: dir
+---
+
+kind: Behaviour
+implementation: mewbot.api.v1.Behaviour
+uuid: aaaaaaaa-aaaa-4aaa-0001-aaaaaaaaaa01
+properties:
+  name: 'Target Dir Change Alerts'
+triggers:
+  - kind: Trigger
+    implementation: examples.file_system_bots.dir_input_monitor_bot.DirSystemAllCommandTrigger
+    uuid: aaaaaaaa-aaaa-4aaa-0001-aaaaaaaaaa02
+    properties: {}
+conditions: []
+actions:
+  - kind: Action
+    implementation: examples.file_system_bots.dir_input_monitor_bot.DirSystemInputPrintResponse
+    uuid: aaaaaaaa-aaaa-4aaa-0001-aaaaaaaaaa03
+    properties: {}

examples/file_system_bots/file_input_None_path_monitor_bot.yaml

@@ -0,0 +1,23 @@
+kind: IOConfig
+implementation: mewbot.io.file_system.FileSystemIO
+uuid: aaaaaaaa-aaaa-4aaa-0001-aaaaaaaaaa00
+properties:
+  input_path: None
+---
+
+kind: Behaviour
+implementation: mewbot.api.v1.Behaviour
+uuid: aaaaaaaa-aaaa-4aaa-0001-aaaaaaaaaa01
+properties:
+  name: 'Target File Change Alerts - but with None path - so it just sits here - hopefully not eating all resources'
+triggers:
+  - kind: Trigger
+    implementation: examples.file_system_bots.file_input_monitor_bot.FileSystemAllCommandTrigger
+    uuid: aaaaaaaa-aaaa-4aaa-0001-aaaaaaaaaa02
+    properties: {}
+conditions: []
+actions:
+  - kind: Action
+    implementation: examples.file_system_bots.file_input_monitor_bot.FileSystemInputPrintResponse
+    uuid: aaaaaaaa-aaaa-4aaa-0001-aaaaaaaaaa03
+    properties: {}

examples/file_system_bots/file_input_monitor_bot.py

@@ -0,0 +1,81 @@
+#!/usr/bin/env python3
+# pylint: disable=duplicate-code
+# this is an example - duplication for emphasis is desirable
+
+from __future__ import annotations
+
+from typing import Any, Dict, Set, Type
+
+import logging
+
+from mewbot.api.v1 import Trigger, Action
+from mewbot.core import InputEvent, OutputEvent, OutputQueue
+from mewbot.io.file_system import (
+    FSInputEvent,
+    UpdatedFileFSInputEvent,
+    InputFileFileCreationInputEvent,
+    InputFileFileDeletionInputEvent,
+)
+
+
+class FileSystemAllCommandTrigger(Trigger):
+    """
+    Nothing fancy - just fires whenever there is a file related FSInputEvent
+    """
+
+    @staticmethod
+    def consumes_inputs() -> Set[Type[InputEvent]]:
+        return {
+            InputFileFileCreationInputEvent,
+            UpdatedFileFSInputEvent,
+            InputFileFileDeletionInputEvent,
+        }
+
+    def matches(self, event: InputEvent) -> bool:
+
+        if not isinstance(
+            event,
+            (
+                InputFileFileCreationInputEvent,
+                UpdatedFileFSInputEvent,
+                InputFileFileDeletionInputEvent,
+            ),
+        ):
+            return False
+
+        return True
+
+
+class FileSystemInputPrintResponse(Action):
+    """
+    Print every FileSystem File related InputEvent.
+    """
+
+    _logger: logging.Logger
+    _queue: OutputQueue
+
+    def __init__(self) -> None:
+        super().__init__()
+        self._logger = logging.getLogger(__name__ + type(self).__name__)
+
+    @staticmethod
+    def consumes_inputs() -> Set[Type[InputEvent]]:
+        return {
+            InputFileFileCreationInputEvent,
+            UpdatedFileFSInputEvent,
+            InputFileFileDeletionInputEvent,
+        }
+
+    @staticmethod
+    def produces_outputs() -> Set[Type[OutputEvent]]:
+        return set()
+
+    async def act(self, event: InputEvent, state: Dict[str, Any]) -> None:
+        """
+        Construct a DiscordOutputEvent with the result of performing the calculation.
+        """
+        if not isinstance(event, FSInputEvent):
+            self._logger.warning("Received wrong event type %s", type(event))
+            return
+
+        print(event)

examples/file_system_bots/file_input_monitor_bot.yaml

@@ -0,0 +1,24 @@
+kind: IOConfig
+implementation: mewbot.io.file_system.FileSystemIO
+uuid: aaaaaaaa-aaaa-4aaa-0001-aaaaaaaaaa00
+properties:
+  input_path: 'C:\mewbot_dev\test_file.md'
+  input_path_type: 'file'
+---
+
+kind: Behaviour
+implementation: mewbot.api.v1.Behaviour
+uuid: aaaaaaaa-aaaa-4aaa-0001-aaaaaaaaaa01
+properties:
+  name: 'Target File Change Alerts'
+triggers:
+  - kind: Trigger
+    implementation: examples.file_system_bots.file_input_monitor_bot.FileSystemAllCommandTrigger
+    uuid: aaaaaaaa-aaaa-4aaa-0001-aaaaaaaaaa02
+    properties: {}
+conditions: []
+actions:
+  - kind: Action
+    implementation: examples.file_system_bots.file_input_monitor_bot.FileSystemInputPrintResponse
+    uuid: aaaaaaaa-aaaa-4aaa-0001-aaaaaaaaaa03
+    properties: {}