Module gatenlp.pam.pampac.getters

Module for PAMPAC getter helper classes

Expand source code 
"""
Module for PAMPAC getter helper classes
"""

from gatenlp.pam.pampac.actions import Getter, _get_span, _get_match


class GetAnn(Getter):
    """
    Helper to access an annoation from a match with the given name.
    """

    def __init__(self, name, resultidx=0, matchidx=0, silent_fail=False):
        """
        Create a GetAnn helper.

        Args:
            name: the name of the match to use.
            resultidx:  the index of the result to use if there is more than one.
            matchidx:  the index of the match info element with the given name to use if there is more than one
            silent_fail: if True, do not raise an exception if the annotation cannot be found, instead return
                None.
        """
        self.name = name
        self.resultidx = resultidx
        self.matchidx = matchidx
        self.silent_fail = silent_fail

    def __call__(self, succ, context=None, location=None):
        match = _get_match(
            succ, self.name, self.resultidx, self.matchidx, self.silent_fail
        )
        ann = match.get("ann")
        if ann is None:
            if not self.silent_fail:
                raise Exception(
                    f"No annotation found for name {self.name}, {self.resultidx}, {self.matchidx}"
                )
        return ann


class GetFeatures(Getter):
    """
    Helper to access the features of an annotation in a match with the given name.
    """

    def __init__(self, name, resultidx=0, matchidx=0, silent_fail=False):
        """
        Create a GetFeatures helper.

        Args:
            name: the name of the match to use.
            resultidx: the index of the result to use if there is more than one.
            matchidx:  the index of the match info element with the given name to use if there is more than one
            silent_fail: if True, do not raise an exception if the annotation cannot be found, instead return
                None
        """
        self.name = name
        self.resultidx = resultidx
        self.matchidx = matchidx
        self.silent_fail = silent_fail

    def __call__(self, succ, context=None, location=None):
        match = _get_match(
            succ, self.name, self.resultidx, self.matchidx, self.silent_fail
        )
        ann = match.get("ann")
        if ann is None:
            if not self.silent_fail:
                raise Exception(
                    f"No annotation found for name {self.name}, {self.resultidx}, {self.matchidx}"
                )
        return ann.features


class GetType(Getter):
    """
    Helper to access the type of an annotation in a match with the given name.
    """

    def __init__(self, name, resultidx=0, matchidx=0, silent_fail=False):
        """
        Create a GetType helper.

        Args:
            name: the name of the match to use.
            resultidx: the index of the result to use if there is more than one.
            matchidx:  the index of the match info element with the given name to use if there is more than one
            silent_fail: if True, do not raise an exception if the annotation cannot be found, instead return
                None
        """
        self.name = name
        self.resultidx = resultidx
        self.matchidx = matchidx
        self.silent_fail = silent_fail

    def __call__(self, succ, context=None, location=None):
        match = _get_match(
            succ, self.name, self.resultidx, self.matchidx, self.silent_fail
        )
        ann = match.get("ann")
        if ann is None:
            if not self.silent_fail:
                raise Exception(
                    f"No annotation found for name {self.name}, {self.resultidx}, {self.matchidx}"
                )
        return ann.type


class GetStart(Getter):
    """
    Helper to access the start offset of the annotation in a match with the given name.
    """

    def __init__(self, name, resultidx=0, matchidx=0, silent_fail=False):
        """
        Create a GetStart helper.

        Args:
            name: the name of the match to use.
            resultidx: the index of the result to use if there is more than one.
            matchidx:  the index of the match info element with the given name to use if there is more than one
            silent_fail: if True, do not raise an exception if the annotation cannot be found, instead return
                None
        """
        self.name = name
        self.resultidx = resultidx
        self.matchidx = matchidx
        self.silent_fail = silent_fail

    def __call__(self, succ, context=None, location=None):
        match = _get_match(
            succ, self.name, self.resultidx, self.matchidx, self.silent_fail
        )
        span = match["span"]
        return span.start


class GetEnd(Getter):
    """
    Helper to access the end offset of the annotation in a match with the given name.
    """

    def __init__(self, name, resultidx=0, matchidx=0, silent_fail=False):
        """
        Create a GetEnd helper.

        Args:
            name: the name of the match to use.
            resultidx: the index of the result to use if there is more than one.
            matchidx:  the index of the match info element with the given name to use if there is more than one
            silent_fail: if True, do not raise an exception if the annotation cannot be found, instead return
                None
        """
        self.name = name
        self.resultidx = resultidx
        self.matchidx = matchidx
        self.silent_fail = silent_fail

    def __call__(self, succ, context=None, location=None):
        return _get_match(
            succ, self.name, self.resultidx, self.matchidx, self.silent_fail
        )["span"].end


