Images - Nebius Token Factory documentation

`class ContreeImage`

class contree_sdk.sdk.objects.image.ContreeImage(client, uuid, tag)

Attributes

timedelta

Time elapsed during execution.

int

Exit code of the executed command.

RunRequest | None

ContreeResult

Execution result. Only available after successful execution.

ImageState

Current state of the image in the execution lifecycle.

Stderr output from the execution.

Configured stdin source.

Stdout output from the execution.

UUID | None

Unique identifier of the image.

str | None

Optional tag associated with the image.

Methods

`apply_files()`

async def apply_files(*args, files) -> TypeVar(ImageLikeAsyncT, bound= ImageLikeAsync)

Upload files into a new image derived from this one.

Files to upload.

default:"None"

Files as a list or a dict mapping destination paths to sources. When both args and files are provided, they are merged.

TypeVar(ImageLikeAsyncT, bound= ImageLikeAsync)

New image with the uploaded files baked in.

`collect_result()`

async def collect_result(executing) -> TypeVar(ImageLikeAsyncT, bound= ImageLikeAsync)

required

TypeVar(ImageLikeAsyncT, bound= ImageLikeAsync)

`copy_self()`

def copy_self() -> TypeVar(ImageLikeT, bound= ImageLikeBase)

TypeVar(ImageLikeT, bound= ImageLikeBase)

`copy_with_state()`

def copy_with_state(data) -> TypeVar(ImageLikeT, bound= ImageLikeBase)

required

TypeVar(ImageLikeT, bound= ImageLikeBase)

`download()`

async def download(image_path, local_path) -> Path

Download a file from the image to local filesystem.

str | PurePosixPath

required

Path to the file inside the image.

str | Path | None

default:"None"

Local destination path. Defaults to filename from image_path.

Path

Path to the downloaded file.

`ensure_started()`

async def ensure_started() -> tuple[TypeVar(ImageLikeAsyncT, bound= ImageLikeAsync), Executing]

tuple[TypeVar(ImageLikeAsyncT, bound= ImageLikeAsync), Executing]

`ensure_state()`

def ensure_state(state_type) -> TypeVar(StateDataT, bound= Pulled | Prepared | Executing | Succeeded | Failed)

required

TypeVar(StateDataT, bound= Pulled | Prepared | Executing | Succeeded | Failed)

`image_uuid()`

async def image_uuid() -> str

str

`iter_output()`

async def iter_output() -> AsyncIterator[OutputChunk]

AsyncIterator[OutputChunk]

`list_entries()`

async def list_entries(path, file_type, dir_type) -> list[TypeVar(FileTypeT) | TypeVar(DirTypeT)]

required

list[TypeVar(FileTypeT) | TypeVar(DirTypeT)]

`ls()`

async def ls(path) -> list[ImageFile | ImageDirectory]

List files and directories at the given path.

str | PurePosixPath

default:"'/'"

Path inside the image to list.

list[ImageFile | ImageDirectory]

list[ImageFile | ImageDirectory]List of ImageFile and ImageDirectory objects.

`prepare_files_for_api()`

async def prepare_files_for_api(files) -> dict[str, FileSpec]

required

dict[str, FileSpec]

`read()`

async def read(image_path) -> bytes

Read file contents from the image.

str | PurePosixPath

required

Path to the file inside the image.

bytes

File contents as bytes.

`run()`

def run(command, *, shell, args, env, cwd, hostname, stdin, stdout, stderr, tag, files, timeout, disposable, truncate_output_at, preserve_env) -> TypeVar(ImageLikeT, bound= ImageLikeBase)

Prepare image for command execution.

str | None

default:"None"

Command to execute (mutually exclusive with shell).

str | None

default:"None"

Shell command string (mutually exclusive with command).

Iterable[str] | None

default:"None"

Command arguments.

dict[str, str] | None

default:"None"

Environment variables.

str | None

default:"None"

Working directory inside the image.

str | None

default:"None"

Hostname for the container.

default:"None"

Input source.

default:"<class 'str'>"

Output destination for stdout.

default:"<class 'str'>"

Output destination for stderr.

str | None

default:"None"

Tag for the resulting image.

default:"None"

Files to upload into the image.

float | timedelta | None

default:"None"

Execution timeout in seconds or as timedelta.

bool

default:"True"

If True, image is discarded after execution.

int | None

default:"None"

number of bytes to truncate stdout and stderr. Defaults to default_truncate_output_at

bool

default:"False"

If True, environment variables are preserved in resulting image after execution.

TypeVar(ImageLikeT, bound= ImageLikeBase)

New image instance configured for execution.

DisposableImageRunError – If attempting to run on a disposed image.

ValueError – If neither command nor shell is provided.

`session()`

def session() -> ContreeSession

ContreeSession

ContreeSession

`set_state()`

def set_state(data) -> None

required

None

`start()`

async def start() -> TypeVar(ImageLikeAsyncT, bound= ImageLikeAsync)

