flytekit.types.file

Flytekit File Type

.. currentmodule:: flytekit.types.file

This list also contains a bunch of pre-formatted :py:class:flytekit.types.file.FlyteFile types.

.. autosummary:: :toctree: generated/ :template: file_types.rst

FlyteFile HDF5EncodedFile HTMLPage JoblibSerializedFile JPEGImageFile PDFFile PNGImageFile PythonPickledFile PythonNotebook SVGImageFile

Directory

Classes

flytekit.types.file.FileExt

Used for annotating file extension types of FlyteFile. This is useful for extensions that have periods in them, e.g., “tar.gz”.

Example: TAR_GZ = Annotated[str, FileExt(“tar.gz”)]

class FileExt(
    ext: str,
)

Methods

check_and_convert_to_str()

def check_and_convert_to_str(
    item: typing.Union[typing.Type, str],
) -> str