Turn ParamSpec non-private (#361)

Author: Kludex

logfire-api/logfire_api/_internal/instrument.pyi

@@ -3,9 +3,13 @@ from .ast_utils import BaseTransformer as BaseTransformer, LogfireArgs as Logfir
 from .main import Logfire as Logfire
 from dataclasses import dataclass
 from types import CodeType
-from typing import Callable
+from typing import Callable, TypeVar
+from typing_extensions import ParamSpec
 
-def instrument(logfire: Logfire, args: LogfireArgs) -> Callable[[Callable[_PARAMS, _RETURN]], Callable[_PARAMS, _RETURN]]: ...
+P = ParamSpec('P')
+R = TypeVar('R')
+
+def instrument(logfire: Logfire, args: LogfireArgs) -> Callable[[Callable[P, R]], Callable[P, R]]: ...
 def transform_code(func_code: CodeType, args: LogfireArgs): ...
 
 @dataclass

logfire-api/logfire_api/_internal/main.pyi

@@ -35,7 +35,7 @@ from starlette.applications import Starlette
 from starlette.requests import Request as Request
 from starlette.websockets import WebSocket as WebSocket
 from typing import Any, Callable, ContextManager, Iterable, Literal, Sequence, TypeVar
-from typing_extensions import LiteralString, Unpack
+from typing_extensions import LiteralString, ParamSpec, Unpack
 
 ExcInfo = SysExcInfo | BaseException | bool | None
 
@@ -216,7 +216,7 @@ class Logfire:
             attributes: The arguments to include in the span and format the message template with.
                 Attributes starting with an underscore are not allowed.
         """
-    def instrument(self, msg_template: LiteralString | None = None, *, span_name: str | None = None, extract_args: bool = True) -> Callable[[Callable[_PARAMS, _RETURN]], Callable[_PARAMS, _RETURN]]:
+    def instrument(self, msg_template: LiteralString | None = None, *, span_name: str | None = None, extract_args: bool = True) -> Callable[[Callable[P, R]], Callable[P, R]]:
         """Decorator for instrumenting a function as a span.
 
         ```py
@@ -961,3 +961,5 @@ def set_user_attribute(otlp_attributes: dict[str, otel_types.AttributeValue], ke
     Returns the final key and value that was added to the dictionary.
     The key will be the original key unless the value was `None`, in which case it will be `NULL_ARGS_KEY`.
     """
+P = ParamSpec('P')
+R = TypeVar('R')

logfire/_internal/instrument.py

@@ -16,15 +16,12 @@
     from .main import Logfire
 
 
-_PARAMS = ParamSpec('_PARAMS')
-_RETURN = TypeVar('_RETURN')
+P = ParamSpec('P')
+R = TypeVar('R')
 
 
-def instrument(
-    logfire: Logfire,
-    args: LogfireArgs,
-) -> Callable[[Callable[_PARAMS, _RETURN]], Callable[_PARAMS, _RETURN]]:
-    def decorator(func: Callable[_PARAMS, _RETURN]) -> Callable[_PARAMS, _RETURN]:
+def instrument(logfire: Logfire, args: LogfireArgs) -> Callable[[Callable[P, R]], Callable[P, R]]:
+    def decorator(func: Callable[P, R]) -> Callable[P, R]:
         # This creates a new function object with code compiled from a modified AST
         # from the original function's source code.
         # Since this doesn't wrap/call the original function,

logfire/_internal/main.py

@@ -519,7 +519,7 @@ def instrument(
         *,
         span_name: str | None = None,
         extract_args: bool = True,
-    ) -> Callable[[Callable[_PARAMS, _RETURN]], Callable[_PARAMS, _RETURN]]:
+    ) -> Callable[[Callable[P, R]], Callable[P, R]]:
         """Decorator for instrumenting a function as a span.
 
         ```py
@@ -1867,5 +1867,5 @@ def set_user_attribute(
     return key, otel_value
 
 
-_PARAMS = ParamSpec('_PARAMS')
-_RETURN = TypeVar('_RETURN')
+P = ParamSpec('P')
+R = TypeVar('R')