transport_data.org.metadata.report.MetadataSet2HTML

class transport_data.org.metadata.report.MetadataSet2HTML(mds: v21.MetadataSet, ref_area: list[str])[source]

Bases: Report

Table of metadata reports.

This table has:

  • One column per value in ref_areas.

  • One row per metadata report in mds.

  • A check-mark in cells where contains_data_for() indicates that the metadata report targets a data flow that contains data for the reference area.

__init__(mds: v21.MetadataSet, ref_area: list[str]) → None

Methods

__init__(mds, ref_area)

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

template_name

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

mds

Metadata set to summarize.

ref_area

Geographies to show.
mds: v21.MetadataSet

Metadata set to summarize.

ref_area: list[str]

Geographies to show.

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 = 'metadata-set-2.html'

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.