xbrl.oim.ReportBuilder

The oim.ReportBuilder class supports the construction of XBRL reports according to the Open Information Model 1.0 specification. The constructed OIM model can then be directly exported to the respective XML, CSV and JSON representations.

class xbrl.oim.ReportBuilder(DTS dts: xbrl_taxonomy.DTS, **kwargs)

Creates a new oim.ReportBuilder object that supports assembling an OIM report based on the provided taxonomy. The namespaces of the taxonomy will be added to the model.

Methods

xbrl.oim.ReportBuilder.add_enum_item_fact(ConstraintSet dimensions: xbrl.ConstraintSet, value: xbrl_taxonomy.Item | None, fact_id: str | None = None)

Add a new enumeration fact with the given dimensions to the report. If value is None, @xsi:nil will be set to True. If the fact id is None then a new id will be generated. This method returns the fact id for this fact.

xbrl.oim.ReportBuilder.add_footnote_fact(unicode value: str, unicode lang: str = u'en')

Add a new footnote fact to the report. The footnote fact must be the target of a link (using oim.ReportBuilder.add_link) from another fact. This method returns the fact id for this fact.

Add a link between facts in a report. The default values for arcrole_uri and role uri are suitable for adding links betweek facts and footnotes.

xbrl.oim.ReportBuilder.add_namespace_binding(unicode namespace_uri: str, prefix: str | None = None)

Add additional namespace bindings to the report. The namespaces from the DTS have been already added in the constructor.

xbrl.oim.ReportBuilder.add_non_numeric_item_fact(ConstraintSet dimensions: xbrl.ConstraintSet, unicode value: str, fact_id: str | None = None)

Add a new non-numeric fact with the given dimensions to the report. If value is None, @xsi:nil will be set to True. If the fact id is None then a new id will be generated. This method returns the fact id for this fact.

xbrl.oim.ReportBuilder.add_numeric_item_fact(ConstraintSet dimensions: xbrl.ConstraintSet, unicode value: str, decimals: str | None = None, fact_id: str | None = None)

Add a new numeric fact with the given dimensions to the report. If value is None, @xsi:nil will be set to True. If the fact id is None then a new id will be generated. This method returns the fact id for this fact.

xbrl.oim.ReportBuilder.add_qname_item_fact(ConstraintSet dimensions: xbrl.ConstraintSet, value: xml.QName | None, fact_id: str | None = None)

Add a new QName fact (OIM prefixed content) with the given dimensions to the report. If value is None, @xsi:nil will be set to True. If the fact id is None then a new id will be generated. This method returns the fact id for this fact.

xbrl.oim.ReportBuilder.add_schemaRef(unicode href: str)

Add a schema reference to the report. The schema reference should provide the URI of the entry point of the taxonomy on which the report is based.

xbrl.oim.ReportBuilder.add_string_item_fact(ConstraintSet dimensions: xbrl.ConstraintSet, unicode value: str, fact_id: str | None = None, lang: str | None = None)

Add a text fact with the given dimensions, id and language to the report. If value is None then @xsi:nil will be set to True for this fact. If the fact id is None then a new id will be generated. If lang is specified then the language core dimension will be added to the model. This methods returns the fact id for this fact.

xbrl.oim.ReportBuilder.close_document()

This constiutes the final step constructing the report and assembles the OIM model for the report. The OIM model can be serialized into different OIM formats like xBRL-CSV, xBRL-JSON and xBRL-XML. This method returns the OIM model for the report.

Special methods

__eq__, __ge__, __gt__, __le__, __lt__, __ne__