class GetFeature(Getter):
    """
    Helper to access the features of the annotation in a match with the given name.
    """

    def __init__(self, name, featurename, resultidx=0, matchidx=0, silent_fail=False):
        """
        Create a GetFeatures helper.

        Args:
            name: the name of the match to use.
            resultidx: the index of the result to use if there is more than one.
            matchidx:  the index of the match info element with the given name to use if there is more than one
            silent_fail: if True, do not raise an exception if the annotation cannot be found, instead return
                None
        """
        self.name = name
        self.resultidx = resultidx
        self.matchidx = matchidx
        self.silent_fail = silent_fail
        self.featurename = featurename

    def __call__(self, succ, context=None, location=None):
        match = _get_match(
            succ, self.name, self.resultidx, self.matchidx, self.silent_fail
        )
        ann = match.get("ann")
        if ann is None:
            if not self.silent_fail:
                raise Exception(
                    f"No annotation found for name {self.name}, {self.resultidx}, {self.matchidx}"
                )
        return ann.features.get(self.featurename)


class GetText(Getter):
    """
    Helper to access text, either covered document text of the annotation or matched text.
    """

    def __init__(self, name=None, resultidx=0, matchidx=0, silent_fail=False):
        """
        Create a GetText helper. This first gets the span that matches the name, resultidx and matchidx
        parameters and then provides the text of the document for that span.

        Args:
            name: the name of the match to use, if None, use the span of the whole match.
            resultidx: the index of the result to use if there is more than one.
            matchidx:  the index of the match info element with the given name to use if there is more than one
            silent_fail: if True, do not raise an exception if the annotation cannot be found, instead return
                None
        """
        self.name = name
        self.resultidx = resultidx
        self.matchidx = matchidx
        self.silent_fail = silent_fail

    def __call__(self, succ, context=None, location=None):
        if self.name is None:
            span = _get_span(succ, self.name, self.resultidx, self.matchidx, self.silent_fail)
        else:
            match = _get_match(
                succ, self.name, self.resultidx, self.matchidx, self.silent_fail
            )
            span = match.get("span")
        if span:
            return context.doc[span]
        else:
            if self.silent_fail:
                return None
            else:
                raise Exception("Could not find a span for match info")


class GetRegexGroup(Getter):
    """
    Helper to access the given regular expression matching group in a match with the given name.
    """

    def __init__(self, name, group=0, resultidx=0, matchidx=0, silent_fail=False):
        """
        Create a GetText helper.

        Args:
            name: the name of the match to use.
            resultidx: the index of the result to use if there is more than one.
            matchidx:  the index of the match info element with the given name to use if there is more than one
            silent_fail: if True, do not raise an exception if the annotation cannot be found, instead return
                None
        """
        self.name = name
        self.resultidx = resultidx
        self.matchidx = matchidx
        self.group = group
        self.silent_fail = silent_fail

    def __call__(self, succ, context=None, location=None):
        match = _get_match(
            succ, self.name, self.resultidx, self.matchidx, self.silent_fail
        )
        groups = match.get("groups")
        if groups:
            return groups[self.group]
        else:
            if self.silent_fail:
                return None
            else:
                raise Exception("Could not find regexp groups for match info")

Classes

class GetAnn (name, resultidx=0, matchidx=0, silent_fail=False)

Helper to access an annoation from a match with the given name.

Create a GetAnn helper.

Args

name
the name of the match to use.
resultidx
the index of the result to use if there is more than one.
matchidx
the index of the match info element with the given name to use if there is more than one
silent_fail
if True, do not raise an exception if the annotation cannot be found, instead return None.
Expand source code 
class GetAnn(Getter):
    """
    Helper to access an annoation from a match with the given name.
    """

    def __init__(self, name, resultidx=0, matchidx=0, silent_fail=False):
        """
        Create a GetAnn helper.

        Args:
            name: the name of the match to use.
            resultidx:  the index of the result to use if there is more than one.
            matchidx:  the index of the match info element with the given name to use if there is more than one
            silent_fail: if True, do not raise an exception if the annotation cannot be found, instead return
                None.
        """
        self.name = name
        self.resultidx = resultidx
        self.matchidx = matchidx
        self.silent_fail = silent_fail

    def __call__(self, succ, context=None, location=None):
        match = _get_match(
            succ, self.name, self.resultidx, self.matchidx, self.silent_fail
        )
        ann = match.get("ann")
        if ann is None:
            if not self.silent_fail:
                raise Exception(
                    f"No annotation found for name {self.name}, {self.resultidx}, {self.matchidx}"
                )
        return ann

Ancestors

class GetEnd (name, resultidx=0, matchidx=0, silent_fail=False)

Helper to access the end offset of the annotation in a match with the given name.

Create a GetEnd helper.

Args

