Class Rule

Create a rule

Parameters:

• pattern (unicode) - valid regexp pattern that trigger the rule
• msgpart (string) - part of the message to be matched by pattern
• hint (unicode) - hint given to user when rule match
• valid (list of unicode key=value) - list of cases that should make or not make rule matching
• casesens (bool) - whether regex matching will be case-sensitive
• ident (unicode or None) - rule identifier
• disabled (bool) - whether rule is disabled
• manual (bool) - whether rule is manually applied
• environ (string or None) - environment in which the rule applies
• mfilter ((msg, cat, envs) -> <anything>) - filter to apply to message before checking
• rfilter ((string) -> string) - filter to apply to rule strings (e.g. on regex patterns)
• trigger ((msg, cat, envs) -> highlight) - function to act as trigger instead of pattern applied to msgpart

Overrides: object.__init__

Compile pattern

Parameters:

• pattern - pattern as an unicode string

Use trigger function instead of pattern.

Parameters:

• trigger ((msg, cat, envs) -> {highlight<msgreport.report_msg_content>}) - function to act as trigger

Parse valid key=value arguments of valid list

Parameters:

• valid - valid line as an unicode string

Apply rule to the message.

If the rule matches, highlight specification of offending spans is returned (see report_msg_content); otherwise an empty list.

Rule will normally apply its own filters to the message before matching (on a local copy, the original message will not be affected). If the message is already appropriately filtered, this self-filtering can be prevented by setting nofilter to {True}.

Parameters:

• msg (instance of Message_base) - message to which the texts belong
• cat (Catalog) - catalog to which the message belongs
• envs (set) - environments in which the rule is applied
• nofilter (bool) - avoid filtering the message if True

Returns:

highlight specification (may be empty list)