From 9c7020d14092eda8054940aa6e2c704c3afe9e51 Mon Sep 17 00:00:00 2001 From: Cade Mirchandani Date: Tue, 18 Feb 2025 05:58:45 -0800 Subject: [PATCH] refactor: rename settings interface, rename plugin attritbute renamed plugin attributes and settings interface --- src/snakemake_interface_logger_plugins/base.py | 6 +++--- src/snakemake_interface_logger_plugins/registry/__init__.py | 4 ++-- src/snakemake_interface_logger_plugins/settings.py | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/src/snakemake_interface_logger_plugins/base.py b/src/snakemake_interface_logger_plugins/base.py index b6465fc..2d6d611 100644 --- a/src/snakemake_interface_logger_plugins/base.py +++ b/src/snakemake_interface_logger_plugins/base.py @@ -6,7 +6,7 @@ from typing import Optional from snakemake_interface_logger_plugins.settings import ( LogHandlerSettingsBase, - LoggerSettingsInterface, + OutputSettingsLoggerInterface, ) from abc import ABC, abstractmethod from logging import Handler @@ -15,7 +15,7 @@ class LogHandlerBase(ABC, Handler): def __init__( self, - common_settings: LoggerSettingsInterface, + common_settings: OutputSettingsLoggerInterface, settings: Optional[LogHandlerSettingsBase], ) -> None: self.common_settings = common_settings @@ -53,4 +53,4 @@ def has_filter(self) -> bool: def has_formatter(self) -> bool: """ Whether this plugin attaches its own formatter - """ \ No newline at end of file + """ diff --git a/src/snakemake_interface_logger_plugins/registry/__init__.py b/src/snakemake_interface_logger_plugins/registry/__init__.py index 2c1dc60..fc5e25d 100644 --- a/src/snakemake_interface_logger_plugins/registry/__init__.py +++ b/src/snakemake_interface_logger_plugins/registry/__init__.py @@ -34,7 +34,7 @@ def load_plugin(self, name: str, module: types.ModuleType) -> Plugin: return Plugin( _name=name, - log_handler=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, diff --git a/src/snakemake_interface_logger_plugins/settings.py b/src/snakemake_interface_logger_plugins/settings.py index 94b8226..e9bbfd4 100644 --- a/src/snakemake_interface_logger_plugins/settings.py +++ b/src/snakemake_interface_logger_plugins/settings.py @@ -12,7 +12,7 @@ from typing import Optional, Sequence -class LoggerSettingsInterface(ABC): +class OutputSettingsLoggerInterface(ABC): printshellcmds: bool nocolor: bool quiet: Optional[Sequence]