Start the prepared command without waiting for completion.

TypeVar(ImageLikeAsyncT, bound= ImageLikeAsync)

New image instance in EXECUTING state; await it or iterate its output chunks to get the result.

`tag_as()`

async def tag_as(tag) -> TypeVar(ImageLikeAsyncT, bound= ImageLikeAsync)

Tag this image with the specified tag, or remove the tag if None.

str | None

required

Tag name to apply to the image, or None to remove the tag.

TypeVar(ImageLikeAsyncT, bound= ImageLikeAsync)

New instance with updated tag.

`untag()`

async def untag() -> TypeVar(ImageLikeAsyncT, bound= ImageLikeAsync)

Remove the tag from this image.

TypeVar(ImageLikeAsyncT, bound= ImageLikeAsync)

New instance with tag set to None.

`update_request()`

def update_request(**kwargs) -> TypeVar(ImageLikeT, bound= ImageLikeBase)

TypeVar(ImageLikeT, bound= ImageLikeBase)

`wait()`

async def wait() -> TypeVar(ImageLikeAsyncT, bound= ImageLikeAsync)

Execute the prepared command and wait for completion.

TypeVar(ImageLikeAsyncT, bound= ImageLikeAsync)

New image instance with execution results.

`class ContreeImageSync`

class contree_sdk.sdk.objects.image.ContreeImageSync(client, uuid, tag)

Attributes

timedelta

Time elapsed during execution.

int

Exit code of the executed command.

RunRequest | None

ContreeResult

Execution result. Only available after successful execution.

ImageState

Current state of the image in the execution lifecycle.

Stderr output from the execution.

Configured stdin source.

Stdout output from the execution.

UUID | None

Unique identifier of the image.

str | None

Optional tag associated with the image.

Methods

`apply_files()`

def apply_files(*args, files) -> TypeVar(ImageLikeSyncT, bound= ImageLikeSync)

Upload files into a new image derived from this one.

Files to upload.

default:"None"

Files as a list or a dict mapping destination paths to sources. When both args and files are provided, they are merged.

TypeVar(ImageLikeSyncT, bound= ImageLikeSync)

New image with the uploaded files baked in.

`collect_result()`

def collect_result(executing) -> TypeVar(ImageLikeSyncT, bound= ImageLikeSync)

required

TypeVar(ImageLikeSyncT, bound= ImageLikeSync)

`copy_self()`

def copy_self() -> TypeVar(ImageLikeT, bound= ImageLikeBase)

TypeVar(ImageLikeT, bound= ImageLikeBase)

`copy_with_state()`

def copy_with_state(data) -> TypeVar(ImageLikeT, bound= ImageLikeBase)

required

TypeVar(ImageLikeT, bound= ImageLikeBase)

`download()`

def download(image_path, local_path) -> Path

Download a file from the image to local filesystem.

str | PurePosixPath

required

Path to the file inside the image.

str | Path | None

default:"None"

Local destination path. Defaults to filename from image_path.

Path

Path to the downloaded file.

`ensure_started()`

def ensure_started() -> tuple[TypeVar(ImageLikeSyncT, bound= ImageLikeSync), Executing]

tuple[TypeVar(ImageLikeSyncT, bound= ImageLikeSync), Executing]

`ensure_state()`

def ensure_state(state_type) -> TypeVar(StateDataT, bound= Pulled | Prepared | Executing | Succeeded | Failed)

required

TypeVar(StateDataT, bound= Pulled | Prepared | Executing | Succeeded | Failed)

`image_uuid()`

def image_uuid() -> str

str

`iter_output()`

def iter_output() -> Iterator[OutputChunk]

Iterator[OutputChunk]

`list_entries()`

def list_entries(path, file_type, dir_type) -> list[TypeVar(FileTypeT) | TypeVar(DirTypeT)]

required

list[TypeVar(FileTypeT) | TypeVar(DirTypeT)]

`ls()`

def ls(path) -> list[ImageFileSync | ImageDirectorySync]

List files and directories at the given path.

str | PurePosixPath

default:"'/'"

Path inside the image to list.

list[ImageFileSync | ImageDirectorySync]

list[ImageFileSync | ImageDirectorySync]List of ImageFileSync and ImageDirectorySync objects.

`popen()`

def popen(args, *, stdin, input, stdout, stderr, shell, cwd, timeout, check, text, env) -> ContreeProcessSync

Run a command with subprocess-like interface.

list[str] | str | None

default:"None"

Command and arguments list.

default:"None"

Input source.

default:"None"

Alternative input source (alias for stdin).

default:"None"

Output destination for stdout.

default:"None"

Output destination for stderr.

bool

default:"False"

If True, treat args as shell command.

str | None

default:"None"

Working directory inside the image.

float | None

default:"None"

Execution timeout in seconds.

bool

default:"False"

If True, raise on non-zero exit code.

bool | None

default:"None"

If True, decode output as text.

dict[str, str] | None

