Add annotations future import to src/* for consistency

Author: hynek

docs/conf.py

@@ -54,11 +54,12 @@
 
 nitpick_ignore = [
     ("py:class", "Context"),
+    ("py:class", "EventDict"),
     ("py:class", "ILogObserver"),
     ("py:class", "PlainFileObserver"),
     ("py:class", "Processor"),
+    ("py:class", "Styles"),
     ("py:class", "WrappedLogger"),
-    ("py:class", "structlog.dev._Styles"),
     ("py:class", "structlog.threadlocal.TLLogger"),
     ("py:class", "structlog.types.EventDict"),
 ]

src/structlog/__init__.py

@@ -7,6 +7,8 @@
 Structured Logging for Python
 """
 
+from __future__ import annotations
+
 from structlog import (
     contextvars,
     dev,

src/structlog/_base.py

@@ -7,7 +7,9 @@
 Logger wrapper and helper class.
 """
 
-from typing import Any, Dict, Iterable, Mapping, Optional, Sequence, Tuple
+from __future__ import annotations
+
+from typing import Any, Iterable, Mapping, Sequence
 
 from structlog.exceptions import DropEvent
 
@@ -65,7 +67,7 @@ def __eq__(self, other: Any) -> bool:
     def __ne__(self, other: Any) -> bool:
         return not self.__eq__(other)
 
-    def bind(self, **new_values: Any) -> "BoundLoggerBase":
+    def bind(self, **new_values: Any) -> BoundLoggerBase:
         """
         Return a new logger with *new_values* added to the existing ones.
         """
@@ -75,7 +77,7 @@ def bind(self, **new_values: Any) -> "BoundLoggerBase":
             self._context.__class__(self._context, **new_values),
         )
 
-    def unbind(self, *keys: str) -> "BoundLoggerBase":
+    def unbind(self, *keys: str) -> BoundLoggerBase:
         """
         Return a new logger with *keys* removed from the context.
 
@@ -87,7 +89,7 @@ def unbind(self, *keys: str) -> "BoundLoggerBase":
 
         return bl
 
-    def try_unbind(self, *keys: str) -> "BoundLoggerBase":
+    def try_unbind(self, *keys: str) -> BoundLoggerBase:
         """
         Like :meth:`unbind`, but best effort: missing keys are ignored.
 
@@ -99,7 +101,7 @@ def try_unbind(self, *keys: str) -> "BoundLoggerBase":
 
         return bl
 
-    def new(self, **new_values: Any) -> "BoundLoggerBase":
+    def new(self, **new_values: Any) -> BoundLoggerBase:
         """
         Clear context and binds *initial_values* using `bind`.
 
@@ -114,8 +116,8 @@ def new(self, **new_values: Any) -> "BoundLoggerBase":
     # Helper methods for sub-classing concrete BoundLoggers.
 
     def _process_event(
-        self, method_name: str, event: Optional[str], event_kw: Dict[str, Any]
-    ) -> Tuple[Sequence[Any], Mapping[str, Any]]:
+        self, method_name: str, event: str | None, event_kw: dict[str, Any]
+    ) -> tuple[Sequence[Any], Mapping[str, Any]]:
         """
         Combines creates an ``event_dict`` and runs the chain.
 
@@ -175,7 +177,7 @@ def _process_event(
             )
 
     def _proxy_to_logger(
-        self, method_name: str, event: Optional[str] = None, **event_kw: Any
+        self, method_name: str, event: str | None = None, **event_kw: Any
     ) -> Any:
         """
         Run processor chain on event & call *method_name* on wrapped logger.

src/structlog/_config.py

@@ -7,20 +7,12 @@
 Global state department.  Don't reload this module or everything breaks.
 """
 
+from __future__ import annotations
 
 import sys
 import warnings
 
-from typing import (
-    Any,
-    Callable,
-    Dict,
-    Iterable,
-    Optional,
-    Sequence,
-    Type,
-    cast,
-)
+from typing import Any, Callable, Iterable, Sequence, Type, cast
 
 from ._log_levels import make_filtering_bound_logger
 from ._loggers import PrintLoggerFactory
@@ -62,7 +54,7 @@ class _Configuration:
 
     is_configured: bool = False
     default_processors: Iterable[Processor] = _BUILTIN_DEFAULT_PROCESSORS[:]
-    default_context_class: Type[Context] = _BUILTIN_DEFAULT_CONTEXT_CLASS
+    default_context_class: type[Context] = _BUILTIN_DEFAULT_CONTEXT_CLASS
     default_wrapper_class: Any = _BUILTIN_DEFAULT_WRAPPER_CLASS
     logger_factory: Callable[
         ..., WrappedLogger
@@ -87,7 +79,7 @@ def is_configured() -> bool:
     return _CONFIG.is_configured
 
 
-def get_config() -> Dict[str, Any]:
+def get_config() -> dict[str, Any]:
     """
     Get a dictionary with the current configuration.
 
@@ -146,12 +138,12 @@ def get_logger(*args: Any, **initial_values: Any) -> Any:
 
 def wrap_logger(
     logger: WrappedLogger,
-    processors: Optional[Iterable[Processor]] = None,
-    wrapper_class: Optional[Type[BindableLogger]] = None,
-    context_class: Optional[Type[Context]] = None,
-    cache_logger_on_first_use: Optional[bool] = None,
-    logger_factory_args: Optional[Iterable[Any]] = None,
-    **initial_values: Any
+    processors: Iterable[Processor] | None = None,
+    wrapper_class: type[BindableLogger] | None = None,
+    context_class: type[Context] | None = None,
+    cache_logger_on_first_use: bool | None = None,
+    logger_factory_args: Iterable[Any] | None = None,
+    **initial_values: Any,
 ) -> Any:
     """
     Create a new bound logger for an arbitrary *logger*.
@@ -189,11 +181,11 @@ def wrap_logger(
 
 
 def configure(
-    processors: Optional[Iterable[Processor]] = None,
-    wrapper_class: Optional[Type[BindableLogger]] = None,
-    context_class: Optional[Type[Context]] = None,
-    logger_factory: Optional[Callable[..., WrappedLogger]] = None,
-    cache_logger_on_first_use: Optional[bool] = None,
+    processors: Iterable[Processor] | None = None,
+    wrapper_class: type[BindableLogger] | None = None,
+    context_class: type[Context] | None = None,
+    logger_factory: Callable[..., WrappedLogger] | None = None,
+    cache_logger_on_first_use: bool | None = None,
 ) -> None:
     """
     Configures the **global** defaults.
@@ -239,11 +231,11 @@ def configure(
 
 
 def configure_once(
-    processors: Optional[Iterable[Processor]] = None,
-    wrapper_class: Optional[Type[BindableLogger]] = None,
-    context_class: Optional[Type[Context]] = None,
-    logger_factory: Optional[Callable[..., WrappedLogger]] = None,
-    cache_logger_on_first_use: Optional[bool] = None,
+    processors: Iterable[Processor] | None = None,
+    wrapper_class: type[BindableLogger] | None = None,
+    context_class: type[Context] | None = None,
+    logger_factory: Callable[..., WrappedLogger] | None = None,
+    cache_logger_on_first_use: bool | None = None,
 ) -> None:
     """
     Configures if structlog isn't configured yet.
@@ -298,11 +290,11 @@ class BoundLoggerLazyProxy:
     def __init__(
         self,
         logger: WrappedLogger,
-        wrapper_class: Optional[Type[BindableLogger]] = None,
-        processors: Optional[Iterable[Processor]] = None,
-        context_class: Optional[Type[Context]] = None,
-        cache_logger_on_first_use: Optional[bool] = None,
-        initial_values: Optional[Dict[str, Any]] = None,
+        wrapper_class: type[BindableLogger] | None = None,
+        processors: Iterable[Processor] | None = None,
+        context_class: type[Context] | None = None,
+        cache_logger_on_first_use: bool | None = None,
+        initial_values: dict[str, Any] | None = None,
         logger_factory_args: Any = None,
     ) -> None:
         self._logger = logger
@@ -398,13 +390,13 @@ def __getattr__(self, name: str) -> Any:
 
         return getattr(bl, name)
 
-    def __getstate__(self) -> Dict[str, Any]:
+    def __getstate__(self) -> dict[str, Any]:
         """
         Our __getattr__ magic makes this necessary.
         """
         return self.__dict__
 
-    def __setstate__(self, state: Dict[str, Any]) -> None:
+    def __setstate__(self, state: dict[str, Any]) -> None:
         """
         Our __getattr__ magic makes this necessary.
         """

src/structlog/_frames.py

@@ -3,12 +3,13 @@
 # 2.0, and the MIT License.  See the LICENSE file in the root of this
 # repository for complete details.
 
+from __future__ import annotations
+
 import sys
 import traceback
 
 from io import StringIO
 from types import FrameType
-from typing import List, Optional, Tuple
 
 from .types import ExcInfo
 
@@ -31,8 +32,8 @@ def _format_exception(exc_info: ExcInfo) -> str:
 
 
 def _find_first_app_frame_and_name(
-    additional_ignores: Optional[List[str]] = None,
-) -> Tuple[FrameType, str]:
+    additional_ignores: list[str] | None = None,
+) -> tuple[FrameType, str]:
     """
     Remove all intra-structlog calls and return the relevant app frame.
 

src/structlog/_generic.py

@@ -7,8 +7,10 @@
 Generic bound logger that can wrap anything.
 """
 
+from __future__ import annotations
+
 from functools import partial
-from typing import Any, Dict
+from typing import Any
 
 from structlog._base import BoundLoggerBase
 
@@ -38,13 +40,13 @@ def __getattr__(self, method_name: str) -> Any:
 
         return wrapped
 
-    def __getstate__(self) -> Dict[str, Any]:
+    def __getstate__(self) -> dict[str, Any]:
         """
         Our __getattr__ magic makes this necessary.
         """
         return self.__dict__
 
-    def __setstate__(self, state: Dict[str, Any]) -> None:
+    def __setstate__(self, state: dict[str, Any]) -> None:
         """
         Our __getattr__ magic makes this necessary.
         """

src/structlog/_greenlets.py

@@ -9,6 +9,8 @@
 Fails to import if not running under greenlet.
 """
 
+from __future__ import annotations
+
 from typing import Any
 from weakref import WeakKeyDictionary
 

src/structlog/_log_levels.py

@@ -7,9 +7,11 @@
 Extracted log level data used by both stdlib and native log level filters.
 """
 
+from __future__ import annotations
+
 import logging
 
-from typing import Any, Callable, Dict, Type
+from typing import Any, Callable
 
 from ._base import BoundLoggerBase
 from .types import EventDict, FilteringBoundLogger
@@ -77,7 +79,7 @@ def exception(self: FilteringBoundLogger, event: str, **kw: Any) -> Any:
     return self.error(event, **kw)
 
 
-def make_filtering_bound_logger(min_level: int) -> Type[FilteringBoundLogger]:
+def make_filtering_bound_logger(min_level: int) -> type[FilteringBoundLogger]:
     """
     Create a new `FilteringBoundLogger` that only logs *min_level* or higher.
 
@@ -110,7 +112,7 @@ def make_filtering_bound_logger(min_level: int) -> Type[FilteringBoundLogger]:
     return _LEVEL_TO_FILTERING_LOGGER[min_level]
 
 
-def _make_filtering_bound_logger(min_level: int) -> Type[FilteringBoundLogger]:
+def _make_filtering_bound_logger(min_level: int) -> type[FilteringBoundLogger]:
     """
     Create a new `FilteringBoundLogger` that only logs *min_level* or higher.
 
@@ -137,7 +139,7 @@ def log(self: Any, level: int, event: str, **kw: Any) -> Any:
         name = _LEVEL_TO_NAME[level]
         return self._proxy_to_logger(name, event, **kw)
 
-    meths: Dict[str, Callable] = {"log": log}
+    meths: dict[str, Callable] = {"log": log}
     for lvl, name in _LEVEL_TO_NAME.items():
         meths[name] = make_method(lvl)
 

src/structlog/_utils.py

@@ -7,6 +7,8 @@
 Generic utilities.
 """
 
+from __future__ import annotations
+
 import errno
 import sys
 

src/structlog/contextvars.py

@@ -15,10 +15,12 @@
 See :doc:`contextvars`.
 """
 
+from __future__ import annotations
+
 import contextlib
 import contextvars
 
-from typing import Any, Dict, Generator, Mapping
+from typing import Any, Generator, Mapping
 
 import structlog
 
@@ -31,10 +33,10 @@
 # For proper isolation, we have to use a dict of ContextVars instead of a
 # single ContextVar with a dict.
 # See https://github.com/hynek/structlog/pull/302 for details.
-_CONTEXT_VARS: Dict[str, contextvars.ContextVar[Any]] = {}
+_CONTEXT_VARS: dict[str, contextvars.ContextVar[Any]] = {}
 
 
-def get_contextvars() -> Dict[str, Any]:
+def get_contextvars() -> dict[str, Any]:
     """
     Return a copy of the ``structlog``-specific context-local context.
 
@@ -50,7 +52,7 @@ def get_contextvars() -> Dict[str, Any]:
     return rv
 
 
-def get_merged_contextvars(bound_logger: BindableLogger) -> Dict[str, Any]:
+def get_merged_contextvars(bound_logger: BindableLogger) -> dict[str, Any]:
     """
     Return a copy of the current context-local context merged with the context
     from *bound_logger*.
@@ -100,7 +102,7 @@ def clear_contextvars() -> None:
             k.set(Ellipsis)
 
 
-def bind_contextvars(**kw: Any) -> "Mapping[str, contextvars.Token[Any]]":
+def bind_contextvars(**kw: Any) -> Mapping[str, contextvars.Token[Any]]:
     r"""
     Put keys and values into the context-local context.
 
@@ -129,7 +131,7 @@ def bind_contextvars(**kw: Any) -> "Mapping[str, contextvars.Token[Any]]":
     return rv
 
 
-def reset_contextvars(**kw: "contextvars.Token[Any]") -> None:
+def reset_contextvars(**kw: contextvars.Token[Any]) -> None:
     r"""
     Reset contextvars corresponding to the given Tokens.