Merge pull request #38 from modern-python/36-feature-add-more-intuitive-messages-about-instruments-state

improve error message for instruments and bootstrappers

Author: lesnik512

lite_bootstrap/bootstrappers/base.py

@@ -27,7 +27,8 @@ class BaseBootstrapper(abc.ABC, typing.Generic[ApplicationT]):
     def __init__(self, bootstrap_config: BaseConfig) -> None:
         self.is_bootstrapped = False
         if not self.is_ready():
-            raise RuntimeError(self.not_ready_message)
+            msg = f"{type(self).__name__} is not ready because {self.not_ready_message}"
+            raise RuntimeError(msg)
 
         self.bootstrap_config = bootstrap_config
         self.instruments = []
@@ -38,7 +39,7 @@ def __init__(self, bootstrap_config: BaseConfig) -> None:
                 continue
 
             if not instrument.is_ready():
-                logger.info(instrument.not_ready_message)
+                logger.info(f"{instrument_type.__name__} is not ready, because {instrument.not_ready_message}")
                 continue
 
             self.instruments.append(instrument)

pyproject.toml

@@ -154,6 +154,7 @@ ignore = [
     "D213", # "multi-line-summary-second-line" conflicting with D212
     "COM812", # flake8-commas "Trailing comma missing"
     "ISC001", # flake8-implicit-str-concat
+    "G004", # allow f-strings in logging
 ]
 isort.lines-after-imports = 2
 isort.no-lines-before = ["standard-library", "local-folder"]

tests/test_free_bootstrap.py

@@ -42,7 +42,9 @@ def test_free_bootstrap_logging_not_ready(log_output: list[EventDict]) -> None:
             logging_buffer_capacity=0,
         ),
     )
-    assert log_output == [{"event": "service_debug is True", "log_level": "info"}]
+    assert log_output == [
+        {"event": "LoggingInstrument is not ready, because service_debug is True", "log_level": "info"}
+    ]
 
 
 @pytest.mark.parametrize(