name
the name of the match to use.
resultidx
the index of the result to use if there is more than one.
matchidx
the index of the match info element with the given name to use if there is more than one
silent_fail
if True, do not raise an exception if the annotation cannot be found, instead return None
Expand source code 
class GetEnd(Getter):
    """
    Helper to access the end offset of the annotation in a match with the given name.
    """

    def __init__(self, name, resultidx=0, matchidx=0, silent_fail=False):
        """
        Create a GetEnd helper.

        Args:
            name: the name of the match to use.
            resultidx: the index of the result to use if there is more than one.
            matchidx:  the index of the match info element with the given name to use if there is more than one
            silent_fail: if True, do not raise an exception if the annotation cannot be found, instead return
                None
        """
        self.name = name
        self.resultidx = resultidx
        self.matchidx = matchidx
        self.silent_fail = silent_fail

    def __call__(self, succ, context=None, location=None):
        return _get_match(
            succ, self.name, self.resultidx, self.matchidx, self.silent_fail
        )["span"].end

Ancestors

class GetFeature (name, featurename, resultidx=0, matchidx=0, silent_fail=False)

Helper to access the features of the annotation in a match with the given name.

Create a GetFeatures helper.

Args

name
the name of the match to use.
resultidx
the index of the result to use if there is more than one.
matchidx
the index of the match info element with the given name to use if there is more than one
silent_fail
if True, do not raise an exception if the annotation cannot be found, instead return None
Expand source code 
class GetFeature(Getter):
    """
    Helper to access the features of the annotation in a match with the given name.
    """

    def __init__(self, name, featurename, resultidx=0, matchidx=0, silent_fail=False):
        """
        Create a GetFeatures helper.

        Args:
            name: the name of the match to use.
            resultidx: the index of the result to use if there is more than one.
            matchidx:  the index of the match info element with the given name to use if there is more than one
            silent_fail: if True, do not raise an exception if the annotation cannot be found, instead return
                None
        """
        self.name = name
        self.resultidx = resultidx
        self.matchidx = matchidx
        self.silent_fail = silent_fail
        self.featurename = featurename

    def __call__(self, succ, context=None, location=None):
        match = _get_match(
            succ, self.name, self.resultidx, self.matchidx, self.silent_fail
        )
        ann = match.get("ann")
        if ann is None:
            if not self.silent_fail:
                raise Exception(
                    f"No annotation found for name {self.name}, {self.resultidx}, {self.matchidx}"
                )
        return ann.features.get(self.featurename)

Ancestors

class GetFeatures (name, resultidx=0, matchidx=0, silent_fail=False)

Helper to access the features of an annotation in a match with the given name.

Create a GetFeatures helper.

Args

name
the name of the match to use.
resultidx
the index of the result to use if there is more than one.
matchidx
the index of the match info element with the given name to use if there is more than one
silent_fail
if True, do not raise an exception if the annotation cannot be found, instead return None
Expand source code 
class GetFeatures(Getter):
    """
    Helper to access the features of an annotation in a match with the given name.
    """

    def __init__(self, name, resultidx=0, matchidx=0, silent_fail=False):
        """
        Create a GetFeatures helper.

        Args:
            name: the name of the match to use.
            resultidx: the index of the result to use if there is more than one.
            matchidx:  the index of the match info element with the given name to use if there is more than one
            silent_fail: if True, do not raise an exception if the annotation cannot be found, instead return
                None
        """
        self.name = name
        self.resultidx = resultidx
        self.matchidx = matchidx
        self.silent_fail = silent_fail

    def __call__(self, succ, context=None, location=None):
        match = _get_match(
            succ, self.name, self.resultidx, self.matchidx, self.silent_fail
        )
        ann = match.get("ann")
        if ann is None:
            if not self.silent_fail:
                raise Exception(
                    f"No annotation found for name {self.name}, {self.resultidx}, {self.matchidx}"
                )
        return ann.features

Ancestors

class GetRegexGroup (name, group=0, resultidx=0, matchidx=0, silent_fail=False)

Helper to access the given regular expression matching group in a match with the given name.

Create a GetText helper.

Args

name
the name of the match to use.
resultidx
the index of the result to use if there is more than one.
matchidx
the index of the match info element with the given name to use if there is more than one
silent_fail
if True, do not raise an exception if the annotation cannot be found, instead return None
Expand source code 
class GetRegexGroup(Getter):
    """
    Helper to access the given regular expression matching group in a match with the given name.
    """

    def __init__(self, name, group=0, resultidx=0, matchidx=0, silent_fail=False):
        """
        Create a GetText helper.

        Args:
            name: the name of the match to use.
            resultidx: the index of the result to use if there is more than one.
            matchidx:  the index of the match info element with the given name to use if there is more than one
            silent_fail: if True, do not raise an exception if the annotation cannot be found, instead return
                None
        """
        self.name = name
        self.resultidx = resultidx
        self.matchidx = matchidx
        self.group = group
        self.silent_fail = silent_fail

    def __call__(self, succ, context=None, location=None):
        match = _get_match(
            succ, self.name, self.resultidx, self.matchidx, self.silent_fail
        )
        groups = match.get("groups")
        if groups:
            return groups[self.group]
        else:
            if self.silent_fail:
                return None
            else:
                raise Exception("Could not find regexp groups for match info")

