xbrl.ReportPackage

An xbrl.ReportPackage object represents an XBRL report package.

class xbrl.ReportPackage

Proper instances of this class will be created within RaptorXML only, instantiation from script code will throw a NotImplementedError exception.

Class methods

classmethod xbrl.ReportPackage.create_from_url(type cls, url, *, catalog=None, **kargs)

Returns a tuple with an xbrl.ReportPackage and xml.ErrorLog object. Constructs a new xbrl.ReportPackage object after processing the content retrieved from the given url. Other validation options can be specified using additional kargs. Please consult the RaptorXML CLI documentation http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_xbrl_valreportpackage.html for a list of available options. Any errors and warnings reported during the validation can be accessed through the returned xml.ErrorLog object.

classmethod xbrl.ReportPackage.get_report_package_type_from_document_type(type cls, document_type_uri)

Returns the xbrl.ReportPackageType type associated with the given document type url.

classmethod xbrl.ReportPackage.get_report_package_type_from_file_extension(type cls, file_url)

Returns the expected xbrl.ReportPackageType type of file_url based on its file extension.

classmethod xbrl.ReportPackage.validate_url(type cls, url, *, catalog=None, **kargs)

Validates the XBRL report package at the given url according to the Report Package 1.0 specification and returns an xml.ErrorLog object with the results. Other validation options can be specified using additional kargs. Please consult the RaptorXML CLI documentation http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_xbrl_valreportpackage.html for a list of available options. Any errors and warnings reported during the validation can be accessed through the returned xml.ErrorLog object.

Attributes

xbrl.ReportPackage.report_infos

Returns an iterator of ReportInfo objects, representing the reports contained within this XBRL report package.

xbrl.ReportPackage.report_package_type

Returns the type of the report package.

xbrl.ReportPackage.taxonomy_package

Returns an xbrl.TaxonomyPackage object which represents the XBRL taxonomy package of this report package.

xbrl.ReportPackage.uri

Returns the URI used to open the XBRL report package.

Special methods

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