prefect-client 3.0.1__py3-none-any.whl → 3.0.3__py3-none-any.whl

prefect/flows.py

@@ -51,8 +51,8 @@ from prefect._internal.concurrency.api import create_call, from_async
 from prefect.blocks.core import Block
 from prefect.client.orchestration import get_client
 from prefect.client.schemas.actions import DeploymentScheduleCreate
+from prefect.client.schemas.objects import ConcurrencyLimitConfig, FlowRun
 from prefect.client.schemas.objects import Flow as FlowSchema
-from prefect.client.schemas.objects import FlowRun
 from prefect.client.utilities import client_injector
 from prefect.docker.docker_image import DockerImage
 from prefect.events import DeploymentTriggerTypes, TriggerTypes
@@ -258,11 +258,11 @@ class Flow(Generic[P, R]):
         if not callable(fn):
             raise TypeError("'fn' must be callable")
 
-        # Validate name if given
-        if name:
-            _raise_on_name_with_banned_characters(name)
-
-        self.name = name or fn.__name__.replace("_", "-")
+        self.name = name or fn.__name__.replace("_", "-").replace(
+            "<lambda>",
+            "unknown-lambda",  # prefect API will not accept "<" or ">" in flow names
+        )
+        _raise_on_name_with_banned_characters(self.name)
 
         if flow_run_name is not None:
             if not isinstance(flow_run_name, str) and not callable(flow_run_name):
@@ -643,7 +643,7 @@ class Flow(Generic[P, R]):
         rrule: Optional[Union[Iterable[str], str]] = None,
         paused: Optional[bool] = None,
         schedules: Optional["FlexibleScheduleList"] = None,
-        concurrency_limit: Optional[int] = None,
+        concurrency_limit: Optional[Union[int, ConcurrencyLimitConfig, None]] = None,
         parameters: Optional[dict] = None,
         triggers: Optional[List[Union[DeploymentTriggerTypes, TriggerTypes]]] = None,
         description: Optional[str] = None,
@@ -715,6 +715,7 @@ class Flow(Generic[P, R]):
                 storage=self._storage,
                 entrypoint=self._entrypoint,
                 name=name,
+                flow_name=self.name,
                 interval=interval,
                 cron=cron,
                 rrule=rrule,
