`xbrl.formula.AssertionSet`¶

An xbrl.formula.AssertionSet class represents an <validation:assertionSet> resource in the formula linkbase.

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

Attributes¶

xbrl.formula.AssertionSet.assertion_set_relationships¶: Returns an iterator of xbrl.formula.AssertionSetRelationship objects which represent the assertion-set relationships from this <validation:assertionSet> resource.

xbrl.taxonomy.Resource.document: Returns an xml.Document object which represents the XBRL taxonomy document which contains this resource.

xbrl.taxonomy.Resource.documentation_label: Returns an xbrl.taxonomy.Label object which represents the standard generic label assigned in the documentation generic linkrole, otherwise None. In case of mulitple labels (e.g. in different languages) only the first label (according to the order attribute on the labelArc) is returned.

xbrl.taxonomy.Resource.effective_role: Returns the value of the ‘xlink:role’ attribute as a string, or the standard role for this resource if the XML element information item doesn’t have an ‘xlink:role’ attribute. If no default standard role has been defined for this resource None is returned.

xbrl.taxonomy.Resource.element: Returns an xml.ElementInformationItem object which represents the XML element information item of the <xl:resource> resource.

xbrl.taxonomy.Resource.extended_link: Returns an xbrl.taxonomy.ExtendedLink object which represents the containin XLink extended link.

xbrl.taxonomy.Resource.id: Returns the value of the ‘id’ attribute as a string, or None if the XML element information item doesn’t have an ‘id’ attribute.

xbrl.taxonomy.Resource.label: Returns an xbrl.taxonomy.Label object which represents the standard generic label assigned in the standard generic linkrole, otherwise None. In case of mulitple labels (e.g. in different languages) only the first label (according to the order attribute on the labelArc) is returned.

xbrl.taxonomy.Resource.qname: Returns an xml.QName object which represents the XML qualified name of the resource element information item.

xbrl.taxonomy.Resource.terse_label: Returns an xbrl.taxonomy.Label object which represents the standard generic label assigned in the terse generic linkrole, otherwise None. In case of mulitple labels (e.g. in different languages) only the first label (according to the order attribute on the labelArc) is returned.

xbrl.taxonomy.Resource.verbose_label: Returns an xbrl.taxonomy.Label object which represents the standard generic label assigned in the verbose generic linkrole, otherwise None. In case of mulitple labels (e.g. in different languages) only the first label (according to the order attribute on the labelArc) is returned.

xbrl.taxonomy.Resource.xlink_label: Returns the value of the ‘xlink:label’ attribute as a string, or None if the XML element information item doesn’t have an ‘xlink:label’ attribute.

xbrl.taxonomy.Resource.xlink_role: Returns the value of the ‘xlink:role’ attribute as a string, or None if the XML element information item doesn’t have an ‘xlink:role’ attribute.

xbrl.taxonomy.Resource.xlink_title: Returns the value of the ‘xlink:title’ attribute as a string, or None if the XML element information item doesn’t have an ‘xlink:title’ attribute.

xbrl.formula.AssertionSet.evaluate(Instance instance, **kargs)¶: Processes all assertions within this assertion set against the given XBRL instance and returns an xbrl.formula.AssertionProcessingResult, xml.ErrorLog tuple. Formula parameters can be set using the ‘formula_parameters’ argument by supplying a dict with the user-supplied parameter values. Use the same JSON format as accepted by the –formula-parameters CLI option. Other assertion processing options can be specified using additional kargs. Please consult the RaptorXML CLI documentation http://manual.altova.com/RaptorXML/raptorxmlxbrlserver/rxcli_xbrl_valxbrl.htm for a list of available options. Any errors and warnings reported during the assertion processing can be accessed through the returned xml.ErrorLog object.

xbrl.taxonomy.Resource.label_relationships(link_role=None): Returns an iterator of xbrl.taxonomy.ElementLabelRelationship objects. If called without any arguments, all element-label <gen:arc> relationships starting from this resource will be returned. Use the link_role argument to constrain the returned relationships.

xbrl.taxonomy.Resource.labels(label_role=None, link_role=None, lang=None): Returns an iterator of xbrl.taxonomy.Label objects. If called without any arguments, all assigned generic labels will be returned. Use label_role, link_role and lang arguments to constrain the returned labels.

xbrl.taxonomy.Resource.reference_relationships(link_role=None): Returns an iterator of xbrl.taxonomy.ElementReferenceRelationship objects. If called without any arguments, all element-reference <gen:arc> relationships starting from this resource will be returned. Use the link_role argument to constrain the returned relationships.

xbrl.taxonomy.Resource.references(reference_role=None, link_role=None): Returns an iterator of xbrl.taxonomy.Reference objects. If called without any arguments, all assigned generic references will be returned. Use reference_role and link_role arguments to constrain the returned references.

xbrl.taxonomy.Resource.xpointer(bForceElementScheme=False): Returns an URI with XPointer fragment that points to this XML element as a string. If the XML element information item has an id attribute, a shorthand pointer with the id attribute value will be generated, otherwise the XPointer element scheme will be used. Set force_element_scheme to True to prevent generation of shorthand pointers.

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