Class LicenseMatch

src/licensedcode/match.py:152–855

License detection match to a rule with matched query positions and lines and matched index positions. Also computes a score for a match. At a high level, a match behaves a little like a Span and has several similar methods taking into account both the query and index-side Spans.

@attr.s(slots=True, eq=False, order=False, repr=False)
class LicenseMatch(object):
    """
    License detection match to a rule with matched query positions and lines and
    matched index positions. Also computes a score for a match. At a high level,
    a match behaves a little like a Span and has several similar methods taking
    into account both the query and index-side Spans.

    Note that the relationship between the query-side qspan Span and the index-
    side ispan Span is such that:

    - they always have the exact same number of items but when sorted each
      value at a given index may be different
    - the nth position when sorted by position is such that their token
      value is equal for this position.

    These properties mean that the qspan and ispan can be safely zipped with
    zip(). Also and as a convention throughout, we always use qspan first then
    ispan: in general we put query-related variables on the left hand side and
    index-related variables on the right hand side.
    """

    rule = attr.ib(
        metadata=dict(
            help='matched Rule object'
        )
    )

    qspan = attr.ib(
        metadata=dict(
            help='query text matched Span, start at zero which is the absolute '
                 'query start (not the query_run start)'
        )
    )

    ispan = attr.ib(
        metadata=dict(
            help='rule text matched Span, start at zero which is the rule start.'
        )
    )

    hispan = attr.ib(
        default=attr.Factory(Span),
        metadata=dict(
            help='rule text matched Span for high tokens, start at zero which '
                 'is the rule start. Always a subset of ispan.'
        )
    )

    query_run_start = attr.ib(
        default=0,
        metadata=dict(
            help='Starting position of the QueryRun where this match '
                 'was found.'
            )
    )

    matcher = attr.ib(
        default='',