prefect-client 2.20.1__tar.gz → 2.20.2__tar.gz

prefect_client-2.20.2/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.1
+Name: prefect-client
+Version: 2.20.2
+Summary: Workflow orchestration and management.
+Home-page: https://www.prefect.io
+Author: Prefect Technologies, Inc.
+Author-email: help@prefect.io
+Project-URL: Changelog, https://github.com/PrefectHQ/prefect/blob/main/RELEASE-NOTES.md
+Project-URL: Documentation, https://docs.prefect.io
+Project-URL: Source, https://github.com/PrefectHQ/prefect
+Project-URL: Tracker, https://github.com/PrefectHQ/prefect/issues
+Classifier: Natural Language :: English
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: anyio<5.0.0,>=4.4.0
+Requires-Dist: asgi-lifespan<3.0,>=1.0
+Requires-Dist: cachetools<6.0,>=5.3
+Requires-Dist: cloudpickle<4.0,>=2.0
+Requires-Dist: coolname<3.0.0,>=1.0.4
+Requires-Dist: croniter<3.0.0,>=1.0.12
+Requires-Dist: fsspec>=2022.5.0
+Requires-Dist: exceptiongroup>=1.2.1
+Requires-Dist: graphviz>=0.20.1
+Requires-Dist: griffe<0.48.0,>=0.20.0
+Requires-Dist: httpcore<2.0.0,>=1.0.5
+Requires-Dist: httpx[http2]!=0.23.2,>=0.23
+Requires-Dist: importlib_metadata>=4.4; python_version < "3.10"
+Requires-Dist: importlib-resources<6.2.0,>=6.1.3
+Requires-Dist: jsonpatch<2.0,>=1.32
+Requires-Dist: jsonschema<5.0.0,>=4.0.0
+Requires-Dist: orjson<4.0,>=3.7
+Requires-Dist: packaging<24.3,>=21.3
+Requires-Dist: pathspec>=0.8.0
+Requires-Dist: pendulum<3.0; python_version < "3.12"
+Requires-Dist: pendulum<4,>=3.0.0; python_version >= "3.12"
+Requires-Dist: pydantic[email]!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0,>=1.10.0
+Requires-Dist: pydantic_core<3.0.0,>=2.12.0
+Requires-Dist: python_dateutil<3.0.0,>=2.8.2
+Requires-Dist: python-slugify<9.0,>=5.0
+Requires-Dist: pyyaml<7.0.0,>=5.4.1
+Requires-Dist: rfc3339-validator<0.2.0,>=0.1.4
+Requires-Dist: rich<14.0,>=11.0
+Requires-Dist: ruamel.yaml>=0.17.0
+Requires-Dist: sniffio<2.0.0,>=1.3.0
+Requires-Dist: toml>=0.10.0
+Requires-Dist: typing_extensions<5.0.0,>=4.5.0
+Requires-Dist: ujson<6.0.0,>=5.8.0
+Requires-Dist: uvicorn!=0.29.0,>=0.14.0
+Requires-Dist: websockets<13.0,>=10.4
+Requires-Dist: itsdangerous
+Requires-Dist: python-multipart>=0.0.7
+Provides-Extra: notifications
+Requires-Dist: apprise<2.0.0,>=1.1.0; extra == "notifications"
+
+<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.20.1 → prefect_client-2.20.2}/setup.cfg

@@ -64,7 +64,7 @@ follow_imports = skip
 ignore_missing_imports = True
 
 [versioneer]
-vcs = git
+VCS = git
 style = pep440
 versionfile_source = src/prefect/_version.py
 versionfile_build = prefect/_version.py

{prefect-client-2.20.1 → prefect_client-2.20.2}/src/prefect/infrastructure/kubernetes.py

@@ -586,7 +586,7 @@ class KubernetesJob(Infrastructure):
                         "prefect-job-"
                         # We generate a name using a hash of the primary job settings
                         + stable_hash(
-                            *self.command,
+                            *self.command if self.command else "",
                             *self.env.keys(),
                             *[v for v in self.env.values() if v is not None],
                         )

{prefect-client-2.20.1 → prefect_client-2.20.2}/src/prefect/runtime/flow_run.py

@@ -12,12 +12,14 @@ Available attributes:
     - `scheduled_start_time`: the flow run's expected scheduled start time; defaults to now if not present
     - `name`: the name of the flow run
     - `flow_name`: the name of the flow
