prefect-client 2.16.2__tar.gz → 2.16.3__tar.gz

{prefect-client-2.16.2/src/prefect_client.egg-info → prefect-client-2.16.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: prefect-client
-Version: 2.16.2
+Version: 2.16.3
 Summary: Workflow orchestration and management.
 Home-page: https://www.prefect.io
 Author: Prefect Technologies, Inc.
@@ -13,12 +13,12 @@ Project-URL: Tracker, https://github.com/PrefectHQ/prefect/issues
 Description: <p align="center"><img src="https://github.com/PrefectHQ/prefect/assets/3407835/c654cbc6-63e8-4ada-a92a-efd2f8f24b85" width=1000></p>
         
         <p align="center">
-            <a href="https://pypi.python.org/pypi/prefect/" alt="PyPI version">
-                <img alt="PyPI" src="https://img.shields.io/pypi/v/prefect?color=0052FF&labelColor=090422"></a>
+            <a href="https://pypi.python.org/pypi/prefect-client/" alt="PyPI version">
+                <img alt="PyPI" src="https://img.shields.io/pypi/v/prefect-client?color=0052FF&labelColor=090422"></a>
             <a href="https://github.com/prefecthq/prefect/" alt="Stars">
                 <img src="https://img.shields.io/github/stars/prefecthq/prefect?color=0052FF&labelColor=090422" /></a>
-            <a href="https://pepy.tech/badge/prefect/" alt="Downloads">
-                <img src="https://img.shields.io/pypi/dm/prefect?color=0052FF&labelColor=090422" /></a>
+            <a href="https://pepy.tech/badge/prefect-client/" alt="Downloads">
+                <img src="https://img.shields.io/pypi/dm/prefect-client?color=0052FF&labelColor=090422" /></a>
             <a href="https://github.com/prefecthq/prefect/pulse" alt="Activity">
                 <img src="https://img.shields.io/github/commit-activity/m/prefecthq/prefect?color=0052FF&labelColor=090422" /></a>
             <br>
@@ -30,78 +30,80 @@ Description: <p align="center"><img src="https://github.com/PrefectHQ/prefect/as
                 <img src="https://img.shields.io/badge/youtube-watch_videos-red.svg?color=0052FF&labelColor=090422&logo=youtube" /></a>
         </p>
         
-        # Prefect
+        # prefect-client
         
-        Prefect is an orchestration and observability platform for building, observing, and triaging workflows. 
-        It's the simplest way to transform Python code into an interactive workflow application.
+        The `prefect-client` package is a minimal-installation of `prefect` which is designed for interacting with Prefect Cloud 
+        or remote any `prefect` server. It sheds some functionality and dependencies in exchange for a smaller installation size, 
+        making it ideal for use in lightweight or ephemeral environments. These characteristics make it ideal for use in lambdas 
+        or other resource-constrained environments. 
         
-        Prefect allows you to expose your workflows through an API so teams dependent on you can programmatically access your pipelines, business logic, and more.
-        Prefect also allows you to standardize workflow development and deployment across your organization.
-        
-        With Prefect, you can build resilient, dynamic workflows that react to the world around them and recover from unexpected changes.
-        With just a few decorators, Prefect supercharges your code with features like automatic retries, distributed execution, scheduling, caching, and much more.
-        
-        Every activity is tracked and can be monitored with a self-hosted [Prefect server](https://docs.prefect.io/latest/guides/host/) instance or managed [Prefect Cloud](https://www.prefect.io/cloud-vs-oss?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none) dashboard.
         
         ## Getting started
         
-        Prefect requires Python 3.8 or later. To [install Prefect](https://docs.prefect.io/getting-started/installation/), run the following command:
+        `prefect-client` shares the same installation requirements as prefect. To install, make sure you are on Python 3.8 or 
+        later and run the following command:
         
         ```bash
-        pip install prefect
+        pip install prefect-client
         ```
         
-        Then create and run a Python file that uses Prefect `flow` and `task` decorators to orchestrate and observe your workflow that fetches the number of GitHub stars from a repository.
+        Next, ensure that your `prefect-client` has access to a remote `prefect` server by exporting the `PREFECT_API_KEY` 
+        (if using Prefect Cloud) and `PREFECT_API_URL` environment variables. Once those are set, use the package in your code as 
+        you would normally use `prefect`! 
+        
+        
+        For example, to remotely trigger a run a deployment:
         
         ```python
-        from prefect import flow, task
-        from typing import List
-        import httpx
+        from prefect.deployments import run_deployment
         
         
-        @task(log_prints=True)
-        def get_stars(repo: str):
-            url = f"https://api.github.com/repos/{repo}"
-            count = httpx.get(url).json()["stargazers_count"]
-            print(f"{repo} has {count} stars!")
+        def my_lambda(event):
+            ...
+            run_deployment(
+                name="my-flow/my-deployment",
+                parameters={"foo": "bar"},
+                timeout=0,
+            )
         
+        my_lambda({})
+        ```
         
-        @flow(name="GitHub Stars")
-        def github_stars(repos: List[str]):
-            for repo in repos:
-                get_stars(repo)
+        To emit events in an event driven system:
         
+        ```python
+        from prefect.events import emit_event
         
-        # run the flow!
-        if __name__=="__main__":
-            github_stars(["PrefectHQ/Prefect"])
-        ```
         
-        Fire up the Prefect UI to see what happened:
+        def something_happened():
+            emit_event("my-event", resource={"prefect.resource.id": "foo.bar"})
         
-        ```bash
-        prefect server start
+        something_happened()
         ```
         
-        ![Prefect UI dashboard](/docs/img/ui/cloud-dashboard.png)
-        
-        To run your workflow on a schedule, turn it into a deployment and schedule it to run every minute by changing the last line of your script to the following:
         
+        Or just interact with a `prefect` API:
         ```python
-            github_stars.serve(name="first-deployment", cron="* * * * *")
-        ```
+        from prefect.client.orchestration import get_client
         
-        You now have a server running locally that is looking for scheduled deployments!
-        Additionally you can run your workflow manually from the UI or CLI - and if you're using Prefect Cloud, you can even run deployments in response to [events](https://docs.prefect.io/latest/concepts/automations/).
         
-        ## Prefect Cloud
+        async def query_api():
+            async with get_client() as client:
+                limits = await client.read_concurrency_limits(limit=10, offset=0)
+                print(limits)
+        
+        
+        query_api()
+        ```
         
-        Stop worrying about your workflows.
-        Prefect Cloud allows you to centrally deploy, monitor, and manage the data workflows you support. With managed orchestration, automations, and webhooks, all backed by enterprise-class security, build production-ready code quickly and reliably.
         
-        Read more about Prefect Cloud [here](https://www.prefect.io/cloud-vs-oss?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none) or sign up to [try it for yourself](https://app.prefect.cloud?utm_source=oss&utm_medium=oss&utm_campaign=oss_gh_repo&utm_term=none&utm_content=none).
+        ## Known limitations
+        By design, `prefect-client` omits all CLI and server components. This means that the CLI is not available for use 
+        and attempts to access server objects will fail. Furthermore, some classes, methods, and objects may be available 
+        for import in `prefect-client` but may not be "runnable" if they tap into server-oriented functionality. If you 
+        encounter such a limitation, feel free to [open an issue](https://github.com/PrefectHQ/prefect/issues/new/choose) 
+        describing the functionality you are interested in using and we will do our best to make it available.
         
-        ![Prefect Automations](/docs/img/ui/automations.png)
         
         ## Next steps
         

prefect-client-2.16.3/README.md

@@ -0,0 +1,109 @@
+<p align="center"><img src="https://github.com/PrefectHQ/prefect/assets/3407835/c654cbc6-63e8-4ada-a92a-efd2f8f24b85" width=1000></p>
+
+<p align="center">
+    <a href="https://pypi.python.org/pypi/prefect-client/" alt="PyPI version">
+        <img alt="PyPI" src="https://img.shields.io/pypi/v/prefect-client?color=0052FF&labelColor=090422"></a>
+    <a href="https://github.com/prefecthq/prefect/" alt="Stars">
+        <img src="https://img.shields.io/github/stars/prefecthq/prefect?color=0052FF&labelColor=090422" /></a>
+    <a href="https://pepy.tech/badge/prefect-client/" alt="Downloads">
+        <img src="https://img.shields.io/pypi/dm/prefect-client?color=0052FF&labelColor=090422" /></a>
+    <a href="https://github.com/prefecthq/prefect/pulse" alt="Activity">
+        <img src="https://img.shields.io/github/commit-activity/m/prefecthq/prefect?color=0052FF&labelColor=090422" /></a>
+    <br>
+    <a href="https://prefect.io/slack" alt="Slack">
+        <img src="https://img.shields.io/badge/slack-join_community-red.svg?color=0052FF&labelColor=090422&logo=slack" /></a>
+    <a href="https://discourse.prefect.io/" alt="Discourse">
+        <img src="https://img.shields.io/badge/discourse-browse_forum-red.svg?color=0052FF&labelColor=090422&logo=discourse" /></a>
+    <a href="https://www.youtube.com/c/PrefectIO/" alt="YouTube">
+        <img src="https://img.shields.io/badge/youtube-watch_videos-red.svg?color=0052FF&labelColor=090422&logo=youtube" /></a>
+</p>
+
+# prefect-client
+
+The `prefect-client` package is a minimal-installation of `prefect` which is designed for interacting with Prefect Cloud 
+or remote any `prefect` server. It sheds some functionality and dependencies in exchange for a smaller installation size, 
+making it ideal for use in lightweight or ephemeral environments. These characteristics make it ideal for use in lambdas 
+or other resource-constrained environments. 
+
+
+## Getting started
+
+`prefect-client` shares the same installation requirements as prefect. To install, make sure you are on Python 3.8 or 
+later and run the following command:
+
+```bash
+pip install prefect-client
+```
+
+Next, ensure that your `prefect-client` has access to a remote `prefect` server by exporting the `PREFECT_API_KEY` 
+(if using Prefect Cloud) and `PREFECT_API_URL` environment variables. Once those are set, use the package in your code as 
+you would normally use `prefect`! 
+
+
+For example, to remotely trigger a run a deployment:
+
+```python
+from prefect.deployments import run_deployment
+
+
+def my_lambda(event):
+    ...
+    run_deployment(
+        name="my-flow/my-deployment",
+        parameters={"foo": "bar"},
+        timeout=0,
+    )
+
+my_lambda({})
+```
+
+To emit events in an event driven system:
+
+```python
+from prefect.events import emit_event
+
+
+def something_happened():
+    emit_event("my-event", resource={"prefect.resource.id": "foo.bar"})
+
+something_happened()
+```
+
+
+Or just interact with a `prefect` API:
+```python
+from prefect.client.orchestration import get_client
+
+
+async def query_api():
+    async with get_client() as client:
+        limits = await client.read_concurrency_limits(limit=10, offset=0)
+        print(limits)
+
+
+query_api()
+```
+
+
+## Known limitations
+By design, `prefect-client` omits all CLI and server components. This means that the CLI is not available for use 
+and attempts to access server objects will fail. Furthermore, some classes, methods, and objects may be available 
+for import in `prefect-client` but may not be "runnable" if they tap into server-oriented functionality. If you 
+encounter such a limitation, feel free to [open an issue](https://github.com/PrefectHQ/prefect/issues/new/choose) 
+describing the functionality you are interested in using and we will do our best to make it available.
+
+
+## Next steps
+
+There's lots more you can do to orchestrate and observe your workflows with Prefect!
+Start with our [friendly tutorial](https://docs.prefect.io/tutorials) or explore the [core concepts of Prefect workflows](https://docs.prefect.io/concepts/).
+
+## Join the community
+
+Prefect is made possible by the fastest growing community of thousands of friendly data engineers. Join us in building a new kind of workflow system. The [Prefect Slack community](https://prefect.io/slack) is a fantastic place to learn more about Prefect, ask questions, or get help with workflow design. All community forums, including code contributions, issue discussions, and slack messages are subject to our [Code of Conduct](https://discourse.prefect.io/faq).
+
+## Contribute
+
+See our [documentation on contributing to Prefect](https://docs.prefect.io/contributing/overview/).
+
+Thanks for being part of the mission to build a new kind of workflow system and, of course, **happy engineering!**

{prefect-client-2.16.2 → prefect-client-2.16.3}/requirements-client.txt

@@ -23,6 +23,7 @@ pydantic[email]>=1.10.0,!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0
 python_dateutil >= 2.8.2, < 3.0.0
 python-slugify >= 5.0, < 9.0
 pyyaml >= 5.4.1, < 7.0.0
+rfc3339-validator >= 0.1.4, < 0.2.0
 rich >= 11.0, < 14.0
 ruamel.yaml >= 0.17.0
 sniffio >=1.3.0, < 2.0.0

{prefect-client-2.16.2 → prefect-client-2.16.3}/src/prefect/_internal/concurrency/services.py

@@ -91,6 +91,11 @@ class QueueService(abc.ABC, Generic[T]):
             self._remove_instance()
             self._stopped = True
 
+            # Allow asyncio task to be garbage-collected. Its context may contain
+            # references to all Prefect Task calls made during a flow run, through
+            # EngineContext. Issue #10338.
+            self._task = None
+
             # Signal completion to the loop
             self._queue.put_nowait(None)
 

{prefect-client-2.16.2 → prefect-client-2.16.3}/src/prefect/_internal/concurrency/threads.py

@@ -214,6 +214,9 @@ class EventLoopThread(Portal):
         for call in self._on_shutdown:
             await self._run_call(call)
 
+        # Empty the list to allow calls to be garbage collected. Issue #10338.
+        self._on_shutdown = []
+
     async def _run_call(self, call: Call) -> None:
         task = call.run()
         if task is not None:

{prefect-client-2.16.2 → prefect-client-2.16.3}/src/prefect/deployments/deployments.py

@@ -36,6 +36,10 @@ from prefect.client.schemas.objects import (
 from prefect.client.schemas.schedules import SCHEDULE_TYPES
 from prefect.client.utilities import inject_client
 from prefect.context import FlowRunContext, PrefectObjectRegistry, TaskRunContext
+from prefect.deployments.schedules import (
+    FlexibleScheduleList,
+    normalize_to_minimal_deployment_schedules,
+)
 from prefect.deployments.steps.core import run_steps
 from prefect.events.schemas import DeploymentTrigger
 from prefect.exceptions import (
@@ -649,11 +653,17 @@ class Deployment(BaseModel):
             cls._validate_schedule(value)
         return value
 
-    @validator("schedules")
-    def validate_schedules(cls, value):
-        for schedule in value:
-            cls._validate_schedule(schedule.schedule)
-        return value
+    @root_validator(pre=True)
+    def validate_schedules(cls, values):
+        if "schedules" in values:
+            values["schedules"] = normalize_to_minimal_deployment_schedules(
+                values["schedules"]
+            )
+
+            for schedule in values["schedules"]:
+                cls._validate_schedule(schedule.schedule)
+
+        return values
 
     @classmethod
     @sync_compatible
@@ -936,6 +946,7 @@ class Deployment(BaseModel):
         ignore_file: str = ".prefectignore",
         apply: bool = False,
         load_existing: bool = True,
+        schedules: Optional[FlexibleScheduleList] = None,
         **kwargs,
     ) -> "Deployment":
         """
@@ -955,6 +966,14 @@ class Deployment(BaseModel):
             load_existing: if True, load any settings that may already be configured for
                 the named deployment server-side (e.g., schedules, default parameter
                 values, etc.)
+            schedules: An optional list of schedules. Each item in the list can be:
+                  - An instance of `MinimalDeploymentSchedule`.
+                  - A dictionary with a `schedule` key, and optionally, an
+                    `active` key. The `schedule` key should correspond to a
+                    schedule type, and `active` is a boolean indicating whether
+                    the schedule is active or not.
+                  - An instance of one of the predefined schedule types:
+                    `IntervalSchedule`, `CronSchedule`, or `RRuleSchedule`.
             **kwargs: other keyword arguments to pass to the constructor for the
                 `Deployment` class
         """
@@ -963,7 +982,11 @@ class Deployment(BaseModel):
 
         # note that `deployment.load` only updates settings that were *not*
         # provided at initialization
-        deployment = cls(name=name, **kwargs)
+        deployment = cls(
+            name=name,
+            schedules=schedules,
+            **kwargs,
+        )
         deployment.flow_name = flow.name
         if not deployment.entrypoint:
             ## first see if an entrypoint can be determined

{prefect-client-2.16.2 → prefect-client-2.16.3}/src/prefect/deployments/runner.py

@@ -34,7 +34,7 @@ import importlib
 import tempfile
 from datetime import datetime, timedelta
 from pathlib import Path
-from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional, Union, get_args
+from typing import TYPE_CHECKING, Any, Dict, Iterable, List, Optional, Union
 from uuid import UUID
 
 import pendulum
@@ -63,6 +63,11 @@ from prefect.client.schemas.schedules import (
     SCHEDULE_TYPES,
     construct_schedule,
 )
+from prefect.deployments.schedules import (
+    FlexibleScheduleList,
+    create_minimal_deployment_schedule,
+    normalize_to_minimal_deployment_schedules,
+)
 from prefect.events.schemas import DeploymentTrigger
 from prefect.exceptions import (
     ObjectNotFound,
@@ -83,18 +88,9 @@ from prefect.utilities.slugify import slugify
 if TYPE_CHECKING:
     from prefect.flows import Flow
 
-FlexibleScheduleList = Union[MinimalDeploymentSchedule, dict, SCHEDULE_TYPES]
-
 __all__ = ["RunnerDeployment"]
 
 
-def _to_deployment_schedule(
-    schedule: Optional[SCHEDULE_TYPES] = None,
-    active: Optional[bool] = True,
-) -> MinimalDeploymentSchedule:
-    return MinimalDeploymentSchedule(schedule=schedule, active=active)
-
-
 class DeploymentApplyError(RuntimeError):
     """
     Raised when an error occurs while applying a deployment.
@@ -264,23 +260,9 @@ class RunnerDeployment(BaseModel):
         schedules = values.get("schedules")
 
         if schedules is None and schedule is not None:
-            values["schedules"] = [_to_deployment_schedule(schedule)]
+            values["schedules"] = [create_minimal_deployment_schedule(schedule)]
         elif schedules is not None and len(schedules) > 0:
-            reconciled = []
-            for obj in schedules:
-                if isinstance(obj, get_args(SCHEDULE_TYPES)):
-                    reconciled.append(_to_deployment_schedule(obj))
-                elif isinstance(obj, dict):
-                    reconciled.append(_to_deployment_schedule(**obj))
-                elif isinstance(obj, MinimalDeploymentSchedule):
-                    reconciled.append(obj)
-                else:
-                    raise ValueError(
-                        "Invalid schedule provided. Must be a schedule object, a dict,"
-                        " or a MinimalDeploymentSchedule."
-                    )
-
-            values["schedules"] = reconciled
+            values["schedules"] = normalize_to_minimal_deployment_schedules(schedules)
 
         return values
 
@@ -389,8 +371,8 @@ class RunnerDeployment(BaseModel):
         rrule: Optional[Union[Iterable[str], str]] = None,
         timezone: Optional[str] = None,
         schedule: Optional[SCHEDULE_TYPES] = None,
-        schedules: Optional[List[FlexibleScheduleList]] = None,
-    ) -> Union[List[MinimalDeploymentSchedule], List[FlexibleScheduleList]]:
+        schedules: Optional[FlexibleScheduleList] = None,
+    ) -> Union[List[MinimalDeploymentSchedule], FlexibleScheduleList]:
         """
         Construct a schedule or schedules from the provided arguments.
 
@@ -448,7 +430,7 @@ class RunnerDeployment(BaseModel):
                 value = [value]
 
             return [
-                _to_deployment_schedule(
+                create_minimal_deployment_schedule(
                     construct_schedule(
                         **{
                             schedule_type: v,
@@ -460,7 +442,7 @@ class RunnerDeployment(BaseModel):
                 for v in value
             ]
         else:
-            return [_to_deployment_schedule(schedule)]
+            return [create_minimal_deployment_schedule(schedule)]
 
     def _set_defaults_from_flow(self, flow: "Flow"):
         self._parameter_openapi_schema = parameter_schema(flow)
@@ -481,7 +463,7 @@ class RunnerDeployment(BaseModel):
         cron: Optional[Union[Iterable[str], str]] = None,
         rrule: Optional[Union[Iterable[str], str]] = None,
         paused: Optional[bool] = None,
-        schedules: Optional[List[FlexibleScheduleList]] = None,
+        schedules: Optional[FlexibleScheduleList] = None,
         schedule: Optional[SCHEDULE_TYPES] = None,
         is_schedule_active: Optional[bool] = None,
         parameters: Optional[dict] = None,
@@ -617,7 +599,7 @@ class RunnerDeployment(BaseModel):
         cron: Optional[Union[Iterable[str], str]] = None,
         rrule: Optional[Union[Iterable[str], str]] = None,
         paused: Optional[bool] = None,
-        schedules: Optional[List[FlexibleScheduleList]] = None,
+        schedules: Optional[FlexibleScheduleList] = None,
         schedule: Optional[SCHEDULE_TYPES] = None,
         is_schedule_active: Optional[bool] = None,
         parameters: Optional[dict] = None,
@@ -715,7 +697,7 @@ class RunnerDeployment(BaseModel):
         cron: Optional[Union[Iterable[str], str]] = None,
         rrule: Optional[Union[Iterable[str], str]] = None,
         paused: Optional[bool] = None,
-        schedules: Optional[List[FlexibleScheduleList]] = None,
+        schedules: Optional[FlexibleScheduleList] = None,
         schedule: Optional[SCHEDULE_TYPES] = None,
         is_schedule_active: Optional[bool] = None,
         parameters: Optional[dict] = None,

prefect-client-2.16.3/src/prefect/deployments/schedules.py

@@ -0,0 +1,37 @@
+from typing import List, Optional, Sequence, Union, get_args
+
+from prefect.client.schemas.objects import MinimalDeploymentSchedule
+from prefect.client.schemas.schedules import SCHEDULE_TYPES
+
+FlexibleScheduleList = Sequence[Union[MinimalDeploymentSchedule, dict, SCHEDULE_TYPES]]
+
+
+def create_minimal_deployment_schedule(
+    schedule: SCHEDULE_TYPES,
+    active: Optional[bool] = True,
+) -> MinimalDeploymentSchedule:
+    return MinimalDeploymentSchedule(
+        schedule=schedule,
+        active=active if active is not None else True,
+    )
+
+
+def normalize_to_minimal_deployment_schedules(
+    schedules: Optional[FlexibleScheduleList],
+) -> List[MinimalDeploymentSchedule]:
+    normalized = []
+    if schedules is not None:
+        for obj in schedules:
+            if isinstance(obj, get_args(SCHEDULE_TYPES)):
+                normalized.append(create_minimal_deployment_schedule(obj))
+            elif isinstance(obj, dict):
+                normalized.append(create_minimal_deployment_schedule(**obj))
+            elif isinstance(obj, MinimalDeploymentSchedule):
+                normalized.append(obj)
+            else:
+                raise ValueError(
+                    "Invalid schedule provided. Must be a schedule object, a dict,"
+                    " or a MinimalDeploymentSchedule."
+                )
+
+    return normalized