Base classes for matcher and library
This commit is contained in:
Ruud
@@ -0,0 +1,284 @@
|
||||
# Copyright 2013 Dean Gardiner <gardiner91@gmail.com>
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
# You may obtain a copy of the License at
|
||||
#
|
||||
# http://www.apache.org/licenses/LICENSE-2.0
|
||||
#
|
||||
# Unless required by applicable law or agreed to in writing, software
|
||||
# distributed under the License is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
# See the License for the specific language governing permissions and
|
||||
# limitations under the License.
|
||||
|
||||
|
||||
from logr import Logr
|
||||
from caper import CaperClosure, CaperFragment
|
||||
from caper.helpers import clean_dict
|
||||
from caper.result import CaperFragmentNode, CaperClosureNode
|
||||
from caper.step import CaptureStep
|
||||
from caper.constraint import CaptureConstraint
|
||||
|
||||
|
||||
class CaptureGroup(object):
|
||||
def __init__(self, parser, result):
|
||||
"""Capture group object
|
||||
|
||||
:type parser: caper.parsers.base.Parser
|
||||
:type result: caper.result.CaperResult
|
||||
"""
|
||||
|
||||
self.parser = parser
|
||||
self.result = result
|
||||
|
||||
#: @type: list of CaptureStep
|
||||
self.steps = []
|
||||
|
||||
#: type: str
|
||||
self.step_source = None
|
||||
|
||||
#: @type: list of CaptureConstraint
|
||||
self.pre_constraints = []
|
||||
|
||||
#: :type: list of CaptureConstraint
|
||||
self.post_constraints = []
|
||||
|
||||
def capture_fragment(self, tag, regex=None, func=None, single=True, **kwargs):
|
||||
Logr.debug('capture_fragment("%s", "%s", %s, %s)', tag, regex, func, single)
|
||||
|
||||
if self.step_source != 'fragment':
|
||||
if self.step_source is None:
|
||||
self.step_source = 'fragment'
|
||||
else:
|
||||
raise ValueError("Unable to mix fragment and closure capturing in a group")
|
||||
|
||||
self.steps.append(CaptureStep(
|
||||
self, tag,
|
||||
'fragment',
|
||||
regex=regex,
|
||||
func=func,
|
||||
single=single,
|
||||
**kwargs
|
||||
))
|
||||
|
||||
return self
|
||||
|
||||
def capture_closure(self, tag, regex=None, func=None, single=True, **kwargs):
|
||||
Logr.debug('capture_closure("%s", "%s", %s, %s)', tag, regex, func, single)
|
||||
|
||||
if self.step_source != 'closure':
|
||||
if self.step_source is None:
|
||||
self.step_source = 'closure'
|
||||
else:
|
||||
raise ValueError("Unable to mix fragment and closure capturing in a group")
|
||||
|
||||
self.steps.append(CaptureStep(
|
||||
self, tag,
|
||||
'closure',
|
||||
regex=regex,
|
||||
func=func,
|
||||
single=single,
|
||||
**kwargs
|
||||
))
|
||||
|
||||
return self
|
||||
|
||||
def until_closure(self, **kwargs):
|
||||
self.pre_constraints.append(CaptureConstraint(self, 'match', target='closure', **kwargs))
|
||||
|
||||
return self
|
||||
|
||||
def until_fragment(self, **kwargs):
|
||||
self.pre_constraints.append(CaptureConstraint(self, 'match', target='fragment', **kwargs))
|
||||
|
||||
return self
|
||||
|
||||
def until_result(self, **kwargs):
|
||||
self.pre_constraints.append(CaptureConstraint(self, 'result', **kwargs))
|
||||
|
||||
return self
|
||||
|
||||
def until_failure(self, **kwargs):
|
||||
self.post_constraints.append(CaptureConstraint(self, 'failure', **kwargs))
|
||||
|
||||
return self
|
||||
|
||||
def until_success(self, **kwargs):
|
||||
self.post_constraints.append(CaptureConstraint(self, 'success', **kwargs))
|
||||
|
||||
return self
|
||||
|
||||
def parse_subject(self, parent_head, subject):
|
||||
Logr.debug("parse_subject (%s) subject: %s", self.step_source, repr(subject))
|
||||
|
||||
if type(subject) is CaperClosure:
|
||||
return self.parse_closure(parent_head, subject)
|
||||
|
||||
if type(subject) is CaperFragment:
|
||||
return self.parse_fragment(parent_head, subject)
|
||||
|
||||
raise ValueError('Unknown subject (%s)', subject)
|
||||
|
||||
def parse_fragment(self, parent_head, subject):
|
||||
parent_node = parent_head[0] if type(parent_head) is list else parent_head
|
||||
|
||||
nodes, match = self.match(parent_head, parent_node, subject)
|
||||
|
||||
# Capturing broke on constraint, return now
|
||||
if not match:
|
||||
return nodes
|
||||
|
||||
Logr.debug('created fragment node with subject.value: "%s"' % subject.value)
|
||||
|
||||
result = [CaperFragmentNode(
|
||||
parent_node.closure,
|
||||
subject.take_right(match.num_fragments),
|
||||
parent_head,
|
||||
match
|
||||
)]
|
||||
|
||||
# Branch if the match was indefinite (weight below 1.0)
|
||||
if match.result and match.weight < 1.0:
|
||||
if match.num_fragments == 1:
|
||||
result.append(CaperFragmentNode(parent_node.closure, [subject], parent_head))
|
||||
else:
|
||||
nodes.append(CaperFragmentNode(parent_node.closure, [subject], parent_head))
|
||||
|
||||
nodes.append(result[0] if len(result) == 1 else result)
|
||||
|
||||
return nodes
|
||||
|
||||
def parse_closure(self, parent_head, subject):
|
||||
parent_node = parent_head[0] if type(parent_head) is list else parent_head
|
||||
|
||||
nodes, match = self.match(parent_head, parent_node, subject)
|
||||
|
||||
# Capturing broke on constraint, return now
|
||||
if not match:
|
||||
return nodes
|
||||
|
||||
Logr.debug('created closure node with subject.value: "%s"' % subject.value)
|
||||
|
||||
result = [CaperClosureNode(
|
||||
subject,
|
||||
parent_head,
|
||||
match
|
||||
)]
|
||||
|
||||
# Branch if the match was indefinite (weight below 1.0)
|
||||
if match.result and match.weight < 1.0:
|
||||
if match.num_fragments == 1:
|
||||
result.append(CaperClosureNode(subject, parent_head))
|
||||
else:
|
||||
nodes.append(CaperClosureNode(subject, parent_head))
|
||||
|
||||
nodes.append(result[0] if len(result) == 1 else result)
|
||||
|
||||
return nodes
|
||||
|
||||
def match(self, parent_head, parent_node, subject):
|
||||
nodes = []
|
||||
|
||||
# Check pre constaints
|
||||
broke, definite = self.check_constraints(self.pre_constraints, parent_head, subject)
|
||||
|
||||
if broke:
|
||||
nodes.append(parent_head)
|
||||
|
||||
if definite:
|
||||
return nodes, None
|
||||
|
||||
# Try match subject against the steps available
|
||||
match = None
|
||||
|
||||
for step in self.steps:
|
||||
if step.source == 'closure' and type(subject) is not CaperClosure:
|
||||
pass
|
||||
elif step.source == 'fragment' and type(subject) is CaperClosure:
|
||||
Logr.debug('Closure encountered on fragment step, jumping into fragments')
|
||||
return [CaperClosureNode(subject, parent_head, None)], None
|
||||
|
||||
match = step.execute(subject)
|
||||
|
||||
if match.success:
|
||||
if type(match.result) is dict:
|
||||
match.result = clean_dict(match.result)
|
||||
|
||||
Logr.debug('Found match with weight %s, match: %s, num_fragments: %s' % (
|
||||
match.weight, match.result, match.num_fragments
|
||||
))
|
||||
|
||||
step.matched = True
|
||||
|
||||
break
|
||||
|
||||
if all([step.single and step.matched for step in self.steps]):
|
||||
Logr.debug('All steps completed, group finished')
|
||||
parent_node.finished_groups.append(self)
|
||||
return nodes, match
|
||||
|
||||
# Check post constraints
|
||||
broke, definite = self.check_constraints(self.post_constraints, parent_head, subject, match=match)
|
||||
if broke:
|
||||
return nodes, None
|
||||
|
||||
return nodes, match
|
||||
|
||||
def check_constraints(self, constraints, parent_head, subject, **kwargs):
|
||||
parent_node = parent_head[0] if type(parent_head) is list else parent_head
|
||||
|
||||
# Check constraints
|
||||
for constraint in [c for c in constraints if c.target == subject.__key__ or not c.target]:
|
||||
Logr.debug("Testing constraint %s against subject %s", repr(constraint), repr(subject))
|
||||
|
||||
weight, success = constraint.execute(parent_node, subject, **kwargs)
|
||||
|
||||
if success:
|
||||
Logr.debug('capturing broke on "%s" at %s', subject.value, constraint)
|
||||
parent_node.finished_groups.append(self)
|
||||
|
||||
return True, weight == 1.0
|
||||
|
||||
return False, None
|
||||
|
||||
def execute(self):
|
||||
heads_finished = None
|
||||
|
||||
while heads_finished is None or not (len(heads_finished) == len(self.result.heads) and all(heads_finished)):
|
||||
heads_finished = []
|
||||
|
||||
heads = self.result.heads
|
||||
self.result.heads = []
|
||||
|
||||
for head in heads:
|
||||
node = head[0] if type(head) is list else head
|
||||
|
||||
if self in node.finished_groups:
|
||||
Logr.debug("head finished for group")
|
||||
self.result.heads.append(head)
|
||||
heads_finished.append(True)
|
||||
continue
|
||||
|
||||
Logr.debug('')
|
||||
|
||||
Logr.debug(node)
|
||||
|
||||
next_subject = node.next()
|
||||
|
||||
Logr.debug('----------[%s] (%s)----------' % (next_subject, repr(next_subject.value) if next_subject else None))
|
||||
|
||||
if next_subject:
|
||||
for node_result in self.parse_subject(head, next_subject):
|
||||
self.result.heads.append(node_result)
|
||||
|
||||
Logr.debug('Heads: %s', self.result.heads)
|
||||
|
||||
heads_finished.append(self in node.finished_groups or next_subject is None)
|
||||
|
||||
if len(self.result.heads) == 0:
|
||||
self.result.heads = heads
|
||||
|
||||
Logr.debug("heads_finished: %s, self.result.heads: %s", heads_finished, self.result.heads)
|
||||
|
||||
Logr.debug("group finished")
|
||||
Reference in New Issue
Block a user