+    - `flow_version`: the version of the flow
     - `parameters`: the parameters that were passed to this run; note that these do not necessarily
         include default values set on the flow function, only the parameter values explicitly passed for the run
     - `parent_flow_run_id`: the ID of the flow run that triggered this run, if any
     - `parent_deployment_id`: the ID of the deployment that triggered this run, if any
     - `run_count`: the number of times this flow run has been run
 """
+
 import os
 from typing import Any, Dict, List, Optional
 
@@ -34,6 +36,7 @@ __all__ = [
     "scheduled_start_time",
     "name",
     "flow_name",
+    "flow_version",
     "parameters",
     "parent_flow_run_id",
     "parent_deployment_id",
@@ -188,6 +191,21 @@ def get_flow_name() -> Optional[str]:
         return flow_run_ctx.flow.name
 
 
+def get_flow_version() -> Optional[str]:
+    flow_run_ctx = FlowRunContext.get()
+    run_id = get_id()
+    if flow_run_ctx is None and run_id is None:
+        return None
+    elif flow_run_ctx is None:
+        flow = from_sync.call_soon_in_loop_thread(
+            create_call(_get_flow_from_run, run_id)
+        ).result()
+
+        return flow.version
+    else:
+        return flow_run_ctx.flow.version
+
+
 def get_scheduled_start_time() -> pendulum.DateTime:
     flow_run_ctx = FlowRunContext.get()
     run_id = get_id()
@@ -271,6 +289,7 @@ FIELDS = {
     "scheduled_start_time": get_scheduled_start_time,
     "name": get_name,
     "flow_name": get_flow_name,
+    "flow_version": get_flow_version,
     "parameters": get_parameters,
     "parent_flow_run_id": get_parent_flow_run_id,
     "parent_deployment_id": get_parent_deployment_id,

{prefect-client-2.20.1 → prefect_client-2.20.2}/src/prefect/settings.py

@@ -345,7 +345,11 @@ def template_with_settings(*upstream_settings: Setting) -> Callable[["Settings",
             setting.name: setting.value_from(settings) for setting in upstream_settings
         }
         template = string.Template(str(value))
-        return original_type(template.substitute(template_values))
+        # Note the use of `safe_substitute` to avoid raising an exception if a
+        # template value is missing. In this case, template values will be left
+        # as-is in the string. Using `safe_substitute` prevents us raising when
+        # the DB password contains a `$` character.
+        return original_type(template.safe_substitute(template_values))
 
     return templater
 

{prefect-client-2.20.1 → prefect_client-2.20.2}/src/prefect/workers/base.py

@@ -981,7 +981,12 @@ class BaseWorker(abc.ABC):
 
         deployment_vars = deployment.job_variables or {}
         flow_run_vars = flow_run.job_variables or {}
-        job_variables = {**deployment_vars, **flow_run_vars}
+        job_variables = {**deployment_vars}
+
+        # merge environment variables carefully, otherwise full override
+        if isinstance(job_variables.get("env"), dict):
+            job_variables["env"].update(flow_run_vars.pop("env", {}))
+        job_variables.update(flow_run_vars)
 
         configuration = await self.job_configuration.from_template_and_values(
             base_job_template=self._work_pool.base_job_template,

prefect_client-2.20.2/src/prefect_client.egg-info/PKG-INFO

@@ -0,0 +1,173 @@
+Metadata-Version: 2.1
+Name: prefect-client
+Version: 2.20.2
+Summary: Workflow orchestration and management.
+Home-page: https://www.prefect.io
+Author: Prefect Technologies, Inc.
+Author-email: help@prefect.io
+Project-URL: Changelog, https://github.com/PrefectHQ/prefect/blob/main/RELEASE-NOTES.md
+Project-URL: Documentation, https://docs.prefect.io
+Project-URL: Source, https://github.com/PrefectHQ/prefect
+Project-URL: Tracker, https://github.com/PrefectHQ/prefect/issues
+Classifier: Natural Language :: English
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: anyio<5.0.0,>=4.4.0
+Requires-Dist: asgi-lifespan<3.0,>=1.0
+Requires-Dist: cachetools<6.0,>=5.3
+Requires-Dist: cloudpickle<4.0,>=2.0
+Requires-Dist: coolname<3.0.0,>=1.0.4
+Requires-Dist: croniter<3.0.0,>=1.0.12
+Requires-Dist: fsspec>=2022.5.0
+Requires-Dist: exceptiongroup>=1.2.1
+Requires-Dist: graphviz>=0.20.1
+Requires-Dist: griffe<0.48.0,>=0.20.0
+Requires-Dist: httpcore<2.0.0,>=1.0.5
+Requires-Dist: httpx[http2]!=0.23.2,>=0.23
+Requires-Dist: importlib_metadata>=4.4; python_version < "3.10"
+Requires-Dist: importlib-resources<6.2.0,>=6.1.3
+Requires-Dist: jsonpatch<2.0,>=1.32
+Requires-Dist: jsonschema<5.0.0,>=4.0.0
+Requires-Dist: orjson<4.0,>=3.7
+Requires-Dist: packaging<24.3,>=21.3
+Requires-Dist: pathspec>=0.8.0
+Requires-Dist: pendulum<3.0; python_version < "3.12"
+Requires-Dist: pendulum<4,>=3.0.0; python_version >= "3.12"
+Requires-Dist: pydantic[email]!=2.0.0,!=2.0.1,!=2.1.0,<3.0.0,>=1.10.0
+Requires-Dist: pydantic_core<3.0.0,>=2.12.0
+Requires-Dist: python_dateutil<3.0.0,>=2.8.2
+Requires-Dist: python-slugify<9.0,>=5.0
+Requires-Dist: pyyaml<7.0.0,>=5.4.1
+Requires-Dist: rfc3339-validator<0.2.0,>=0.1.4
+Requires-Dist: rich<14.0,>=11.0
+Requires-Dist: ruamel.yaml>=0.17.0
+Requires-Dist: sniffio<2.0.0,>=1.3.0
+Requires-Dist: toml>=0.10.0
+Requires-Dist: typing_extensions<5.0.0,>=4.5.0
+Requires-Dist: ujson<6.0.0,>=5.8.0
+Requires-Dist: uvicorn!=0.29.0,>=0.14.0
+Requires-Dist: websockets<13.0,>=10.4
+Requires-Dist: itsdangerous
+Requires-Dist: python-multipart>=0.0.7
+Provides-Extra: notifications
+Requires-Dist: apprise<2.0.0,>=1.1.0; extra == "notifications"
+
+<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.20.1 → prefect_client-2.20.2}/src/prefect_client.egg-info/SOURCES.txt

@@ -94,6 +94,7 @@ src/prefect/_vendor/fastapi/exceptions.py
 src/prefect/_vendor/fastapi/logger.py
 src/prefect/_vendor/fastapi/param_functions.py
 src/prefect/_vendor/fastapi/params.py
+src/prefect/_vendor/fastapi/py.typed
 src/prefect/_vendor/fastapi/requests.py
 src/prefect/_vendor/fastapi/responses.py
 src/prefect/_vendor/fastapi/routing.py
@@ -139,6 +140,7 @@ src/prefect/_vendor/starlette/datastructures.py
 src/prefect/_vendor/starlette/endpoints.py
 src/prefect/_vendor/starlette/exceptions.py
 src/prefect/_vendor/starlette/formparsers.py
+src/prefect/_vendor/starlette/py.typed
 src/prefect/_vendor/starlette/requests.py
 src/prefect/_vendor/starlette/responses.py
 src/prefect/_vendor/starlette/routing.py
@@ -298,4 +300,30 @@ src/prefect_client.egg-info/PKG-INFO
 src/prefect_client.egg-info/SOURCES.txt
 src/prefect_client.egg-info/dependency_links.txt
 src/prefect_client.egg-info/requires.txt
-src/prefect_client.egg-info/top_level.txt
+src/prefect_client.egg-info/top_level.txt
+tests/test_artifacts.py
+tests/test_automations.py
+tests/test_background_tasks.py
+tests/test_context.py
+tests/test_deployments.py
+tests/test_engine.py
+tests/test_exceptions.py
+tests/test_filesystems.py
+tests/test_flow_runs.py
+tests/test_flows.py
+tests/test_flows_compat.py
+tests/test_futures.py
+tests/test_highlighters.py
+tests/test_import_interceptor.py
+tests/test_log_prints.py
+tests/test_logging.py
+tests/test_new_flow_engine.py
+tests/test_new_task_engine.py
+tests/test_plugins.py
+tests/test_serializers.py
+tests/test_settings.py
+tests/test_states.py
+tests/test_task_runners.py
+tests/test_task_server.py
+tests/test_tasks.py
+tests/test_variables.py