`xbrl.formula.VariableSetAssertion`¶

An xbrl.formula.VariableSetAssertion class represents a <validation:variableSetAsertion> resource in the formula linkbase.

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

Attributes¶

xbrl.formula.VariableSet.aspect_model: Returns the value of the ‘aspectModel’ attribute as an xbrl.formula.AspectModel enumeration.

xbrl.formula.VariableSet.filter_relationships: Returns an iterator of xbrl.formula.VariableSetFilterRelationship objects which represent the variable-set-filter relationships from this <variable:variableSet> resource.

xbrl.formula.VariableSet.implicit_filtering: Returns the inferred value of the ‘implicitFiltering’ attribute as bool.

xbrl.formula.VariableSet.precondition_relationships: Returns an iterator of xbrl.formula.VariableSetPreconditionRelationship objects which represent the variable-set-precondition relationships from this <variable:variableSet> resource.

xbrl.formula.VariableSetAssertion.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.VariableSetAssertion.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.VariableSetAssertion.unsatisfied_severity¶: Returns either the associated or default severity level as an xbrl.formula.SeverityLevel enumeration.

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

xbrl.formula.VariableSet.variable_set_relationships: Returns an iterator of xbrl.formula.VariableSetRelationship objects which represent the variable-set relationships from this <variable:variableSet> resource.

xbrl.formula.VariableSetAssertion.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.

xbrl.formula.VariableSet.find_variable(qname): [Deprecated: Use resolve_variable() instead!] Returns an xbrl.formula.Parameter or xbrl.formula.Variable object which represents the formula paramter or variable with the given XML qualified name within the scope of this variable set, or None if no parameter or variable was found.

xbrl.formula.VariableSet.referenced_parameters(): Returns an iterator of xbrl.formula.Parameter objects representing the referenced formula parameters by this <variable:variableSet> resource and any other associated resources.

xbrl.formula.VariableSet.resolve_variable(qname): Returns an xbrl.formula.Parameter or xbrl.formula.Variable object which represents the formula paramter or variable with the given XML qualified name within the scope of this variable set, or None if no parameter or variable was found.

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