xbrl.ReportPackageBuilder

The xbrl.ReportPackageBuilder specifies an interface to create XBRL Report Packages.

class xbrl.ReportPackageBuilder(top_level_directory_name, report_package_type, catalog=None, *, **kargs)

Creates a new xbrl.ReportPackageBuilder object.

Methods

xbrl.ReportPackageBuilder.add_file_from_buffer(pathInTopLevelDirectory, buf)

Adds a file with content buf at path pathInTopLevelDirectory to the report package.

xbrl.ReportPackageBuilder.add_file_from_url(pathInTopLevelDirectory, url)

Adds the file located at url at path pathInTopLevelDirectory to the report package.

xbrl.ReportPackageBuilder.finalize(url)

Returns a tuple with an xbrl.ReportPackage and xml.ErrorLog object. Creates a report package containing the files added by previous calls to add_file_from_url, add_file_from_buffer and set_taxonomy_package methods and writes it to url. Any errors and warnings reported during the report package creation and validation can be accessed through the returned xml.ErrorLog object.

xbrl.ReportPackageBuilder.set_taxonomy_package(url)

Adds the taxonomy package located at url to the report package.

Special methods

__bool__, __eq__, __ge__, __gt__, __le__, __lt__, __ne__