xbrl.formula.Assertion

An xbrl.formula.Assertion class represents an <validation:assertion> resource in the formula linkbase.

class xbrl.formula.Assertion

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

Attributes

xbrl.formula.Assertion.satisfied_message_relationships

Returns an iterator of xbrl.formula.AssertionSatisfiedMessageRelationship objects which represent the assertion-satisfied-message relationships from this <validation:assertion> resource.

xbrl.formula.Assertion.unsatisfied_message_relationships

Returns an iterator of xbrl.formula.AssertionUnsatisfiedMessageRelationship objects which represent the assertion-unsatisfied-message relationships from this <validation:assertion> resource.

xbrl.formula.Assertion.unsatisfied_severity

Returns either the associated or default severity level as an xbrl.formula.SeverityLevel enumeration.

xbrl.formula.Assertion.unsatisfied_severity_relationships

Returns an iterator of xbrl.formula.AssertionUnsatisfiedSeverityRelationship objects which represent the assertion-unsatisfied-severity relationships from this <validation:assertion> resource.

Methods

xbrl.formula.Assertion.evaluate(Instance instance, **kargs)

Processes this assertion 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__