Dagger
Search

e2e

No long description provided.

Installation

dagger install github.com/dagger/python-sdk/.dagger/modules/e2e@60249b7ca88f887dab21d8c0525bff8623799305

Entrypoint

Return Type
E2E !
Example
dagger -m github.com/dagger/python-sdk/.dagger/modules/e2e@60249b7ca88f887dab21d8c0525bff8623799305 call \
func (m *MyModule) Example() *dagger.E2E  {
	return dag.
			E2e()
}
@function
def example() -> dagger.E2E:
	return (
		dag.e2e()
	)
@func()
example(): E2E {
	return dag
		.e2e()
}

Types

E2E 🔗

End-to-end checks for the Python SDK helper module.

skipGenerateFilenameCheck() 🔗

The helper should expose the generate skip marker used by callers.

Return Type
Void !
Example
dagger -m github.com/dagger/python-sdk/.dagger/modules/e2e@60249b7ca88f887dab21d8c0525bff8623799305 call \
 skip-generate-filename-check
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			SkipGenerateFilenameCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.skip_generate_filename_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.skipGenerateFilenameCheck()
}

moduleLookupCheck() 🔗

Mod lookup should find the owning Python SDK module when called from a nested path.

Return Type
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			ModuleLookupCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.module_lookup_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.moduleLookupCheck()
}

initCheck() 🔗

initModule should seed SDK-owned template files without running codegen and without writing engine-owned files (dagger.json / dagger-module.toml). Generated SDK files appear later via mod.generate.

Return Type
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			InitCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.init_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.initCheck()
}

generateCheck() 🔗

Generating an existing module should produce generated files rooted at that module without touching unrelated paths.

Return Type
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			GenerateCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.generate_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.generateCheck()
}

generateAllCheck() 🔗

Generating all modules should discover Python SDK modules and ignore skipped ones.

Return Type
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			GenerateAllCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.generate_all_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.generateAllCheck()
}

skipGenerateCheck() 🔗

A skip marker above a module should make generate return an empty changeset.

Return Type
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			SkipGenerateCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.skip_generate_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.skipGenerateCheck()
}

targetRuntimeCheck() 🔗

The SDK should report the builtin runtime that modules it authors target.

Return Type
Void !
Example
dagger -m github.com/dagger/python-sdk/.dagger/modules/e2e@60249b7ca88f887dab21d8c0525bff8623799305 call \
 target-runtime-check
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			TargetRuntimeCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.target_runtime_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.targetRuntimeCheck()
}

initClientCheck() 🔗

initClient should not materialize files itself. The engine records the client and owns the generated context changeset.

Return Type
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			InitClientCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.init_client_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.initClientCheck()
}

configCheck() 🔗

config.get should reflect pyproject.toml and report unset values as null rather than guessing, and config.set should edit only pyproject.toml.

Return Type
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			ConfigCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.config_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.configCheck()
}

initConfigCheck() 🔗

Init flags should write configuration into the generated pyproject.toml, and defaults should leave it unconfigured.

Return Type
Void !
Arguments
NameTypeDefault ValueDescription
wsWorkspace -No description provided
Example
echo 'Custom types are not supported in shell examples'
func (m *MyModule) Example(ctx context.Context)   {
	return dag.
			E2e().
			InitConfigCheck(ctx)
}
@function
async def example() -> None:
	return await (
		dag.e2e()
		.init_config_check()
	)
@func()
async example(): Promise<void> {
	return dag
		.e2e()
		.initConfigCheck()
}