prefect-client 3.1.10__py3-none-any.whl → 3.1.12__py3-none-any.whl

prefect/serializers.py

@@ -11,9 +11,8 @@ All serializers must implement `dumps` and `loads` which convert objects to byte
 bytes to an object respectively.
 """
 
-import abc
 import base64
-from typing import Any, Generic, Optional, Type, Union
+from typing import Any, ClassVar, Generic, Optional, Union, overload
 
 from pydantic import (
     BaseModel,
@@ -54,7 +53,7 @@ def prefect_json_object_encoder(obj: Any) -> Any:
         }
 
 
-def prefect_json_object_decoder(result: dict[str, Any]):
+def prefect_json_object_decoder(result: dict[str, Any]) -> Any:
     """
     `JSONDecoder.object_hook` for decoding objects from JSON when previously encoded
     with `prefect_json_object_encoder`
@@ -70,7 +69,7 @@ def prefect_json_object_decoder(result: dict[str, Any]):
 
 
 @register_base_type
-class Serializer(BaseModel, Generic[D], abc.ABC):
+class Serializer(BaseModel, Generic[D]):
     """
     A serializer that can encode objects of type 'D' into bytes.
     """
@@ -80,10 +79,18 @@ class Serializer(BaseModel, Generic[D], abc.ABC):
         data.setdefault("type", type_string)
         super().__init__(**data)
 
-    def __new__(cls: Type[Self], **kwargs: Any) -> Self:
-        if "type" in kwargs:
+    @overload
+    def __new__(cls, *, type: str, **kwargs: Any) -> "Serializer[Any]":
+        ...
+
+    @overload
+    def __new__(cls, *, type: None = ..., **kwargs: Any) -> Self:
+        ...
+
+    def __new__(cls, **kwargs: Any) -> Union[Self, "Serializer[Any]"]:
+        if type_ := kwargs.get("type"):
             try:
-                subcls = lookup_type(cls, dispatch_key=kwargs["type"])
+                subcls = lookup_type(cls, dispatch_key=type_)
             except KeyError as exc:
                 raise ValidationError.from_exception_data(
                     title=cls.__name__,
@@ -97,15 +104,15 @@ class Serializer(BaseModel, Generic[D], abc.ABC):
 
     type: str
 
-    @abc.abstractmethod
     def dumps(self, obj: D) -> bytes:
         """Encode the object into a blob of bytes."""
+        raise NotImplementedError
 
-    @abc.abstractmethod
     def loads(self, blob: bytes) -> D:
         """Decode the blob of bytes into an object."""
+        raise NotImplementedError
 
-    model_config = ConfigDict(extra="forbid")
+    model_config: ClassVar[ConfigDict] = ConfigDict(extra="forbid")
 
     @classmethod
     def __dispatch_key__(cls) -> Optional[str]:
@@ -113,7 +120,7 @@ class Serializer(BaseModel, Generic[D], abc.ABC):
         return type_str if isinstance(type_str, str) else None
 
 
-class PickleSerializer(Serializer):
+class PickleSerializer(Serializer[D]):
     """
     Serializes objects using the pickle protocol.
 
@@ -132,17 +139,17 @@ class PickleSerializer(Serializer):
     def check_picklelib(cls, value: str) -> str:
         return validate_picklelib(value)
 
-    def dumps(self, obj: Any) -> bytes:
+    def dumps(self, obj: D) -> bytes:
         pickler = from_qualified_name(self.picklelib)
         blob = pickler.dumps(obj)
         return base64.encodebytes(blob)
 
-    def loads(self, blob: bytes) -> Any:
+    def loads(self, blob: bytes) -> D:
         pickler = from_qualified_name(self.picklelib)
         return pickler.loads(base64.decodebytes(blob))
 
 
-class JSONSerializer(Serializer):
+class JSONSerializer(Serializer[D]):
     """
     Serializes data to JSON.
 
@@ -186,7 +193,7 @@ class JSONSerializer(Serializer):
     ) -> dict[str, Any]:
         return validate_load_kwargs(value)
 
-    def dumps(self, obj: Any) -> bytes:
+    def dumps(self, obj: D) -> bytes:
         json = from_qualified_name(self.jsonlib)
         kwargs = self.dumps_kwargs.copy()
         if self.object_encoder:
@@ -197,7 +204,7 @@ class JSONSerializer(Serializer):
             result = result.encode()
         return result
 
