flytekit.interaction.click_types

Directory

Classes

Methods

Variables

Methods

is_pydantic_basemodel()

def is_pydantic_basemodel(
    python_type: typing.Type,
) -> bool

Checks if the python type is a pydantic BaseModel

key_value_callback()

def key_value_callback(
    _: typing.Any,
    param: str,
    values: typing.List[str],
) -> typing.Optional[typing.Dict[str, str]]

Callback for click to parse key-value pairs.

labels_callback()

def labels_callback(
    _: typing.Any,
    param: str,
    values: typing.List[str],
) -> typing.Optional[typing.Dict[str, str]]

Callback for click to parse labels.

literal_type_to_click_type()

def literal_type_to_click_type(
    lt: flytekit.models.types.LiteralType,
    python_type: typing.Type,
) -> click.types.ParamType

Converts a Flyte LiteralType given a python_type to a click.ParamType

modify_literal_uris()

def modify_literal_uris(
    lit: flytekit.models.literals.Literal,
)

Modifies the literal object recursively to replace the URIs with the native paths.

resource_callback()

def resource_callback(
    _: typing.Any,
    param: str,
    value: typing.Optional[str],
) -> typing.Optional[flytekit.core.resources.Resources]

Click callback to parse resource strings like ‘cpu=1,mem=2Gi’ into a Resources object

flytekit.interaction.click_types.DateTimeType

def DateTimeType()

Methods

convert()

def convert(
    value: typing.Any,
    param: typing.Optional[click.core.Parameter],
    ctx: typing.Optional[click.core.Context],
) -> typing.Any

Convert the value to the correct type. This is not called if the value is None (the missing value).

This must accept string values from the command line, as well as values that are already the correct type. It may also convert other compatible types.

The param and ctx arguments may be None in certain situations, such as when converting prompt input.

If the value cannot be converted, call :meth:fail with a descriptive message.

fail()

