prefect-client 3.1.11__py3-none-any.whl → 3.1.13__py3-none-any.whl

prefect/logging/loggers.py

@@ -1,3 +1,5 @@
+from __future__ import annotations
+
 import io
 import logging
 import sys
@@ -5,7 +7,7 @@ from builtins import print
 from contextlib import contextmanager
 from functools import lru_cache
 from logging import LogRecord
-from typing import TYPE_CHECKING, Any, Dict, List, Optional, Union
+from typing import TYPE_CHECKING, Any, List, Mapping, MutableMapping, Optional, Union
 
 from typing_extensions import Self
 
@@ -13,6 +15,14 @@ from prefect.exceptions import MissingContextError
 from prefect.logging.filters import ObfuscateApiKeyFilter
 from prefect.telemetry.logging import add_telemetry_log_handler
 
+if sys.version_info >= (3, 12):
+    LoggingAdapter = logging.LoggerAdapter[logging.Logger]
+else:
+    if TYPE_CHECKING:
+        LoggingAdapter = logging.LoggerAdapter[logging.Logger]
+    else:
+        LoggingAdapter = logging.LoggerAdapter
+
 if TYPE_CHECKING:
     from prefect.client.schemas import FlowRun as ClientFlowRun
     from prefect.client.schemas.objects import FlowRun, TaskRun
@@ -21,11 +31,6 @@ if TYPE_CHECKING:
     from prefect.tasks import Task
     from prefect.workers.base import BaseWorker
 
-if sys.version_info >= (3, 12):
-    LoggingAdapter = logging.LoggerAdapter[logging.Logger]
-else:
-    LoggingAdapter = logging.LoggerAdapter
-
 
 class PrefectLogAdapter(LoggingAdapter):
     """
@@ -37,27 +42,28 @@ class PrefectLogAdapter(LoggingAdapter):
     not a bug in the LoggingAdapter and subclassing is the intended workaround.
     """
 
-    def process(self, msg, kwargs):
+    def process(
+        self, msg: str, kwargs: MutableMapping[str, Any]
+    ) -> tuple[str, MutableMapping[str, Any]]:
         kwargs["extra"] = {**(self.extra or {}), **(kwargs.get("extra") or {})}
         return (msg, kwargs)
 
     def getChild(
-        self, suffix: str, extra: Optional[Dict[str, str]] = None
+        self, suffix: str, extra: dict[str, Any] | None = None
     ) -> "PrefectLogAdapter":
-        if extra is None:
-            extra = {}
+        _extra: Mapping[str, object] = extra or {}
 
         return PrefectLogAdapter(
             self.logger.getChild(suffix),
             extra={
-                **self.extra,
-                **extra,
+                **(self.extra or {}),
+                **_extra,
             },
         )
 
 
 @lru_cache()
-def get_logger(name: Optional[str] = None) -> logging.Logger:
+def get_logger(name: str | None = None) -> logging.Logger:
     """
     Get a `prefect` logger. These loggers are intended for internal use within the
     `prefect` package.
@@ -161,7 +167,7 @@ def flow_run_logger(
     flow_run: Union["FlowRun", "ClientFlowRun"],
     flow: Optional["Flow[Any, Any]"] = None,
     **kwargs: str,
-) -> LoggingAdapter:
+) -> PrefectLogAdapter:
     """
     Create a flow run logger with the run's metadata attached.
 
@@ -189,7 +195,7 @@ def task_run_logger(
     flow_run: Optional["FlowRun"] = None,
     flow: Optional["Flow[Any, Any]"] = None,
     **kwargs: Any,
-):
+) -> LoggingAdapter:
     """
     Create a task run logger with the run's metadata attached.
 
@@ -225,7 +231,9 @@ def task_run_logger(
     )
 
 
-def get_worker_logger(worker: "BaseWorker", name: Optional[str] = None):
+def get_worker_logger(
+    worker: "BaseWorker[Any, Any, Any]", name: Optional[str] = None
+) -> logging.Logger | LoggingAdapter:
     """
     Create a worker logger with the worker's metadata attached.
 
@@ -361,7 +369,9 @@ class LogEavesdropper(logging.Handler):
         # It's important that we use a very minimalistic formatter for use cases where
         # we may present these logs back to the user.  We shouldn't leak filenames,
         # versions, or other environmental information.
-        self.formatter = logging.Formatter("[%(levelname)s]: %(message)s")
+        self.formatter: logging.Formatter | None = logging.Formatter(
+            "[%(levelname)s]: %(message)s"
+        )
 
     def __enter__(self) -> Self:
         self._target_logger = logging.getLogger(self.eavesdrop_on)
@@ -371,7 +381,7 @@ class LogEavesdropper(logging.Handler):
         self._lines = []
         return self
 
-    def __exit__(self, *_):
+    def __exit__(self, *_: Any) -> None:
         if self._target_logger:
             self._target_logger.removeHandler(self)
             self._target_logger.level = self._original_level

prefect/logging/logging.yml

@@ -32,7 +32,7 @@ formatters:
 # Define any custom filters to drops records containing
 # sensitive information
 # my_filter:
-# class: your_module.FilterClass
+# (): your_module.FilterClass
 
 handlers:
   # The handlers we define here will output all logs they receive by default

prefect/main.py

@@ -3,7 +3,7 @@ from typing import Any
 from prefect.deployments import deploy
 from prefect.states import State
 from prefect.logging import get_run_logger
-from prefect.flows import flow, Flow, serve, aserve
+from prefect.flows import FlowDecorator, flow, Flow, serve, aserve
 from prefect.transactions import Transaction
 from prefect.tasks import task, Task
 from prefect.context import tags
@@ -58,6 +58,8 @@ from prefect._internal.compatibility.deprecated import (
 
 inject_renamed_module_alias_finder()
 
+flow: FlowDecorator
+
 
 # Declare API for type-checkers
 __all__ = [