-    def loads(self, blob: bytes) -> Any:
+    def loads(self, blob: bytes) -> D:
         json = from_qualified_name(self.jsonlib)
         kwargs = self.loads_kwargs.copy()
         if self.object_decoder:
@@ -205,7 +212,7 @@ class JSONSerializer(Serializer):
         return json.loads(blob.decode(), **kwargs)
 
 
-class CompressedSerializer(Serializer):
+class CompressedSerializer(Serializer[D]):
     """
     Wraps another serializer, compressing its output.
     Uses `lzma` by default. See `compressionlib` for using alternative libraries.
@@ -219,43 +226,43 @@ class CompressedSerializer(Serializer):
 
     type: str = Field(default="compressed", frozen=True)
 
-    serializer: Serializer
+    serializer: Serializer[D]
     compressionlib: str = "lzma"
 
     @field_validator("serializer", mode="before")
-    def validate_serializer(cls, value: Union[str, Serializer]) -> Serializer:
+    def validate_serializer(cls, value: Union[str, Serializer[D]]) -> Serializer[D]:
         return cast_type_names_to_serializers(value)
 
     @field_validator("compressionlib")
     def check_compressionlib(cls, value: str) -> str:
         return validate_compressionlib(value)
 
-    def dumps(self, obj: Any) -> bytes:
+    def dumps(self, obj: D) -> bytes:
         blob = self.serializer.dumps(obj)
         compressor = from_qualified_name(self.compressionlib)
         return base64.encodebytes(compressor.compress(blob))
 
-    def loads(self, blob: bytes) -> Any:
+    def loads(self, blob: bytes) -> D:
         compressor = from_qualified_name(self.compressionlib)
         uncompressed = compressor.decompress(base64.decodebytes(blob))
         return self.serializer.loads(uncompressed)
 
 
-class CompressedPickleSerializer(CompressedSerializer):
+class CompressedPickleSerializer(CompressedSerializer[D]):
     """
     A compressed serializer preconfigured to use the pickle serializer.
     """
 
     type: str = Field(default="compressed/pickle", frozen=True)
 
-    serializer: Serializer = Field(default_factory=PickleSerializer)
+    serializer: Serializer[D] = Field(default_factory=PickleSerializer)
 
 
-class CompressedJSONSerializer(CompressedSerializer):
+class CompressedJSONSerializer(CompressedSerializer[D]):
     """
     A compressed serializer preconfigured to use the json serializer.
     """
 
     type: str = Field(default="compressed/json", frozen=True)
 
-    serializer: Serializer = Field(default_factory=JSONSerializer)
+    serializer: Serializer[D] = Field(default_factory=JSONSerializer)

prefect/settings/legacy.py

@@ -23,9 +23,9 @@ class Setting:
         self._default = default
         self._type = type_
         if accessor is None:
-            self.accessor = _env_var_to_accessor(name)
+            self.accessor: str = _env_var_to_accessor(name)
         else:
-            self.accessor = accessor
+            self.accessor: str = accessor
 
     @property
     def name(self):
@@ -58,7 +58,7 @@ class Setting:
 
         return self.value_from(get_current_settings())
 
-    def value_from(self: Self, settings: "Settings") -> Any:
+    def value_from(self: Self, settings: Settings) -> Any:
         path = self.accessor.split(".")
         current_value = settings
         for key in path:
@@ -97,7 +97,7 @@ def _get_valid_setting_names(cls: type[BaseSettings]) -> Set[str]:
     """
     A set of valid setting names, e.g. "PREFECT_API_URL" or "PREFECT_API_KEY".
     """
-    settings_fields = set()
+    settings_fields: set[str] = set()
     for field_name, field in cls.model_fields.items():
         if inspect.isclass(field.annotation) and issubclass(
             field.annotation, PrefectBaseSettings

prefect/settings/models/api.py

@@ -1,7 +1,7 @@
 import os
-from typing import Optional
+from typing import ClassVar, Optional
 
-from pydantic import Field, SecretStr
+from pydantic import ConfigDict, Field, SecretStr
 
 from prefect.settings.base import (
     PrefectBaseSettings,
@@ -14,7 +14,7 @@ class APISettings(PrefectBaseSettings):
     Settings for interacting with the Prefect API
     """
 
