prefect-client 2.19.4__py3-none-any.whl → 3.0.0rc2__py3-none-any.whl

prefect/settings.py

@@ -65,36 +65,22 @@ from typing import (
 )
 from urllib.parse import urlparse
 
+import pydantic
 import toml
-
-from prefect._internal.pydantic import HAS_PYDANTIC_V2
-from prefect._internal.schemas.validators import validate_settings
-
-if HAS_PYDANTIC_V2:
-    from pydantic.v1 import (
-        BaseModel,
-        BaseSettings,
-        Field,
-        create_model,
-        fields,
-        root_validator,
-        validator,
-    )
-else:
-    from pydantic import (
-        BaseModel,
-        BaseSettings,
-        Field,
-        create_model,
-        fields,
-        root_validator,
-        validator,
-    )
-
+from pydantic import (
+    BaseModel,
+    ConfigDict,
+    Field,
+    create_model,
+    field_validator,
+    fields,
+    model_validator,
+)
+from pydantic_settings import BaseSettings, SettingsConfigDict
 from typing_extensions import Literal
 
 from prefect._internal.compatibility.deprecated import generate_deprecation_message
-from prefect._internal.pydantic import HAS_PYDANTIC_V2
+from prefect._internal.schemas.validators import validate_settings
 from prefect.exceptions import MissingProfileError
 from prefect.utilities.names import OBFUSCATED_PREFIX, obfuscate
 from prefect.utilities.pydantic import add_cloudpickle_reduction
@@ -104,13 +90,19 @@ T = TypeVar("T")
 
 DEFAULT_PROFILES_PATH = Path(__file__).parent.joinpath("profiles.toml")
 
+# When we remove the experimental settings we also want to add them to the set of REMOVED_EXPERIMENTAL_FLAGS.
+# The reason for this is removing the settings entirely causes the CLI to crash for anyone who has them in one or more of their profiles.
+# Adding them to REMOVED_EXPERIMENTAL_FLAGS will make it so that the user is warned about it and they have time to take action.
 REMOVED_EXPERIMENTAL_FLAGS = {
     "PREFECT_EXPERIMENTAL_ENABLE_ENHANCED_SCHEDULING_UI",
     "PREFECT_EXPERIMENTAL_ENABLE_ENHANCED_DEPLOYMENT_PARAMETERS",
     "PREFECT_EXPERIMENTAL_ENABLE_EVENTS_CLIENT",
+    "PREFECT_EXPERIMENTAL_ENABLE_EVENTS",
+    "PREFECT_EXPERIMENTAL_EVENTS",
     "PREFECT_EXPERIMENTAL_WARN_EVENTS_CLIENT",
     "PREFECT_EXPERIMENTAL_ENABLE_FLOW_RUN_INFRA_OVERRIDES",
     "PREFECT_EXPERIMENTAL_WARN_FLOW_RUN_INFRA_OVERRIDES",
+    "PREFECT_EXPERIMENTAL_ENABLE_WORK_POOLS",
 }
 
 
@@ -245,7 +237,7 @@ class Setting(Generic[T]):
         )
 
     def __repr__(self) -> str:
-        return f"<{self.name}: {self.type.__name__}>"
+        return f"<{self.name}: {self.type!r}>"
 
     def __bool__(self) -> bool:
         """
@@ -386,21 +378,6 @@ def warn_on_database_password_value_without_usage(values):
     return values
 
 
-def check_for_deprecated_cloud_url(settings, value):
-    deprecated_value = PREFECT_CLOUD_URL.value_from(settings, bypass_callback=True)
-    if deprecated_value is not None:
-        warnings.warn(
-            (
-                "`PREFECT_CLOUD_URL` is set and will be used instead of"
-                " `PREFECT_CLOUD_API_URL` for backwards compatibility."
-                " `PREFECT_CLOUD_URL` is deprecated, set `PREFECT_CLOUD_API_URL`"
-                " instead."
-            ),
-            DeprecationWarning,
-        )
-    return deprecated_value or value
-
-
 def warn_on_misconfigured_api_url(values):
     """
     Validator for settings warning if the API URL is misconfigured.
