flytekit.configuration.plugin

Defines a plugin API allowing other libraries to modify the behavior of flytekit.

Libraries can register by defining an object that follows the same API as FlytekitPlugin and providing an entrypoint with the group name “flytekit.plugin”. In setuptools, you can specific them with:

setup(entry_points={
    "flytekit.configuration.plugin": ["my_plugin=my_module:MyCustomPlugin"]
})

or in pyproject.toml:

[project.entry-points."flytekit.configuration.plugin"]
my_plugin = "my_module:MyCustomPlugin"

Directory

Classes

Methods

Methods

get_plugin()

def get_plugin()

Get current plugin

flytekit.configuration.plugin.FlytekitPlugin

Methods

configure_pyflyte_cli()

def configure_pyflyte_cli(
    main: click.core.Group,
) -> click.core.Group

Configure pyflyte’s CLI.

get_auth_success_html()

def get_auth_success_html(
    endpoint: str,
) -> typing.Optional[str]

Get default success html. Return None to use flytekit’s default success html.

get_default_cache_policies()

def get_default_cache_policies()

Get default cache policies for tasks.

get_default_image()

def get_default_image()

Get default image. Return None to use the images from flytekit.configuration.DefaultImages

get_remote()

def get_remote(
    config: typing.Optional[str],
    project: str,
    domain: str,
    data_upload_location: typing.Optional[str],
) -> flytekit.remote.remote.FlyteRemote

Get FlyteRemote object for CLI session.

secret_requires_group()

def secret_requires_group()

Return True if secrets require group entry during registration time.

flytekit.configuration.plugin.FlytekitPluginProtocol

Base class for protocol classes.

Protocol classes are defined as::

class Proto(Protocol):
    def meth(self) -> int:
        ...

Such classes are primarily used with static type checkers that recognize structural subtyping (static duck-typing).

For example::

class C:
    def meth(self) -> int:
        return 0

def func(x: Proto) -> int:
    return x.meth()

func(C())  # Passes static type check

See PEP 544 for details. Protocol classes decorated with @typing.runtime_checkable act as simple-minded runtime protocols that check only the presence of given attributes, ignoring their type signatures. Protocol classes can be generic, they are defined as::

class GenProto[T](Protocol):
    def meth(self) -> T:
        ...

class FlytekitPluginProtocol(
    args,
    kwargs,
)

Methods

configure_pyflyte_cli()

def configure_pyflyte_cli(
    main: click.core.Group,
) -> click.core.Group

Configure pyflyte’s CLI.

get_auth_success_html()

def get_auth_success_html(
    endpoint: str,
) -> typing.Optional[str]

Get default success html for auth. Return None to use flytekit’s default success html.

get_default_cache_policies()

def get_default_cache_policies()

Get default cache policies for tasks.

get_default_image()

def get_default_image()

Get default image. Return None to use the images from flytekit.configuration.DefaultImages

get_remote()

def get_remote(
    config: typing.Optional[str],
    project: str,
    domain: str,
    data_upload_location: typing.Optional[str],
) -> flytekit.remote.remote.FlyteRemote

Get FlyteRemote object for CLI session.

secret_requires_group()

def secret_requires_group()

Return True if secrets require group entry.