transport_data.org.metadata.report.MetadataReport0Plain

class transport_data.org.metadata.report.MetadataReport0Plain(mdr: v21.MetadataReport)

Bases: Report

Contents of a single metadata report.

This includes:

1. The reported attribute values for all metadata attributes.

2. The data flow that is targeted by the report and its dimensions.

__init__(mdr: v21.MetadataReport) → None

Methods

__init__(mdr)
render()	Render the report (generate its contents) and return as str or bytes.
render_jinja_template(*args, **kwargs)	Retrieve the Jinja2 template_name and call its render method.
rst2odt(content)	Convert content from reStructuredText to OpenDocument Text (ODT).
write_file(path, **kwargs)	render() the report and write to path.

Attributes

mdr	Metadata report to report.
template_name	Name of a Jinja2 template used by the report; see render_jinja_template().

mdr: v21.MetadataReport

Metadata report to report.

render() → str

Render the report (generate its contents) and return as str or bytes.

The content may be in any format: plain text, HTML, binary file content, etc.

render_jinja_template(*args, **kwargs) → str

Retrieve the Jinja2 template_name and call its render method.

rst2odt(content: str) → bytes

Convert content from reStructuredText to OpenDocument Text (ODT).

Returns:

The ODT (ZIP) archive.

Return type:

bytes

template_name: str

Name of a Jinja2 template used by the report; see render_jinja_template().

write_file(path: Path, **kwargs) → None

render() the report and write to path.