​

prefect.deployments.steps.pull

​

Functions

​

set_working_directory

set_working_directory(directory: str) -> dict[str, str]

• directory: the directory to set as the working directory

• a dictionary containing a directory key of the absolute path of the directory that was set

​

agit_clone

agit_clone(repository: str, branch: Optional[str] = None, commit_sha: Optional[str] = None, include_submodules: bool = False, access_token: Optional[str] = None, credentials: Optional['Block'] = None, directories: Optional[list[str]] = None, clone_directory_name: Optional[str] = None) -> dict[str, str]

• repository: the URL of the repository to clone
• branch: the branch to clone; if not provided, the default branch will be used
• commit_sha: the commit SHA to clone; if not provided, the default branch will be used
• include_submodules: whether to include git submodules when cloning the repository
• access_token: an access token to use for cloning the repository; if not provided the repository will be cloned using the default git credentials
• credentials: a GitHubCredentials, GitLabCredentials, or BitBucketCredentials block can be used to specify the credentials to use for cloning the repository.
• clone_directory_name: the name of the local directory to clone into; if not provided, the name will be inferred from the repository URL and branch

• a dictionary containing a directory key of the new directory that was created

• subprocess.CalledProcessError: if the git clone command fails for any reason

​

git_clone

git_clone(repository: str, branch: Optional[str] = None, commit_sha: Optional[str] = None, include_submodules: bool = False, access_token: Optional[str] = None, credentials: Optional['Block'] = None, directories: Optional[list[str]] = None, clone_directory_name: Optional[str] = None) -> dict[str, str]

• repository: the URL of the repository to clone
• branch: the branch to clone; if not provided, the default branch will be used
• commit_sha: the commit SHA to clone; if not provided, the default branch will be used
• include_submodules: whether to include git submodules when cloning the repository
• access_token: an access token to use for cloning the repository; if not provided the repository will be cloned using the default git credentials
• credentials: a GitHubCredentials, GitLabCredentials, or BitBucketCredentials block can be used to specify the credentials to use for cloning the repository.
• directories: Specify directories you want to be included (uses git sparse-checkout)
• clone_directory_name: the name of the local directory to clone into; if not provided, the name will be inferred from the repository URL and branch

• a dictionary containing a directory key of the new directory that was created

• subprocess.CalledProcessError: if the git clone command fails for any reason

pull:
    - prefect.deployments.steps.git_clone:
        repository: https://github.com/PrefectHQ/prefect.git

pull:
    - prefect.deployments.steps.git_clone:
        repository: https://github.com/PrefectHQ/prefect.git
        branch: my-branch

pull:
    - prefect.deployments.steps.git_clone:
        repository: https://github.com/org/repo.git
        credentials: "{{ prefect.blocks.github-credentials.my-github-credentials-block }}"

pull:
    - prefect.deployments.steps.git_clone:
        repository: https://github.com/org/repo.git
        access_token: "{{ prefect.blocks.secret.github-access-token }}" # Requires creation of a Secret block

pull:
    - prefect.deployments.steps.git_clone:
        repository: https://github.com/org/repo.git
        include_submodules: true

pull:
    - prefect.deployments.steps.git_clone:
        repository: git@github.com:org/repo.git

pull:
    - prefect.deployments.steps.git_clone:
        repository: https://github.com/org/repo.git
        directories: ["dir_1", "dir_2", "prefect"]

pull:
    - prefect.deployments.steps.git_clone:
        repository: https://github.com/org/repo.git
        branch: dev
        clone_directory_name: my-custom-name

​

pull_from_remote_storage

pull_from_remote_storage(url: str, **settings: Any) -> dict[str, Any]

• url: the URL of the remote storage location. Should be a valid fsspec URL. Some protocols may require an additional fsspec dependency to be installed. Refer to the fsspec docs for more details.
• **settings: any additional settings to pass the fsspec filesystem class.

• a dictionary containing a directory key of the new directory that was created

pull:
    - prefect.deployments.steps.pull_from_remote_storage:
        url: s3://my-bucket/my-folder

pull:
    - prefect.deployments.steps.pull_from_remote_storage:
        url: s3://my-bucket/my-folder
        key: {{ prefect.blocks.secret.my-aws-access-key }}}
        secret: {{ prefect.blocks.secret.my-aws-secret-key }}}

​

pull_with_block

pull_with_block(block_document_name: str, block_type_slug: str) -> dict[str, Any]

• block_document_name: The name of the block document to use
• block_type_slug: The slug of the type of block to use