def fail(
    message: str,
    param: Parameter | None,
    ctx: Context | None,
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

def get_metavar(
    param: Parameter,
    ctx: Context,
) -> str | None

Returns the metavar default for this param if it provides one.

get_missing_message()

def get_missing_message(
    param: Parameter,
    ctx: Context | None,
) -> str | None

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> list[CompletionItem]

Return a list of :class:~click.shell_completion.CompletionItem objects for the incomplete value. Most types do not provide completions, but some do, and this allows custom types to provide custom completions as well.

split_envvar_value()

def split_envvar_value(
    rv: str,
) -> cabc.Sequence[str]

Given a value from an environment variable this splits it up into small chunks depending on the defined envvar list splitter.

If the splitter is set to None, which means that whitespace splits, then leading and trailing whitespace is ignored. Otherwise, leading and trailing splitters usually lead to empty items being included.

to_info_dict()

def to_info_dict()

Gather information that could be useful for a tool generating user-facing documentation.

Use :meth:click.Context.to_info_dict to traverse the entire CLI structure.

.. versionadded:: 8.0

flytekit.interaction.click_types.DirParamType

Methods

convert()

def convert(
    value: typing.Any,
    param: typing.Optional[click.core.Parameter],
    ctx: typing.Optional[click.core.Context],
) -> typing.Any

Convert the value to the correct type. This is not called if the value is None (the missing value).

This must accept string values from the command line, as well as values that are already the correct type. It may also convert other compatible types.

The param and ctx arguments may be None in certain situations, such as when converting prompt input.

If the value cannot be converted, call :meth:fail with a descriptive message.

fail()

def fail(
    message: str,
    param: Parameter | None,
    ctx: Context | None,
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

def get_metavar(
    param: Parameter,
    ctx: Context,
) -> str | None

Returns the metavar default for this param if it provides one.

get_missing_message()

def get_missing_message(
    param: Parameter,
    ctx: Context | None,
) -> str | None

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> list[CompletionItem]

Return a list of :class:~click.shell_completion.CompletionItem objects for the incomplete value. Most types do not provide completions, but some do, and this allows custom types to provide custom completions as well.

split_envvar_value()

def split_envvar_value(
    rv: str,
) -> cabc.Sequence[str]

Given a value from an environment variable this splits it up into small chunks depending on the defined envvar list splitter.

If the splitter is set to None, which means that whitespace splits, then leading and trailing whitespace is ignored. Otherwise, leading and trailing splitters usually lead to empty items being included.

to_info_dict()

def to_info_dict()

Gather information that could be useful for a tool generating user-facing documentation.

Use :meth:click.Context.to_info_dict to traverse the entire CLI structure.

.. versionadded:: 8.0

flytekit.interaction.click_types.DurationParamType

Methods

convert()

def convert(
    value: typing.Any,
    param: typing.Optional[click.core.Parameter],
    ctx: typing.Optional[click.core.Context],
) -> typing.Any

Convert the value to the correct type. This is not called if the value is None (the missing value).

This must accept string values from the command line, as well as values that are already the correct type. It may also convert other compatible types.

The param and ctx arguments may be None in certain situations, such as when converting prompt input.

If the value cannot be converted, call :meth:fail with a descriptive message.

fail()

def fail(
    message: str,
    param: Parameter | None,
    ctx: Context | None,
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

def get_metavar(
    param: Parameter,
    ctx: Context,
) -> str | None

Returns the metavar default for this param if it provides one.

get_missing_message()

def get_missing_message(
    param: Parameter,
    ctx: Context | None,
) -> str | None

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> list[CompletionItem]

Return a list of :class:~click.shell_completion.CompletionItem objects for the incomplete value. Most types do not provide completions, but some do, and this allows custom types to provide custom completions as well.

split_envvar_value()

def split_envvar_value(
    rv: str,
) -> cabc.Sequence[str]

Given a value from an environment variable this splits it up into small chunks depending on the defined envvar list splitter.

If the splitter is set to None, which means that whitespace splits, then leading and trailing whitespace is ignored. Otherwise, leading and trailing splitters usually lead to empty items being included.

to_info_dict()

def to_info_dict()

Gather information that could be useful for a tool generating user-facing documentation.

Use :meth:click.Context.to_info_dict to traverse the entire CLI structure.

.. versionadded:: 8.0

flytekit.interaction.click_types.EnumParamType

class EnumParamType(
    enum_type: typing.Type[enum.Enum],
)

Methods

convert()

def convert(
    value: typing.Any,
    param: typing.Optional[click.core.Parameter],
    ctx: typing.Optional[click.core.Context],
) -> <enum 'Enum'>

For a given value from the parser, normalize it and find its matching normalized value in the list of choices. Then return the matched “original” choice.

fail()

def fail(
    message: str,
    param: Parameter | None,
    ctx: Context | None,
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_invalid_choice_message()

def get_invalid_choice_message(
    value: t.Any,
    ctx: Context | None,
) -> str

Get the error message when the given choice is invalid.

get_metavar()

def get_metavar(
    param: Parameter,
    ctx: Context,
) -> str | None

Returns the metavar default for this param if it provides one.

get_missing_message()

def get_missing_message(
    param: Parameter,
    ctx: Context | None,
) -> str

Message shown when no choice is passed.

.. versionchanged:: 8.2.0 Added ctx argument.

normalize_choice()

def normalize_choice(
    choice: ParamTypeValue,
    ctx: Context | None,
) -> str

Normalize a choice value, used to map a passed string to a choice. Each choice must have a unique normalized value.

By default uses :meth:Context.token_normalize_func and if not case sensitive, convert it to a casefolded value.

.. versionadded:: 8.2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> list[CompletionItem]

Complete choices that start with the incomplete value.

split_envvar_value()

def split_envvar_value(
    rv: str,
) -> cabc.Sequence[str]

Given a value from an environment variable this splits it up into small chunks depending on the defined envvar list splitter.

If the splitter is set to None, which means that whitespace splits, then leading and trailing whitespace is ignored. Otherwise, leading and trailing splitters usually lead to empty items being included.

to_info_dict()

def to_info_dict()

Gather information that could be useful for a tool generating user-facing documentation.

Use :meth:click.Context.to_info_dict to traverse the entire CLI structure.

.. versionadded:: 8.0

flytekit.interaction.click_types.FileParamType

Methods

convert()

def convert(
    value: typing.Any,
    param: typing.Optional[click.core.Parameter],
    ctx: typing.Optional[click.core.Context],
) -> typing.Any

Convert the value to the correct type. This is not called if the value is None (the missing value).

This must accept string values from the command line, as well as values that are already the correct type. It may also convert other compatible types.

The param and ctx arguments may be None in certain situations, such as when converting prompt input.

If the value cannot be converted, call :meth:fail with a descriptive message.

fail()

def fail(
    message: str,
    param: Parameter | None,
    ctx: Context | None,
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

def get_metavar(
    param: Parameter,
    ctx: Context,
) -> str | None

Returns the metavar default for this param if it provides one.

get_missing_message()

def get_missing_message(
    param: Parameter,
    ctx: Context | None,
) -> str | None

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> list[CompletionItem]

Return a list of :class:~click.shell_completion.CompletionItem objects for the incomplete value. Most types do not provide completions, but some do, and this allows custom types to provide custom completions as well.

split_envvar_value()

def split_envvar_value(
    rv: str,
) -> cabc.Sequence[str]

Given a value from an environment variable this splits it up into small chunks depending on the defined envvar list splitter.

If the splitter is set to None, which means that whitespace splits, then leading and trailing whitespace is ignored. Otherwise, leading and trailing splitters usually lead to empty items being included.

to_info_dict()

def to_info_dict()

Gather information that could be useful for a tool generating user-facing documentation.

Use :meth:click.Context.to_info_dict to traverse the entire CLI structure.

.. versionadded:: 8.0

flytekit.interaction.click_types.FlyteLiteralConverter

class FlyteLiteralConverter(
    flyte_ctx: flytekit.core.context_manager.FlyteContext,
    literal_type: flytekit.models.types.LiteralType,
    python_type: typing.Type,
    is_remote: bool,
)

Properties

Methods

convert()

def convert(
    ctx: click.core.Context,
    param: typing.Optional[click.core.Parameter],
    value: typing.Any,
) -> typing.Union[flytekit.models.literals.Literal, typing.Any]

Convert the value to a Flyte Literal or a python native type. This is used by click to convert the input.

is_bool()

def is_bool()

flytekit.interaction.click_types.JSONIteratorParamType

Methods

convert()

def convert(
    value: typing.Any,
    param: typing.Optional[click.core.Parameter],
    ctx: typing.Optional[click.core.Context],
) -> typing.Any

Convert the value to the correct type. This is not called if the value is None (the missing value).

This must accept string values from the command line, as well as values that are already the correct type. It may also convert other compatible types.

The param and ctx arguments may be None in certain situations, such as when converting prompt input.

If the value cannot be converted, call :meth:fail with a descriptive message.

fail()

def fail(
    message: str,
    param: Parameter | None,
    ctx: Context | None,
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

def get_metavar(
    param: Parameter,
    ctx: Context,
) -> str | None

Returns the metavar default for this param if it provides one.

get_missing_message()

def get_missing_message(
    param: Parameter,
    ctx: Context | None,
) -> str | None

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> list[CompletionItem]

Return a list of :class:~click.shell_completion.CompletionItem objects for the incomplete value. Most types do not provide completions, but some do, and this allows custom types to provide custom completions as well.

split_envvar_value()

def split_envvar_value(
    rv: str,
) -> cabc.Sequence[str]

Given a value from an environment variable this splits it up into small chunks depending on the defined envvar list splitter.

If the splitter is set to None, which means that whitespace splits, then leading and trailing whitespace is ignored. Otherwise, leading and trailing splitters usually lead to empty items being included.

to_info_dict()

def to_info_dict()

Gather information that could be useful for a tool generating user-facing documentation.

Use :meth:click.Context.to_info_dict to traverse the entire CLI structure.

.. versionadded:: 8.0

flytekit.interaction.click_types.JsonParamType

class JsonParamType(
    python_type: typing.Type,
)

Methods

convert()

def convert(
    value: typing.Any,
    param: typing.Optional[click.core.Parameter],
    ctx: typing.Optional[click.core.Context],
) -> typing.Any

Convert the value to the correct type. This is not called if the value is None (the missing value).

This must accept string values from the command line, as well as values that are already the correct type. It may also convert other compatible types.

The param and ctx arguments may be None in certain situations, such as when converting prompt input.

If the value cannot be converted, call :meth:fail with a descriptive message.

fail()

def fail(
    message: str,
    param: Parameter | None,
    ctx: Context | None,
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

def get_metavar(
    param: Parameter,
    ctx: Context,
) -> str | None

Returns the metavar default for this param if it provides one.

get_missing_message()

def get_missing_message(
    param: Parameter,
    ctx: Context | None,
) -> str | None

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> list[CompletionItem]

Return a list of :class:~click.shell_completion.CompletionItem objects for the incomplete value. Most types do not provide completions, but some do, and this allows custom types to provide custom completions as well.

split_envvar_value()

def split_envvar_value(
    rv: str,
) -> cabc.Sequence[str]

Given a value from an environment variable this splits it up into small chunks depending on the defined envvar list splitter.

If the splitter is set to None, which means that whitespace splits, then leading and trailing whitespace is ignored. Otherwise, leading and trailing splitters usually lead to empty items being included.

to_info_dict()

def to_info_dict()

Gather information that could be useful for a tool generating user-facing documentation.

Use :meth:click.Context.to_info_dict to traverse the entire CLI structure.

.. versionadded:: 8.0

flytekit.interaction.click_types.PickleParamType

Methods

convert()

def convert(
    value: typing.Any,
    param: typing.Optional[click.core.Parameter],
    ctx: typing.Optional[click.core.Context],
) -> typing.Any

Convert the value to the correct type. This is not called if the value is None (the missing value).

This must accept string values from the command line, as well as values that are already the correct type. It may also convert other compatible types.

The param and ctx arguments may be None in certain situations, such as when converting prompt input.

If the value cannot be converted, call :meth:fail with a descriptive message.

fail()

def fail(
    message: str,
    param: Parameter | None,
    ctx: Context | None,
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

def get_metavar(
    param: click.core.Parameter,
    ctx: click.core.Context,
) -> typing.Optional[str]

Returns the metavar default for this param if it provides one.

get_missing_message()

def get_missing_message(
    param: Parameter,
    ctx: Context | None,
) -> str | None

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> list[CompletionItem]

Return a list of :class:~click.shell_completion.CompletionItem objects for the incomplete value. Most types do not provide completions, but some do, and this allows custom types to provide custom completions as well.

split_envvar_value()

def split_envvar_value(
    rv: str,
) -> cabc.Sequence[str]

Given a value from an environment variable this splits it up into small chunks depending on the defined envvar list splitter.

If the splitter is set to None, which means that whitespace splits, then leading and trailing whitespace is ignored. Otherwise, leading and trailing splitters usually lead to empty items being included.

to_info_dict()

def to_info_dict()

Gather information that could be useful for a tool generating user-facing documentation.

Use :meth:click.Context.to_info_dict to traverse the entire CLI structure.

.. versionadded:: 8.0

flytekit.interaction.click_types.StructuredDatasetParamType

TODO handle column types

Methods

convert()

def convert(
    value: typing.Any,
    param: typing.Optional[click.core.Parameter],
    ctx: typing.Optional[click.core.Context],
) -> typing.Any

Convert the value to the correct type. This is not called if the value is None (the missing value).

This must accept string values from the command line, as well as values that are already the correct type. It may also convert other compatible types.

The param and ctx arguments may be None in certain situations, such as when converting prompt input.

If the value cannot be converted, call :meth:fail with a descriptive message.

fail()

def fail(
    message: str,
    param: Parameter | None,
    ctx: Context | None,
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

def get_metavar(
    param: Parameter,
    ctx: Context,
) -> str | None

Returns the metavar default for this param if it provides one.

get_missing_message()

def get_missing_message(
    param: Parameter,
    ctx: Context | None,
) -> str | None

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> list[CompletionItem]

Return a list of :class:~click.shell_completion.CompletionItem objects for the incomplete value. Most types do not provide completions, but some do, and this allows custom types to provide custom completions as well.

split_envvar_value()

def split_envvar_value(
    rv: str,
) -> cabc.Sequence[str]

Given a value from an environment variable this splits it up into small chunks depending on the defined envvar list splitter.

If the splitter is set to None, which means that whitespace splits, then leading and trailing whitespace is ignored. Otherwise, leading and trailing splitters usually lead to empty items being included.

to_info_dict()

def to_info_dict()

Gather information that could be useful for a tool generating user-facing documentation.

Use :meth:click.Context.to_info_dict to traverse the entire CLI structure.

.. versionadded:: 8.0

flytekit.interaction.click_types.UnionParamType

A composite type that allows for multiple types to be specified. This is used for union types.

class UnionParamType(
    types: typing.List[click.types.ParamType],
)

Properties

Methods

convert()

def convert(
    value: typing.Any,
    param: typing.Optional[click.core.Parameter],
    ctx: typing.Optional[click.core.Context],
) -> typing.Any

Important to implement NoneType / Optional. Also could we just determine the click types from the python types

fail()

def fail(
    message: str,
    param: Parameter | None,
    ctx: Context | None,
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

def get_metavar(
    param: Parameter,
    ctx: Context,
) -> str | None

Returns the metavar default for this param if it provides one.

get_missing_message()

def get_missing_message(
    param: Parameter,
    ctx: Context | None,
) -> str | None

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> list[CompletionItem]

Return a list of :class:~click.shell_completion.CompletionItem objects for the incomplete value. Most types do not provide completions, but some do, and this allows custom types to provide custom completions as well.

split_envvar_value()

def split_envvar_value(
    rv: str,
) -> cabc.Sequence[str]

Given a value from an environment variable this splits it up into small chunks depending on the defined envvar list splitter.

If the splitter is set to None, which means that whitespace splits, then leading and trailing whitespace is ignored. Otherwise, leading and trailing splitters usually lead to empty items being included.

to_info_dict()

def to_info_dict()

Gather information that could be useful for a tool generating user-facing documentation.

Use :meth:click.Context.to_info_dict to traverse the entire CLI structure.

.. versionadded:: 8.0