-    model_config = _build_settings_config(("api",))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("api",))
     url: Optional[str] = Field(
         default=None,
         description="The URL of the Prefect API. If not set, the client will attempt to infer it.",

prefect/settings/models/cli.py

@@ -1,6 +1,6 @@
-from typing import Optional
+from typing import ClassVar, Optional
 
-from pydantic import Field
+from pydantic import ConfigDict, Field
 
 from prefect.settings.base import (
     PrefectBaseSettings,
@@ -13,7 +13,7 @@ class CLISettings(PrefectBaseSettings):
     Settings for controlling CLI behavior
     """
 
-    model_config = _build_settings_config(("cli",))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("cli",))
 
     colors: bool = Field(
         default=True,

prefect/settings/models/client.py

@@ -1,4 +1,6 @@
-from pydantic import AliasChoices, AliasPath, Field
+from typing import ClassVar
+
+from pydantic import AliasChoices, AliasPath, ConfigDict, Field
 
 from prefect.settings.base import (
     PrefectBaseSettings,
@@ -12,7 +14,7 @@ class ClientMetricsSettings(PrefectBaseSettings):
     Settings for controlling metrics reporting from the client
     """
 
-    model_config = _build_settings_config(("client", "metrics"))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("client", "metrics"))
 
     enabled: bool = Field(
         default=False,
@@ -37,7 +39,7 @@ class ClientSettings(PrefectBaseSettings):
     Settings for controlling API client behavior
     """
 
-    model_config = _build_settings_config(("client",))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("client",))
 
     max_retries: int = Field(
         default=5,

prefect/settings/models/cloud.py

@@ -1,7 +1,7 @@
 import re
-from typing import Optional
+from typing import ClassVar, Optional
 
-from pydantic import Field, model_validator
+from pydantic import ConfigDict, Field, model_validator
 from typing_extensions import Self
 
 from prefect.settings.base import (
@@ -32,13 +32,18 @@ class CloudSettings(PrefectBaseSettings):
     Settings for interacting with Prefect Cloud
     """
 
-    model_config = _build_settings_config(("cloud",))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("cloud",))
 
     api_url: str = Field(
         default="https://api.prefect.cloud/api",
         description="API URL for Prefect Cloud. Used for authentication with Prefect Cloud.",
     )
 
+    enable_orchestration_telemetry: bool = Field(
+        default=True,
+        description="Whether or not to enable orchestration telemetry.",
+    )
+
     ui_url: Optional[str] = Field(
         default=None,
         description="The URL of the Prefect Cloud UI. If not set, the client will attempt to infer it.",

prefect/settings/models/deployments.py

@@ -1,6 +1,6 @@
-from typing import Optional
+from typing import ClassVar, Optional
 
-from pydantic import AliasChoices, AliasPath, Field
+from pydantic import AliasChoices, AliasPath, ConfigDict, Field
 
 from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
@@ -10,7 +10,7 @@ class DeploymentsSettings(PrefectBaseSettings):
     Settings for configuring deployments defaults
     """
 
-    model_config = _build_settings_config(("deployments",))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("deployments",))
 
     default_work_pool_name: Optional[str] = Field(
         default=None,

prefect/settings/models/experiments.py

@@ -1,4 +1,6 @@
-from pydantic import AliasChoices, AliasPath, Field
+from typing import ClassVar
+
+from pydantic import AliasChoices, AliasPath, ConfigDict, Field
 
 from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
@@ -8,7 +10,7 @@ class ExperimentsSettings(PrefectBaseSettings):
     Settings for configuring experimental features
     """
 
-    model_config = _build_settings_config(("experiments",))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("experiments",))
 
     warn: bool = Field(
         default=True,
@@ -18,11 +20,6 @@ class ExperimentsSettings(PrefectBaseSettings):
         ),
     )
 
