`beta.xbrl.xule`¶

The beta.xbrl.xule module provides an API for the XULE language. The API allows rules written in XULE to parsed and executed.

Classes¶

beta.xbrl.xule.compile(ruleset, *, catalog=None, **kargs)¶: Returns a beta.xbrl.xule.RuleSet object that represents the compiled rule set in the given XULE source code. Argument ruleset can be either a XULE source string or buffer. A beta.xbrl.xule.:obj:`ParseError` exception is raised if a syntax error is encountered during parsing.

beta.xbrl.xule.execute(ruleset, *, Instance instance=None, Session session=None, catalog=None, rules_to_process=None, stack_size=None, use_namespaces_from_instance=None, **kargs)¶: Executes the given XULE source code and returns a list of beta.xbrl.xule.Result objects that represent the assertion and output rule results. Argument ruleset can be either a XULE source string or buffer or beta.xbrl.RuleSet and beta.xbrl.RuleSetMap objects. The default XULE session is used if no session is explicitly specified. Raises a beta.xbrl.xule.:obj:`ParseError` or beta.xbrl.xule.:obj:`RuntimeError` exception when an error is encountered during compilation or execution.

beta.xbrl.xule.execute_expression(expr, *, Instance instance=None, Session session=None, catalog=None, stack_size=None, use_namespaces_from_instance=True, **kargs)¶: Executes a simple XULE expression and returns a list of beta.xbrl.xule.Result objects that represent the assertion and output rule results. The default XULE session is used if no session is explicitly specified. Raises a beta.xbrl.xule.:obj:`ParseError` or beta.xbrl.xule.:obj:`RuntimeError` exception when an error is encountered during compilation or execution.