rats-apps 0.10.3.dev20250520163928__py3-none-any.whl → 0.10.3.dev20250520164722__py3-none-any.whl

rats/logs/__init__.py

@@ -1,7 +1,22 @@
-"""Small package to help configure logging for rats applications."""
+"""
+Small module to help configure logging for rats applications.
 
-from ._app import ConfigureApplication
+We provide a rats application that can be executed at the beginning of your process, that will
+handle configuring the python logging libraries, with a few configuration options being exposed.
+
+!!! warning
+    We expose the logging functionality through a [rats.apps.AppContainer][] in order to leverage
+    the built in plugin system to give users the ability to adjust the default settings, but this
+    entire application should be lightweight and should not contain very complex logic, avoiding
+    logic that is very time consuming or has a chance of failing with confusing errors.
+
+    If the logging options made available through this module are far from what is desired, instead
+    of adding flags and options to this module, we recommend configuring logging in your own code.
+"""
+
+from ._app import AppConfigs, ConfigureApplication
 
 __all__ = [
+    "AppConfigs",
     "ConfigureApplication",
 ]

rats/logs/_app.py

@@ -1,12 +1,58 @@
 import logging.config
+import warnings
+from collections.abc import Iterator
+from typing import Any
 
 from rats import apps
 
 logger = logging.getLogger(__name__)
+LoggerConfigEntry = tuple[str, dict[str, Any]]
+
+
+@apps.autoscope
+class AppConfigs:
+    LOGGERS = apps.ServiceId[LoggerConfigEntry]("loggers.config-group")
+    """
+    Register additional loggers to this service group.
+
+    ```python
+    from rats import apps
+
+
+    class PluginContainer(apps.Container, apps.PluginMixin):
+        @apps.group(AppConfigs.LOGGERS)
+        def _custom_loggers(self) -> Iterator[LoggerConfigEntry]:
+            yield "", {"level": "INFO", "handlers": ["console"]}
+            yield "azure", {"level": "WARNING", "handlers": ["console"]}
+
+
+    # provide the new configuration when executing `logs.ConfigureAppilcation`
+    apps.run(apps.AppBundle(
+        app_plugin=logs.ConfigureApplication,
+        container_plugin=PluginContainer,
+    ))
+    ```
+    """
 
 
 class ConfigureApplication(apps.AppContainer, apps.PluginMixin):
+    """
+    Configure logging for the current process.
+
+    We try to provide some simple default loggers, but you can replace the loggers by providing the
+    [rats.logs.AppConfigs.LOGGERS][] service group.
+
+    ```python
+    from rats import apps, logs
+
+    apps.run(apps.AppBundle(app_plugin=logs.ConfigureApplication))
+    ```
+    """
+
     def execute(self) -> None:
+        """Applies the logging configuration."""
+        logger_configs = self._app.get_group(AppConfigs.LOGGERS)
+        loggers_dict = {key: value for key, value in logger_configs}
         logging.config.dictConfig(
             {
                 "version": 1,
@@ -36,10 +82,15 @@ class ConfigureApplication(apps.AppContainer, apps.PluginMixin):
                         "stream": "ext://sys.stderr",
                     }
                 },
-                "loggers": {
-                    "": {"level": "INFO", "handlers": ["console"]},
-                    "azure": {"level": "WARNING", "handlers": ["console"]},
-                },
+                "loggers": loggers_dict,
             }
         )
+        # enable deprecation warnings by default
+        logging.captureWarnings(True)
+        warnings.simplefilter("default", DeprecationWarning)
         logger.debug("done configuring logging")
+
+    @apps.fallback_group(AppConfigs.LOGGERS)
+    def _default_loggers(self) -> Iterator[LoggerConfigEntry]:
+        yield "", {"level": "INFO", "handlers": ["console"]}
+        yield "azure", {"level": "WARNING", "handlers": ["console"]}

{rats_apps-0.10.3.dev20250520163928.dist-info → rats_apps-0.10.3.dev20250520164722.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: rats-apps
-Version: 0.10.3.dev20250520163928
+Version: 0.10.3.dev20250520164722
 Summary: research analysis tools for building applications
 License: MIT
 Keywords: pipelines,machine learning,research

{rats_apps-0.10.3.dev20250520163928.dist-info → rats_apps-0.10.3.dev20250520164722.dist-info}/RECORD

@@ -30,8 +30,8 @@ rats/cli/_container.py,sha256=FIQBqi9PTNpE2P52qkfGET51BczdD-JvcWXLTjCNPDI,3512
 rats/cli/_functions.py,sha256=BNmgWVquQUEqJAYsed_l8vLnlLP7u3XC1TDyEFI1AiU,1552
 rats/cli/_plugin.py,sha256=o-pmEqU6mVH3QoRfRBrbG-XRTWCzt6pLKtSV3-5VSx0,1144
 rats/cli/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-rats/logs/__init__.py,sha256=sizLa6JbqekhJGKDyRZUUQvTuqiJx6yxwA5jT-tDQck,152
-rats/logs/_app.py,sha256=TF6rfQXQfaHd3AFW2anAoAGaxzU31kqJMoKkjuBtbF0,1617
+rats/logs/__init__.py,sha256=dSO-V2eu2W7w4w7oRau-UOfXXIkyZ2bHB6-kaasbeFM,970
+rats/logs/_app.py,sha256=SoTxk6g84tygOP_346NwXPcG1o6KZLd7lIgayq5vMdc,3239
 rats/logs/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 rats_e2e/apps/__init__.py,sha256=c2QG818ACyS9MBXs_Evg5yYT6k-KPMQfIqF7Z77Cau0,142
 rats_e2e/apps/__main__.py,sha256=ETECGDD8glcbmx0P-WWmjQQX6gtF-5L7_DxZjNmx3X4,350
@@ -42,6 +42,6 @@ rats_e2e/apps/inputs/_app.py,sha256=FiaLgOZc-d1ryKSwKnL5XBNGcOP1bHbxxeMJqoU_RJg,
 rats_e2e/apps/minimal/__init__.py,sha256=bUR6Oexx6Jsouxor0cL9emXoVha4cm3WqyhU1pgchsI,521
 rats_e2e/apps/minimal/__main__.py,sha256=Mf-a2iQKTTgh9hMd6AeuzmU9araMIyf1AtdWkh_L07E,117
 rats_e2e/apps/minimal/_app.py,sha256=CQ09LVTNRarz7Pb1wiSuNHrZ_2KGcgH8nUqy4BjxMUY,849
-rats_apps-0.10.3.dev20250520163928.dist-info/METADATA,sha256=8S_U7EpOEgolriB2hEv7VauOv1PKzo-R63MmSwFMXfE,867
-rats_apps-0.10.3.dev20250520163928.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
-rats_apps-0.10.3.dev20250520163928.dist-info/RECORD,,
+rats_apps-0.10.3.dev20250520164722.dist-info/METADATA,sha256=bohmgF0FEaU8yt4eVjEvGPFkgZn3U1qc7k1qRpPSk0w,867
+rats_apps-0.10.3.dev20250520164722.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+rats_apps-0.10.3.dev20250520164722.dist-info/RECORD,,