Module gatenlp.pam.pampac.rule
Module for the Pampac rule classe.
Expand source code
"""
Module for the Pampac rule classe.
"""
from gatenlp.pam.pampac.pampac_parsers import PampacParser
from gatenlp.pam.pampac.actions import Actions
class Rule(PampacParser):
"""
A matching rule: this defines the parser and some action (a function) to carry out if the rule matches
as it is tried as one of many rules with a Pampac instance. Depending on select setting for pampac
the action only fires under certain circumstances (e.g. the rule is the first that matches at a location).
Rule is thus different from pattern.call() or Call(pattern, func) as these always call the function if
there is a successful match.
"""
def __init__(self, parser, *actions, priority=0):
"""
Create a Rule.
Args:
parser: the parser to match for the rule
action: the action to perform, or a function to call. The action callable is passed the success object
and the kwargs context and location
priority: the priority of the rule
"""
self.parser = parser
self.action = Actions(*actions)
self.priority = priority
def set_priority(self, val):
"""
Different way of setting the priority.
"""
self.priority = val
return self
def parse(self, location, context):
"""
Return the parse result. This does NOT automatically invoke the action if the parse result is a success.
The invoking Pampac instance decides, based on its setting, for which matching rules the action is
actually carried out.
Returns:
Success or failure of the parser
"""
ret = self.parser.parse(location, context)
# print(f"DEBUG: rule returning {ret}")
return ret
def add_action(self, action, tofront=False):
"""
Add an action to the actions defined for this rule.
Args:
action: the action to add
tofront: if True, add to the front instead of the end of the list
"""
self.action.add(action, tofront=tofront)Classes
class Rule (parser, *actions, priority=0)-
A matching rule: this defines the parser and some action (a function) to carry out if the rule matches as it is tried as one of many rules with a Pampac instance. Depending on select setting for pampac the action only fires under certain circumstances (e.g. the rule is the first that matches at a location). Rule is thus different from pattern.call() or Call(pattern, func) as these always call the function if there is a successful match.
Create a Rule.
Args
parser- the parser to match for the rule
action- the action to perform, or a function to call. The action callable is passed the success object and the kwargs context and location
priority- the priority of the rule
Expand source code
class Rule(PampacParser): """ A matching rule: this defines the parser and some action (a function) to carry out if the rule matches as it is tried as one of many rules with a Pampac instance. Depending on select setting for pampac the action only fires under certain circumstances (e.g. the rule is the first that matches at a location). Rule is thus different from pattern.call() or Call(pattern, func) as these always call the function if there is a successful match. """ def __init__(self, parser, *actions, priority=0): """ Create a Rule. Args: parser: the parser to match for the rule action: the action to perform, or a function to call. The action callable is passed the success object and the kwargs context and location priority: the priority of the rule """ self.parser = parser self.action = Actions(*actions) self.priority = priority def set_priority(self, val): """ Different way of setting the priority. """ self.priority = val return self def parse(self, location, context): """ Return the parse result. This does NOT automatically invoke the action if the parse result is a success. The invoking Pampac instance decides, based on its setting, for which matching rules the action is actually carried out. Returns: Success or failure of the parser """ ret = self.parser.parse(location, context) # print(f"DEBUG: rule returning {ret}") return ret def add_action(self, action, tofront=False): """ Add an action to the actions defined for this rule. Args: action: the action to add tofront: if True, add to the front instead of the end of the list """ self.action.add(action, tofront=tofront)Ancestors
- PampacParser
- abc.ABC
Methods
def add_action(self, action, tofront=False)-
Add an action to the actions defined for this rule.
Args
action- the action to add
tofront- if True, add to the front instead of the end of the list
Expand source code
def add_action(self, action, tofront=False): """ Add an action to the actions defined for this rule. Args: action: the action to add tofront: if True, add to the front instead of the end of the list """ self.action.add(action, tofront=tofront) def parse(self, location, context)-
Return the parse result. This does NOT automatically invoke the action if the parse result is a success. The invoking Pampac instance decides, based on its setting, for which matching rules the action is actually carried out.
Returns
Success or failure of the parser
Expand source code
def parse(self, location, context): """ Return the parse result. This does NOT automatically invoke the action if the parse result is a success. The invoking Pampac instance decides, based on its setting, for which matching rules the action is actually carried out. Returns: Success or failure of the parser """ ret = self.parser.parse(location, context) # print(f"DEBUG: rule returning {ret}") return ret def set_priority(self, val)-
Different way of setting the priority.
Expand source code
def set_priority(self, val): """ Different way of setting the priority. """ self.priority = val return self
Inherited members