flyte.remote

Remote Entities that are accessible from the Union Server once deployed or created.

Directory

Classes

Methods

Methods

create_channel()

def create_channel(
    endpoint: str | None,
    api_key: str | None,
    insecure: typing.Optional[bool],
    insecure_skip_verify: typing.Optional[bool],
    ca_cert_file_path: typing.Optional[str],
    ssl_credentials: typing.Optional[ssl_channel_credentials],
    grpc_options: typing.Optional[typing.Sequence[typing.Tuple[str, typing.Any]]],
    compression: typing.Optional[grpc.Compression],
    http_session: httpx.AsyncClient | None,
    proxy_command: typing.Optional[typing.List[str]],
    kwargs,
) -> grpc.aio._base_channel.Channel

Creates a new gRPC channel with appropriate authentication interceptors.

This function creates either a secure or insecure gRPC channel based on the provided parameters, and adds authentication interceptors to the channel. If SSL credentials are not provided, they are created based on the insecure_skip_verify and ca_cert_file_path parameters.

The function is async because it may need to read certificate files asynchronously and create authentication interceptors that perform async operations.

upload_dir()

def upload_dir(
    dir_path: pathlib._local.Path,
    verify: bool,
) -> str

Uploads a directory to a remote location and returns the remote URI.

upload_file()

def upload_file(
    fp: pathlib._local.Path,
    verify: bool,
) -> typing.Tuple[str, str]

Uploads a file to a remote location and returns the remote URI.

flyte.remote.Action

A class representing an action. It is used to manage the run of a task and its state on the remote Union API.

class Action(
    pb2: run_definition_pb2.Action,
    _details: ActionDetails | None,
)

Methods

details()

def details()

Get the details of the action. This is a placeholder for getting the action details.

done()

def done()

Check if the action is done.

show_logs()

def show_logs(
    attempt: int | None,
    max_lines: int,
    show_ts: bool,
    raw: bool,
    filter_system: bool,
)

sync()

def sync()

Sync the action with the remote server. This is a placeholder for syncing the action.

wait()

def wait(
    quiet: bool,
    wait_for: WaitFor,
)

Wait for the run to complete, displaying a rich progress panel with status transitions, time elapsed, and error details in case of failure.

watch()

def watch(
    cache_data_on_done: bool,
    wait_for: WaitFor,
) -> AsyncGenerator[ActionDetails, None]

Watch the action for updates. This is a placeholder for watching the action.

Properties

flyte.remote.ActionDetails

A class representing an action. It is used to manage the run of a task and its state on the remote Union API.

class ActionDetails(
    pb2: run_definition_pb2.ActionDetails,
    _inputs: ActionInputs | None,
    _outputs: ActionOutputs | None,
)

Methods

done()

def done()

Check if the action is in a terminal state (completed or failed). This is a placeholder for checking the action state.

inputs()

def inputs()

Placeholder for inputs. This can be extended to handle inputs from the run context.

logs_available()

def logs_available(
    attempt: int | None,
) -> bool

Check if logs are available for the action, optionally for a specific attempt. If attempt is None, it checks for the latest attempt.

outputs()

def outputs()

Placeholder for outputs. This can be extended to handle outputs from the run context.

watch_updates()

def watch_updates(
    cache_data_on_done: bool,
) -> AsyncGenerator[ActionDetails, None]

Properties

flyte.remote.ActionInputs

A class representing the inputs of an action. It is used to manage the inputs of a task and its state on the remote Union API.

class ActionInputs(
    pb2: run_definition_pb2.Inputs,
    data: Dict[str, Any],
)

Methods

clear()

def clear()

D.clear() -> None. Remove all items from D.

copy()

def copy()

fromkeys()

def fromkeys(
    iterable,
    value,
)

get()

def get(
    key,
    default,
)

D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.

items()

def items()

D.items() -> a set-like object providing a view on D’s items

keys()

def keys()

D.keys() -> a set-like object providing a view on D’s keys

pop()

def pop(
    key,
    default,
)

D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised.

popitem()

def popitem()

D.popitem() -> (k, v), remove and return some (key, value) pair as a 2-tuple; but raise KeyError if D is empty.

setdefault()

def setdefault(
    key,
    default,
)

D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D

update()

def update(
    other,
    kwds,
)

D.update([E, ]**F) -> None. Update D from mapping/iterable E and F. If E present and has a .keys() method, does: for k in E.keys(): D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values()

def values()

D.values() -> an object providing a view on D’s values

flyte.remote.ActionOutputs

A class representing the outputs of an action. It is used to manage the outputs of a task and its state on the remote Union API.

class ActionOutputs(
    pb2: run_definition_pb2.Outputs,
    data: Tuple[Any, ...],
)

flyte.remote.Project

A class representing a project in the Union API.

class Project(
    _pb2: project_pb2.Project,
)

flyte.remote.Run

A class representing a run of a task. It is used to manage the run of a task and its state on the remote Union API.

class Run(
    pb2: run_definition_pb2.Run,
    _details: RunDetails | None,
)

Methods

done()

def done()

Check if the run is done.

show_logs()

def show_logs(
    attempt: int | None,
    max_lines: int,
    show_ts: bool,
    raw: bool,
    filter_system: bool,
)

sync()

def sync()

Sync the run with the remote server. This is a placeholder for syncing the run.

watch()

def watch(
    cache_data_on_done: bool,
) -> AsyncGenerator[ActionDetails, None]

Get the details of the run. This is a placeholder for getting the run details.

Properties

flyte.remote.RunDetails

A class representing a run of a task. It is used to manage the run of a task and its state on the remote Union API.

class RunDetails(
    pb2: run_definition_pb2.RunDetails,
)

Methods

done()

def done()

Check if the run is in a terminal state (completed or failed). This is a placeholder for checking the run state.

inputs()

def inputs()

Placeholder for inputs. This can be extended to handle inputs from the run context.

outputs()

def outputs()

Placeholder for outputs. This can be extended to handle outputs from the run context.

Properties

flyte.remote.Secret

class Secret(
    pb2: definition_pb2.Secret,
)

Properties

flyte.remote.Task

class Task(
    pb2: task_definition_pb2.Task,
)

Methods

get()

def get(
    name: str,
    project: str | None,
    domain: str | None,
    version: str | None,
    auto_version: AutoVersioning | None,
) -> LazyEntity

Get a task by its ID or name. If both are provided, the ID will take precedence.

Either version or auto_version are required parameters.

Properties