flytekit.clis.sdk_in_container.run
Directory
Classes
| Class | Description |
|---|---|
DynamicEntityLaunchCommand |
This is a dynamic command that is created for each launch plan. |
Entities |
NamedTuple to group all entities in a file. |
RemoteEntityGroup |
click multicommand that retrieves launchplans from a remote flyte instance and executes them. |
RunCommand |
A click command group for registering and executing flyte workflows & tasks in a file. |
RunLevelComputedParams |
This class is used to store the computed parameters that are used to run a workflow / task / launchplan. |
RunLevelParams |
This class is used to store the parameters that are used to run a workflow / task / launchplan. |
WorkflowCommand |
click multicommand at the python file layer, subcommands should be all the workflows in the file. |
YamlFileReadingCommand |
Methods
| Method | Description |
|---|---|
dump_flyte_remote_snippet() |
|
get_entities_in_file() |
Returns a list of flyte workflow names and list of Flyte tasks in a file. |
is_optional() |
Checks if the given type is Optional Type. |
load_naive_entity() |
Load the workflow of a script file. |
options_from_run_params() |
|
run_command() |
Returns a function that is used to implement WorkflowCommand and execute a flyte workflow. |
run_remote() |
Helper method that executes the given remote FlyteLaunchplan, FlyteWorkflow or FlyteTask. |
to_click_option() |
This handles converting workflow input types to supported click parameters with callbacks to initialize the input values to their expected types. |
Methods
dump_flyte_remote_snippet()
def dump_flyte_remote_snippet(
execution: flytekit.remote.executions.FlyteWorkflowExecution,
project: str,
domain: str,
)| Parameter | Type | Description |
|---|---|---|
execution |
flytekit.remote.executions.FlyteWorkflowExecution |
|
project |
str |
|
domain |
str |
get_entities_in_file()
def get_entities_in_file(
filename: pathlib.Path,
should_delete: bool,
) -> flytekit.clis.sdk_in_container.run.EntitiesReturns a list of flyte workflow names and list of Flyte tasks in a file.
| Parameter | Type | Description |
|---|---|---|
filename |
pathlib.Path |
|
should_delete |
bool |
is_optional()
def is_optional()Checks if the given type is Optional Type
load_naive_entity()
def load_naive_entity(
module_name: str,
entity_name: str,
project_root: str,
) -> typing.Union[flytekit.core.workflow.WorkflowBase, flytekit.core.base_task.PythonTask]Load the workflow of a script file. N.B.: it assumes that the file is self-contained, in other words, there are no relative imports.
| Parameter | Type | Description |
|---|---|---|
module_name |
str |
|
entity_name |
str |
|
project_root |
str |
options_from_run_params()
def options_from_run_params(
run_level_params: flytekit.clis.sdk_in_container.run.RunLevelParams,
) -> flytekit.core.options.Options| Parameter | Type | Description |
|---|---|---|
run_level_params |
flytekit.clis.sdk_in_container.run.RunLevelParams |
run_command()
def run_command(
ctx: click.core.Context,
entity: typing.Union[flytekit.core.workflow.PythonFunctionWorkflow, flytekit.core.base_task.PythonTask, flytekit.core.launch_plan.LaunchPlan],
)Returns a function that is used to implement WorkflowCommand and execute a flyte workflow.
| Parameter | Type | Description |
|---|---|---|
ctx |
click.core.Context |
|
entity |
typing.Union[flytekit.core.workflow.PythonFunctionWorkflow, flytekit.core.base_task.PythonTask, flytekit.core.launch_plan.LaunchPlan] |
run_remote()
def run_remote(
remote: flytekit.remote.remote.FlyteRemote,
entity: typing.Union[flytekit.remote.entities.FlyteWorkflow, flytekit.remote.entities.FlyteTask, flytekit.remote.entities.FlyteLaunchPlan],
project: str,
domain: str,
inputs: typing.Dict[str, typing.Any],
run_level_params: flytekit.clis.sdk_in_container.run.RunLevelParams,
type_hints: typing.Optional[typing.Dict[str, typing.Type]] = None,
)Helper method that executes the given remote FlyteLaunchplan, FlyteWorkflow or FlyteTask
| Parameter | Type | Description |
|---|---|---|
remote |
flytekit.remote.remote.FlyteRemote |
|
entity |
typing.Union[flytekit.remote.entities.FlyteWorkflow, flytekit.remote.entities.FlyteTask, flytekit.remote.entities.FlyteLaunchPlan] |
|
project |
str |
|
domain |
str |
|
inputs |
typing.Dict[str, typing.Any] |
|
run_level_params |
flytekit.clis.sdk_in_container.run.RunLevelParams |
|
type_hints |
typing.Optional[typing.Dict[str, typing.Type]] |
to_click_option()
def to_click_option(
ctx: click.core.Context,
flyte_ctx: flytekit.core.context_manager.FlyteContext,
input_name: str,
literal_var: flytekit.models.interface.Variable,
python_type: typing.Type,
default_val: typing.Any,
required: bool,
) -> click.core.OptionThis handles converting workflow input types to supported click parameters with callbacks to initialize the input values to their expected types.
| Parameter | Type | Description |
|---|---|---|
ctx |
click.core.Context |
|
flyte_ctx |
flytekit.core.context_manager.FlyteContext |
|
input_name |
str |
|
literal_var |
flytekit.models.interface.Variable |
|
python_type |
typing.Type |
|
default_val |
typing.Any |
|
required |
bool |
flytekit.clis.sdk_in_container.run.DynamicEntityLaunchCommand
This is a dynamic command that is created for each launch plan. This is used to execute a launch plan. It will fetch the launch plan from remote and create parameters from all the inputs of the launch plan.
Parameters
class DynamicEntityLaunchCommand(
name: str,
h: str,
entity_name: str,
launcher: str,
**kwargs,
)Create Rich Command instance.
| Parameter | Type | Description |
|---|---|---|
name |
str |
|
h |
str |
|
entity_name |
str |
|
launcher |
str |
|
**kwargs |
Methods
| Method | Description |
|---|---|
get_params() |
|
invoke() |
Default or None values should be ignored. |
get_params()
def get_params(
ctx: click.core.Context,
) -> typing.List[ForwardRef('click.Parameter')]| Parameter | Type | Description |
|---|---|---|
ctx |
click.core.Context |
invoke()
def invoke(
ctx: click.core.Context,
) -> typing.AnyDefault or None values should be ignored. Only values that are provided by the user should be passed to the remote execution.
| Parameter | Type | Description |
|---|---|---|
ctx |
click.core.Context |
flytekit.clis.sdk_in_container.run.Entities
NamedTuple to group all entities in a file
Methods
| Method | Description |
|---|---|
all() |
|
matching_lp() |
Returns the variable name of the launch plan in the file. |
all()
def all()matching_lp()
def matching_lp(
lp_name: str,
) -> typing.Optional[str]Returns the variable name of the launch plan in the file
| Parameter | Type | Description |
|---|---|---|
lp_name |
str |
flytekit.clis.sdk_in_container.run.RemoteEntityGroup
click multicommand that retrieves launchplans from a remote flyte instance and executes them.
Parameters
class RemoteEntityGroup(
command_name: str,
)Create RichGroup instance.
| Parameter | Type | Description |
|---|---|---|
command_name |
str |
Methods
| Method | Description |
|---|---|
get_command() |
Given a context and a command name, this returns a Command object if it exists or returns None. |
list_commands() |
Returns a list of subcommand names in the order they should appear. |
get_command()
def get_command(
ctx,
name,
)Given a context and a command name, this returns a Command
object if it exists or returns None.
| Parameter | Type | Description |
|---|---|---|
ctx |
||
name |
list_commands()
def list_commands(
ctx,
)Returns a list of subcommand names in the order they should appear.
| Parameter | Type | Description |
|---|---|---|
ctx |
flytekit.clis.sdk_in_container.run.RunCommand
A click command group for registering and executing flyte workflows & tasks in a file.
Parameters
class RunCommand(
*args,
**kwargs,
)Create RichGroup instance.
| Parameter | Type | Description |
|---|---|---|
*args |
||
**kwargs |
Methods
| Method | Description |
|---|---|
get_command() |
Given a context and a command name, this returns a Command object if it exists or returns None. |
list_commands() |
Returns a list of subcommand names in the order they should appear. |
get_command()
def get_command(
ctx,
filename,
)Given a context and a command name, this returns a Command
object if it exists or returns None.
| Parameter | Type | Description |
|---|---|---|
ctx |
||
filename |
list_commands()
def list_commands(
ctx,
add_remote: bool = True,
)Returns a list of subcommand names in the order they should appear.
| Parameter | Type | Description |
|---|---|---|
ctx |
||
add_remote |
bool |
flytekit.clis.sdk_in_container.run.RunLevelComputedParams
This class is used to store the computed parameters that are used to run a workflow / task / launchplan. Computed parameters are created during the execution
Parameters
class RunLevelComputedParams(
project_root: typing.Optional[str] = None,
module: typing.Optional[str] = None,
temp_file_name: typing.Optional[str] = None,
)| Parameter | Type | Description |
|---|---|---|
project_root |
typing.Optional[str] |
|
module |
typing.Optional[str] |
|
temp_file_name |
typing.Optional[str] |
flytekit.clis.sdk_in_container.run.RunLevelParams
This class is used to store the parameters that are used to run a workflow / task / launchplan.
Parameters
class RunLevelParams(
config_file: typing.Optional[str] = None,
verbose: bool = False,
pkgs: typing.List[str] = <factory>,
project: str = 'flytesnacks',
domain: str = 'development',
destination_dir: str = '.',
copy_all: bool = False,
copy: typing.Optional[flytekit.constants.CopyFileDetection] = 'auto',
image_config: flytekit.configuration.ImageConfig = <factory>,
service_account: str = '',
wait_execution: bool = False,
poll_interval: int = None,
dump_snippet: bool = False,
overwrite_cache: bool = False,
interruptible: typing.Optional[bool] = None,
envvars: typing.Dict[str, str] = <factory>,
resource_requests: typing.Optional[flytekit.core.resources.Resources] = Sentinel.UNSET,
resource_limits: typing.Optional[flytekit.core.resources.Resources] = Sentinel.UNSET,
tags: typing.List[str] = <factory>,
name: str = Sentinel.UNSET,
labels: typing.Dict[str, str] = <factory>,
annotations: typing.Dict[str, str] = <factory>,
raw_output_data_prefix: str = Sentinel.UNSET,
max_parallelism: int = Sentinel.UNSET,
disable_notifications: bool = False,
remote: bool = False,
limit: int = 50,
cluster_pool: str = '',
execution_cluster_label: str = '',
computed_params: flytekit.clis.sdk_in_container.run.RunLevelComputedParams = <factory>,
)| Parameter | Type | Description |
|---|---|---|
config_file |
typing.Optional[str] |
|
verbose |
bool |
|
pkgs |
typing.List[str] |
|
project |
str |
|
domain |
str |
|
destination_dir |
str |
|
copy_all |
bool |
|
copy |
typing.Optional[flytekit.constants.CopyFileDetection] |
|
image_config |
flytekit.configuration.ImageConfig |
|
service_account |
str |
|
wait_execution |
bool |
|
poll_interval |
int |
|
dump_snippet |
bool |
|
overwrite_cache |
bool |
|
interruptible |
typing.Optional[bool] |
|
envvars |
typing.Dict[str, str] |
|
resource_requests |
typing.Optional[flytekit.core.resources.Resources] |
|
resource_limits |
typing.Optional[flytekit.core.resources.Resources] |
|
tags |
typing.List[str] |
|
name |
str |
|
labels |
typing.Dict[str, str] |
|
annotations |
typing.Dict[str, str] |
|
raw_output_data_prefix |
str |
|
max_parallelism |
int |
|
disable_notifications |
bool |
|
remote |
bool |
|
limit |
int |
|
cluster_pool |
str |
|
execution_cluster_label |
str |
|
computed_params |
flytekit.clis.sdk_in_container.run.RunLevelComputedParams |
Properties
| Property | Type | Description |
|---|---|---|
is_remote |
bool |
Methods
| Method | Description |
|---|---|
from_dict() |
|
options() |
Return the set of base parameters added to every pyflyte run workflow subcommand. |
remote_instance() |
from_dict()
def from_dict(
d: typing.Dict[str, typing.Any],
) -> RunLevelParams| Parameter | Type | Description |
|---|---|---|
d |
typing.Dict[str, typing.Any] |
options()
def options()Return the set of base parameters added to every pyflyte run workflow subcommand.
remote_instance()
def remote_instance()flytekit.clis.sdk_in_container.run.WorkflowCommand
click multicommand at the python file layer, subcommands should be all the workflows in the file.
Parameters
class WorkflowCommand(
filename: str,
*args,
**kwargs,
)Create RichGroup instance.
| Parameter | Type | Description |
|---|---|---|
filename |
str |
|
*args |
||
**kwargs |
Methods
| Method | Description |
|---|---|
get_command() |
This command uses the filename with which this command was created, and the string name of the entity passed after the Python filename on the command line, to load the Python object, and then return the Command that click should run. |
list_commands() |
Returns a list of subcommand names in the order they should appear. |
get_command()
def get_command(
ctx,
exe_entity,
)This command uses the filename with which this command was created, and the string name of the entity passed after the Python filename on the command line, to load the Python object, and then return the Command that click should run.
| Parameter | Type | Description |
|---|---|---|
ctx |
The click Context object. | |
exe_entity |
string of the flyte entity provided by the user. Should be the name of a workflow, or task function. |
list_commands()
def list_commands(
ctx,
)Returns a list of subcommand names in the order they should appear.
| Parameter | Type | Description |
|---|---|---|
ctx |
flytekit.clis.sdk_in_container.run.YamlFileReadingCommand
Parameters
class YamlFileReadingCommand(
name: str,
params: typing.List[click.core.Option],
help: str,
callback: typing.Callable = None,
)Create Rich Command instance.
| Parameter | Type | Description |
|---|---|---|
name |
str |
|
params |
typing.List[click.core.Option] |
|
help |
str |
|
callback |
typing.Callable |
Methods
| Method | Description |
|---|---|
parse_args() |
parse_args()
def parse_args(
ctx: click.core.Context,
args: typing.List[str],
) -> typing.List[str]| Parameter | Type | Description |
|---|---|---|
ctx |
click.core.Context |
|
args |
typing.List[str] |