Add missing return on instrument methods (#360)

Author: Kludex

logfire-api/logfire_api/__init__.pyi

@@ -1,11 +1,6 @@
 from ._internal.auto_trace import AutoTraceModule as AutoTraceModule
 from ._internal.auto_trace.rewrite_ast import no_auto_trace as no_auto_trace
-from ._internal.config import (
-    ConsoleOptions as ConsoleOptions,
-    METRICS_PREFERRED_TEMPORALITY as METRICS_PREFERRED_TEMPORALITY,
-    PydanticPlugin as PydanticPlugin,
-    configure as configure,
-)
+from ._internal.config import ConsoleOptions as ConsoleOptions, METRICS_PREFERRED_TEMPORALITY as METRICS_PREFERRED_TEMPORALITY, PydanticPlugin as PydanticPlugin, configure as configure
 from ._internal.constants import LevelName as LevelName
 from ._internal.exporters.file import load_file as load_spans_from_file
 from ._internal.exporters.tail_sampling import TailSamplingOptions as TailSamplingOptions
@@ -16,57 +11,7 @@ from .integrations.logging import LogfireLoggingHandler as LogfireLoggingHandler
 from .integrations.structlog import LogfireProcessor as StructlogProcessor
 from .version import VERSION as VERSION
 
-__all__ = [
-    'Logfire',
-    'LogfireSpan',
-    'LevelName',
-    'ConsoleOptions',
-    'PydanticPlugin',
-    'configure',
-    'span',
-    'instrument',
-    'log',
-    'trace',
-    'debug',
-    'notice',
-    'info',
-    'warn',
-    'error',
-    'fatal',
-    'force_flush',
-    'log_slow_async_callbacks',
-    'install_auto_tracing',
-    'instrument_fastapi',
-    'instrument_openai',
-    'instrument_anthropic',
-    'instrument_asyncpg',
-    'instrument_httpx',
-    'instrument_celery',
-    'instrument_requests',
-    'instrument_psycopg',
-    'instrument_django',
-    'instrument_flask',
-    'instrument_starlette',
-    'instrument_aiohttp_client',
-    'instrument_sqlalchemy',
-    'instrument_redis',
-    'instrument_pymongo',
-    'instrument_mysql',
-    'AutoTraceModule',
-    'with_tags',
-    'with_settings',
-    'shutdown',
-    'load_spans_from_file',
-    'no_auto_trace',
-    'METRICS_PREFERRED_TEMPORALITY',
-    'ScrubMatch',
-    'ScrubbingOptions',
-    'VERSION',
-    'suppress_instrumentation',
-    'StructlogProcessor',
-    'LogfireLoggingHandler',
-    'TailSamplingOptions',
-]
+__all__ = ['Logfire', 'LogfireSpan', 'LevelName', 'ConsoleOptions', 'PydanticPlugin', 'configure', 'span', 'instrument', 'log', 'trace', 'debug', 'notice', 'info', 'warn', 'error', 'fatal', 'force_flush', 'log_slow_async_callbacks', 'install_auto_tracing', 'instrument_fastapi', 'instrument_openai', 'instrument_anthropic', 'instrument_asyncpg', 'instrument_httpx', 'instrument_celery', 'instrument_requests', 'instrument_psycopg', 'instrument_django', 'instrument_flask', 'instrument_starlette', 'instrument_aiohttp_client', 'instrument_sqlalchemy', 'instrument_redis', 'instrument_pymongo', 'instrument_mysql', 'AutoTraceModule', 'with_tags', 'with_settings', 'shutdown', 'load_spans_from_file', 'no_auto_trace', 'METRICS_PREFERRED_TEMPORALITY', 'ScrubMatch', 'ScrubbingOptions', 'VERSION', 'suppress_instrumentation', 'StructlogProcessor', 'LogfireLoggingHandler', 'TailSamplingOptions']
 
 DEFAULT_LOGFIRE_INSTANCE = Logfire()
 span = DEFAULT_LOGFIRE_INSTANCE.span

logfire-api/logfire_api/_internal/constants.pyi

@@ -9,10 +9,8 @@ LOGGING_TO_OTEL_LEVEL_NUMBERS: Incomplete
 ATTRIBUTES_LOG_LEVEL_NAME_KEY: Incomplete
 ATTRIBUTES_LOG_LEVEL_NUM_KEY: Incomplete
 
-
 def log_level_attributes(level: LevelName | int) -> dict[str, otel_types.AttributeValue]: ...
 
-
 SpanTypeType: Incomplete
 ATTRIBUTES_SPAN_TYPE_KEY: Incomplete
 ATTRIBUTES_PENDING_SPAN_REAL_PARENT_KEY: Incomplete

logfire-api/logfire_api/_internal/main.pyi

@@ -552,7 +552,7 @@ class Logfire:
                 for future compatibility.
 
         """
-    def instrument_requests(self, excluded_urls: str | None = None, **kwargs: Any):
+    def instrument_requests(self, excluded_urls: str | None = None, **kwargs: Any) -> None:
         """Instrument the `requests` module so that spans are automatically created for each request.
 
         Args:
@@ -597,7 +597,7 @@ class Logfire:
         [OpenTelemetry Starlette Instrumentation](https://opentelemetry-python-contrib.readthedocs.io/en/latest/instrumentation/starlette/starlette.html)
         library, specifically `StarletteInstrumentor.instrument_app()`, to which it passes `**kwargs`.
         """
-    def instrument_aiohttp_client(self, **kwargs: Any):
+    def instrument_aiohttp_client(self, **kwargs: Any) -> None:
         """Instrument the `aiohttp` module so that spans are automatically created for each client request.
 
         Uses the

logfire/_internal/main.py

@@ -1107,7 +1107,7 @@ def instrument_django(
             **kwargs,
         )
 
-    def instrument_requests(self, excluded_urls: str | None = None, **kwargs: Any):
+    def instrument_requests(self, excluded_urls: str | None = None, **kwargs: Any) -> None:
         """Instrument the `requests` module so that spans are automatically created for each request.
 
         Args:
@@ -1176,7 +1176,7 @@ def instrument_starlette(
         self._warn_if_not_initialized_for_instrumentation()
         return instrument_starlette(app, capture_headers=capture_headers, **kwargs)
 
-    def instrument_aiohttp_client(self, **kwargs: Any):
+    def instrument_aiohttp_client(self, **kwargs: Any) -> None:
         """Instrument the `aiohttp` module so that spans are automatically created for each client request.
 
         Uses the