flytekit.deck.renderer

Directory

Classes

Protocols

Variables

flytekit.deck.renderer.ArrowRenderer

Render an Arrow dataframe as an HTML table.

Methods

to_html()

def to_html(
    df: pyarrow.Table,
) -> str

flytekit.deck.renderer.MarkdownRenderer

Convert a markdown string to HTML and return HTML as a unicode string.

Methods

to_html()

def to_html(
    text: str,
) -> str

flytekit.deck.renderer.PythonDependencyRenderer

PythonDependencyDeck is a deck that contains information about packages installed via pip.

class PythonDependencyRenderer(
    title: str,
)

Methods

to_html()

def to_html()

flytekit.deck.renderer.Renderable

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:
        ...

protocol Renderable()

Methods

to_html()

def to_html(
    python_value: typing.Any,
) -> str

Convert an object(markdown, pandas.dataframe) to HTML and return HTML as a unicode string. Returns: An HTML document as a string.

flytekit.deck.renderer.SourceCodeRenderer

Convert Python source code to HTML, and return HTML as a unicode string.

class SourceCodeRenderer(
    title: str,
)

Methods

to_html()

def to_html(
    source_code: str,
) -> str

Convert the provided Python source code into HTML format using Pygments library.

This method applies a colorful style and replaces the color “#fff0f0” with “#ffffff” in CSS.

flytekit.deck.renderer.TopFrameRenderer

Render a DataFrame as an HTML table.

class TopFrameRenderer(
    max_rows: int,
    max_cols: int,
)

Methods

to_html()

def to_html(
    df: pandas.DataFrame,
) -> str