2.0.0b1

flyte.report

Class	Description
`Report`

Methods

def current_report()

Get the current report. This is a dummy report if not in a task context.

:return: The current report.

def flush()

Flush the report.

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

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

Parameter	Type
`name`	`str`
`create_if_missing`	`bool`

        
    
def log(
    content: str,
    do_flush: bool,
)

Log content to the main tab. The content should be a valid HTML string, but not a complete HTML document, as it will be inserted into a div.

Parameter	Type
`content`	`str`
`do_flush`	`bool`

        
    
def replace(
    content: str,
    do_flush: bool,
)

Get the report. Replaces the content of the main tab.

:return: The report.

Parameter	Type
`content`	`str`
`do_flush`	`bool`

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

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

Method	Description
`get_final_report()`	Get the final report as a string.
`get_tab()`	Get a tab by name.

def get_final_report()

Get the final report as a string.

:return: The final report.

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

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

Parameter	Type
`name`	`str`
`create_if_missing`	`bool`