prefect-client 2.20.4__py3-none-any.whl → 3.0.0__py3-none-any.whl

prefect/deployments/steps/pull.py

@@ -1,18 +1,21 @@
 """
 Core set of steps for specifying a Prefect project pull step.
 """
+
 import os
 from pathlib import Path
-from typing import Any, Optional
+from typing import TYPE_CHECKING, Any, Optional
 
-from prefect._internal.compatibility.deprecated import deprecated_callable
-from prefect.blocks.core import Block
+from prefect._internal.retries import retry_async_fn
 from prefect.logging.loggers import get_logger
 from prefect.runner.storage import BlockStorageAdapter, GitRepository, RemoteStorage
 from prefect.utilities.asyncutils import sync_compatible
 
 deployment_logger = get_logger("deployment")
 
+if TYPE_CHECKING:
+    from prefect.blocks.core import Block
+
 
 def set_working_directory(directory: str) -> dict:
     """
@@ -29,13 +32,19 @@ def set_working_directory(directory: str) -> dict:
     return dict(directory=directory)
 
 
+@retry_async_fn(
+    max_attempts=3,
+    base_delay=1,
+    max_delay=10,
+    retry_on_exceptions=(RuntimeError,),
+)
 @sync_compatible
 async def git_clone(
     repository: str,
     branch: Optional[str] = None,
     include_submodules: bool = False,
     access_token: Optional[str] = None,
-    credentials: Optional[Block] = None,
+    credentials: Optional["Block"] = None,
 ) -> dict:
     """
     Clones a git repository into the current working directory.
@@ -177,6 +186,8 @@ async def pull_with_block(block_document_name: str, block_type_slug: str):
         block_document_name: The name of the block document to use
         block_type_slug: The slug of the type of block to use
     """
+    from prefect.blocks.core import Block
+
     full_slug = f"{block_type_slug}/{block_document_name}"
     try:
         block = await Block.load(full_slug)
@@ -199,20 +210,3 @@ async def pull_with_block(block_document_name: str, block_type_slug: str):
         "Pulled code using block '%s' into '%s'", full_slug, directory
     )
     return {"directory": directory}
-
-
-@deprecated_callable(start_date="Jun 2023", help="Use 'git clone' instead.")
-@sync_compatible
-async def git_clone_project(
-    repository: str,
-    branch: Optional[str] = None,
-    include_submodules: bool = False,
-    access_token: Optional[str] = None,
-) -> dict:
-    """Deprecated. Use `git_clone` instead."""
-    return await git_clone(
-        repository=repository,
-        branch=branch,
-        include_submodules=include_submodules,
-        access_token=access_token,
-    )

prefect/deployments/steps/utility.py

@@ -4,7 +4,7 @@ Utility project steps that are useful for managing a project's deployment lifecy
 Steps within this module can be used within a `build`, `push`, or `pull` deployment action.
 
 Example:
-    Use the `run_shell_script` setp to retrieve the short Git commit hash of the current 
+    Use the `run_shell_script` setp to retrieve the short Git commit hash of the current
         repository and use it as a Docker image tag:
     ```yaml
     build:
@@ -19,6 +19,7 @@ Example:
             dockerfile: auto
     ```
 """
+
 import io
 import os
 import shlex

prefect/docker/__init__.py

@@ -0,0 +1,20 @@
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from prefect.docker.docker_image import DockerImage
+
+__all__ = ["DockerImage"]
+
+_public_api: dict[str, tuple[str, str]] = {
+    "DockerImage": ("prefect.docker.docker_image", "DockerImage"),
+}
+
+
+def __getattr__(name: str) -> object:
+    from importlib import import_module
+
+    if name in _public_api:
+        module, attr = _public_api[name]
+        return getattr(import_module(module), attr)
+
+    raise ImportError(f"module {__name__!r} has no attribute {name!r}")

prefect/docker/docker_image.py

@@ -0,0 +1,82 @@
+from pathlib import Path
+from typing import Optional
+
+from pendulum import now as pendulum_now
+
+from prefect.settings import (
+    PREFECT_DEFAULT_DOCKER_BUILD_NAMESPACE,
+)
+from prefect.utilities.dockerutils import (
+    PushError,
+    build_image,
+    docker_client,
+    generate_default_dockerfile,
+    parse_image_tag,
+    split_repository_path,
+)
+from prefect.utilities.slugify import slugify
+
+
+class DockerImage:
+    """
+    Configuration used to build and push a Docker image for a deployment.
+
+    Attributes:
+        name: The name of the Docker image to build, including the registry and
+            repository.
+        tag: The tag to apply to the built image.
+        dockerfile: The path to the Dockerfile to use for building the image. If
+            not provided, a default Dockerfile will be generated.
+        **build_kwargs: Additional keyword arguments to pass to the Docker build request.
+            See the [`docker-py` documentation](https://docker-py.readthedocs.io/en/stable/images.html#docker.models.images.ImageCollection.build)
+            for more information.
+
+    """
+
+    def __init__(
+        self, name: str, tag: Optional[str] = None, dockerfile="auto", **build_kwargs
+    ):
+        image_name, image_tag = parse_image_tag(name)
+        if tag and image_tag:
+            raise ValueError(
+                f"Only one tag can be provided - both {image_tag!r} and {tag!r} were"
+                " provided as tags."
+            )
+        namespace, repository = split_repository_path(image_name)
+        # if the provided image name does not include a namespace (registry URL or user/org name),
+        # use the default namespace
+        if not namespace:
+            namespace = PREFECT_DEFAULT_DOCKER_BUILD_NAMESPACE.value()
+        # join the namespace and repository to create the full image name
+        # ignore namespace if it is None
+        self.name = "/".join(filter(None, [namespace, repository]))
+        self.tag = tag or image_tag or slugify(pendulum_now("utc").isoformat())
+        self.dockerfile = dockerfile
+        self.build_kwargs = build_kwargs
+
+    @property
+    def reference(self):
+        return f"{self.name}:{self.tag}"
+
+    def build(self):
+        full_image_name = self.reference
+        build_kwargs = self.build_kwargs.copy()
+        build_kwargs["context"] = Path.cwd()
+        build_kwargs["tag"] = full_image_name
+        build_kwargs["pull"] = build_kwargs.get("pull", True)
+
+        if self.dockerfile == "auto":
+            with generate_default_dockerfile():
+                build_image(**build_kwargs)
+        else:
+            build_kwargs["dockerfile"] = self.dockerfile
+            build_image(**build_kwargs)
+
+    def push(self):
+        with docker_client() as client:
+            events = client.api.push(
+                repository=self.name, tag=self.tag, stream=True, decode=True
+            )
+            for event in events:
+                if "error" in event:
+                    raise PushError(event["error"])