Template async

AsyncTemplate

class AsyncTemplate(TemplateBase)

Asynchronous template builder for E2B sandboxes.

build

@staticmethod
async def build(template: TemplateClass,
                name: Optional[str] = None,
                *,
                alias: Optional[str] = None,
                tags: Optional[List[str]] = None,
                cpu_count: int = 2,
                memory_mb: int = 1024,
                skip_cache: bool = False,
                on_build_logs: Optional[Callable[[LogEntry], None]] = None,
                **opts: Unpack[ApiParams]) -> BuildInfo

Build and deploy a template to E2B infrastructure.

Arguments:

• template: The template to build
• name: Template name in ‘name’ or ‘name:tag’ format
• alias: (Deprecated) Alias name for the template. Use name instead.
• tags: Optional additional tags to assign to the template
• cpu_count: Number of CPUs allocated to the sandbox
• memory_mb: Amount of memory in MB allocated to the sandbox
• skip_cache: If True, forces a complete rebuild ignoring cache
• on_build_logs: Callback function to receive build logs during the build process Example

from e2b import AsyncTemplate

template = (
    AsyncTemplate()
    .from_python_image('3')
    .copy('requirements.txt', '/home/user/')
    .run_cmd('pip install -r /home/user/requirements.txt')
)

await AsyncTemplate.build(template, 'my-python-env:v1.0')

await AsyncTemplate.build(template, 'my-python-env', tags=['v1.1.0', 'stable'])

build_in_background

@staticmethod
async def build_in_background(template: TemplateClass,
                              name: Optional[str] = None,
                              *,
                              alias: Optional[str] = None,
                              tags: Optional[List[str]] = None,
                              cpu_count: int = 2,
                              memory_mb: int = 1024,
                              skip_cache: bool = False,
                              on_build_logs: Optional[Callable[[LogEntry],
                                                               None]] = None,
                              **opts: Unpack[ApiParams]) -> BuildInfo

Build and deploy a template to E2B infrastructure without waiting for completion.

Arguments:

• template: The template to build
• name: Template name in ‘name’ or ‘name:tag’ format
• alias: (Deprecated) Alias name for the template. Use name instead.
• tags: Optional additional tags to assign to the template
• cpu_count: Number of CPUs allocated to the sandbox
• memory_mb: Amount of memory in MB allocated to the sandbox
• skip_cache: If True, forces a complete rebuild ignoring cache

Returns:

BuildInfo containing the template ID and build ID Example

from e2b import AsyncTemplate

template = (
    AsyncTemplate()
    .from_python_image('3')
    .run_cmd('echo "test"')
    .set_start_cmd('echo "Hello"', 'sleep 1')
)

build_info = await AsyncTemplate.build_in_background(template, 'my-python-env:v1.0')

build_info = await AsyncTemplate.build_in_background(template, 'my-python-env', tags=['v1.1.0', 'stable'])

get_build_status

@staticmethod
async def get_build_status(build_info: BuildInfo,
                           logs_offset: int = 0,
                           **opts: Unpack[ApiParams])

Get the status of a build.

Arguments:

• build_info: Build identifiers returned from build_in_background
• logs_offset: Offset for fetching logs

Returns:

TemplateBuild containing the build status and logs Example

from e2b import AsyncTemplate

build_info = await AsyncTemplate.build_in_background(template, alias='my-template')
status = await AsyncTemplate.get_build_status(build_info, logs_offset=0)

alias_exists

@staticmethod
async def alias_exists(alias: str, **opts: Unpack[ApiParams]) -> bool

Check if a template with the given alias exists.

Arguments:

• alias: Template alias to check

Returns:

True if the alias exists, False otherwise Example

from e2b import AsyncTemplate

exists = await AsyncTemplate.alias_exists('base')
if exists:
    print('Template exists!')

assign_tags

@staticmethod
async def assign_tags(target_name: str, tags: Union[str, List[str]],
                      **opts: Unpack[ApiParams]) -> TemplateTagInfo

Assign tag(s) to an existing template build.

Arguments:

• target_name: Template name in ‘name:tag’ format (the source build to tag from)
• tags: Tag or tags to assign

Returns:

TemplateTagInfo with build_id and assigned tags Example

from e2b import AsyncTemplate

result = await AsyncTemplate.assign_tags('my-template:v1.0', 'production')

result = await AsyncTemplate.assign_tags('my-template:v1.0', ['production', 'stable'])

remove_tags

@staticmethod
async def remove_tags(name: str, tags: Union[str, List[str]],
                      **opts: Unpack[ApiParams]) -> None

Remove tag(s) from a template.

Arguments:

• name: Template name
• tags: Tag or tags to remove Example

from e2b import AsyncTemplate

await AsyncTemplate.remove_tags('my-template', 'production')

await AsyncTemplate.remove_tags('my-template', ['production', 'stable'])

check_alias_exists

async def check_alias_exists(client: AuthenticatedClient, alias: str) -> bool

Check if a template with the given alias exists.

Arguments:

• client - Authenticated API client
• alias - Template alias to check

Returns:

True if the alias exists, False otherwise

assign_tags

async def assign_tags(client: AuthenticatedClient, target_name: str,
                      tags: List[str]) -> TemplateTagInfo

Assign tag(s) to an existing template build.

Arguments:

• client - Authenticated API client
• target_name - Template name in ‘name:tag’ format (the source build to tag from)
• tags - Tags to assign

Returns:

TemplateTagInfo with build_id and assigned tags

remove_tags

async def remove_tags(client: AuthenticatedClient, name: str,
                      tags: List[str]) -> None

Remove tag(s) from a template.

Arguments:

• client - Authenticated API client
• name - Template name
• tags - List of tags to remove