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.

flytekit.interaction.click_types.DateTimeType

The DateTime type converts date strings into datetime objects.

The format strings which are checked are configurable, but default to some common (non-timezone aware) ISO 8601 formats.

When specifying DateTime formats, you should only pass a list or a tuple. Other iterables, like generators, may lead to surprising results.

The format strings are processed using datetime.strptime, and this consequently defines the format strings which are allowed.

Parsing is tried using each format, in order, and the first format which parses successfully is used.

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: typing.Optional[ForwardRef('Parameter')],
    ctx: typing.Optional[ForwardRef('Context')],
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

def get_metavar(
    param: Parameter,
) -> str

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

get_missing_message()

def get_missing_message(
    param: Parameter,
) -> typing.Optional[str]

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> typing.List[ForwardRef('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,
) -> typing.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

Represents the type of a parameter. Validates and converts values from the command line or Python into the correct type.

To implement a custom type, subclass and implement at least the following:

• The :attr:name class attribute must be set.
• Calling an instance of the type with None must return None. This is already implemented by default.
• :meth:convert must convert string values to the correct type.
• :meth:convert must accept values that are already the correct type.
• It must be able to convert a value if the ctx and param arguments are None. This can occur when converting prompt input.

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: typing.Optional[ForwardRef('Parameter')],
    ctx: typing.Optional[ForwardRef('Context')],
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

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

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

get_missing_message()

def get_missing_message(
    param: Parameter,
) -> typing.Optional[str]

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> typing.List[ForwardRef('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,
) -> typing.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

Represents the type of a parameter. Validates and converts values from the command line or Python into the correct type.

To implement a custom type, subclass and implement at least the following:

• The :attr:name class attribute must be set.
• Calling an instance of the type with None must return None. This is already implemented by default.
• :meth:convert must convert string values to the correct type.
• :meth:convert must accept values that are already the correct type.
• It must be able to convert a value if the ctx and param arguments are None. This can occur when converting prompt input.

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: typing.Optional[ForwardRef('Parameter')],
    ctx: typing.Optional[ForwardRef('Context')],
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

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

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

get_missing_message()

def get_missing_message(
    param: Parameter,
) -> typing.Optional[str]

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> typing.List[ForwardRef('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,
) -> typing.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

The choice type allows a value to be checked against a fixed set of supported values. All of these values have to be strings.

You should only pass a list or tuple of choices. Other iterables (like generators) may lead to surprising results.

The resulting value will always be one of the originally passed choices regardless of case_sensitive or any ctx.token_normalize_func being specified.

See :ref:choice-opts for an example.

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'>

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: typing.Optional[ForwardRef('Parameter')],
    ctx: typing.Optional[ForwardRef('Context')],
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

def get_metavar(
    param: Parameter,
) -> str

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

get_missing_message()

def get_missing_message(
    param: Parameter,
) -> str

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> typing.List[ForwardRef('CompletionItem')]

Complete choices that start with the incomplete value.

split_envvar_value()

def split_envvar_value(
    rv: str,
) -> typing.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

Represents the type of a parameter. Validates and converts values from the command line or Python into the correct type.

To implement a custom type, subclass and implement at least the following:

• The :attr:name class attribute must be set.
• Calling an instance of the type with None must return None. This is already implemented by default.
• :meth:convert must convert string values to the correct type.
• :meth:convert must accept values that are already the correct type.
• It must be able to convert a value if the ctx and param arguments are None. This can occur when converting prompt input.

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: typing.Optional[ForwardRef('Parameter')],
    ctx: typing.Optional[ForwardRef('Context')],
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

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

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

get_missing_message()

def get_missing_message(
    param: Parameter,
) -> typing.Optional[str]

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> typing.List[ForwardRef('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,
) -> typing.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,
)

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()

Properties

flytekit.interaction.click_types.JSONIteratorParamType

Represents the type of a parameter. Validates and converts values from the command line or Python into the correct type.

To implement a custom type, subclass and implement at least the following:

• The :attr:name class attribute must be set.
• Calling an instance of the type with None must return None. This is already implemented by default.
• :meth:convert must convert string values to the correct type.
• :meth:convert must accept values that are already the correct type.
• It must be able to convert a value if the ctx and param arguments are None. This can occur when converting prompt input.

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: typing.Optional[ForwardRef('Parameter')],
    ctx: typing.Optional[ForwardRef('Context')],
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

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

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

get_missing_message()

def get_missing_message(
    param: Parameter,
) -> typing.Optional[str]

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> typing.List[ForwardRef('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,
) -> typing.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

Represents the type of a parameter. Validates and converts values from the command line or Python into the correct type.

To implement a custom type, subclass and implement at least the following:

• The :attr:name class attribute must be set.
• Calling an instance of the type with None must return None. This is already implemented by default.
• :meth:convert must convert string values to the correct type.
• :meth:convert must accept values that are already the correct type.
• It must be able to convert a value if the ctx and param arguments are None. This can occur when converting prompt input.

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: typing.Optional[ForwardRef('Parameter')],
    ctx: typing.Optional[ForwardRef('Context')],
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

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

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

get_missing_message()

def get_missing_message(
    param: Parameter,
) -> typing.Optional[str]

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> typing.List[ForwardRef('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,
) -> typing.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

Represents the type of a parameter. Validates and converts values from the command line or Python into the correct type.

To implement a custom type, subclass and implement at least the following:

• The :attr:name class attribute must be set.
• Calling an instance of the type with None must return None. This is already implemented by default.
• :meth:convert must convert string values to the correct type.
• :meth:convert must accept values that are already the correct type.
• It must be able to convert a value if the ctx and param arguments are None. This can occur when converting prompt input.

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: typing.Optional[ForwardRef('Parameter')],
    ctx: typing.Optional[ForwardRef('Context')],
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

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

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

get_missing_message()

def get_missing_message(
    param: Parameter,
) -> typing.Optional[str]

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> typing.List[ForwardRef('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,
) -> typing.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: typing.Optional[ForwardRef('Parameter')],
    ctx: typing.Optional[ForwardRef('Context')],
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

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

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

get_missing_message()

def get_missing_message(
    param: Parameter,
) -> typing.Optional[str]

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> typing.List[ForwardRef('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,
) -> typing.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],
)

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: typing.Optional[ForwardRef('Parameter')],
    ctx: typing.Optional[ForwardRef('Context')],
) -> t.NoReturn

Helper method to fail with an invalid value message.

get_metavar()

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

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

get_missing_message()

def get_missing_message(
    param: Parameter,
) -> typing.Optional[str]

Optionally might return extra information about a missing parameter.

.. versionadded:: 2.0

shell_complete()

def shell_complete(
    ctx: Context,
    param: Parameter,
    incomplete: str,
) -> typing.List[ForwardRef('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,
) -> typing.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

Properties