Method match

src/licensedcode/index.py:898–964

This is the main entry point to match licenses. Return a sequence of LicenseMatch by matching the file at ``location`` or the ``query_string`` string against this index. Only include matches with scores greater or equal to ``min_score``. If ``as_expression`

(
        self,
        location=None,
        query_string=None,
        min_score=0,
        as_expression=False,
        expression_symbols=None,
        approximate=True,
        unknown_licenses=False,
        deadline=sys.maxsize,
        _skip_hash_match=False,
        **kwargs,
    )

        return matches

    def match(
        self,
        location=None,
        query_string=None,
        min_score=0,
        as_expression=False,
        expression_symbols=None,
        approximate=True,
        unknown_licenses=False,
        deadline=sys.maxsize,
        _skip_hash_match=False,
        **kwargs,
    ):
        """
        This is the main entry point to match licenses.

        Return a sequence of LicenseMatch by matching the file at ``location`` or
        the ``query_string`` string against this index. Only include matches with
        scores greater or equal to ``min_score``.

        If ``as_expression`` is True, treat the whole text as a single SPDX
        license expression and use only expression matching.

        Use the ``expression_symbols`` mapping of {lowered key: LicenseSymbol}
        if provided. Otherwise use the standard SPDX license symbols mapping.

        If ``approximate`` is True, perform approximate matching as a last
        matching step. Otherwise, only do hash, exact and expression matching.

        If ``unknown_licenses`` is True, perform unknown licenses matching after
        all regular matching steps.

        ``deadline`` is a time.time() value in seconds by which the processing
        should stop and return whatever was matched so far.

        ``_skip_hash_match`` is used only for testing.
        """
        assert 0 <= min_score <= 100

        if not location and not query_string:
            return []

        qry = query.build_query(
            location=location,
            query_string=query_string,
            idx=self,
            text_line_threshold=15,
            bin_line_threshold=50,
        )

        if TRACE:
            logger_debug('Index.match: for:', location, 'query:', qry)

        if not qry:
            return []

        return self.match_query(
            qry=qry,