default:"None"

Environment variables.

ContreeProcessSync

ContreeProcessSyncContreeProcessSync object with execution results.

`prepare_files_for_api()`

def prepare_files_for_api(files) -> dict[str, FileSpec]

required

dict[str, FileSpec]

`read()`

def read(image_path) -> bytes

Read file contents from the image.

str | PurePosixPath

required

Path to the file inside the image.

bytes

File contents as bytes.

`run()`

def run(command, *, shell, args, env, cwd, hostname, stdin, stdout, stderr, tag, files, timeout, disposable, truncate_output_at, preserve_env) -> TypeVar(ImageLikeT, bound= ImageLikeBase)

Prepare image for command execution.

str | None

default:"None"

Command to execute (mutually exclusive with shell).

str | None

default:"None"

Shell command string (mutually exclusive with command).

Iterable[str] | None

default:"None"

Command arguments.

dict[str, str] | None

default:"None"

Environment variables.

str | None

default:"None"

Working directory inside the image.

str | None

default:"None"

Hostname for the container.

default:"None"

Input source.

default:"<class 'str'>"

Output destination for stdout.

default:"<class 'str'>"

Output destination for stderr.

str | None

default:"None"

Tag for the resulting image.

default:"None"

Files to upload into the image.

float | timedelta | None

default:"None"

Execution timeout in seconds or as timedelta.

bool

default:"True"

If True, image is discarded after execution.

int | None

default:"None"

number of bytes to truncate stdout and stderr. Defaults to default_truncate_output_at

bool

default:"False"

If True, environment variables are preserved in resulting image after execution.

TypeVar(ImageLikeT, bound= ImageLikeBase)

New image instance configured for execution.

DisposableImageRunError – If attempting to run on a disposed image.

ValueError – If neither command nor shell is provided.

`session()`

def session() -> ContreeSessionSync

ContreeSessionSync

ContreeSessionSync

`set_state()`

def set_state(data) -> None

required

None

`start()`

def start() -> TypeVar(ImageLikeSyncT, bound= ImageLikeSync)

Start the prepared command without waiting for completion.

TypeVar(ImageLikeSyncT, bound= ImageLikeSync)

New image instance in EXECUTING state; call wait() or iterate its output chunks to get the result.

`tag_as()`

def tag_as(tag) -> TypeVar(ImageLikeSyncT, bound= ImageLikeSync)

Tag this image with the specified tag, or remove the tag if None.

str | None

required

Tag name to apply to the image, or None to remove the tag.

TypeVar(ImageLikeSyncT, bound= ImageLikeSync)

New instance with updated tag.

`untag()`

def untag() -> TypeVar(ImageLikeSyncT, bound= ImageLikeSync)

Remove the tag from this image.

TypeVar(ImageLikeSyncT, bound= ImageLikeSync)

New instance with tag set to None.

`update_request()`

def update_request(**kwargs) -> TypeVar(ImageLikeT, bound= ImageLikeBase)

TypeVar(ImageLikeT, bound= ImageLikeBase)

`wait()`

def wait() -> TypeVar(ImageLikeSyncT, bound= ImageLikeSync)

Execute the prepared command and wait for completion.

TypeVar(ImageLikeSyncT, bound= ImageLikeSync)

New image instance with execution results.

​class ContreeImage

​Attributes

​Methods

​apply_files()

​collect_result()

​copy_self()

​copy_with_state()

​download()

​ensure_started()

​ensure_state()

​image_uuid()

​iter_output()

​list_entries()

​ls()

​prepare_files_for_api()

​read()

​run()

​session()

​set_state()

​start()

​tag_as()

​untag()

​update_request()

​wait()

​class ContreeImageSync

​Attributes

​Methods

​apply_files()

​collect_result()

​copy_self()

​copy_with_state()

​download()

​ensure_started()

​ensure_state()

​image_uuid()

​iter_output()

​list_entries()

​ls()

​popen()

​prepare_files_for_api()

​read()

​run()

​session()

​set_state()

​start()

​tag_as()

​untag()

​update_request()

​wait()

`class ContreeImage`

Attributes

Methods

`apply_files()`

`collect_result()`

`copy_self()`

`copy_with_state()`

`download()`

`ensure_started()`

`ensure_state()`

`image_uuid()`

`iter_output()`

`list_entries()`

`ls()`

`prepare_files_for_api()`

`read()`

`run()`

`session()`

`set_state()`

`start()`

`tag_as()`

`untag()`

`update_request()`

`wait()`

`class ContreeImageSync`

Attributes

Methods

`apply_files()`

`collect_result()`

`copy_self()`

`copy_with_state()`

`download()`

`ensure_started()`

`ensure_state()`

`image_uuid()`

`iter_output()`

`list_entries()`

`ls()`

`popen()`

`prepare_files_for_api()`

`read()`

`run()`

`session()`

`set_state()`

`start()`

`tag_as()`

`untag()`

`update_request()`

`wait()`