@@ -610,7 +587,7 @@ This is recommended only during development, e.g. when using self-signed certifi
 """
 
 PREFECT_API_SSL_CERT_FILE = Setting(
-    str,
+    Optional[str],
     default=os.environ.get("SSL_CERT_FILE"),
 )
 """
@@ -620,7 +597,7 @@ If left unset, the setting will default to the value provided by the `SSL_CERT_F
 """
 
 PREFECT_API_URL = Setting(
-    str,
+    Optional[str],
     default=None,
 )
 """
@@ -639,7 +616,7 @@ we would like to silence this warning so we will set it to `FALSE`.
 """
 
 PREFECT_API_KEY = Setting(
-    str,
+    Optional[str],
     default=None,
     is_secret=True,
 )
@@ -702,22 +679,10 @@ Defaults to `True`, ensuring CSRF protection is enabled by default.
 PREFECT_CLOUD_API_URL = Setting(
     str,
     default="https://api.prefect.cloud/api",
-    value_callback=check_for_deprecated_cloud_url,
 )
 """API URL for Prefect Cloud. Used for authentication."""
 
 
-PREFECT_CLOUD_URL = Setting(
-    str,
-    default=None,
-    deprecated=True,
-    deprecated_start_date="Dec 2022",
-    deprecated_help="Use `PREFECT_CLOUD_API_URL` instead.",
-)
-"""
-DEPRECATED: Use `PREFECT_CLOUD_API_URL` instead.
-"""
-
 PREFECT_UI_URL = Setting(
     Optional[str],
     default=None,
@@ -732,7 +697,7 @@ When using an ephemeral server, this will be `None`.
 
 
 PREFECT_CLOUD_UI_URL = Setting(
-    str,
+    Optional[str],
     default=None,
     value_callback=default_cloud_ui_url,
 )
@@ -946,7 +911,7 @@ The following options are available:
 """
 
 PREFECT_SQLALCHEMY_POOL_SIZE = Setting(
-    int,
+    Optional[int],
     default=None,
 )
 """
@@ -954,7 +919,7 @@ Controls connection pool size when using a PostgreSQL database with the Prefect
 """
 
 PREFECT_SQLALCHEMY_MAX_OVERFLOW = Setting(
-    int,
+    Optional[int],
     default=None,
 )
 """
@@ -1040,7 +1005,7 @@ registered.
 """
 
 PREFECT_API_DATABASE_PASSWORD = Setting(
-    str,
+    Optional[str],
     default=None,
     is_secret=True,
 )
@@ -1051,7 +1016,7 @@ To use this setting, you must include it in your connection URL.
 """
 
 PREFECT_API_DATABASE_CONNECTION_URL = Setting(
-    str,
+    Optional[str],
     default=None,
     value_callback=default_database_connection_url,
     is_secret=True,
@@ -1243,6 +1208,9 @@ PREFECT_API_SERVICES_FOREMAN_WORK_QUEUE_LAST_POLLED_TIMEOUT_SECONDS = Setting(
 """The number of seconds before a work queue is marked as not ready if it has not been
 polled."""
 
+PREFECT_API_LOG_RETRYABLE_ERRORS = Setting(bool, default=False)
+"""If `True`, log retryable errors in the API and it's services."""
+
 
 PREFECT_API_DEFAULT_LIMIT = Setting(
     int,
@@ -1313,7 +1281,7 @@ PREFECT_UI_ENABLED = Setting(
 """Whether or not to serve the Prefect UI."""
 
 PREFECT_UI_API_URL = Setting(
-    str,
+    Optional[str],
     default=None,
     value_callback=default_ui_api_url,
 )
@@ -1401,16 +1369,6 @@ PREFECT_EXPERIMENTAL_ENABLE_STATES_ON_FLOW_RUN_GRAPH = Setting(bool, default=Tru
 Whether or not to enable flow run states on the flow run graph.
 """
 
-PREFECT_EXPERIMENTAL_ENABLE_WORK_POOLS = Setting(bool, default=True)
-"""
-Whether or not to enable experimental Prefect work pools.
-"""
-
-PREFECT_EXPERIMENTAL_WARN_WORK_POOLS = Setting(bool, default=False)
-"""
-Whether or not to warn when experimental Prefect work pools are used.
-"""
-
 PREFECT_EXPERIMENTAL_ENABLE_WORKERS = Setting(bool, default=True)
 """
 Whether or not to enable experimental Prefect workers.
@@ -1459,13 +1417,6 @@ Whether or not to enable flow run input.
 
 # Prefect Events feature flags
 
-PREFECT_EXPERIMENTAL_EVENTS = Setting(bool, default=False)
-"""
-Whether to enable Prefect's server-side event features. Note that Prefect Cloud clients
-will always emit events during flow and task runs regardless of this setting.
-"""
-
-
 PREFECT_RUNNER_PROCESS_LIMIT = Setting(int, default=5)
 """
 Maximum number of processes a runner will execute in parallel.
@@ -1538,6 +1489,11 @@ PREFECT_WORKER_WEBSERVER_PORT = Setting(
 The port the worker's webserver should bind to.
 """
 
+PREFECT_API_SERVICES_TASK_SCHEDULING_ENABLED = Setting(bool, default=True)
+"""
+Whether or not to start the task scheduling service in the server application.
+"""
+
 PREFECT_TASK_SCHEDULING_DEFAULT_STORAGE_BLOCK = Setting(
     str,
     default="local-file-system/prefect-task-scheduling",
@@ -1574,9 +1530,9 @@ PREFECT_TASK_SCHEDULING_PENDING_TASK_TIMEOUT = Setting(
     default=timedelta(seconds=30),
 )
 """
-How long before a PENDING task are made available to another task server.  In practice,
-a task server should move a task from PENDING to RUNNING very quickly, so runs stuck in
-PENDING for a while is a sign that the task server may have crashed.
+How long before a PENDING task are made available to another task worker.  In practice,
+a task worker should move a task from PENDING to RUNNING very quickly, so runs stuck in
+PENDING for a while is a sign that the task worker may have crashed.
 """
 
 PREFECT_EXPERIMENTAL_ENABLE_EXTRA_RUNNER_ENDPOINTS = Setting(bool, default=False)
@@ -1604,42 +1560,33 @@ PREFECT_EXPERIMENTAL_WARN_WORKSPACE_DASHBOARD = Setting(bool, default=False)
 Whether or not to warn when the experimental workspace dashboard is enabled.
 """
 
-PREFECT_EXPERIMENTAL_ENABLE_TASK_SCHEDULING = Setting(bool, default=False)
-"""
-Whether or not to enable experimental task scheduling.
-"""
-
 PREFECT_EXPERIMENTAL_ENABLE_WORK_QUEUE_STATUS = Setting(bool, default=True)
 """
 Whether or not to enable experimental work queue status in-place of work queue health.
 """
 
-PREFECT_EXPERIMENTAL_ENABLE_NEW_ENGINE = Setting(bool, default=False)
-"""
-Whether or not to enable experimental new engine.
-"""
-
 PREFECT_EXPERIMENTAL_DISABLE_SYNC_COMPAT = Setting(bool, default=False)
 """
 Whether or not to disable the sync_compatible decorator utility.
 """
 
+PREFECT_EXPERIMENTAL_ENABLE_SCHEDULE_CONCURRENCY = Setting(bool, default=False)
 
 # Defaults -----------------------------------------------------------------------------
 
 PREFECT_DEFAULT_RESULT_STORAGE_BLOCK = Setting(
-    str,
+    Optional[str],
     default=None,
 )
 """The `block-type/block-document` slug of a block to use as the default result storage."""
 
-PREFECT_DEFAULT_WORK_POOL_NAME = Setting(str, default=None)
+PREFECT_DEFAULT_WORK_POOL_NAME = Setting(Optional[str], default=None)
 """
 The default work pool to deploy to.
 """
 
 PREFECT_DEFAULT_DOCKER_BUILD_NAMESPACE = Setting(
-    str,
+    Optional[str],
     default=None,
 )
 """
@@ -1659,7 +1606,7 @@ Defaults to the root path.
 """
 
 PREFECT_UI_STATIC_DIRECTORY = Setting(
-    str,
+    Optional[str],
     default=None,
 )
 """
@@ -1756,16 +1703,6 @@ How long to cache related resource data for emitting server-side vents
 """
 
 
-def automation_settings_enabled() -> bool:
-    """
-    Whether or not automations are enabled.
-    """
-    return (
-        PREFECT_EXPERIMENTAL_EVENTS.value()
-        and PREFECT_API_SERVICES_TRIGGERS_ENABLED.value()
-    )
-
-
 # Deprecated settings ------------------------------------------------------------------
 
 
@@ -1783,10 +1720,14 @@ for __name, __setting in SETTING_VARIABLES.items():
 
 # Dynamically create a pydantic model that includes all of our settings
 
-SettingsFieldsMixin = create_model(
+
+class PrefectBaseSettings(BaseSettings):
+    model_config = SettingsConfigDict(extra="ignore")
+
+
+SettingsFieldsMixin: Type[BaseSettings] = create_model(
     "SettingsFieldsMixin",
-    # Inheriting from `BaseSettings` provides environment variable loading
-    __base__=BaseSettings,
+    __base__=PrefectBaseSettings,  # Inheriting from `BaseSettings` provides environment variable loading
     **{
         setting.name: (setting.type, setting.field)
         for setting in SETTING_VARIABLES.values()
@@ -1828,32 +1769,33 @@ class Settings(SettingsFieldsMixin):
             value = setting.value_callback(self, value)
         return value
 
-    @validator(PREFECT_LOGGING_LEVEL.name, PREFECT_LOGGING_SERVER_LEVEL.name)
+    @field_validator(PREFECT_LOGGING_LEVEL.name, PREFECT_LOGGING_SERVER_LEVEL.name)
     def check_valid_log_level(cls, value):
         if isinstance(value, str):
             value = value.upper()
         logging._checkLevel(value)
         return value
 
-    @root_validator
-    def post_root_validators(cls, values):
+    @model_validator(mode="after")
+    def emit_warnings(self):
         """
         Add root validation functions for settings here.
         """
         # TODO: We could probably register these dynamically but this is the simpler
         #       approach for now. We can explore more interesting validation features
         #       in the future.
+        values = self.model_dump()
         values = max_log_size_smaller_than_batch_size(values)
         values = warn_on_database_password_value_without_usage(values)
         if not values["PREFECT_SILENCE_API_URL_MISCONFIGURATION"]:
             values = warn_on_misconfigured_api_url(values)
-        return values
+        return self
 
     def copy_with_update(
         self,
-        updates: Mapping[Setting, Any] = None,
-        set_defaults: Mapping[Setting, Any] = None,
-        restore_defaults: Iterable[Setting] = None,
+        updates: Optional[Mapping[Setting, Any]] = None,
+        set_defaults: Optional[Mapping[Setting, Any]] = None,
+        restore_defaults: Optional[Iterable[Setting]] = None,
     ) -> "Settings":
         """
         Create a new `Settings` object with validation.
@@ -1876,7 +1818,7 @@ class Settings(SettingsFieldsMixin):
         return self.__class__(
             **{
                 **{setting.name: value for setting, value in set_defaults.items()},
-                **self.dict(exclude_unset=True, exclude=restore_defaults_names),
+                **self.model_dump(exclude_unset=True, exclude=restore_defaults_names),
                 **{setting.name: value for setting, value in updates.items()},
             }
         )
@@ -1885,7 +1827,7 @@ class Settings(SettingsFieldsMixin):
         """
         Returns a copy of this settings object with secret setting values obfuscated.
         """
-        settings = self.copy(
+        settings = self.model_copy(
             update={
                 setting.name: obfuscate(self.value_of(setting))
                 for setting in SETTING_VARIABLES.values()
@@ -1896,7 +1838,11 @@ class Settings(SettingsFieldsMixin):
         )
         # Ensure that settings that have not been marked as "set" before are still so
         # after we have updated their value above
-        settings.__fields_set__.intersection_update(self.__fields_set__)
+        with warnings.catch_warnings():
+            warnings.simplefilter(
+                "ignore", category=pydantic.warnings.PydanticDeprecatedSince20
+            )
+            settings.__fields_set__.intersection_update(self.__fields_set__)
         return settings
 
     def hash_key(self) -> str:
@@ -1908,7 +1854,7 @@ class Settings(SettingsFieldsMixin):
         return str(hash(tuple((key, value) for key, value in env_variables.items())))
 
     def to_environment_variables(
-        self, include: Iterable[Setting] = None, exclude_unset: bool = False
+        self, include: Optional[Iterable[Setting]] = None, exclude_unset: bool = False
     ) -> Dict[str, str]:
         """
         Convert the settings object to environment variables.
@@ -1932,7 +1878,7 @@ class Settings(SettingsFieldsMixin):
             set_keys = {
                 # Collect all of the "set" keys and cast to `Setting` objects
                 SETTING_VARIABLES[key]
-                for key in self.dict(exclude_unset=True)
+                for key in self.model_dump(exclude_unset=True)
             }
             include.intersection_update(set_keys)
 
@@ -1943,23 +1889,19 @@ class Settings(SettingsFieldsMixin):
                     "Invalid type {type(key).__name__!r} for key in `include`."
                 )
 
-        env = {
-            # Use `getattr` instead of `value_of` to avoid value callback resolution
-            key: getattr(self, key)
-            for key, setting in SETTING_VARIABLES.items()
-            if setting in include
-        }
+        env: dict[str, Any] = self.model_dump(
+            mode="json", include={s.name for s in include}
+        )
 
         # Cast to strings and drop null values
         return {key: str(value) for key, value in env.items() if value is not None}
 
-    class Config:
-        frozen = True
+    model_config = ConfigDict(frozen=True)
 
 
 # Functions to instantiate `Settings` instances
 
-_DEFAULTS_CACHE: Settings = None
+_DEFAULTS_CACHE: Optional[Settings] = None
 _FROM_ENV_CACHE: Dict[int, Settings] = {}
 
 
@@ -2066,9 +2008,10 @@ class Profile(BaseModel):
 
     name: str
     settings: Dict[Setting, Any] = Field(default_factory=dict)
-    source: Optional[Path]
+    source: Optional[Path] = None
+    model_config = ConfigDict(extra="ignore", arbitrary_types_allowed=True)
 
-    @validator("settings", pre=True)
+    @field_validator("settings", mode="before")
     def map_names_to_settings(cls, value):
         return validate_settings(value)
 
@@ -2105,9 +2048,6 @@ class Profile(BaseModel):
                 changed.append((setting, setting.deprecated_renamed_to))
         return changed
 
-    class Config:
-        arbitrary_types_allowed = True
-
 
 class ProfilesCollection:
     """ "

prefect/states.py

@@ -13,10 +13,6 @@ from typing_extensions import TypeGuard
 
 from prefect.client.schemas import State as State
 from prefect.client.schemas import StateDetails, StateType
-from prefect.deprecated.data_documents import (
-    DataDocument,
-    result_from_state_with_data_document,
-)
 from prefect.exceptions import (
     CancelledRun,
     CrashedRun,
@@ -47,7 +43,6 @@ def get_state_result(
     ):
         # Fetch defaults to `True` for sync users or async users who have opted in
         fetch = True
-
     if not fetch:
         if fetch is None and in_async_main_thread():
             warnings.warn(
@@ -60,13 +55,8 @@ def get_state_result(
                 DeprecationWarning,
                 stacklevel=2,
             )
-        # Backwards compatibility
-        if isinstance(state.data, DataDocument):
-            return result_from_state_with_data_document(
-                state, raise_on_failure=raise_on_failure
-            )
-        else:
-            return state.data
+
+        return state.data
     else:
         return _get_state_result(state, raise_on_failure=raise_on_failure)
 
@@ -90,11 +80,7 @@ async def _get_state_result(state: State[R], raise_on_failure: bool) -> R:
     ):
         raise await get_state_exception(state)
 
-    if isinstance(state.data, DataDocument):
-        result = result_from_state_with_data_document(
-            state, raise_on_failure=raise_on_failure
-        )
-    elif isinstance(state.data, BaseResult):
+    if isinstance(state.data, BaseResult):
         result = await state.data.get()
     elif state.data is None:
         if state.is_failed() or state.is_crashed() or state.is_cancelled():
@@ -212,10 +198,15 @@ async def exception_to_failed_state(
     #       excluded from messages for now
     message = existing_message + format_exception(exc)
 
-    return Failed(data=data, message=message, **kwargs)
+    state = Failed(data=data, message=message, **kwargs)
+    state.state_details.retriable = False
 
+    return state
 
-async def return_value_to_state(retval: R, result_factory: ResultFactory) -> State[R]:
+
+async def return_value_to_state(
+    retval: R, result_factory: ResultFactory, key: str = None
+) -> State[R]:
     """
     Given a return value from a user's function, create a `State` the run should
     be placed in.
@@ -238,26 +229,21 @@ async def return_value_to_state(retval: R, result_factory: ResultFactory) -> Sta
     """
 
     if (
-        is_state(retval)
+        isinstance(retval, State)
         # Check for manual creation
         and not retval.state_details.flow_run_id
         and not retval.state_details.task_run_id
     ):
         state = retval
-
-        # Do not modify states with data documents attached; backwards compatibility
-        if isinstance(state.data, DataDocument):
-            return state
-
         # Unless the user has already constructed a result explicitly, use the factory
         # to update the data to the correct type
         if not isinstance(state.data, BaseResult):
-            state.data = await result_factory.create_result(state.data)
+            state.data = await result_factory.create_result(state.data, key=key)
 
         return state
 
     # Determine a new state from the aggregate of contained states
-    if is_state(retval) or is_state_iterable(retval):
+    if isinstance(retval, State) or is_state_iterable(retval):
         states = StateGroup(ensure_iterable(retval))
 
         # Determine the new state type
@@ -292,7 +278,7 @@ async def return_value_to_state(retval: R, result_factory: ResultFactory) -> Sta
         return State(
             type=new_state_type,
             message=message,
-            data=await result_factory.create_result(retval),
+            data=await result_factory.create_result(retval, key=key),
         )
 
     # Generators aren't portable, implicitly convert them to a list.
@@ -302,7 +288,10 @@ async def return_value_to_state(retval: R, result_factory: ResultFactory) -> Sta
         data = retval
 
     # Otherwise, they just gave data and this is a completed retval
-    return Completed(data=await result_factory.create_result(data))
+    if isinstance(data, BaseResult):
+        return Completed(data=data)
+    else:
+        return Completed(data=await result_factory.create_result(data, key=key))
 
 
 @sync_compatible
@@ -360,7 +349,7 @@ async def get_state_exception(state: State) -> BaseException:
     elif isinstance(result, str):
         return wrapper(result)
 
-    elif is_state(result):
+    elif isinstance(result, State):
         # Return the exception from the inner state
         return await get_state_exception(result)
 
@@ -392,23 +381,6 @@ async def raise_state_exception(state: State) -> None:
     raise await get_state_exception(state)
 
 
-def is_state(obj: Any) -> TypeGuard[State]:
-    """
-    Check if the given object is a state instance
-    """
-    # We may want to narrow this to client-side state types but for now this provides
-    # backwards compatibility
-    try:
-        from prefect.server.schemas.states import State as State_
-
-        classes_ = (State, State_)
-    except ImportError:
-        classes_ = State
-
-    # return isinstance(obj, (State, State_))
-    return isinstance(obj, classes_)
-
-
 def is_state_iterable(obj: Any) -> TypeGuard[Iterable[State]]:
     """
     Check if a the given object is an iterable of states types
@@ -427,7 +399,7 @@ def is_state_iterable(obj: Any) -> TypeGuard[Iterable[State]]:
         and isinstance(obj, (list, set, tuple))
         and obj
     ):
-        return all([is_state(o) for o in obj])
+        return all([isinstance(o, State) for o in obj])
     else:
         return False
 
@@ -495,7 +467,7 @@ def Scheduled(
     Returns:
         State: a Scheduled state
     """
-    state_details = StateDetails.parse_obj(kwargs.pop("state_details", {}))
+    state_details = StateDetails.model_validate(kwargs.pop("state_details", {}))
     if scheduled_time is None:
         scheduled_time = pendulum.now("UTC")
     elif state_details.scheduled_time:
@@ -581,7 +553,7 @@ def Paused(
     Returns:
         State: a Paused state
     """
-    state_details = StateDetails.parse_obj(kwargs.pop("state_details", {}))
+    state_details = StateDetails.model_validate(kwargs.pop("state_details", {}))
 
     if state_details.pause_timeout:
         raise ValueError("An extra pause timeout was provided in state_details")