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.

Methods

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.

Special methods

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