Report

Package: flyte.report

Parameters

        
    
class Report(
    name: str,
    tabs: typing.Dict[str, flyte.report._report.Tab] = <factory>,
    template_path: pathlib.Path = <factory>,
)

Parameter	Type	Description
`name`	`str`
`tabs`	`typing.Dict[str, flyte.report._report.Tab]`
`template_path`	`pathlib.Path`

Methods

Method	Description
`get_final_report()`	Get the final report as a string.
`get_tab()`	Get a tab by name.
`has_content()`	Whether anything has been logged to this report.

get_final_report()

        
    
def get_final_report()

Get the final report as a string.

Returns: The final report.

get_tab()

        
    
def get_tab(
    name: str,
    create_if_missing: bool = True,
) -> flyte.report._report.Tab

Get a tab by name. If the tab does not exist, create it.

Parameter	Type	Description
`name`	`str`	The name of the tab.
`create_if_missing`	`bool`	Whether to create the tab if it does not exist.

Returns: The tab.

has_content()

        
    
def has_content()

Whether anything has been logged to this report.

__post_init__ always creates the “main” tab, so the existence of a Report — or of a tab — says nothing about whether it holds content.

Returns: True if any tab has content.