xbrl.taxonomy.TaxonomyPackage
¶
An xbrl.taxonomy.TaxonomyPackage
object represents an XBRL taxonomy package.
-
class
xbrl.taxonomy.
TaxonomyPackage
¶ Proper instances of this class will be created within RaptorXML only, instantiation from script code will throw a
NotImplementedError
exception.
Class methods¶
-
classmethod
xbrl.taxonomy.TaxonomyPackage.
create_from_buffer
(type cls, buf, **kargs)¶ Returns a tuple with an
xbrl.taxonomy.TaxonomyPackage
andxml.ErrorLog
object. Constructs a newxbrl.taxonomy.TaxonomyPackage
object after processing the content in the given buffer. Other validation options can be specified using additional kargs. Please consult the RaptorXML CLI documentation http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_xbrl_valtaxonomypkg.htm for a list of available options. Any errors and warnings reported during the validation can be accessed through the returnedxml.ErrorLog
object.
-
classmethod
xbrl.taxonomy.TaxonomyPackage.
create_from_url
(type cls, url, **kargs)¶ Returns a tuple with an
xbrl.taxonomy.TaxonomyPackage
andxml.ErrorLog
object. Constructs a newxbrl.taxonomy.TaxonomyPackage
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_valtaxonomypkg.htm for a list of available options. Any errors and warnings reported during the validation can be accessed through the returnedxml.ErrorLog
object.
-
classmethod
xbrl.taxonomy.TaxonomyPackage.
validate_buffer
(type cls, buf, **kargs)¶ Validates the XBRL taxonomy package from the given buffer buf according to the Taxonomy 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_valtaxonomypkg.htm for a list of available options. Any errors and warnings reported during the validation can be accessed through the returnedxml.ErrorLog
object.
-
classmethod
xbrl.taxonomy.TaxonomyPackage.
validate_url
(type cls, url, **kargs)¶ Validates the XBRL taxonomy package at the given url according to the Taxonomy 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_valtaxonomypkg.htm for a list of available options. Any errors and warnings reported during the validation can be accessed through the returnedxml.ErrorLog
object.
Attributes¶
-
xbrl.taxonomy.TaxonomyPackage.
catalog
¶ Returns an
xml.Catalog
object which represents the OASIS XML Catalog contained within the XBRL taxonomy package.
-
xbrl.taxonomy.TaxonomyPackage.
inline_xbrl_report_urls
¶ Returns a list of document set URLs to inline XBRL reports contained within this XBRL taxonomy package. See http://www.xbrl.org/WGN/report-packages/WGN-2018-08-14/report-packages-WGN-2018-08-14.html for more details.
-
xbrl.taxonomy.TaxonomyPackage.
meta_data
¶ Returns an xbrl.TaxonomyPackageMetaData object which represents the XBRL taxonomy metadata information in taxonomyPackage.xml.
-
xbrl.taxonomy.TaxonomyPackage.
uri
¶ Returns the URI used to open the XBRL taxonomy package.
-
xbrl.taxonomy.TaxonomyPackage.
xbrl_report_urls
¶ Returns a list of URLs to XBRL reports contained within this XBRL taxonomy package. See http://www.xbrl.org/WGN/report-packages/WGN-2018-08-14/report-packages-WGN-2018-08-14.html for more details.
Special methods¶
__bool__, __eq__, __ge__, __gt__, __le__, __lt__, __ne__