1.15.4.dev2+g3e3ce2426

flytekit.deck.renderer

Directory

Classes

Class Description
Any Special type indicating an unconstrained type.
ArrowRenderer Render an Arrow dataframe as an HTML table.
MarkdownIt None.
MarkdownRenderer Convert a markdown string to HTML and return HTML as a unicode string.
Protocol Base class for protocol classes.
PythonDependencyRenderer PythonDependencyDeck is a deck that contains information about packages installed via pip.
Renderable Base class for protocol classes.
SourceCodeRenderer Convert Python source code to HTML, and return HTML as a unicode string.
TopFrameRenderer Render a DataFrame as an HTML table.

flytekit.deck.renderer.Any

Special type indicating an unconstrained type.

  • Any is compatible with every type.
  • Any assumed to have all methods.
  • All values assumed to be instances of Any.

Note that all the above statements are true from the point of view of static type checkers. At runtime, Any should not be used with instance checks.

flytekit.deck.renderer.ArrowRenderer

Render an Arrow dataframe as an HTML table.

Methods

Method Description
to_html() None

to_html()

def to_html(
    df: pyarrow.Table,
):
Parameter Type
df pyarrow.Table

flytekit.deck.renderer.MarkdownRenderer

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

Methods

Method Description
to_html() None

to_html()

def to_html(
    text: str,
):
Parameter Type
text str

flytekit.deck.renderer.Protocol

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 GenProtoT: def meth(self) -> T: …

flytekit.deck.renderer.PythonDependencyRenderer

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

def PythonDependencyRenderer(
    title: str,
):
Parameter Type
title str

Methods

Method Description
to_html() None

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 GenProtoT: def meth(self) -> T: …

def Renderable(
    args,
    kwargs,
):
Parameter Type
args *args
kwargs **kwargs

Methods

Method Description
to_html() Convert an object(markdown, pandas

to_html()

def to_html(
    python_value: typing.Any,
):

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

Parameter Type
python_value typing.Any

flytekit.deck.renderer.SourceCodeRenderer

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

def SourceCodeRenderer(
    title: str,
):
Parameter Type
title str

Methods

Method Description
to_html() Convert the provided Python source code into HTML format using Pygments library

to_html()

def to_html(
    source_code: 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.

Parameter Type
source_code str

flytekit.deck.renderer.TopFrameRenderer

Render a DataFrame as an HTML table.

def TopFrameRenderer(
    max_rows: int,
    max_cols: int,
):
Parameter Type
max_rows int
max_cols int

Methods

Method Description
to_html() None

to_html()

def to_html(
    df: pandas.DataFrame,
):
Parameter Type
df pandas.DataFrame