Method __init__

src/licensedcode/query.py:196–294

Initialize the query from a file `location` or `query_string` string for an `idx` LicenseIndex. Break query in runs when there are at least `line_threshold` empty lines or junk-only lines. Line numbers start at ``start_line`` which is 1-based by default.

(
        self,
        location=None,
        query_string=None,
        idx=None,
        line_threshold=LINES_THRESHOLD,
        start_line=1,
        _test_mode=False,
    )

    )

    def __init__(
        self,
        location=None,
        query_string=None,
        idx=None,
        line_threshold=LINES_THRESHOLD,
        start_line=1,
        _test_mode=False,
    ):
        """
        Initialize the query from a file `location` or `query_string` string for
        an `idx` LicenseIndex.
        Break query in runs when there are at least `line_threshold` empty lines
        or junk-only lines.
        Line numbers start at ``start_line`` which is 1-based by default.
        """
        assert (location or query_string) and idx

        self.location = location
        self.query_string = query_string
        self.idx = idx

        self.line_threshold = line_threshold
        self.start_line = start_line

        # True if the text is made of very long lines
        self.has_long_lines = False

        # True if the query is binary
        self.is_binary = False

        # known token ids array
        self.tokens = []

        # index of known position -> line number where the pos is the list index
        self.line_by_pos = []

        # index of "known positions" (yes really!) to a number of unknown tokens
        # after that known position. For unknowns at the start, the position is
        # using the magic -1 key
        self.unknowns_by_pos = {}

        # Span of "known positions" (yes really!) followed by unknown token(s)
        self.unknowns_span = None

        # index of "known positions" (yes really!) to a number of stopword
        # tokens after this known position. For stopwords at the start, the
        # position is using the magic -1 key
        self.stopwords_by_pos = {}

        # set of known positions were there is a short, single letter token or
        # digits-only token
        # TODO: consider using an intbitset
        self.shorts_and_digits_pos = set()

        # list of the three SPDX-License-Identifier tokens to identify to detect
        # a line for SPDX id matching.
        # note: this will not match anything if the index is not properly set