flytekit.Description#

class flytekit.Description(value=None, uri=None, icon_link=None, format=DescriptionFormat.RST)[source]#

Full user description with formatting preserved. This can be rendered by clients, such as the console or command line tools with in-tact formatting.

Methods

Parameters:

  • value (str | None)

  • uri (str | None)

  • icon_link (str | None)

  • format (DescriptionFormat)

classmethod from_flyte_idl(pb2_object)[source]#
Parameters:

pb2_object (Description)

Return type:

Description

serialize_to_string()[source]#
Return type:

str

short_string()[source]#
Return type:

Text

to_flyte_idl()[source]#
verbose_string()[source]#
Return type:

Text

Attributes

format: DescriptionFormat = 3[source]
icon_link: str | None = None
is_empty
uri: str | None = None
value: str | None = None