xbrl.InlineXBRLDocumentSet

An xbrl.InlineXBRLDocumentSet object represents an Inline XBRL document set.

class xbrl.InlineXBRLDocumentSet

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

Class methods

classmethod xbrl.InlineXBRLDocumentSet.transform_xbrl_from_buffer(type cls, buf, *, DTS dts=None, catalog=None, taxonomy_package=None, utr=None, **kargs)

Transforms the InlineXBRL document set from the given buffer or buffers according to the InlineXBRL 1.0 or 1.1 specification and returns a dictionary of xbrl.Instance target documents. To validate the target XBRL instances against a specific DTS, supply an xbrl.taxonomy.DTS object using the dts parameters. Optional user XML catalogs can be specified with the catalog argument. Optional taxonomy packages can be specified with the taxonomy_package argument. Optional Units Registry can be specified with the utr argument. Other validation options can be specified using additional kargs. Please consult the RaptorXML CLI documentation http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_xbrl_valinlinexbrl.htm 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.InlineXBRLDocumentSet.transform_xbrl_from_element(type cls, elem, *, DTS dts=None, catalog=None, taxonomy_package=None, utr=None, **kargs)

Transforms the InlineXBRL document set from the given XML element or elements according to the InlineXBRL 1.0 or 1.1 specification and returns a dictionary of xbrl.Instance target documents. To validate the target XBRL instances against a specific DTS, supply an xbrl.taxonomy.DTS object using the dts parameters. Optional user XML catalogs can be specified with the catalog argument. Optional taxonomy packages can be specified with the taxonomy_package argument. Optional Units Registry can be specified with the utr argument. Other validation options can be specified using additional kargs. Please consult the RaptorXML CLI documentation http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_xbrl_valinlinexbrl.htm 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.InlineXBRLDocumentSet.transform_xbrl_from_url(type cls, url, *, DTS dts=None, catalog=None, taxonomy_package=None, utr=None, **kargs)

Transforms the InlineXBRL document set from the given url or urls according to the InlineXBRL 1.0 or 1.1 specification and returns a dictionary of xbrl.Instance target documents. To validate the target XBRL instances against a specific DTS, supply an xbrl.taxonomy.DTS object using the dts parameters. Optional user XML catalogs can be specified with the catalog argument. Optional taxonomy packages can be specified with the taxonomy_package argument. Optional Units Registry can be specified with the utr argument. Other validation options can be specified using additional kargs. Please consult the RaptorXML CLI documentation http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_xbrl_valinlinexbrl.htm 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.InlineXBRLDocumentSet.transform_xml_from_buffer(type cls, buf, *, catalog=None, **kargs)

Transforms the InlineXBRL document set from the given buffer or buffers according to the InlineXBRL 1.0 or 1.1 specification and returns a dictionary of xml.Instance target documents. Optional user XML catalogs can be specified with the catalog argument. Other validation options can be specified using additional kargs. Please consult the RaptorXML CLI documentation http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_xbrl_valinlinexbrl.htm 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.InlineXBRLDocumentSet.transform_xml_from_element(type cls, elem, *, catalog=None, **kargs)

Transforms the InlineXBRL document set from the given XML element or elements according to the InlineXBRL 1.0 or 1.1 specification and returns a dictionary of xml.Instance target documents. Optional user XML catalogs can be specified with the catalog argument. Other validation options can be specified using additional kargs. Please consult the RaptorXML CLI documentation http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_xbrl_valinlinexbrl.htm 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.InlineXBRLDocumentSet.transform_xml_from_url(type cls, url, *, catalog=None, **kargs)

Transforms the InlineXBRL document set from the given url or urls according to the InlineXBRL 1.0 or 1.1 specification and returns a dictionary of xml.Instance target documents. Optional user XML catalogs can be specified with the catalog argument. Other validation options can be specified using additional kargs. Please consult the RaptorXML CLI documentation http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_xbrl_valinlinexbrl.htm 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.InlineXBRLDocumentSet.validate_buffer(type cls, buf, *, DTS dts=None, catalog=None, taxonomy_package=None, utr=None, **kargs)

Validates the InlineXBRL document set from the given buffer or buffers according to the InlineXBRL 1.0 or 1.1 specification and returns xml.ErrorLog object with the results. By default the transformed XBRL target instance is also validated according to the XBRL 2.1, Dimensions 1.0, Formula 1.0 and Table Linkbase 1.0 specifications. To validate the instance against a specific DTS, supply an xbrl.taxonomy.DTS object using the dts parameters. Optional user XML catalogs can be specified with the catalog argument. Optional taxonomy packages can be specified with the taxonomy_package argument. Optional Units Registry can be specified with the utr argument. Other validation options can be specified using additional kargs. Please consult the RaptorXML CLI documentation http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_xbrl_valinlinexbrl.htm 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.InlineXBRLDocumentSet.validate_element(type cls, elem, *, DTS dts=None, catalog=None, taxonomy_package=None, utr=None, **kargs)

Validates the InlineXBRL document set from the given XML element or elements according to the InlineXBRL 1.0 or 1.1 specification and returns xml.ErrorLog object with the results. By default the transformed XBRL target instance is also validated according to the XBRL 2.1, Dimensions 1.0, Formula 1.0 and Table Linkbase 1.0 specifications. To validate the instance against a specific DTS, supply an xbrl.taxonomy.DTS object using the dts parameters. Optional user XML catalogs can be specified with the catalog argument. Optional taxonomy packages can be specified with the taxonomy_package argument. Optional Units Registry can be specified with the utr argument. Other validation options can be specified using additional kargs. Please consult the RaptorXML CLI documentation http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_xbrl_valinlinexbrl.htm 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.InlineXBRLDocumentSet.validate_url(type cls, url, *, DTS dts=None, catalog=None, taxonomy_package=None, utr=None, **kargs)

Validates the InlineXBRL document set from the given url or urls according to the InlineXBRL 1.0 or 1.1 specification and returns xml.ErrorLog object with the results. By default the transformed XBRL target instance is also validated according to the XBRL 2.1, Dimensions 1.0, Formula 1.0 and Table Linkbase 1.0 specifications. To validate the instance against a specific DTS, supply an xbrl.taxonomy.DTS object using the dts parameters. Optional user XML catalogs can be specified with the catalog argument. Optional taxonomy packages can be specified with the taxonomy_package argument. Optional Units Registry can be specified with the utr argument. Other validation options can be specified using additional kargs. Please consult the RaptorXML CLI documentation http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_xbrl_valinlinexbrl.htm for a list of available options. Any errors and warnings reported during the validation can be accessed through the returned xml.ErrorLog object.

Special methods

__eq__, __ge__, __gt__, __le__, __lt__, __ne__