Ancestors

class GetStart (name, resultidx=0, matchidx=0, silent_fail=False)

Helper to access the start offset of the annotation in a match with the given name.

Create a GetStart helper.

Args

name
the name of the match to use.
resultidx
the index of the result to use if there is more than one.
matchidx
the index of the match info element with the given name to use if there is more than one
silent_fail
if True, do not raise an exception if the annotation cannot be found, instead return None
Expand source code 
class GetStart(Getter):
    """
    Helper to access the start offset of the annotation in a match with the given name.
    """

    def __init__(self, name, resultidx=0, matchidx=0, silent_fail=False):
        """
        Create a GetStart helper.

        Args:
            name: the name of the match to use.
            resultidx: the index of the result to use if there is more than one.
            matchidx:  the index of the match info element with the given name to use if there is more than one
            silent_fail: if True, do not raise an exception if the annotation cannot be found, instead return
                None
        """
        self.name = name
        self.resultidx = resultidx
        self.matchidx = matchidx
        self.silent_fail = silent_fail

    def __call__(self, succ, context=None, location=None):
        match = _get_match(
            succ, self.name, self.resultidx, self.matchidx, self.silent_fail
        )
        span = match["span"]
        return span.start

Ancestors

class GetText (name=None, resultidx=0, matchidx=0, silent_fail=False)

Helper to access text, either covered document text of the annotation or matched text.

Create a GetText helper. This first gets the span that matches the name, resultidx and matchidx parameters and then provides the text of the document for that span.

Args

name
the name of the match to use, if None, use the span of the whole match.
resultidx
the index of the result to use if there is more than one.
matchidx
the index of the match info element with the given name to use if there is more than one
silent_fail
if True, do not raise an exception if the annotation cannot be found, instead return None
Expand source code 
class GetText(Getter):
    """
    Helper to access text, either covered document text of the annotation or matched text.
    """

    def __init__(self, name=None, resultidx=0, matchidx=0, silent_fail=False):
        """
        Create a GetText helper. This first gets the span that matches the name, resultidx and matchidx
        parameters and then provides the text of the document for that span.

        Args:
            name: the name of the match to use, if None, use the span of the whole match.
            resultidx: the index of the result to use if there is more than one.
            matchidx:  the index of the match info element with the given name to use if there is more than one
            silent_fail: if True, do not raise an exception if the annotation cannot be found, instead return
                None
        """
        self.name = name
        self.resultidx = resultidx
        self.matchidx = matchidx
        self.silent_fail = silent_fail

    def __call__(self, succ, context=None, location=None):
        if self.name is None:
            span = _get_span(succ, self.name, self.resultidx, self.matchidx, self.silent_fail)
        else:
            match = _get_match(
                succ, self.name, self.resultidx, self.matchidx, self.silent_fail
            )
            span = match.get("span")
        if span:
            return context.doc[span]
        else:
            if self.silent_fail:
                return None
            else:
                raise Exception("Could not find a span for match info")

Ancestors

class GetType (name, resultidx=0, matchidx=0, silent_fail=False)

Helper to access the type of an annotation in a match with the given name.

Create a GetType helper.

Args

name
the name of the match to use.
resultidx
the index of the result to use if there is more than one.
matchidx
the index of the match info element with the given name to use if there is more than one
silent_fail
if True, do not raise an exception if the annotation cannot be found, instead return None
Expand source code 
class GetType(Getter):
    """
    Helper to access the type of an annotation in a match with the given name.
    """

    def __init__(self, name, resultidx=0, matchidx=0, silent_fail=False):
        """
        Create a GetType helper.

        Args:
            name: the name of the match to use.
            resultidx: the index of the result to use if there is more than one.
            matchidx:  the index of the match info element with the given name to use if there is more than one
            silent_fail: if True, do not raise an exception if the annotation cannot be found, instead return
                None
        """
        self.name = name
        self.resultidx = resultidx
        self.matchidx = matchidx
        self.silent_fail = silent_fail

    def __call__(self, succ, context=None, location=None):
        match = _get_match(
            succ, self.name, self.resultidx, self.matchidx, self.silent_fail
        )
        ann = match.get("ann")
        if ann is None:
            if not self.silent_fail:
                raise Exception(
                    f"No annotation found for name {self.name}, {self.resultidx}, {self.matchidx}"
                )
        return ann.type

Ancestors