-    telemetry_enabled: bool = Field(
-        default=False,
-        description="Enables sending telemetry to Prefect Cloud.",
-    )
-
     lineage_events_enabled: bool = Field(
         default=False,
         description="If `True`, enables emitting lineage events. Set to `False` to disable lineage event emission.",

prefect/settings/models/flows.py

@@ -1,6 +1,6 @@
-from typing import Union
+from typing import ClassVar, Union
 
-from pydantic import AliasChoices, AliasPath, Field
+from pydantic import AliasChoices, AliasPath, ConfigDict, Field
 
 from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
@@ -10,7 +10,7 @@ class FlowsSettings(PrefectBaseSettings):
     Settings for controlling flow behavior
     """
 
-    model_config = _build_settings_config(("flows",))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("flows",))
 
     default_retries: int = Field(
         default=0,

prefect/settings/models/internal.py

@@ -1,11 +1,13 @@
-from pydantic import AliasChoices, AliasPath, Field
+from typing import ClassVar
+
+from pydantic import AliasChoices, AliasPath, ConfigDict, Field
 
 from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 from prefect.types import LogLevel
 
 
 class InternalSettings(PrefectBaseSettings):
-    model_config = _build_settings_config(("internal",))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("internal",))
 
     logging_level: LogLevel = Field(
         default="ERROR",

prefect/settings/models/logging.py

@@ -1,11 +1,12 @@
 from functools import partial
 from pathlib import Path
-from typing import Annotated, Literal, Optional, Union
+from typing import Annotated, ClassVar, Literal, Optional, Union
 
 from pydantic import (
     AliasChoices,
     AliasPath,
     BeforeValidator,
+    ConfigDict,
     Field,
     model_validator,
 )
@@ -32,7 +33,7 @@ class LoggingToAPISettings(PrefectBaseSettings):
     Settings for controlling logging to the API
     """
 
-    model_config = _build_settings_config(("logging", "to_api"))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("logging", "to_api"))
 
     enabled: bool = Field(
         default=True,
@@ -85,7 +86,7 @@ class LoggingSettings(PrefectBaseSettings):
     Settings for controlling logging behavior
     """
 
-    model_config = _build_settings_config(("logging",))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("logging",))
 
     level: LogLevel = Field(
         default="INFO",

prefect/settings/models/results.py

@@ -1,7 +1,7 @@
 from pathlib import Path
-from typing import Optional
+from typing import ClassVar, Optional
 
-from pydantic import AliasChoices, AliasPath, Field
+from pydantic import AliasChoices, AliasPath, ConfigDict, Field
 
 from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
@@ -11,7 +11,7 @@ class ResultsSettings(PrefectBaseSettings):
     Settings for controlling result storage behavior
     """
 
-    model_config = _build_settings_config(("results",))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("results",))
 
     default_serializer: str = Field(
         default="pickle",

prefect/settings/models/root.py

@@ -4,13 +4,14 @@ from typing import (
     TYPE_CHECKING,
     Annotated,
     Any,
+    ClassVar,
     Iterable,
     Mapping,
     Optional,
 )
 from urllib.parse import urlparse
 
-from pydantic import BeforeValidator, Field, SecretStr, model_validator
+from pydantic import BeforeValidator, ConfigDict, Field, SecretStr, model_validator
 from typing_extensions import Self
 
 from prefect.settings.base import PrefectBaseSettings, _build_settings_config
@@ -43,7 +44,7 @@ class Settings(PrefectBaseSettings):
     See https://docs.pydantic.dev/latest/concepts/pydantic_settings
     """
 
-    model_config = _build_settings_config()
+    model_config: ClassVar[ConfigDict] = _build_settings_config()
 
     home: Annotated[Path, BeforeValidator(lambda x: Path(x).expanduser())] = Field(
         default=Path("~") / ".prefect",

prefect/settings/models/runner.py

@@ -1,6 +1,6 @@
-from typing import Optional
+from typing import ClassVar, Optional
 
-from pydantic import Field
+from pydantic import ConfigDict, Field
 
 from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 from prefect.types import LogLevel
@@ -11,7 +11,7 @@ class RunnerServerSettings(PrefectBaseSettings):
     Settings for controlling runner server behavior
     """
 
-    model_config = _build_settings_config(("runner", "server"))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("runner", "server"))
 
     enable: bool = Field(
         default=False,
@@ -44,7 +44,7 @@ class RunnerSettings(PrefectBaseSettings):
     Settings for controlling runner behavior
     """
 
-    model_config = _build_settings_config(("runner",))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("runner",))
 
     process_limit: int = Field(
         default=5,

prefect/settings/models/server/api.py

@@ -1,7 +1,7 @@
 from datetime import timedelta
-from typing import Optional
+from typing import ClassVar, Optional
 
-from pydantic import AliasChoices, AliasPath, Field, SecretStr
+from pydantic import AliasChoices, AliasPath, ConfigDict, Field, SecretStr
 
 from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
@@ -11,7 +11,7 @@ class ServerAPISettings(PrefectBaseSettings):
     Settings for controlling API server behavior
     """
 
-    model_config = _build_settings_config(("server", "api"))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("server", "api"))
 
     auth_string: Optional[SecretStr] = Field(
         default=None,

prefect/settings/models/server/database.py

@@ -1,8 +1,15 @@
 import warnings
-from typing import Optional
+from typing import ClassVar, Optional
 from urllib.parse import quote_plus
 
-from pydantic import AliasChoices, AliasPath, Field, SecretStr, model_validator
+from pydantic import (
+    AliasChoices,
+    AliasPath,
+    ConfigDict,
+    Field,
+    SecretStr,
+    model_validator,
+)
 from typing_extensions import Literal, Self
 
 from prefect.settings.base import PrefectBaseSettings, _build_settings_config
@@ -13,7 +20,7 @@ class ServerDatabaseSettings(PrefectBaseSettings):
     Settings for controlling server database behavior
     """
 
-    model_config = _build_settings_config(("server", "database"))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("server", "database"))
 
     connection_url: Optional[SecretStr] = Field(
         default=None,
@@ -130,7 +137,7 @@ class ServerDatabaseSettings(PrefectBaseSettings):
     )
 
     connection_timeout: Optional[float] = Field(
-        default=5,
+        default=5.0,
         description="A connection timeout, in seconds, applied to database connections. Defaults to `5`.",
         validation_alias=AliasChoices(
             AliasPath("connection_timeout"),

prefect/settings/models/server/deployments.py

@@ -1,10 +1,14 @@
-from pydantic import AliasChoices, AliasPath, Field
+from typing import ClassVar
+
+from pydantic import AliasChoices, AliasPath, ConfigDict, Field
 
 from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
 
 class ServerDeploymentsSettings(PrefectBaseSettings):
-    model_config = _build_settings_config(("server", "deployments"))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(
+        ("server", "deployments")
+    )
 
     concurrency_slot_wait_seconds: float = Field(
         default=30.0,

prefect/settings/models/server/ephemeral.py

@@ -1,4 +1,6 @@
-from pydantic import AliasChoices, AliasPath, Field
+from typing import ClassVar
+
+from pydantic import AliasChoices, AliasPath, ConfigDict, Field
 
 from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
@@ -8,7 +10,7 @@ class ServerEphemeralSettings(PrefectBaseSettings):
     Settings for controlling ephemeral server behavior
     """
 
-    model_config = _build_settings_config(("server", "ephemeral"))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("server", "ephemeral"))
 
     enabled: bool = Field(
         default=False,

prefect/settings/models/server/events.py

@@ -1,6 +1,7 @@
 from datetime import timedelta
+from typing import ClassVar
 
-from pydantic import AliasChoices, AliasPath, Field
+from pydantic import AliasChoices, AliasPath, ConfigDict, Field
 
 from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
@@ -10,7 +11,7 @@ class ServerEventsSettings(PrefectBaseSettings):
     Settings for controlling behavior of the events subsystem
     """
 
-    model_config = _build_settings_config(("server", "events"))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("server", "events"))
 
     ###########################################################################
     # Events settings

prefect/settings/models/server/flow_run_graph.py

@@ -1,4 +1,6 @@
-from pydantic import AliasChoices, AliasPath, Field
+from typing import ClassVar
+
+from pydantic import AliasChoices, AliasPath, ConfigDict, Field
 
 from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 
@@ -8,7 +10,9 @@ class ServerFlowRunGraphSettings(PrefectBaseSettings):
     Settings for controlling behavior of the flow run graph
     """
 
-    model_config = _build_settings_config(("server", "flow_run_graph"))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(
+        ("server", "flow_run_graph")
+    )
 
     max_nodes: int = Field(
         default=10000,

prefect/settings/models/server/root.py

@@ -1,7 +1,7 @@
 from pathlib import Path
-from typing import Optional
+from typing import ClassVar, Optional
 
-from pydantic import AliasChoices, AliasPath, Field
+from pydantic import AliasChoices, AliasPath, ConfigDict, Field
 
 from prefect.settings.base import PrefectBaseSettings, _build_settings_config
 from prefect.types import LogLevel
@@ -22,7 +22,7 @@ class ServerSettings(PrefectBaseSettings):
     Settings for controlling server behavior
     """
 
-    model_config = _build_settings_config(("server",))
+    model_config: ClassVar[ConfigDict] = _build_settings_config(("server",))
 
     logging_level: LogLevel = Field(
         default="WARNING",