Merge pull request #9 from community-of-python/feature/make-docs-great-again

Start making some nice docs

Author: insani7y

README.md

@@ -23,12 +23,15 @@
 class ApplicationBootstrapper(abc.ABC, typing.Generic[SettingsT, ApplicationT, DataclassT]):
     application_type: type[ApplicationT]
     application_config: DataclassT
-    __instrument_box: InstrumentBox = InstrumentBox()
     console_writer: ConsoleWriter
+    __instrument_box: InstrumentBox
 
     def __init__(self, settings: SettingsT) -> None:
         self.settings = settings
         self.console_writer = ConsoleWriter(writer_enabled=settings.service_debug)
+
+        if not hasattr(self, "__instrument_box"):
+            self.__instrument_box = InstrumentBox()
         self.__instrument_box.initialize(self.settings)
 
     def configure_application(
@@ -45,22 +48,34 @@ def configure_instrument(
         self.__instrument_box.configure_instrument(instrument_config)
         return self
 
+    def configure_instruments(
+        self: typing_extensions.Self,
+        *instrument_configs: InstrumentConfigT,
+    ) -> typing_extensions.Self:
+        for instrument_config in instrument_configs:
+            self.configure_instrument(instrument_config)
+        return self
+
     @classmethod
     def use_instrument(
         cls,
     ) -> typing.Callable[
         [type[Instrument[InstrumentConfigT]]],
         type[Instrument[InstrumentConfigT]],
     ]:
+        if not hasattr(cls, "__instrument_box"):
+            cls.__instrument_box = InstrumentBox()
         return cls.__instrument_box.extend_instruments
 
     def bootstrap(self: typing_extensions.Self) -> ApplicationT:
         resulting_application_config = dataclass_to_dict_no_defaults(self.application_config)
         for instrument in self.__instrument_box.instruments:
             if instrument.is_ready():
+                instrument.bootstrap()
+
                 resulting_application_config = merge_dict_configs(
                     resulting_application_config,
-                    instrument.bootstrap(),
+                    instrument.bootstrap_before(),
                 )
             instrument.write_status(self.console_writer)
 

microbootstrap/bootstrappers/base.py

@@ -39,7 +39,7 @@ def is_ready(self) -> bool:
         raise NotImplementedError
 
     @abc.abstractmethod
-    def bootstrap(self) -> dict[str, typing.Any]:
+    def bootstrap(self) -> None:
         raise NotImplementedError
 
     @abc.abstractmethod

microbootstrap/instruments/base.py

@@ -147,7 +147,7 @@ def is_ready(self) -> bool:
     def teardown(self) -> None:
         structlog.reset_defaults()
 
-    def bootstrap(self) -> dict[str, typing.Any]:
+    def bootstrap(self) -> None:
         for unset_handlers_logger in self.instrument_config.logging_unset_handlers:
             logging.getLogger(unset_handlers_logger).handlers = []
 
@@ -167,8 +167,6 @@ def bootstrap(self) -> dict[str, typing.Any]:
             cache_logger_on_first_use=True,
         )
 
-        return self.bootstrap_before()
-
     @classmethod
     def get_config_type(cls) -> type[LoggingConfig]:
         return LoggingConfig

microbootstrap/instruments/logging_instrument.py

@@ -31,7 +31,7 @@ class OpentelemetryConfig(BaseInstrumentConfig):
     opentelemetry_namespace: str | None = None
     opentelemetry_insecure: bool = pydantic.Field(default=True)
     opentelemetry_insrtumentors: list[OpenTelemetryInstrumentor] = pydantic.Field(default_factory=list)
-    opentelemetry_exclude_urls: list[str] = pydantic.Field(default=["/health"])
+    opentelemetry_exclude_urls: list[str] = pydantic.Field(default=[])
 
 
 class OpentelemetryInstrument(Instrument[OpentelemetryConfig]):
@@ -60,7 +60,7 @@ def teardown(self) -> None:
         for instrumentor_with_params in self.instrument_config.opentelemetry_insrtumentors:
             instrumentor_with_params.instrumentor.uninstrument(**instrumentor_with_params.additional_params)
 
-    def bootstrap(self) -> dict[str, typing.Any]:
+    def bootstrap(self) -> None:
         resource: typing.Final = resources.Resource.create(
             attributes={
                 resources.SERVICE_NAME: self.instrument_config.service_name,
@@ -85,7 +85,6 @@ def bootstrap(self) -> dict[str, typing.Any]:
                 tracer_provider=self.tracer_provider,
                 **opentelemetry_instrumentor.additional_params,
             )
-        return self.bootstrap_before()
 
     @classmethod
     def get_config_type(cls) -> type[OpentelemetryConfig]:

microbootstrap/instruments/opentelemetry_instrument.py

@@ -37,8 +37,8 @@ def is_ready(self) -> bool:
     def teardown(self) -> None:
         return
 
-    def bootstrap(self) -> dict[str, typing.Any]:
-        return self.bootstrap_before()
+    def bootstrap(self) -> None:
+        pass
 
     @classmethod
     def get_config_type(cls) -> type[PrometheusConfig]:

microbootstrap/instruments/prometheus_instrument.py

@@ -41,7 +41,7 @@ def is_ready(self) -> bool:
     def teardown(self) -> None:
         return
 
-    def bootstrap(self) -> dict[str, typing.Any]:
+    def bootstrap(self) -> None:
         sentry_sdk.init(
             dsn=self.instrument_config.sentry_dsn,
             sample_rate=self.instrument_config.sentry_sample_rate,
@@ -52,7 +52,6 @@ def bootstrap(self) -> dict[str, typing.Any]:
             integrations=self.instrument_config.sentry_integrations,
             **self.instrument_config.sentry_additional_params,
         )
-        return self.bootstrap_before()
 
     @classmethod
     def get_config_type(cls) -> type[SentryConfig]:

microbootstrap/instruments/sentry_instrument.py

@@ -27,6 +27,21 @@ async def test_litestar_configure_instrument() -> None:
         assert response.status_code == status_codes.HTTP_200_OK
 
 
+async def test_litestar_configure_instruments() -> None:
+    test_metrics_path: typing.Final = "/test-metrics-path"
+    application: typing.Final = (
+        LitestarBootstrapper(LitestarSettings())
+        .configure_instruments(
+            PrometheusConfig(prometheus_metrics_path=test_metrics_path),
+        )
+        .bootstrap()
+    )
+
+    async with AsyncTestClient(app=application) as async_client:
+        response: typing.Final = await async_client.get(test_metrics_path)
+        assert response.status_code == status_codes.HTTP_200_OK
+
+
 async def test_litestar_configure_application_add_handler() -> None:
     test_handler_path: typing.Final = "/test-handler"
     test_response: typing.Final = {"hello": "world"}

tests/bootstrappers/test_litestar.py

@@ -23,7 +23,7 @@ def test_logging_is_ready(minimum_logging_config: LoggingConfig, console_writer:
 def test_logging_bootstrap_is_not_ready(minimum_logging_config: LoggingConfig) -> None:
     minimum_logging_config.service_debug = True
     logging_instrument: typing.Final = LoggingInstrument(minimum_logging_config)
-    assert logging_instrument.bootstrap() == {}
+    assert logging_instrument.bootstrap_before() == {}
 
 
 def test_logging_bootstrap_after(
@@ -43,7 +43,8 @@ def test_logging_teardown(
 
 def test_litestar_logging_bootstrap(minimum_logging_config: LoggingConfig) -> None:
     logging_instrument: typing.Final = LitestarLoggingInstrument(minimum_logging_config)
-    bootsrap_result: typing.Final = logging_instrument.bootstrap()
+    logging_instrument.bootstrap()
+    bootsrap_result: typing.Final = logging_instrument.bootstrap_before()
     assert "middleware" in bootsrap_result
     assert isinstance(bootsrap_result["middleware"], list)
     assert len(bootsrap_result["middleware"]) == 1
@@ -56,9 +57,10 @@ async def test_litestar_logging_bootstrap_working(minimum_logging_config: Loggin
     async def error_handler() -> str:
         return "Ok"
 
+    logging_instrument.bootstrap()
     litestar_application: typing.Final = litestar.Litestar(
         route_handlers=[error_handler],
-        **logging_instrument.bootstrap(),
+        **logging_instrument.bootstrap_before(),
     )
 
     async with AsyncTestClient(app=litestar_application) as async_client:
@@ -77,9 +79,10 @@ async def test_litestar_logging_bootstrap_tracer_injection(minimum_logging_confi
     async def error_handler() -> str:
         return "Ok"
 
+    logging_instrument.bootstrap()
     litestar_application: typing.Final = litestar.Litestar(
         route_handlers=[error_handler],
-        **logging_instrument.bootstrap(),
+        **logging_instrument.bootstrap_before(),
     )
     with tracer.start_as_current_span("my_fake_span") as span:
         # Do some fake work inside the span

tests/instruments/test_logging.py

@@ -24,7 +24,7 @@ def test_opentelemetry_is_ready(
 def test_opentelemetry_bootstrap_is_not_ready(minimum_opentelemetry_config: OpentelemetryConfig) -> None:
     minimum_opentelemetry_config.service_name = ""
     opentelemetry_instrument: typing.Final = OpentelemetryInstrument(minimum_opentelemetry_config)
-    assert opentelemetry_instrument.bootstrap() == {}
+    assert not opentelemetry_instrument.is_ready()
 
 
 def test_opentelemetry_bootstrap_after(
@@ -49,7 +49,8 @@ def test_litestar_opentelemetry_bootstrap(
     minimum_opentelemetry_config.opentelemetry_insrtumentors = [magic_mock]
     opentelemetry_instrument: typing.Final = LitetstarOpentelemetryInstrument(minimum_opentelemetry_config)
 
-    opentelemetry_bootstrap_result: typing.Final = opentelemetry_instrument.bootstrap()
+    opentelemetry_instrument.bootstrap()
+    opentelemetry_bootstrap_result: typing.Final = opentelemetry_instrument.bootstrap_before()
 
     assert opentelemetry_bootstrap_result
     assert "middleware" in opentelemetry_bootstrap_result
@@ -73,7 +74,8 @@ async def test_litestar_opentelemetry_bootstrap_working(
     async_mock: AsyncMock,
 ) -> None:
     opentelemetry_instrument: typing.Final = LitetstarOpentelemetryInstrument(minimum_opentelemetry_config)
-    opentelemetry_bootstrap_result: typing.Final = opentelemetry_instrument.bootstrap()
+    opentelemetry_instrument.bootstrap()
+    opentelemetry_bootstrap_result: typing.Final = opentelemetry_instrument.bootstrap_before()
 
     opentelemetry_middleware = opentelemetry_bootstrap_result["middleware"][0]
     assert isinstance(opentelemetry_middleware, DefineMiddleware)