@@ -733,7 +734,7 @@ class Flow(Generic[P, R]):
             )  # type: ignore # TODO: remove sync_compatible
         else:
             return RunnerDeployment.from_flow(
-                self,
+                flow=self,
                 name=name,
                 interval=interval,
                 cron=cron,
@@ -798,6 +799,7 @@ class Flow(Generic[P, R]):
         rrule: Optional[Union[Iterable[str], str]] = None,
         paused: Optional[bool] = None,
         schedules: Optional["FlexibleScheduleList"] = None,
+        global_limit: Optional[Union[int, ConcurrencyLimitConfig, None]] = None,
         triggers: Optional[List[Union[DeploymentTriggerTypes, TriggerTypes]]] = None,
         parameters: Optional[dict] = None,
         description: Optional[str] = None,
@@ -827,6 +829,7 @@ class Flow(Generic[P, R]):
             paused: Whether or not to set this deployment as paused.
             schedules: A list of schedule objects defining when to execute runs of this deployment.
                 Used to define multiple schedules or additional scheduling options like `timezone`.
+            global_limit: The maximum number of concurrent runs allowed across all served flow instances associated with the same deployment.
             parameters: A dictionary of default parameter values to pass to runs of this deployment.
             description: A description for the created deployment. Defaults to the flow's
                 description if not provided.
@@ -838,7 +841,7 @@ class Flow(Generic[P, R]):
             pause_on_shutdown: If True, provided schedule will be paused when the serve function is stopped.
                 If False, the schedules will continue running.
             print_starting_message: Whether or not to print the starting message when flow is served.
-            limit: The maximum number of runs that can be executed concurrently.
+            limit: The maximum number of runs that can be executed concurrently by the created runner; only applies to this served flow. To apply a limit across multiple served flows, use `global_limit`.
             webserver: Whether or not to start a monitoring webserver for this flow.
             entrypoint_type: Type of entrypoint to use for the deployment. When using a module path
                 entrypoint, ensure that the module will be importable in the execution environment.
@@ -890,6 +893,7 @@ class Flow(Generic[P, R]):
             rrule=rrule,
             paused=paused,
             schedules=schedules,
+            concurrency_limit=global_limit,
             parameters=parameters,
             description=description,
             tags=tags,
@@ -1057,7 +1061,7 @@ class Flow(Generic[P, R]):
         rrule: Optional[str] = None,
         paused: Optional[bool] = None,
         schedules: Optional[List[DeploymentScheduleCreate]] = None,
-        concurrency_limit: Optional[int] = None,
+        concurrency_limit: Optional[Union[int, ConcurrencyLimitConfig, None]] = None,
         triggers: Optional[List[Union[DeploymentTriggerTypes, TriggerTypes]]] = None,
         parameters: Optional[dict] = None,
         description: Optional[str] = None,
@@ -1622,7 +1626,7 @@ def flow(
         )
 
 
-def _raise_on_name_with_banned_characters(name: str) -> str:
+def _raise_on_name_with_banned_characters(name: Optional[str]) -> Optional[str]:
     """
     Raise an InvalidNameError if the given name contains any invalid
     characters.

prefect/locking/filesystem.py

@@ -0,0 +1,243 @@
+import time
+from pathlib import Path
+from typing import Dict, Optional
+
+import anyio
+import pendulum
+import pydantic_core
+from typing_extensions import TypedDict
+
+from prefect.logging.loggers import get_logger
+
+from .protocol import LockManager
+
+logger = get_logger(__name__)
+
+
+class _LockInfo(TypedDict):
+    """
+    A dictionary containing information about a lock.
+
+    Attributes:
+        holder: The holder of the lock.
+        expiration: Datetime when the lock expires.
+        path: Path to the lock file.
+    """
+
+    holder: str
+    expiration: Optional[pendulum.DateTime]
+    path: Path
+
+
+class FileSystemLockManager(LockManager):
+    """
+    A lock manager that implements locking using local files.
+
+    Attributes:
+        lock_files_directory: the directory where lock files are stored
+    """
+
+    def __init__(self, lock_files_directory: Path):
+        self.lock_files_directory = lock_files_directory.expanduser().resolve()
+        self._locks: Dict[str, _LockInfo] = {}
+
+    def _ensure_lock_files_directory_exists(self):
+        self.lock_files_directory.mkdir(parents=True, exist_ok=True)
+
+    def _lock_path_for_key(self, key: str) -> Path:
+        if (lock_info := self._locks.get(key)) is not None:
+            return lock_info["path"]
+        return self.lock_files_directory.joinpath(key).with_suffix(".lock")
+
+    def _get_lock_info(self, key: str, use_cache=True) -> Optional[_LockInfo]:
+        if use_cache:
+            if (lock_info := self._locks.get(key)) is not None:
+                return lock_info
+
+        lock_path = self._lock_path_for_key(key)
+
+        try:
+            with open(lock_path, "rb") as lock_file:
+                lock_info = pydantic_core.from_json(lock_file.read())
+                lock_info["path"] = lock_path
+                expiration = lock_info.get("expiration")
+                lock_info["expiration"] = (
+                    pendulum.parse(expiration) if expiration is not None else None
+                )
+            self._locks[key] = lock_info
+            return lock_info
+        except FileNotFoundError:
+            return None
+
+    async def _aget_lock_info(
+        self, key: str, use_cache: bool = True
+    ) -> Optional[_LockInfo]:
+        if use_cache:
+            if (lock_info := self._locks.get(key)) is not None:
+                return lock_info
+
+        lock_path = self._lock_path_for_key(key)
+
+        try:
+            lock_info_bytes = await anyio.Path(lock_path).read_bytes()
+            lock_info = pydantic_core.from_json(lock_info_bytes)
+            lock_info["path"] = lock_path
+            expiration = lock_info.get("expiration")
+            lock_info["expiration"] = (
+                pendulum.parse(expiration) if expiration is not None else None
+            )
+            self._locks[key] = lock_info
+            return lock_info
+        except FileNotFoundError:
+            return None
+
+    def acquire_lock(
+        self,
+        key: str,
+        holder: str,
+        acquire_timeout: Optional[float] = None,
+        hold_timeout: Optional[float] = None,
+    ) -> bool:
+        self._ensure_lock_files_directory_exists()
+        lock_path = self._lock_path_for_key(key)
+
+        if self.is_locked(key) and not self.is_lock_holder(key, holder):
+            lock_free = self.wait_for_lock(key, acquire_timeout)
+            if not lock_free:
+                return False
+
+        try:
+            Path(lock_path).touch(exist_ok=False)
+        except FileExistsError:
+            if not self.is_lock_holder(key, holder):
+                logger.debug(
+                    f"Another actor acquired the lock for record with key {key}. Trying again."
+                )
+                return self.acquire_lock(key, holder, acquire_timeout, hold_timeout)
+        expiration = (
+            pendulum.now("utc") + pendulum.duration(seconds=hold_timeout)
+            if hold_timeout is not None
+            else None
+        )
+
+        with open(Path(lock_path), "wb") as lock_file:
+            lock_file.write(
+                pydantic_core.to_json(
+                    {
+                        "holder": holder,
+                        "expiration": str(expiration)
+                        if expiration is not None
+                        else None,
+                    },
+                )
+            )
+
+        self._locks[key] = {
+            "holder": holder,
+            "expiration": expiration,
+            "path": lock_path,
+        }
+
+        return True
+
+    async def aacquire_lock(
+        self,
+        key: str,
+        holder: str,
+        acquire_timeout: Optional[float] = None,
+        hold_timeout: Optional[float] = None,
+    ) -> bool:
+        await anyio.Path(self.lock_files_directory).mkdir(parents=True, exist_ok=True)
+        lock_path = self._lock_path_for_key(key)
+
+        if self.is_locked(key) and not self.is_lock_holder(key, holder):
+            lock_free = await self.await_for_lock(key, acquire_timeout)
+            if not lock_free:
+                return False
+
+        try:
+            await anyio.Path(lock_path).touch(exist_ok=False)
+        except FileExistsError:
+            if not self.is_lock_holder(key, holder):
+                logger.debug(
+                    f"Another actor acquired the lock for record with key {key}. Trying again."
+                )
+                return self.acquire_lock(key, holder, acquire_timeout, hold_timeout)
+        expiration = (
+            pendulum.now("utc") + pendulum.duration(seconds=hold_timeout)
+            if hold_timeout is not None
+            else None
+        )
+
+        async with await anyio.Path(lock_path).open("wb") as lock_file:
+            await lock_file.write(
+                pydantic_core.to_json(
+                    {
+                        "holder": holder,
+                        "expiration": str(expiration)
+                        if expiration is not None
+                        else None,
+                    },
+                )
+            )
+
+        self._locks[key] = {
+            "holder": holder,
+            "expiration": expiration,
+            "path": lock_path,
+        }
+
+        return True
+
+    def release_lock(self, key: str, holder: str) -> None:
+        lock_path = self._lock_path_for_key(key)
+        if not self.is_locked(key):
+            ValueError(f"No lock for transaction with key {key}")
+        if self.is_lock_holder(key, holder):
+            Path(lock_path).unlink(missing_ok=True)
+            self._locks.pop(key, None)
+        else:
+            raise ValueError(f"No lock held by {holder} for transaction with key {key}")
+
+    def is_locked(self, key: str, use_cache: bool = False) -> bool:
+        if (lock_info := self._get_lock_info(key, use_cache=use_cache)) is None:
+            return False
+
+        if (expiration := lock_info.get("expiration")) is None:
+            return True
+
+        expired = expiration < pendulum.now("utc")
+        if expired:
+            Path(lock_info["path"]).unlink()
+            self._locks.pop(key, None)
+            return False
+        else:
+            return True
+
+    def is_lock_holder(self, key: str, holder: str) -> bool:
+        if not self.is_locked(key):
+            return False
+
+        if not self.is_locked(key):
+            return False
+        if (lock_info := self._get_lock_info(key)) is None:
+            return False
+        return lock_info["holder"] == holder
+
+    def wait_for_lock(self, key: str, timeout: Optional[float] = None) -> bool:
+        seconds_waited = 0
+        while self.is_locked(key, use_cache=False):
+            if timeout and seconds_waited >= timeout:
+                return False
+            seconds_waited += 0.1
+            time.sleep(0.1)
+        return True
+
+    async def await_for_lock(self, key: str, timeout: Optional[float] = None) -> bool:
+        seconds_waited = 0
+        while self.is_locked(key, use_cache=False):
+            if timeout and seconds_waited >= timeout:
+                return False
+            seconds_waited += 0.1
+            await anyio.sleep(0.1)
+        return True

prefect/logging/handlers.py

@@ -138,8 +138,6 @@ class APILogHandler(logging.Handler):
                 return  # Respect the global settings toggle
             if not getattr(record, "send_to_api", True):
                 return  # Do not send records that have opted out
-            if not getattr(record, "send_to_orion", True):
-                return  # Backwards compatibility
 
             log = self.prepare(record)
             APILogWorker.instance().send(log)

prefect/logging/loggers.py

@@ -1,7 +1,6 @@
 import io
 import logging
 import sys
-import warnings
 from builtins import print
 from contextlib import contextmanager
 from functools import lru_cache
@@ -34,23 +33,6 @@ class PrefectLogAdapter(logging.LoggerAdapter):
 
     def process(self, msg, kwargs):
         kwargs["extra"] = {**(self.extra or {}), **(kwargs.get("extra") or {})}
-
-        from prefect._internal.compatibility.deprecated import (
-            PrefectDeprecationWarning,
-            generate_deprecation_message,
-        )
-
-        if "send_to_orion" in kwargs["extra"]:
-            warnings.warn(
-                generate_deprecation_message(
-                    'The "send_to_orion" option',
-                    start_date="May 2023",
-                    help='Use "send_to_api" instead.',
-                ),
-                PrefectDeprecationWarning,
-                stacklevel=4,
-            )
-
         return (msg, kwargs)
 
     def getChild(

prefect/logging/logging.yml

@@ -77,6 +77,7 @@ loggers:
     prefect.extra:
         level: "${PREFECT_LOGGING_LEVEL}"
         handlers: [api]
+        propagate: false
 
     prefect.flow_runs:
         level: NOTSET

prefect/main.py

@@ -7,7 +7,7 @@ from prefect.transactions import Transaction
 from prefect.tasks import task, Task
 from prefect.context import tags
 from prefect.utilities.annotations import unmapped, allow_failure
-from prefect.results import BaseResult
+from prefect.results import BaseResult, ResultRecordMetadata
 from prefect.flow_runs import pause_flow_run, resume_flow_run, suspend_flow_run
 from prefect.client.orchestration import get_client, PrefectClient
 from prefect.client.cloud import get_cloud_client, CloudClient
@@ -26,12 +26,26 @@ import prefect.context
 import prefect.client.schemas
 
 prefect.context.FlowRunContext.model_rebuild(
-    _types_namespace={"Flow": Flow, "BaseResult": BaseResult}
+    _types_namespace={
+        "Flow": Flow,
+        "BaseResult": BaseResult,
+        "ResultRecordMetadata": ResultRecordMetadata,
+    }
+)
+prefect.context.TaskRunContext.model_rebuild(
+    _types_namespace={"Task": Task, "BaseResult": BaseResult}
+)
+prefect.client.schemas.State.model_rebuild(
+    _types_namespace={
+        "BaseResult": BaseResult,
+        "ResultRecordMetadata": ResultRecordMetadata,
+    }
 )
-prefect.context.TaskRunContext.model_rebuild(_types_namespace={"Task": Task})
-prefect.client.schemas.State.model_rebuild(_types_namespace={"BaseResult": BaseResult})
 prefect.client.schemas.StateCreate.model_rebuild(
-    _types_namespace={"BaseResult": BaseResult}
+    _types_namespace={
+        "BaseResult": BaseResult,
+        "ResultRecordMetadata": ResultRecordMetadata,
+    }
 )
 Transaction.model_rebuild()
 

prefect/plugins.py

@@ -14,6 +14,8 @@ from typing import Any, Dict, Union
 import prefect.settings
 from prefect.utilities.compat import EntryPoints, entry_points
 
+COLLECTIONS: Union[None, Dict[str, Union[ModuleType, Exception]]] = None
+
 
 def safe_load_entrypoints(entrypoints: EntryPoints) -> Dict[str, Union[Exception, Any]]:
     """
@@ -38,11 +40,16 @@ def safe_load_entrypoints(entrypoints: EntryPoints) -> Dict[str, Union[Exception
     return results
 
 
-def load_prefect_collections() -> Dict[str, ModuleType]:
+def load_prefect_collections() -> Dict[str, Union[ModuleType, Exception]]:
     """
     Load all Prefect collections that define an entrypoint in the group
     `prefect.collections`.
     """
+    global COLLECTIONS
+
+    if COLLECTIONS is not None:
+        return COLLECTIONS
+
     collection_entrypoints: EntryPoints = entry_points(group="prefect.collections")
     collections = safe_load_entrypoints(collection_entrypoints)
 
@@ -61,4 +68,5 @@ def load_prefect_collections() -> Dict[str, ModuleType]:
             if prefect.settings.PREFECT_DEBUG_MODE:
                 print(f"Loaded collection {name!r}.")
 
+    COLLECTIONS = collections
     return collections

prefect/records/base.py

@@ -6,11 +6,18 @@ from contextlib import contextmanager
 from dataclasses import dataclass
 from typing import TYPE_CHECKING, Optional
 
+from prefect._internal.compatibility import deprecated
+
 if TYPE_CHECKING:
     from prefect.results import BaseResult
     from prefect.transactions import IsolationLevel
 
 
+@deprecated.deprecated_class(
+    start_date="Sep 2024",
+    end_date="Nov 2024",
+    help="Use `ResultRecord` instead to represent a result and its associated metadata.",
+)
 @dataclass
 class TransactionRecord:
     """
@@ -21,6 +28,11 @@ class TransactionRecord:
     result: "BaseResult"
 
 
+@deprecated.deprecated_class(
+    start_date="Sep 2024",
+    end_date="Nov 2024",
+    help="Use `ResultStore` and provide a `WritableFileSystem` for `metadata_storage` instead.",
+)
 class RecordStore(abc.ABC):
     @abc.abstractmethod
     def read(

prefect/records/filesystem.py

@@ -6,6 +6,7 @@ from typing import Dict, Optional
 import pendulum
 from typing_extensions import TypedDict
 
+from prefect._internal.compatibility import deprecated
 from prefect.logging.loggers import get_logger
 from prefect.records.base import RecordStore, TransactionRecord
 from prefect.results import BaseResult
@@ -29,6 +30,11 @@ class _LockInfo(TypedDict):
     path: Path
 
 
+@deprecated.deprecated_class(
+    start_date="Sep 2024",
+    end_date="Nov 2024",
+    help="Use `ResultStore` with a `LocalFileSystem` for `metadata_storage` and a `FileSystemLockManager` instead.",
+)
 class FileSystemRecordStore(RecordStore):
     """
     A record store that stores data on the local filesystem.
@@ -56,7 +62,6 @@ class FileSystemRecordStore(RecordStore):
     def _get_lock_info(self, key: str, use_cache=True) -> Optional[_LockInfo]:
         if use_cache:
             if (lock_info := self._locks.get(key)) is not None:
-                print("Got lock info from cache")
                 return lock_info
 
         lock_path = self._lock_path_for_key(key)
@@ -70,7 +75,6 @@ class FileSystemRecordStore(RecordStore):
                     pendulum.parse(expiration) if expiration is not None else None
                 )
             self._locks[key] = lock_info
-            print("Got lock info from file")
             return lock_info
         except FileNotFoundError:
             return None

prefect/records/memory.py

@@ -1,6 +1,7 @@
 import threading
 from typing import Dict, Optional, TypedDict
 
+from prefect._internal.compatibility import deprecated
 from prefect.results import BaseResult
 from prefect.transactions import IsolationLevel
 
@@ -22,6 +23,11 @@ class _LockInfo(TypedDict):
     expiration_timer: Optional[threading.Timer]
 
 
+@deprecated.deprecated_class(
+    start_date="Sep 2024",
+    end_date="Nov 2024",
+    help="Use `ResultStore` with a `MemoryLockManager` instead.",
+)
 class MemoryRecordStore(RecordStore):
     """
     A record store that stores data in memory.

prefect/records/result_store.py

@@ -3,6 +3,7 @@ from typing import Any, Optional
 
 import pendulum
 
+from prefect._internal.compatibility import deprecated
 from prefect.results import BaseResult, PersistedResult, ResultStore
 from prefect.transactions import IsolationLevel
 from prefect.utilities.asyncutils import run_coro_as_sync
@@ -10,6 +11,11 @@ from prefect.utilities.asyncutils import run_coro_as_sync
 from .base import RecordStore, TransactionRecord
 
 
+@deprecated.deprecated_class(
+    start_date="Sep 2024",
+    end_date="Nov 2024",
+    help="Use `ResultStore` directly instead.",
+)
 @dataclass
 class ResultRecordStore(RecordStore):
     """