Client

Automatically generated client from Dagger API.

class dagger.BuildArg(name: str, value: str)

Bases: Input

Key value object that represents a build argument.

name: str
value: str
class dagger.CacheSharingMode(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Sharing mode of the cache volume.

LOCKED = 'LOCKED'
PRIVATE = 'PRIVATE'
SHARED = 'SHARED'
class dagger.CacheVolume(ctx: Context)

Bases: Type

A directory whose contents persist across runs.

async id() → CacheVolumeID[source]

Note

This is lazily evaluated, no operation is actually run.

Returns:

A global cache volume identifier.

Return type:

CacheVolumeID

Raises:
class dagger.CacheVolumeID

Bases: Scalar

A global cache volume identifier.

class dagger.Client(ctx: Context | None = None)

Bases: Root

cache_volume(key: str) → CacheVolume[source]

Constructs a cache volume for a given cache key.

Parameters:

key – A string identifier to target this cache volume (e.g., “modules- cache”).

async check_version_compatibility(version: str) → bool[source]

Checks if the current Dagger Engine is compatible with an SDK’s required version.

Parameters:

version – The SDK’s required version.

Returns:

The Boolean scalar type represents true or false.

Return type:

bool

Raises:
container(*, id: ContainerID | None = None, platform: Platform | None = None) → Container[source]

Creates a scratch container or loads one by ID.

Optional platform argument initializes new containers to execute and publish as that platform. Platform defaults to that of the builder’s host.

current_function_call() → FunctionCall[source]

The FunctionCall context that the SDK caller is currently executing in. If the caller is not currently executing in a function, this will return an error.

current_module() → Module[source]

The module currently being served in the session, if any.

async default_platform() → Platform[source]

The default platform of the builder.

Returns:

The platform config OS and architecture in a Container. The format is [os]/[platform]/[version] (e.g., “darwin/arm64/v7”, “windows/amd64”, “linux/arm64”).

Return type:

Platform

Raises:
directory(*, id: DirectoryID | None = None) → Directory[source]

Creates an empty directory or loads one by ID.

file(id: FileID) → File[source]

Loads a file by ID.

Deprecated

Use load_file_from_id() instead.

function(name: str, return_type: TypeDef) → Function[source]

Create a function.

generated_code(code: Directory) → GeneratedCode[source]

Create a code generation result, given a directory containing the generated code.

git(url: str, *, keep_git_dir: bool | None = None, ssh_known_hosts: str | None = None, ssh_auth_socket: Socket | None = None, experimental_service_host: Service | None = None) → GitRepository[source]

Queries a git repository.

Parameters:

  • url – Url of the git repository. Can be formatted as https://{host}/{owner}/{repo}, git@{host}:{owner}/{repo} Suffix “.git” is optional.

  • keep_git_dir – Set to true to keep .git directory.

  • ssh_known_hosts – Set SSH known hosts

  • ssh_auth_socket – Set SSH auth socket

  • experimental_service_host – A service which must be started before the repo is fetched.

host() → Host[source]

Queries the host environment.

http(url: str, *, experimental_service_host: Service | None = None) → File[source]

Returns a file containing an http remote url content.

Parameters:

  • url – HTTP url to get the content from (e.g., “https://docs.dagger.io”).

  • experimental_service_host – A service which must be started before the URL is fetched.

load_cache_volume_from_id(id: CacheVolumeID) → CacheVolume[source]

Load a CacheVolume from its ID.

load_container_from_id(id: ContainerID) → Container[source]

Loads a container from an ID.

load_directory_from_id(id: DirectoryID) → Directory[source]

Load a Directory from its ID.

load_file_from_id(id: FileID) → File[source]

Load a File from its ID.

load_function_arg_from_id(id: FunctionArgID) → FunctionArg[source]

Load a function argument by ID.

load_function_from_id(id: FunctionID) → Function[source]

Load a function by ID.

load_generated_code_from_id(id: GeneratedCodeID) → GeneratedCode[source]

Load a GeneratedCode by ID.

load_module_from_id(id: ModuleID) → Module[source]

Load a module by ID.

load_secret_from_id(id: SecretID) → Secret[source]

Load a Secret from its ID.

load_service_from_id(id: ServiceID) → Service[source]

Loads a service from ID.

load_socket_from_id(id: SocketID) → Socket[source]

Load a Socket from its ID.

load_type_def_from_id(id: TypeDefID) → TypeDef[source]

Load a TypeDef by ID.

module() → Module[source]

Create a new module.

module_config(source_directory: Directory, *, subpath: str | None = None) → ModuleConfig[source]

Load the static configuration for a module from the given source directory and optional subpath.

pipeline(name: str, *, description: str | None = None, labels: Sequence[PipelineLabel] | None = None) → Client[source]

Creates a named sub-pipeline.

Parameters:

  • name – Pipeline name.

  • description – Pipeline description.

  • labels – Pipeline labels.

secret(id: SecretID) → Secret[source]

Loads a secret from its ID.

Deprecated

Use load_secret_from_id() instead

set_secret(name: str, plaintext: str) → Secret[source]

Sets a secret given a user defined name to its plaintext and returns the secret. The plaintext value is limited to a size of 128000 bytes.

Parameters:

  • name – The user defined name for this secret

  • plaintext – The plaintext of the secret

socket(*, id: SocketID | None = None) → Socket[source]

Loads a socket by its ID.

Deprecated

Use load_socket_from_id() instead.

type_def() → TypeDef[source]

Create a new TypeDef.

with_(cb: Callable[[Client], Client]) → Client[source]

Call the provided callable with current Client.

This is useful for reusability and readability by not breaking the calling chain.

class dagger.Container(ctx: Context)

Bases: Type

An OCI-compatible container, also known as a docker container.

as_service() → Service[source]

Turn the container into a Service.

Be sure to set any exposed ports before this conversion.

as_tarball(*, platform_variants: Sequence[Container] | None = None, forced_compression: ImageLayerCompression | None = None, media_types: ImageMediaTypes | None = None) → File[source]

Returns a File representing the container serialized to a tarball.

Parameters:

  • platform_variants – Identifiers for other platform specific containers. Used for multi-platform image.

  • forced_compression – Force each layer of the image to use the specified compression algorithm. If this is unset, then if a layer already has a compressed blob in the engine’s cache, that will be used (this can result in a mix of compression algorithms for different layers). If this is unset and a layer has no compressed blob in the engine’s cache, then it will be compressed using Gzip.

  • media_types – Use the specified media types for the image’s layers. Defaults to OCI, which is largely compatible with most recent container runtimes, but Docker may be needed for older runtimes without OCI support.

build(context: Directory, *, dockerfile: str | None = None, build_args: Sequence[BuildArg] | None = None, target: str | None = None, secrets: Sequence[Secret] | None = None) → Container[source]

Initializes this container from a Dockerfile build.

Parameters:

  • context – Directory context used by the Dockerfile.

  • dockerfile – Path to the Dockerfile to use. Default: ‘./Dockerfile’.

  • build_args – Additional build arguments.

  • target – Target build stage to build.

  • secrets – Secrets to pass to the build. They will be mounted at /run/secrets/[secret-name] in the build container They can be accessed in the Dockerfile using the “secret” mount type and mount path /run/secrets/[secret-name] e.g. RUN –mount=type=secret,id=my-secret curl url?token=$(cat /run/secrets/my-secret)”

async default_args() → list[str] | None[source]

Retrieves default arguments for future commands.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

list[str] | None

Raises:
directory(path: str) → Directory[source]

Retrieves a directory at the given path.

Mounts are included.

Parameters:

path – The path of the directory to retrieve (e.g., “./src”).

async entrypoint() → list[str] | None[source]

Retrieves entrypoint to be prepended to the arguments of all commands.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

list[str] | None

Raises:
async env_variable(name: str) → str | None[source]

Retrieves the value of the specified environment variable.

Parameters:

name – The name of the environment variable to retrieve (e.g., “PATH”).

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str | None

Raises:
async env_variables() → list[EnvVariable][source]

Retrieves the list of environment variables passed to commands.

experimental_with_all_gp_us() → Container[source]

EXPERIMENTAL API! Subject to change/removal at any time.

experimentalWithAllGPUs configures all available GPUs on the host to be accessible to this container. This currently works for Nvidia devices only.

experimental_with_gpu(devices: Sequence[str]) → Container[source]

EXPERIMENTAL API! Subject to change/removal at any time.

experimentalWithGPU configures the provided list of devices to be accesible to this container. This currently works for Nvidia devices only.

async export(path: str, *, platform_variants: Sequence[Container] | None = None, forced_compression: ImageLayerCompression | None = None, media_types: ImageMediaTypes | None = None) → bool[source]

Writes the container as an OCI tarball to the destination file path on the host for the specified platform variants.

Return true on success. It can also publishes platform variants.

Parameters:

  • path – Host’s destination path (e.g., “./tarball”). Path can be relative to the engine’s workdir or absolute.

  • platform_variants – Identifiers for other platform specific containers. Used for multi-platform image.

  • forced_compression – Force each layer of the exported image to use the specified compression algorithm. If this is unset, then if a layer already has a compressed blob in the engine’s cache, that will be used (this can result in a mix of compression algorithms for different layers). If this is unset and a layer has no compressed blob in the engine’s cache, then it will be compressed using Gzip.

  • media_types – Use the specified media types for the exported image’s layers. Defaults to OCI, which is largely compatible with most recent container runtimes, but Docker may be needed for older runtimes without OCI support.

Returns:

The Boolean scalar type represents true or false.

Return type:

bool

Raises:
async exposed_ports() → list[Port][source]

Retrieves the list of exposed ports.

This includes ports already exposed by the image, even if not explicitly added with dagger.

file(path: str) → File[source]

Retrieves a file at the given path.

Mounts are included.

Parameters:

path – The path of the file to retrieve (e.g., “./README.md”).

from_(address: str) → Container[source]

Initializes this container from a pulled base image.

Parameters:

address – Image’s address from its registry. Formatted as [host]/[user]/[repo]:[tag] (e.g., “docker.io/dagger/dagger:main”).

async id() → ContainerID[source]

A unique identifier for this container.

Note

This is lazily evaluated, no operation is actually run.

Returns:

A unique container identifier. Null designates an empty container (scratch).

Return type:

ContainerID

Raises:
async image_ref() → str | None[source]

The unique image reference which can only be retrieved immediately after the ‘Container.From’ call.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str | None

Raises:
import_(source: File, *, tag: str | None = None) → Container[source]

Reads the container from an OCI tarball.

NOTE: this involves unpacking the tarball to an OCI store on the host at $XDG_CACHE_DIR/dagger/oci. This directory can be removed whenever you like.

Parameters:

  • source – File to read the container from.

  • tag – Identifies the tag to import from the archive, if the archive bundles multiple tags.

async label(name: str) → str | None[source]

Retrieves the value of the specified label.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str | None

Raises:
async labels() → list[Label][source]

Retrieves the list of labels passed to container.

async mounts() → list[str][source]

Retrieves the list of paths where a directory is mounted.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

list[str]

Raises:
pipeline(name: str, *, description: str | None = None, labels: Sequence[PipelineLabel] | None = None) → Container[source]

Creates a named sub-pipeline

Parameters:

  • name – Pipeline name.

  • description – Pipeline description.

  • labels – Pipeline labels.

async platform() → Platform[source]

The platform this container executes and publishes as.

Returns:

The platform config OS and architecture in a Container. The format is [os]/[platform]/[version] (e.g., “darwin/arm64/v7”, “windows/amd64”, “linux/arm64”).

Return type:

Platform

Raises:
async publish(address: str, *, platform_variants: Sequence[Container] | None = None, forced_compression: ImageLayerCompression | None = None, media_types: ImageMediaTypes | None = None) → str[source]

Publishes this container as a new image to the specified address.

Publish returns a fully qualified ref. It can also publish platform variants.

Parameters:

  • address – Registry’s address to publish the image to. Formatted as [host]/[user]/[repo]:[tag] (e.g. “docker.io/dagger/dagger:main”).

  • platform_variants – Identifiers for other platform specific containers. Used for multi-platform image.

  • forced_compression – Force each layer of the published image to use the specified compression algorithm. If this is unset, then if a layer already has a compressed blob in the engine’s cache, that will be used (this can result in a mix of compression algorithms for different layers). If this is unset and a layer has no compressed blob in the engine’s cache, then it will be compressed using Gzip.

  • media_types – Use the specified media types for the published image’s layers. Defaults to OCI, which is largely compatible with most recent registries, but Docker may be needed for older registries without OCI support.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
rootfs() → Directory[source]

Retrieves this container’s root filesystem. Mounts are not included.

async shell_endpoint() → str[source]

Return a websocket endpoint that, if connected to, will start the container with a TTY streamed over the websocket.

Primarily intended for internal use with the dagger CLI.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
async stderr() → str[source]

The error stream of the last executed command.

Will execute default command if none is set, or error if there’s no default.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
async stdout() → str[source]

The output stream of the last executed command.

Will execute default command if none is set, or error if there’s no default.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
async sync() → Container[source]

Forces evaluation of the pipeline in the engine.

It doesn’t run the default command if no exec has been set.

Raises:
async user() → str | None[source]

Retrieves the user to be set for all commands.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str | None

Raises:
with_(cb: Callable[[Container], Container]) → Container[source]

Call the provided callable with current Container.

This is useful for reusability and readability by not breaking the calling chain.

with_default_args(*, args: Sequence[str] | None = None) → Container[source]

Configures default arguments for future commands.

Parameters:

args – Arguments to prepend to future executions (e.g., [“-v”, “–no- cache”]).

with_directory(path: str, directory: Directory, *, exclude: Sequence[str] | None = None, include: Sequence[str] | None = None, owner: str | None = None) → Container[source]

Retrieves this container plus a directory written at the given path.

Parameters:

  • path – Location of the written directory (e.g., “/tmp/directory”).

  • directory – Identifier of the directory to write

  • exclude – Patterns to exclude in the written directory (e.g., [“node_modules/**”, “.gitignore”, “.git/”]).

  • include – Patterns to include in the written directory (e.g., [”*.go”, “go.mod”, “go.sum”]).

  • owner – A user:group to set for the directory and its contents. The user and group can either be an ID (1000:1000) or a name (foo:bar). If the group is omitted, it defaults to the same as the user.

with_entrypoint(args: Sequence[str]) → Container[source]

Retrieves this container but with a different command entrypoint.

Parameters:

args – Entrypoint to use for future executions (e.g., [“go”, “run”]).

with_env_variable(name: str, value: str, *, expand: bool | None = None) → Container[source]

Retrieves this container plus the given environment variable.

Parameters:

  • name – The name of the environment variable (e.g., “HOST”).

  • value – The value of the environment variable. (e.g., “localhost”).

  • expand – Replace ${VAR} or $VAR in the value according to the current environment variables defined in the container (e.g., “/opt/bin:$PATH”).

with_exec(args: Sequence[str], *, skip_entrypoint: bool | None = None, stdin: str | None = None, redirect_stdout: str | None = None, redirect_stderr: str | None = None, experimental_privileged_nesting: bool | None = None, insecure_root_capabilities: bool | None = None) → Container[source]

Retrieves this container after executing the specified command inside it.

Parameters:

  • args – Command to run instead of the container’s default command (e.g., [“run”, “main.go”]). If empty, the container’s default command is used.

  • skip_entrypoint – If the container has an entrypoint, ignore it for args rather than using it to wrap them.

  • stdin – Content to write to the command’s standard input before closing (e.g., “Hello world”).

  • redirect_stdout – Redirect the command’s standard output to a file in the container (e.g., “/tmp/stdout”).

  • redirect_stderr – Redirect the command’s standard error to a file in the container (e.g., “/tmp/stderr”).

  • experimental_privileged_nesting – Provides dagger access to the executed command. Do not use this option unless you trust the command being executed. The command being executed WILL BE GRANTED FULL ACCESS TO YOUR HOST FILESYSTEM.

  • insecure_root_capabilities – Execute the command with all root capabilities. This is similar to running a command with “sudo” or executing docker run with the –privileged flag. Containerization does not provide any security guarantees when using this option. It should only be used when absolutely necessary and only with trusted commands.

with_exposed_port(port: int, *, protocol: NetworkProtocol | None = None, description: str | None = None) → Container[source]

Expose a network port.

Exposed ports serve two purposes:

  • For health checks and introspection, when running services

  • For setting the EXPOSE OCI field when publishing the container

Parameters:

  • port – Port number to expose

  • protocol – Transport layer network protocol

  • description – Optional port description

with_file(path: str, source: File, *, permissions: int | None = None, owner: str | None = None) → Container[source]

Retrieves this container plus the contents of the given file copied to the given path.

Parameters:

  • path – Location of the copied file (e.g., “/tmp/file.txt”).

  • source – Identifier of the file to copy.

  • permissions – Permission given to the copied file (e.g., 0600). Default: 0644.

  • owner – A user:group to set for the file. The user and group can either be an ID (1000:1000) or a name (foo:bar). If the group is omitted, it defaults to the same as the user.

with_focus() → Container[source]

Indicate that subsequent operations should be featured more prominently in the UI.

with_label(name: str, value: str) → Container[source]

Retrieves this container plus the given label.

Parameters:

  • name – The name of the label (e.g., “org.opencontainers.artifact.created”).

  • value – The value of the label (e.g., “2023-01-01T00:00:00Z”).

with_mounted_cache(path: str, cache: CacheVolume, *, source: Directory | None = None, sharing: CacheSharingMode | None = None, owner: str | None = None) → Container[source]

Retrieves this container plus a cache volume mounted at the given path.

Parameters:

  • path – Location of the cache directory (e.g., “/cache/node_modules”).

  • cache – Identifier of the cache volume to mount.

  • source – Identifier of the directory to use as the cache volume’s root.

  • sharing – Sharing mode of the cache volume.

  • owner – A user:group to set for the mounted cache directory. Note that this changes the ownership of the specified mount along with the initial filesystem provided by source (if any). It does not have any effect if/when the cache has already been created. The user and group can either be an ID (1000:1000) or a name (foo:bar). If the group is omitted, it defaults to the same as the user.

with_mounted_directory(path: str, source: Directory, *, owner: str | None = None) → Container[source]

Retrieves this container plus a directory mounted at the given path.

Parameters:

  • path – Location of the mounted directory (e.g., “/mnt/directory”).

  • source – Identifier of the mounted directory.

  • owner – A user:group to set for the mounted directory and its contents. The user and group can either be an ID (1000:1000) or a name (foo:bar). If the group is omitted, it defaults to the same as the user.

with_mounted_file(path: str, source: File, *, owner: str | None = None) → Container[source]

Retrieves this container plus a file mounted at the given path.

Parameters:

  • path – Location of the mounted file (e.g., “/tmp/file.txt”).

  • source – Identifier of the mounted file.

  • owner – A user or user:group to set for the mounted file. The user and group can either be an ID (1000:1000) or a name (foo:bar). If the group is omitted, it defaults to the same as the user.

with_mounted_secret(path: str, source: Secret, *, owner: str | None = None, mode: int | None = None) → Container[source]

Retrieves this container plus a secret mounted into a file at the given path.

Parameters:

  • path – Location of the secret file (e.g., “/tmp/secret.txt”).

  • source – Identifier of the secret to mount.

  • owner – A user:group to set for the mounted secret. The user and group can either be an ID (1000:1000) or a name (foo:bar). If the group is omitted, it defaults to the same as the user.

  • mode – Permission given to the mounted secret (e.g., 0600). This option requires an owner to be set to be active. Default: 0400.

with_mounted_temp(path: str) → Container[source]

Retrieves this container plus a temporary directory mounted at the given path.

Parameters:

path – Location of the temporary directory (e.g., “/tmp/temp_dir”).

with_new_file(path: str, *, contents: str | None = None, permissions: int | None = None, owner: str | None = None) → Container[source]

Retrieves this container plus a new file written at the given path.

Parameters:

  • path – Location of the written file (e.g., “/tmp/file.txt”).

  • contents – Content of the file to write (e.g., “Hello world!”).

  • permissions – Permission given to the written file (e.g., 0600). Default: 0644.

  • owner – A user:group to set for the file. The user and group can either be an ID (1000:1000) or a name (foo:bar). If the group is omitted, it defaults to the same as the user.

with_registry_auth(address: str, username: str, secret: Secret) → Container[source]

Retrieves this container with a registry authentication for a given address.

Parameters:

  • address – Registry’s address to bind the authentication to. Formatted as [host]/[user]/[repo]:[tag] (e.g. docker.io/dagger/dagger:main).

  • username – The username of the registry’s account (e.g., “Dagger”).

  • secret – The API key, password or token to authenticate to this registry.

with_rootfs(directory: Directory) → Container[source]

Initializes this container from this DirectoryID.

with_secret_variable(name: str, secret: Secret) → Container[source]

Retrieves this container plus an env variable containing the given secret.

Parameters:

  • name – The name of the secret variable (e.g., “API_SECRET”).

  • secret – The identifier of the secret value.

with_service_binding(alias: str, service: Service) → Container[source]

Establish a runtime dependency on a service.

The service will be started automatically when needed and detached when it is no longer needed, executing the default command if none is set.

The service will be reachable from the container via the provided hostname alias.

The service dependency will also convey to any files or directories produced by the container.

Parameters:

  • alias – A name that can be used to reach the service from the container

  • service – Identifier of the service container

with_unix_socket(path: str, source: Socket, *, owner: str | None = None) → Container[source]

Retrieves this container plus a socket forwarded to the given Unix socket path.

Parameters:

  • path – Location of the forwarded Unix socket (e.g., “/tmp/socket”).

  • source – Identifier of the socket to forward.

  • owner – A user:group to set for the mounted socket. The user and group can either be an ID (1000:1000) or a name (foo:bar). If the group is omitted, it defaults to the same as the user.

with_user(name: str) → Container[source]

Retrieves this container with a different command user.

Parameters:

name – The user to set (e.g., “root”).

with_workdir(path: str) → Container[source]

Retrieves this container with a different working directory.

Parameters:

path – The path to set as the working directory (e.g., “/app”).

without_env_variable(name: str) → Container[source]

Retrieves this container minus the given environment variable.

Parameters:

name – The name of the environment variable (e.g., “HOST”).

without_exposed_port(port: int, *, protocol: NetworkProtocol | None = None) → Container[source]

Unexpose a previously exposed port.

Parameters:

  • port – Port number to unexpose

  • protocol – Port protocol to unexpose

without_focus() → Container[source]

Indicate that subsequent operations should not be featured more prominently in the UI.

This is the initial state of all containers.

without_label(name: str) → Container[source]

Retrieves this container minus the given environment label.

Parameters:

name – The name of the label to remove (e.g., “org.opencontainers.artifact.created”).

without_mount(path: str) → Container[source]

Retrieves this container after unmounting everything at the given path.

Parameters:

path – Location of the cache directory (e.g., “/cache/node_modules”).

without_registry_auth(address: str) → Container[source]

Retrieves this container without the registry authentication of a given address.

Parameters:

address – Registry’s address to remove the authentication from. Formatted as [host]/[user]/[repo]:[tag] (e.g. docker.io/dagger/dagger:main).

without_unix_socket(path: str) → Container[source]

Retrieves this container with a previously added Unix socket removed.

Parameters:

path – Location of the socket to remove (e.g., “/tmp/socket”).

async workdir() → str | None[source]

Retrieves the working directory for all commands.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str | None

Raises:
class dagger.ContainerID

Bases: Scalar

A unique container identifier. Null designates an empty container (scratch).

class dagger.Directory(ctx: Context)

Bases: Type

A directory.

as_module(*, source_subpath: str | None = None) → Module[source]

Load the directory as a Dagger module

Parameters:

source_subpath – An optional subpath of the directory which contains the module’s source code. This is needed when the module code is in a subdirectory but requires parent directories to be loaded in order to execute. For example, the module source code may need a go.mod, project.toml, package.json, etc. file from a parent directory. If not set, the module source code is loaded from the root of the directory.

diff(other: Directory) → Directory[source]

Gets the difference between this directory and an another directory.

Parameters:

other – Identifier of the directory to compare.

directory(path: str) → Directory[source]

Retrieves a directory at the given path.

Parameters:

path – Location of the directory to retrieve (e.g., “/src”).

docker_build(*, dockerfile: str | None = None, platform: Platform | None = None, build_args: Sequence[BuildArg] | None = None, target: str | None = None, secrets: Sequence[Secret] | None = None) → Container[source]

Builds a new Docker container from this directory.

Parameters:

  • dockerfile – Path to the Dockerfile to use (e.g., “frontend.Dockerfile”). Defaults: ‘./Dockerfile’.

  • platform – The platform to build.

  • build_args – Build arguments to use in the build.

  • target – Target build stage to build.

  • secrets – Secrets to pass to the build. They will be mounted at /run/secrets/[secret-name].

async entries(*, path: str | None = None) → list[str][source]

Returns a list of files and directories at the given path.

Parameters:

path – Location of the directory to look at (e.g., “/src”).

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

list[str]

Raises:
async export(path: str) → bool[source]

Writes the contents of the directory to a path on the host.

Parameters:

path – Location of the copied directory (e.g., “logs/”).

Returns:

The Boolean scalar type represents true or false.

Return type:

bool

Raises:
file(path: str) → File[source]

Retrieves a file at the given path.

Parameters:

path – Location of the file to retrieve (e.g., “README.md”).

async glob(pattern: str) → list[str][source]

Returns a list of files and directories that matche the given pattern.

Parameters:

pattern – Pattern to match (e.g., “*.md”).

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

list[str]

Raises:
async id() → DirectoryID[source]

The content-addressed identifier of the directory.

Note

This is lazily evaluated, no operation is actually run.

Returns:

A content-addressed directory identifier.

Return type:

DirectoryID

Raises:
pipeline(name: str, *, description: str | None = None, labels: Sequence[PipelineLabel] | None = None) → Directory[source]

Creates a named sub-pipeline

Parameters:

  • name – Pipeline name.

  • description – Pipeline description.

  • labels – Pipeline labels.

async sync() → Directory[source]

Force evaluation in the engine.

Raises:
with_(cb: Callable[[Directory], Directory]) → Directory[source]

Call the provided callable with current Directory.

This is useful for reusability and readability by not breaking the calling chain.

with_directory(path: str, directory: Directory, *, exclude: Sequence[str] | None = None, include: Sequence[str] | None = None) → Directory[source]

Retrieves this directory plus a directory written at the given path.

Parameters:

  • path – Location of the written directory (e.g., “/src/”).

  • directory – Identifier of the directory to copy.

  • exclude – Exclude artifacts that match the given pattern (e.g., [“node_modules/”, “.git*”]).

  • include – Include only artifacts that match the given pattern (e.g., [“app/”, “package.*”]).

with_file(path: str, source: File, *, permissions: int | None = None) → Directory[source]

Retrieves this directory plus the contents of the given file copied to the given path.

Parameters:

  • path – Location of the copied file (e.g., “/file.txt”).

  • source – Identifier of the file to copy.

  • permissions – Permission given to the copied file (e.g., 0600). Default: 0644.

with_new_directory(path: str, *, permissions: int | None = None) → Directory[source]

Retrieves this directory plus a new directory created at the given path.

Parameters:

  • path – Location of the directory created (e.g., “/logs”).

  • permissions – Permission granted to the created directory (e.g., 0777). Default: 0755.

with_new_file(path: str, contents: str, *, permissions: int | None = None) → Directory[source]

Retrieves this directory plus a new file written at the given path.

Parameters:

  • path – Location of the written file (e.g., “/file.txt”).

  • contents – Content of the written file (e.g., “Hello world!”).

  • permissions – Permission given to the copied file (e.g., 0600). Default: 0644.

with_timestamps(timestamp: int) → Directory[source]

Retrieves this directory with all file/dir timestamps set to the given time.

Parameters:

timestamp – Timestamp to set dir/files in. Formatted in seconds following Unix epoch (e.g., 1672531199).

without_directory(path: str) → Directory[source]

Retrieves this directory with the directory at the given path removed.

Parameters:

path – Location of the directory to remove (e.g., “.github/”).

without_file(path: str) → Directory[source]

Retrieves this directory with the file at the given path removed.

Parameters:

path – Location of the file to remove (e.g., “/file.txt”).

class dagger.DirectoryID

Bases: Scalar

A content-addressed directory identifier.

class dagger.EnvVariable(ctx: Context)

Bases: Type

A simple key value object that represents an environment variable.

async name() → str[source]

The environment variable name.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
async value() → str[source]

The environment variable value.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
class dagger.FieldTypeDef(ctx: Context)

Bases: Type

A definition of a field on a custom object defined in a Module. A field on an object has a static value, as opposed to a function on an object whose value is computed by invoking code (and can accept arguments).

async description() → str | None[source]

A doc string for the field, if any

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str | None

Raises:
async name() → str[source]

The name of the field in the object

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
type_def() → TypeDef[source]

The type of the field

class dagger.File(ctx: Context)

Bases: Type

A file.

async contents() → str[source]

Retrieves the contents of the file.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
async export(path: str, *, allow_parent_dir_path: bool | None = None) → bool[source]

Writes the file to a file path on the host.

Parameters:

  • path – Location of the written directory (e.g., “output.txt”).

  • allow_parent_dir_path – If allowParentDirPath is true, the path argument can be a directory path, in which case the file will be created in that directory.

Returns:

The Boolean scalar type represents true or false.

Return type:

bool

Raises:
async id() → FileID[source]

Retrieves the content-addressed identifier of the file.

Note

This is lazily evaluated, no operation is actually run.

Returns:

A file identifier.

Return type:

FileID

Raises:
async size() → int[source]

Gets the size of the file, in bytes.

Returns:

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Return type:

int

Raises:
async sync() → File[source]

Force evaluation in the engine.

Raises:
with_(cb: Callable[[File], File]) → File[source]

Call the provided callable with current File.

This is useful for reusability and readability by not breaking the calling chain.

with_timestamps(timestamp: int) → File[source]

Retrieves this file with its created/modified timestamps set to the given time.

Parameters:

timestamp – Timestamp to set dir/files in. Formatted in seconds following Unix epoch (e.g., 1672531199).

class dagger.FileID

Bases: Scalar

A file identifier.

class dagger.Function(ctx: Context)

Bases: Type

Function represents a resolver provided by a Module. A function always evaluates against a parent object and is given a set of named arguments.

async args() → list[FunctionArg][source]

Arguments accepted by this function, if any

async description() → str | None[source]

A doc string for the function, if any

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str | None

Raises:
async id() → FunctionID[source]

The ID of the function

Note

This is lazily evaluated, no operation is actually run.

Returns:

A reference to a Function.

Return type:

FunctionID

Raises:
async name() → str[source]

The name of the function

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
return_type() → TypeDef[source]

The type returned by this function

with_(cb: Callable[[Function], Function]) → Function[source]

Call the provided callable with current Function.

This is useful for reusability and readability by not breaking the calling chain.

with_arg(name: str, type_def: TypeDef, *, description: str | None = None, default_value: JSON | None = None) → Function[source]

Returns the function with the provided argument

Parameters:

  • name – The name of the argument

  • type_def – The type of the argument

  • description – A doc string for the argument, if any

  • default_value – A default value to use for this argument if not explicitly set by the caller, if any

with_description(description: str) → Function[source]

Returns the function with the doc string

class dagger.FunctionArg(ctx: Context)

Bases: Type

An argument accepted by a function. This is a specification for an argument at function definition time, not an argument passed at function call time.

async default_value() → JSON | None[source]

A default value to use for this argument when not explicitly set by the caller, if any

Returns:

An arbitrary JSON-encoded value.

Return type:

JSON | None

Raises:
async description() → str | None[source]

A doc string for the argument, if any

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str | None

Raises:
async id() → FunctionArgID[source]

The ID of the argument

Note

This is lazily evaluated, no operation is actually run.

Returns:

A reference to a FunctionArg.

Return type:

FunctionArgID

Raises:
async name() → str[source]

The name of the argument

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
type_def() → TypeDef[source]

The type of the argument

class dagger.FunctionArgID

Bases: Scalar

A reference to a FunctionArg.

class dagger.FunctionCall(ctx: Context)

Bases: Type

async input_args() → list[FunctionCallArgValue][source]

The argument values the function is being invoked with.

async name() → str[source]

The name of the function being called.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
async parent() → JSON[source]

The value of the parent object of the function being called. If the function is “top-level” to the module, this is always an empty object.

Returns:

An arbitrary JSON-encoded value.

Return type:

JSON

Raises:
async parent_name() → str[source]

The name of the parent object of the function being called. If the function is “top-level” to the module, this is the name of the module.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
async return_value(value: JSON) → Void | None[source]

Set the return value of the function call to the provided value. The value should be a string of the JSON serialization of the return value.

Returns:

The absense of a value. A Null Void is used as a placeholder for resolvers that do not return anything.

Return type:

Void | None

Raises:
class dagger.FunctionCallArgValue(ctx: Context)

Bases: Type

async name() → str[source]

The name of the argument.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
async value() → JSON[source]

The value of the argument represented as a string of the JSON serialization.

Returns:

An arbitrary JSON-encoded value.

Return type:

JSON

Raises:
class dagger.FunctionID

Bases: Scalar

A reference to a Function.

class dagger.GeneratedCode(ctx: Context)

Bases: Type

code() → Directory[source]

The directory containing the generated code

async id() → GeneratedCodeID[source]

Note

This is lazily evaluated, no operation is actually run.

Returns:

A reference to GeneratedCode.

Return type:

GeneratedCodeID

Raises:
async vcs_generated_paths() → list[str] | None[source]

List of paths to mark generated in version control (i.e. .gitattributes)

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

list[str] | None

Raises:
async vcs_ignored_paths() → list[str] | None[source]

List of paths to ignore in version control (i.e. .gitignore)

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

list[str] | None

Raises:
with_(cb: Callable[[GeneratedCode], GeneratedCode]) → GeneratedCode[source]

Call the provided callable with current GeneratedCode.

This is useful for reusability and readability by not breaking the calling chain.

with_vcs_generated_paths(paths: Sequence[str]) → GeneratedCode[source]

Set the list of paths to mark generated in version control

with_vcs_ignored_paths(paths: Sequence[str]) → GeneratedCode[source]

Set the list of paths to ignore in version control

class dagger.GeneratedCodeID

Bases: Scalar

A reference to GeneratedCode.

class dagger.GitRef(ctx: Context)

Bases: Type

A git ref (tag, branch or commit).

async commit() → str[source]

The resolved commit id at this ref.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
tree(*, ssh_known_hosts: str | None = None, ssh_auth_socket: Socket | None = None) → Directory[source]

The filesystem tree at this ref.

class dagger.GitRepository(ctx: Context)

Bases: Type

A git repository.

branch(name: str) → GitRef[source]

Returns details on one branch.

Parameters:

name – Branch’s name (e.g., “main”).

commit(id: str) → GitRef[source]

Returns details on one commit.

Parameters:

id – Identifier of the commit (e.g., “b6315d8f2810962c601af73f86831f6866ea798b”).

tag(name: str) → GitRef[source]

Returns details on one tag.

Parameters:

name – Tag’s name (e.g., “v0.3.9”).

class dagger.Host(ctx: Context)

Bases: Type

Information about the host execution environment.

directory(path: str, *, exclude: Sequence[str] | None = None, include: Sequence[str] | None = None) → Directory[source]

Accesses a directory on the host.

Parameters:

  • path – Location of the directory to access (e.g., “.”).

  • exclude – Exclude artifacts that match the given pattern (e.g., [“node_modules/”, “.git*”]).

  • include – Include only artifacts that match the given pattern (e.g., [“app/”, “package.*”]).

file(path: str) → File[source]

Accesses a file on the host.

Parameters:

path – Location of the file to retrieve (e.g., “README.md”).

service(ports: Sequence[PortForward], *, host: str | None = 'localhost') → Service[source]

Creates a service that forwards traffic to a specified address via the host.

Parameters:

  • ports – Ports to expose via the service, forwarding through the host network. If a port’s frontend is unspecified or 0, it defaults to the same as the backend port. An empty set of ports is not valid; an error will be returned.

  • host – Upstream host to forward traffic to.

set_secret_file(name: str, path: str) → Secret[source]

Sets a secret given a user-defined name and the file path on the host, and returns the secret. The file is limited to a size of 512000 bytes.

Parameters:

  • name – The user defined name for this secret.

  • path – Location of the file to set as a secret.

tunnel(service: Service, *, native: bool | None = False, ports: Sequence[PortForward] | None = None) → Service[source]

Creates a tunnel that forwards traffic from the host to a service.

Parameters:

  • service – Service to send traffic from the tunnel.

  • native – Map each service port to the same port on the host, as if the service were running natively. Note: enabling may result in port conflicts.

  • ports – Configure explicit port forwarding rules for the tunnel. If a port’s frontend is unspecified or 0, a random port will be chosen by the host. If no ports are given, all of the service’s ports are forwarded. If native is true, each port maps to the same port on the host. If native is false, each port maps to a random port chosen by the host. If ports are given and native is true, the ports are additive.

unix_socket(path: str) → Socket[source]

Accesses a Unix socket on the host.

Parameters:

path – Location of the Unix socket (e.g., “/var/run/docker.sock”).

class dagger.ImageLayerCompression(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Compression algorithm to use for image layers.

EStarGZ = 'EStarGZ'
Gzip = 'Gzip'
Uncompressed = 'Uncompressed'
Zstd = 'Zstd'
class dagger.ImageMediaTypes(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Mediatypes to use in published or exported image metadata.

DockerMediaTypes = 'DockerMediaTypes'
OCIMediaTypes = 'OCIMediaTypes'
class dagger.JSON

Bases: Scalar

An arbitrary JSON-encoded value.

class dagger.Label(ctx: Context)

Bases: Type

A simple key value object that represents a label.

async name() → str[source]

The label name.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
async value() → str[source]

The label value.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
class dagger.ListTypeDef(ctx: Context)

Bases: Type

A definition of a list type in a Module.

element_type_def() → TypeDef[source]

The type of the elements in the list

class dagger.Module(ctx: Context)

Bases: Type

async dependencies() → list[Module][source]

Modules used by this module

async dependency_config() → list[str][source]

The dependencies as configured by the module

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

list[str]

Raises:
async description() → str | None[source]

The doc string of the module, if any

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str | None

Raises:
generated_code() → GeneratedCode[source]

The code generated by the SDK’s runtime

async id() → ModuleID[source]

The ID of the module

Note

This is lazily evaluated, no operation is actually run.

Returns:

A reference to a Module.

Return type:

ModuleID

Raises:
async name() → str[source]

The name of the module

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
async objects() → list[TypeDef][source]

Objects served by this module

async sdk() → str[source]

The SDK used by this module. Either a name of a builtin SDK or a module ref pointing to the SDK’s implementation.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
async serve() → Void | None[source]
Serve a module’s API in the current session.

Note: this can only be called once per session. In the future, it could return a stream or service to remove the

side effect.

Returns:

The absense of a value. A Null Void is used as a placeholder for resolvers that do not return anything.

Return type:

Void | None

Raises:
source_directory() → Directory[source]

The directory containing the module’s source code

async source_directory_sub_path() → str[source]

The module’s subpath within the source directory

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
with_(cb: Callable[[Module], Module]) → Module[source]

Call the provided callable with current Module.

This is useful for reusability and readability by not breaking the calling chain.

with_object(object: TypeDef) → Module[source]

This module plus the given Object type and associated functions

class dagger.ModuleConfig(ctx: Context)

Bases: Type

Static configuration for a module (e.g. parsed contents of dagger.json)

async dependencies() → list[str] | None[source]

Modules that this module depends on.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

list[str] | None

Raises:
async exclude() → list[str] | None[source]

Exclude these file globs when loading the module root.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

list[str] | None

Raises:
async include() → list[str] | None[source]

Include only these file globs when loading the module root.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

list[str] | None

Raises:
async name() → str[source]

The name of the module.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
async root() → str | None[source]

The root directory of the module’s project, which may be above the module source code.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str | None

Raises:
async sdk() → str[source]

Either the name of a built-in SDK (‘go’, ‘python’, etc.) OR a module reference pointing to the SDK’s module implementation.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
class dagger.ModuleID

Bases: Scalar

A reference to a Module.

class dagger.NetworkProtocol(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Transport layer network protocol associated to a port.

TCP = 'TCP'
UDP = 'UDP'
class dagger.ObjectTypeDef(ctx: Context)

Bases: Type

A definition of a custom object defined in a Module.

constructor() → Function[source]

The function used to construct new instances of this object, if any

async description() → str | None[source]

The doc string for the object, if any

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str | None

Raises:
async fields() → list[FieldTypeDef][source]

Static fields defined on this object, if any

async functions() → list[Function][source]

Functions defined on this object, if any

async name() → str[source]

The name of the object

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
class dagger.PipelineLabel(name: str, value: str)

Bases: Input

Key value object that represents a Pipeline label.

name: str
value: str
class dagger.Platform

Bases: Scalar

The platform config OS and architecture in a Container. The format is [os]/[platform]/[version] (e.g., “darwin/arm64/v7”, “windows/amd64”, “linux/arm64”).

class dagger.Port(ctx: Context)

Bases: Type

A port exposed by a container.

async description() → str | None[source]

The port description.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str | None

Raises:
async port() → int[source]

The port number.

Returns:

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

Return type:

int

Raises:
async protocol() → NetworkProtocol[source]

The transport layer network protocol.

Returns:

Transport layer network protocol associated to a port.

Return type:

NetworkProtocol

Raises:
class dagger.PortForward(backend: int, frontend: int | None = None, protocol: NetworkProtocol | None = None)

Bases: Input

Port forwarding rules for tunneling network traffic.

backend: int
frontend: int | None
protocol: NetworkProtocol | None
class dagger.Secret(ctx: Context)

Bases: Type

A reference to a secret value, which can be handled more safely than the value itself.

async id() → SecretID[source]

The identifier for this secret.

Note

This is lazily evaluated, no operation is actually run.

Returns:

A unique identifier for a secret.

Return type:

SecretID

Raises:
async plaintext() → str[source]

The value of this secret.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
class dagger.SecretID

Bases: Scalar

A unique identifier for a secret.

class dagger.Service(ctx: Context)

Bases: Type

async endpoint(*, port: int | None = None, scheme: str | None = None) → str[source]

Retrieves an endpoint that clients can use to reach this container.

If no port is specified, the first exposed port is used. If none exist an error is returned.

If a scheme is specified, a URL is returned. Otherwise, a host:port pair is returned.

Parameters:

  • port – The exposed port number for the endpoint

  • scheme – Return a URL with the given scheme, eg. http for http://

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
async hostname() → str[source]

Retrieves a hostname which can be used by clients to reach this container.

Returns:

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

Return type:

str

Raises:
async id() → ServiceID[source]

A unique identifier for this service.

Note

This is lazily evaluated, no operation is actually run.

Returns:

A unique service identifier.

Return type:

ServiceID

Raises:
async ports() → list[Port][source]

Retrieves the list of ports provided by the service.

async start() → Service[source]

Start the service and wait for its health checks to succeed.

Services bound to a Container do not need to be manually started.

Raises:
async stop() → Service[source]

Stop the service.

Raises:
class dagger.ServiceID

Bases: Scalar

A unique service identifier.

class dagger.Socket(ctx: Context)

Bases: Type

async id() → SocketID[source]

The content-addressed identifier of the socket.

Note

This is lazily evaluated, no operation is actually run.

Returns:

A content-addressed socket identifier.

Return type:

SocketID

Raises:
class dagger.SocketID

Bases: Scalar

A content-addressed socket identifier.

class dagger.TypeDef(ctx: Context)

Bases: Type

A definition of a parameter or return type in a Module.

as_list() → ListTypeDef[source]

If kind is LIST, the list-specific type definition. If kind is not LIST, this will be null.

as_object() → ObjectTypeDef[source]

If kind is OBJECT, the object-specific type definition. If kind is not OBJECT, this will be null.

async id() → TypeDefID[source]

Note

This is lazily evaluated, no operation is actually run.

Returns:

A reference to a TypeDef.

Return type:

TypeDefID

Raises:
async kind() → TypeDefKind | None[source]

The kind of type this is (e.g. primitive, list, object)

Returns:

Distinguishes the different kinds of TypeDefs.

Return type:

TypeDefKind | None

Raises:
async optional() → bool[source]

Whether this type can be set to null. Defaults to false.

Returns:

The Boolean scalar type represents true or false.

Return type:

bool

Raises:
with_(cb: Callable[[TypeDef], TypeDef]) → TypeDef[source]

Call the provided callable with current TypeDef.

This is useful for reusability and readability by not breaking the calling chain.

with_constructor(function: Function) → TypeDef[source]

Adds a function for constructing a new instance of an Object TypeDef, failing if the type is not an object.

with_field(name: str, type_def: TypeDef, *, description: str | None = None) → TypeDef[source]

Adds a static field for an Object TypeDef, failing if the type is not an object.

Parameters:

  • name – The name of the field in the object

  • type_def – The type of the field

  • description – A doc string for the field, if any

with_function(function: Function) → TypeDef[source]

Adds a function for an Object TypeDef, failing if the type is not an object.

with_kind(kind: TypeDefKind) → TypeDef[source]

Sets the kind of the type.

with_list_of(element_type: TypeDef) → TypeDef[source]

Returns a TypeDef of kind List with the provided type for its elements.

with_object(name: str, *, description: str | None = None) → TypeDef[source]

Returns a TypeDef of kind Object with the provided name.

Note that an object’s fields and functions may be omitted if the intent is only to refer to an object. This is how functions are able to return their own object, or any other circular reference.

with_optional(optional: bool) → TypeDef[source]

Sets whether this type can be set to null.

class dagger.TypeDefID

Bases: Scalar

A reference to a TypeDef.

class dagger.TypeDefKind(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Distinguishes the different kinds of TypeDefs.

BooleanKind = 'BooleanKind'
IntegerKind = 'IntegerKind'
ListKind = 'ListKind'
ObjectKind = 'ObjectKind'
StringKind = 'StringKind'
VoidKind = 'VoidKind'
class dagger.Void

Bases: Scalar

The absense of a value. A Null Void is used as a placeholder for resolvers that do not return anything.