feat: add OutputSettingsLoggerInterface and abstract methods to LogHandlerBase (#11)

* fix: fix plugin init in registry

* refactor: fix typo in docstring

* feat: add LoggerSettingsInterface for shared settings, add abstractmethods to communicate log plugin behavior

new argument to LogHandlerBase init

* refactor: rename settings interface, rename plugin attritbute

renamed plugin attributes and settings interface

Author: cademirch

src/snakemake_interface_logger_plugins/base.py

@@ -4,17 +4,53 @@
 __license__ = "MIT"
 
 from typing import Optional
-from snakemake_interface_logger_plugins.settings import LogHandlerSettingsBase
+from snakemake_interface_logger_plugins.settings import (
+    LogHandlerSettingsBase,
+    OutputSettingsLoggerInterface,
+)
+from abc import ABC, abstractmethod
 from logging import Handler
 
 
-class LogHandlerBase(Handler):
+class LogHandlerBase(ABC, Handler):
     def __init__(
         self,
+        common_settings: OutputSettingsLoggerInterface,
         settings: Optional[LogHandlerSettingsBase],
     ) -> None:
+        self.common_settings = common_settings
         self.settings = settings
-        self.__post__init()
+        self.__post__init__()
+        if self.writes_to_stream and self.writes_to_file:
+            raise ValueError("A handler cannot write to both stream and file")
 
-    def __post__init(self) -> None:
+    def __post__init__(self) -> None:
         pass
+
+    @property
+    @abstractmethod
+    def writes_to_stream(self) -> bool:
+        """
+        Whether this plugin writes to stderr/stdout
+        """
+
+    @property
+    @abstractmethod
+    def writes_to_file(self) -> bool:
+        """
+        Whether this plugin writes to a file
+        """
+
+    @property
+    @abstractmethod
+    def has_filter(self) -> bool:
+        """
+        Whether this plugin attaches its own filter
+        """
+
+    @property
+    @abstractmethod
+    def has_formatter(self) -> bool:
+        """
+        Whether this plugin attaches its own formatter
+        """

src/snakemake_interface_logger_plugins/registry/__init__.py

@@ -23,7 +23,7 @@
 
 
 class LoggerPluginRegistry(PluginRegistryBase):
-    """This class is a singleton that holds all registered executor plugins."""
+    """This class is a singleton that holds all registered logger plugins."""
 
     @property
     def module_prefix(self) -> str:
@@ -34,7 +34,7 @@ def load_plugin(self, name: str, module: types.ModuleType) -> Plugin:
 
         return Plugin(
             _name=name,
-            logger_plugin=module.LoggerPlugin,
+            log_handler=module.LogHandler,
             _logger_settings_cls=getattr(module, "LogHandlerSettings", None),
         )
 
@@ -45,7 +45,7 @@ def expected_attributes(self) -> Mapping[str, AttributeType]:
                 mode=AttributeMode.OPTIONAL,
                 kind=AttributeKind.CLASS,
             ),
-            "LoggerPlugin": AttributeType(
+            "LogHandler": AttributeType(
                 cls=LogHandlerBase,
                 mode=AttributeMode.REQUIRED,
                 kind=AttributeKind.CLASS,

src/snakemake_interface_logger_plugins/settings.py

@@ -8,6 +8,21 @@
 import snakemake_interface_common.plugin_registry.plugin
 
 
+from abc import ABC
+from typing import Optional, Sequence
+
+
+class OutputSettingsLoggerInterface(ABC):
+    printshellcmds: bool
+    nocolor: bool
+    quiet: Optional[Sequence]
+    debug_dag: bool
+    verbose: bool
+    show_failed_logs: bool
+    stdout: bool
+    dryrun: bool
+
+
 @dataclass
 class LogHandlerSettingsBase(
     snakemake_interface_common.plugin_registry.plugin.SettingsBase