`xbrl.taxonomy.LinkbaseDocument`¶

An xbrl.taxonomy.LinkbaseDocument class represents a linkbase document in the DTS.

class xbrl.taxonomy.LinkbaseDocument¶: 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.Instance.create_from_buffer(type cls, buf, *, DTD dtd=None, Schema schema=None, catalog=None, **kargs): Returns a tuple with an xml.Instance and xml.ErrorLog object. Constructs a new xml.Instance object after parsing the XML content in the given buffer. To validate the instance against a specific DTD or XML Schema, supply an xml.dtd.DTD or xsd.Schema object using the dtd or schema parameters. 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_xmlval_xmldtd.htm and http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_xmlval_xmlxsd.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.taxonomy.Instance.create_from_string(type cls, text, Schema schema=None, catalog=None, DTD dtd=None): Returns a tuple with an xml.Instance and xml.ErrorLog object. Constructs a new xml.Instance object after parsing the XML string in text and optionally validating it against the given xsd.Schema. Any errors or warnings reported during the validation are set on the returned xml.ErrorLog object. [DEPRECATED] This method has been deprecated, please use the new xml.Instance.create_from_buffer() class method instead.

classmethod xbrl.taxonomy.Instance.create_from_url(type cls, url, *, DTD dtd=None, Schema schema=None, catalog=None, **kargs): Returns a tuple with an xml.Instance and xml.ErrorLog object. Constructs a new xml.Instance object after parsing the XML content retrieved from the given url. To validate the instance against a specific DTD or XML Schema, supply an xml.dtd.DTD or xsd.Schema object using the dtd or schema parameters. 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_xmlval_xmldtd.htm and http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_xmlval_xmlxsd.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.taxonomy.Instance.is_wellformed_buffer(type cls, buf, *, DTD dtd=None, catalog=None, **kargs): Checks the buffer buf containing a XML document according to the XML 1.0 or XML 1.1 specification for wellformedness and returns an xml.ErrorLog object with the results. 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_wf_xml.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.taxonomy.Instance.is_wellformed_url(type cls, url, *, DTD dtd=None, catalog=None, **kargs): Checks the XML document at the given url according to the XML 1.0 or XML 1.1 specification for wellformedness and returns an xml.ErrorLog object with the results. 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_wf_xml.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.taxonomy.Instance.validate_buffer(type cls, buf, *, DTD dtd=None, Schema schema=None, catalog=None, **kargs): Validates the buffer buf containing a XML document according to either the XML or XML Schema specification and returns an xml.ErrorLog object with the results. To validate the instance against a specific DTD or XML Schema, supply an xml.dtd.DTD or xsd.Schema object using the dtd or schema parameters. 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_xmlval_dtd.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.taxonomy.Instance.validate_url(type cls, url, *, DTD dtd=None, Schema schema=None, catalog=None, **kargs): Validates the XML document at the given url according to either the XML or XML Schema specification and returns an xml.ErrorLog object with the results. To validate the instance against a specific DTD or XML Schema, supply an xml.dtd.DTD or xsd.Schema object using the dtd or schema parameters. 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_xmlval_dtd.htm for a list of available options. Any errors and warnings reported during the validation can be accessed through the returned xml.ErrorLog object.

xbrl.taxonomy.LinkbaseDocument.linkbase¶: Returns an xbrl.taxonomy.Linkbase object which represent the <link:linkbase> root element of this document.

xbrl.taxonomy.LinkbaseDocument.schema¶: Returns an xsd.Schema object which represent the schema against which the document was validated.

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