Dagger Python SDK

A client package for running Dagger pipelines.

Tip

New to Dagger? Learn how it works and start using it.

Reference

• Connection
  • connection()
  • Connection
  • Config
  • Timeout
  • Retry
• Client
  • Binding
    • Binding.as_cache_volume()
    • Binding.as_container()
    • Binding.as_directory()
    • Binding.as_env()
    • Binding.as_file()
    • Binding.as_git_ref()
    • Binding.as_git_repository()
    • Binding.as_llm()
    • Binding.as_module()
    • Binding.as_module_config_client()
    • Binding.as_module_source()
    • Binding.as_secret()
    • Binding.as_service()
    • Binding.as_socket()
    • Binding.as_string()
    • Binding.digest()
    • Binding.id()
    • Binding.is_null()
    • Binding.name()
    • Binding.type_name()
  • BindingID
  • BuildArg
    • BuildArg.name
    • BuildArg.value
  • CacheSharingMode
    • CacheSharingMode.LOCKED
    • CacheSharingMode.PRIVATE
    • CacheSharingMode.SHARED
  • CacheVolume
    • CacheVolume.id()
  • CacheVolumeID
  • Client
    • Client.cache_volume()
    • Client.container()
    • Client.current_function_call()
    • Client.current_module()
    • Client.current_type_defs()
    • Client.default_platform()
    • Client.directory()
    • Client.engine()
    • Client.env()
    • Client.error()
    • Client.function()
    • Client.generated_code()
    • Client.git()
    • Client.host()
    • Client.http()
    • Client.llm()
    • Client.load_binding_from_id()
    • Client.load_cache_volume_from_id()
    • Client.load_container_from_id()
    • Client.load_current_module_from_id()
    • Client.load_directory_from_id()
    • Client.load_engine_cache_entry_from_id()
    • Client.load_engine_cache_entry_set_from_id()
    • Client.load_engine_cache_from_id()
    • Client.load_engine_from_id()
    • Client.load_enum_type_def_from_id()
    • Client.load_enum_value_type_def_from_id()
    • Client.load_env_from_id()
    • Client.load_env_variable_from_id()
    • Client.load_error_from_id()
    • Client.load_error_value_from_id()
    • Client.load_field_type_def_from_id()
    • Client.load_file_from_id()
    • Client.load_function_arg_from_id()
    • Client.load_function_call_arg_value_from_id()
    • Client.load_function_call_from_id()
    • Client.load_function_from_id()
    • Client.load_generated_code_from_id()
    • Client.load_git_ref_from_id()
    • Client.load_git_repository_from_id()
    • Client.load_host_from_id()
    • Client.load_input_type_def_from_id()
    • Client.load_interface_type_def_from_id()
    • Client.load_label_from_id()
    • Client.load_list_type_def_from_id()
    • Client.load_llm_from_id()
    • Client.load_llm_token_usage_from_id()
    • Client.load_module_config_client_from_id()
    • Client.load_module_from_id()
    • Client.load_module_source_from_id()
    • Client.load_object_type_def_from_id()
    • Client.load_port_from_id()
    • Client.load_scalar_type_def_from_id()
    • Client.load_sdk_config_from_id()
    • Client.load_secret_from_id()
    • Client.load_service_from_id()
    • Client.load_socket_from_id()
    • Client.load_source_map_from_id()
    • Client.load_terminal_from_id()
    • Client.load_type_def_from_id()
    • Client.module()
    • Client.module_source()
    • Client.secret()
    • Client.set_secret()
    • Client.source_map()
    • Client.type_def()
    • Client.version()
  • Container
    • Container.as_service()
    • Container.as_tarball()
    • Container.build()
    • Container.default_args()
    • Container.directory()
    • Container.entrypoint()
    • Container.env_variable()
    • Container.env_variables()
    • Container.exit_code()
    • Container.experimental_with_all_gp_us()
    • Container.experimental_with_gpu()
    • Container.export()
    • Container.exposed_ports()
    • Container.file()
    • Container.from_()
    • Container.id()
    • Container.image_ref()
    • Container.import_()
    • Container.label()
    • Container.labels()
    • Container.mounts()
    • Container.platform()
    • Container.publish()
    • Container.rootfs()
    • Container.stderr()
    • Container.stdout()
    • Container.sync()
    • Container.terminal()
    • Container.up()
    • Container.user()
    • Container.with_()
    • Container.with_annotation()
    • Container.with_default_args()
    • Container.with_default_terminal_cmd()
    • Container.with_directory()
    • Container.with_entrypoint()
    • Container.with_env_variable()
    • Container.with_exec()
    • Container.with_exposed_port()
    • Container.with_file()
    • Container.with_files()
    • Container.with_label()
    • Container.with_mounted_cache()
    • Container.with_mounted_directory()
    • Container.with_mounted_file()
    • Container.with_mounted_secret()
    • Container.with_mounted_temp()
    • Container.with_new_file()
    • Container.with_registry_auth()
    • Container.with_rootfs()
    • Container.with_secret_variable()
    • Container.with_service_binding()
    • Container.with_unix_socket()
    • Container.with_user()
    • Container.with_workdir()
    • Container.without_annotation()
    • Container.without_default_args()
    • Container.without_directory()
    • Container.without_entrypoint()
    • Container.without_env_variable()
    • Container.without_exposed_port()
    • Container.without_file()
    • Container.without_files()
    • Container.without_label()
    • Container.without_mount()
    • Container.without_registry_auth()
    • Container.without_secret_variable()
    • Container.without_unix_socket()
    • Container.without_user()
    • Container.without_workdir()
    • Container.workdir()
  • ContainerID
  • CurrentModule
    • CurrentModule.id()
    • CurrentModule.name()
    • CurrentModule.source()
    • CurrentModule.workdir()
    • CurrentModule.workdir_file()
  • CurrentModuleID
  • Directory
    • Directory.as_git()
    • Directory.as_module()
    • Directory.as_module_source()
    • Directory.diff()
    • Directory.digest()
    • Directory.directory()
    • Directory.docker_build()
    • Directory.entries()
    • Directory.export()
    • Directory.file()
    • Directory.filter()
    • Directory.glob()
    • Directory.id()
    • Directory.name()
    • Directory.sync()
    • Directory.terminal()
    • Directory.with_()
    • Directory.with_directory()
    • Directory.with_file()
    • Directory.with_files()
    • Directory.with_new_directory()
    • Directory.with_new_file()
    • Directory.with_timestamps()
    • Directory.without_directory()
    • Directory.without_file()
    • Directory.without_files()
  • DirectoryID
  • Engine
    • Engine.id()
    • Engine.local_cache()
  • EngineCache
    • EngineCache.entry_set()
    • EngineCache.id()
    • EngineCache.keep_bytes()
    • EngineCache.max_used_space()
    • EngineCache.min_free_space()
    • EngineCache.prune()
    • EngineCache.reserved_space()
  • EngineCacheEntry
    • EngineCacheEntry.actively_used()
    • EngineCacheEntry.created_time_unix_nano()
    • EngineCacheEntry.description()
    • EngineCacheEntry.disk_space_bytes()
    • EngineCacheEntry.id()
    • EngineCacheEntry.most_recent_use_time_unix_nano()
  • EngineCacheEntryID
  • EngineCacheEntrySet
    • EngineCacheEntrySet.disk_space_bytes()
    • EngineCacheEntrySet.entries()
    • EngineCacheEntrySet.entry_count()
    • EngineCacheEntrySet.id()
  • EngineCacheEntrySetID
  • EngineCacheID
  • EngineID
  • EnumTypeDef
    • EnumTypeDef.description()
    • EnumTypeDef.id()
    • EnumTypeDef.name()
    • EnumTypeDef.source_map()
    • EnumTypeDef.source_module_name()
    • EnumTypeDef.values()
  • EnumTypeDefID
  • EnumValueTypeDef
    • EnumValueTypeDef.description()
    • EnumValueTypeDef.id()
    • EnumValueTypeDef.name()
    • EnumValueTypeDef.source_map()
  • EnumValueTypeDefID
  • Env
    • Env.id()
    • Env.input()
    • Env.inputs()
    • Env.output()
    • Env.outputs()
    • Env.with_()
    • Env.with_cache_volume_input()
    • Env.with_cache_volume_output()
    • Env.with_container_input()
    • Env.with_container_output()
    • Env.with_directory_input()
    • Env.with_directory_output()
    • Env.with_env_input()
    • Env.with_env_output()
    • Env.with_file_input()
    • Env.with_file_output()
    • Env.with_git_ref_input()
    • Env.with_git_ref_output()
    • Env.with_git_repository_input()
    • Env.with_git_repository_output()
    • Env.with_llm_input()
    • Env.with_llm_output()
    • Env.with_module_config_client_input()
    • Env.with_module_config_client_output()
    • Env.with_module_input()
    • Env.with_module_output()
    • Env.with_module_source_input()
    • Env.with_module_source_output()
    • Env.with_secret_input()
    • Env.with_secret_output()
    • Env.with_service_input()
    • Env.with_service_output()
    • Env.with_socket_input()
    • Env.with_socket_output()
    • Env.with_string_input()
    • Env.with_string_output()
  • EnvID
  • EnvVariable
    • EnvVariable.id()
    • EnvVariable.name()
    • EnvVariable.value()
  • EnvVariableID
  • Error
    • Error.id()
    • Error.message()
    • Error.values()
    • Error.with_()
    • Error.with_value()
  • ErrorID
  • ErrorValue
    • ErrorValue.id()
    • ErrorValue.name()
    • ErrorValue.value()
  • ErrorValueID
  • FieldTypeDef
    • FieldTypeDef.description()
    • FieldTypeDef.id()
    • FieldTypeDef.name()
    • FieldTypeDef.source_map()
    • FieldTypeDef.type_def()
  • FieldTypeDefID
  • File
    • File.contents()
    • File.digest()
    • File.export()
    • File.id()
    • File.name()
    • File.size()
    • File.sync()
    • File.with_()
    • File.with_name()
    • File.with_timestamps()
  • FileID
  • Function
    • Function.args()
    • Function.description()
    • Function.id()
    • Function.name()
    • Function.return_type()
    • Function.source_map()
    • Function.with_()
    • Function.with_arg()
    • Function.with_description()
    • Function.with_source_map()
  • FunctionArg
    • FunctionArg.default_path()
    • FunctionArg.default_value()
    • FunctionArg.description()
    • FunctionArg.id()
    • FunctionArg.ignore()
    • FunctionArg.name()
    • FunctionArg.source_map()
    • FunctionArg.type_def()
  • FunctionArgID
  • FunctionCall
    • FunctionCall.id()
    • FunctionCall.input_args()
    • FunctionCall.name()
    • FunctionCall.parent()
    • FunctionCall.parent_name()
    • FunctionCall.return_error()
    • FunctionCall.return_value()
  • FunctionCallArgValue
    • FunctionCallArgValue.id()
    • FunctionCallArgValue.name()
    • FunctionCallArgValue.value()
  • FunctionCallArgValueID
  • FunctionCallID
  • FunctionID
  • GeneratedCode
    • GeneratedCode.code()
    • GeneratedCode.id()
    • GeneratedCode.vcs_generated_paths()
    • GeneratedCode.vcs_ignored_paths()
    • GeneratedCode.with_()
    • GeneratedCode.with_vcs_generated_paths()
    • GeneratedCode.with_vcs_ignored_paths()
  • GeneratedCodeID
  • GitRef
    • GitRef.commit()
    • GitRef.id()
    • GitRef.tree()
  • GitRefID
  • GitRepository
    • GitRepository.branch()
    • GitRepository.commit()
    • GitRepository.head()
    • GitRepository.id()
    • GitRepository.ref()
    • GitRepository.tag()
    • GitRepository.tags()
    • GitRepository.with_()
    • GitRepository.with_auth_header()
    • GitRepository.with_auth_token()
  • GitRepositoryID
  • Host
    • Host.directory()
    • Host.file()
    • Host.id()
    • Host.service()
    • Host.set_secret_file()
    • Host.tunnel()
    • Host.unix_socket()
  • HostID
  • ImageLayerCompression
    • ImageLayerCompression.EStarGZ
    • ImageLayerCompression.Gzip
    • ImageLayerCompression.Uncompressed
    • ImageLayerCompression.Zstd
  • ImageMediaTypes
    • ImageMediaTypes.DockerMediaTypes
    • ImageMediaTypes.OCIMediaTypes
  • InputTypeDef
    • InputTypeDef.fields()
    • InputTypeDef.id()
    • InputTypeDef.name()
  • InputTypeDefID
  • InterfaceTypeDef
    • InterfaceTypeDef.description()
    • InterfaceTypeDef.functions()
    • InterfaceTypeDef.id()
    • InterfaceTypeDef.name()
    • InterfaceTypeDef.source_map()
    • InterfaceTypeDef.source_module_name()
  • InterfaceTypeDefID
  • JSON
  • LLM
    • LLM.attempt()
    • LLM.bind_result()
    • LLM.env()
    • LLM.history()
    • LLM.history_json()
    • LLM.id()
    • LLM.last_reply()
    • LLM.loop()
    • LLM.model()
    • LLM.provider()
    • LLM.sync()
    • LLM.token_usage()
    • LLM.tools()
    • LLM.with_()
    • LLM.with_env()
    • LLM.with_model()
    • LLM.with_prompt()
    • LLM.with_prompt_file()
    • LLM.with_system_prompt()
    • LLM.without_default_system_prompt()
  • LLMID
  • LLMTokenUsage
    • LLMTokenUsage.id()
    • LLMTokenUsage.input_tokens()
    • LLMTokenUsage.output_tokens()
    • LLMTokenUsage.total_tokens()
  • LLMTokenUsageID
  • Label
    • Label.id()
    • Label.name()
    • Label.value()
  • LabelID
  • ListTypeDef
    • ListTypeDef.element_type_def()
    • ListTypeDef.id()
  • ListTypeDefID
  • Module
    • Module.dependencies()
    • Module.description()
    • Module.enums()
    • Module.generated_context_directory()
    • Module.id()
    • Module.interfaces()
    • Module.name()
    • Module.objects()
    • Module.runtime()
    • Module.sdk()
    • Module.serve()
    • Module.source()
    • Module.sync()
    • Module.with_()
    • Module.with_description()
    • Module.with_enum()
    • Module.with_interface()
    • Module.with_object()
  • ModuleConfigClient
    • ModuleConfigClient.dev()
    • ModuleConfigClient.directory()
    • ModuleConfigClient.generator()
    • ModuleConfigClient.id()
  • ModuleConfigClientID
  • ModuleID
  • ModuleSource
    • ModuleSource.as_module()
    • ModuleSource.as_string()
    • ModuleSource.clone_ref()
    • ModuleSource.commit()
    • ModuleSource.config_clients()
    • ModuleSource.config_exists()
    • ModuleSource.context_directory()
    • ModuleSource.dependencies()
    • ModuleSource.digest()
    • ModuleSource.directory()
    • ModuleSource.engine_version()
    • ModuleSource.generated_context_directory()
    • ModuleSource.html_repo_url()
    • ModuleSource.html_url()
    • ModuleSource.id()
    • ModuleSource.kind()
    • ModuleSource.local_context_directory_path()
    • ModuleSource.module_name()
    • ModuleSource.module_original_name()
    • ModuleSource.original_subpath()
    • ModuleSource.pin()
    • ModuleSource.repo_root_path()
    • ModuleSource.sdk()
    • ModuleSource.source_root_subpath()
    • ModuleSource.source_subpath()
    • ModuleSource.sync()
    • ModuleSource.version()
    • ModuleSource.with_()
    • ModuleSource.with_client()
    • ModuleSource.with_dependencies()
    • ModuleSource.with_engine_version()
    • ModuleSource.with_includes()
    • ModuleSource.with_name()
    • ModuleSource.with_sdk()
    • ModuleSource.with_source_subpath()
    • ModuleSource.with_update_dependencies()
    • ModuleSource.without_client()
    • ModuleSource.without_dependencies()
  • ModuleSourceID
  • ModuleSourceKind
    • ModuleSourceKind.DIR_SOURCE
    • ModuleSourceKind.GIT_SOURCE
    • ModuleSourceKind.LOCAL_SOURCE
  • NetworkProtocol
    • NetworkProtocol.TCP
    • NetworkProtocol.UDP
  • ObjectTypeDef
    • ObjectTypeDef.constructor()
    • ObjectTypeDef.description()
    • ObjectTypeDef.fields()
    • ObjectTypeDef.functions()
    • ObjectTypeDef.id()
    • ObjectTypeDef.name()
    • ObjectTypeDef.source_map()
    • ObjectTypeDef.source_module_name()
  • ObjectTypeDefID
  • PipelineLabel
    • PipelineLabel.name
    • PipelineLabel.value
  • Platform
  • Port
    • Port.description()
    • Port.experimental_skip_healthcheck()
    • Port.id()
    • Port.port()
    • Port.protocol()
  • PortForward
    • PortForward.backend
    • PortForward.frontend
    • PortForward.protocol
  • PortID
  • ReturnType
    • ReturnType.ANY
    • ReturnType.FAILURE
    • ReturnType.SUCCESS
  • SDKConfig
    • SDKConfig.id()
    • SDKConfig.source()
  • SDKConfigID
  • ScalarTypeDef
    • ScalarTypeDef.description()
    • ScalarTypeDef.id()
    • ScalarTypeDef.name()
    • ScalarTypeDef.source_module_name()
  • ScalarTypeDefID
  • Secret
    • Secret.id()
    • Secret.name()
    • Secret.plaintext()
    • Secret.uri()
  • SecretID
  • Service
    • Service.endpoint()
    • Service.hostname()
    • Service.id()
    • Service.ports()
    • Service.start()
    • Service.stop()
    • Service.up()
    • Service.with_()
    • Service.with_hostname()
  • ServiceID
  • Socket
    • Socket.id()
  • SocketID
  • SourceMap
    • SourceMap.column()
    • SourceMap.filename()
    • SourceMap.id()
    • SourceMap.line()
    • SourceMap.module()
  • SourceMapID
  • Terminal
    • Terminal.id()
    • Terminal.sync()
  • TerminalID
  • TypeDef
    • TypeDef.as_enum()
    • TypeDef.as_input()
    • TypeDef.as_interface()
    • TypeDef.as_list()
    • TypeDef.as_object()
    • TypeDef.as_scalar()
    • TypeDef.id()
    • TypeDef.kind()
    • TypeDef.optional()
    • TypeDef.with_()
    • TypeDef.with_constructor()
    • TypeDef.with_enum()
    • TypeDef.with_enum_value()
    • TypeDef.with_field()
    • TypeDef.with_function()
    • TypeDef.with_interface()
    • TypeDef.with_kind()
    • TypeDef.with_list_of()
    • TypeDef.with_object()
    • TypeDef.with_optional()
    • TypeDef.with_scalar()
  • TypeDefID
  • TypeDefKind
    • TypeDefKind.BOOLEAN_KIND
    • TypeDefKind.ENUM_KIND
    • TypeDefKind.FLOAT_KIND
    • TypeDefKind.INPUT_KIND
    • TypeDefKind.INTEGER_KIND
    • TypeDefKind.INTERFACE_KIND
    • TypeDefKind.LIST_KIND
    • TypeDefKind.OBJECT_KIND
    • TypeDefKind.SCALAR_KIND
    • TypeDefKind.STRING_KIND
    • TypeDefKind.VOID_KIND
  • Void
• Exceptions
  • DaggerError
  • Client execution
    • QueryError
      • QueryError.debug_query()
    • ExecError
      • ExecError.command
      • ExecError.message
      • ExecError.exit_code
      • ExecError.stdout
      • ExecError.stderr
      • ExecError.__str__()
  • Client connection
    • ClientError
    • ClientConnectionError
    • TransportError
    • ExecuteTimeoutError
    • InvalidQueryError
  • Engine provisioning
    • ProvisionError
    • DownloadError
    • SessionError
  • Warnings
    • VersionMismatch
• Modules
  • object_type()
  • field()
  • function()
  • enum_type()
  • DefaultPath
  • Ignore
  • Enum
  • Name
  • Doc

Project links

• PyPI Project

• Conda Package

• Documentation

• Source code

• Release Notes

Indices and tables

• Index

• Module Index

• Search Page