Class MatchResult

explainshell/matcher.py:35–49

A single matched token span in the input command line.

@dataclass(frozen=True, slots=True)
class MatchResult:
    """A single matched token span in the input command line."""

    start: int  # start position in the input string
    end: int  # end position in the input string (exclusive)
    text: str | None  # help text from the manpage option, or None if unknown
    match: str | None  # the matched portion of the input string
    # Debug metadata for the explain.html debug panel; excluded from
    # equality/hashing.  Every creation site populates this with a dict
    # whose "kind" key describes the match type.
    debug_info: dict | None = field(default=None, compare=False, hash=False)

    @property
    def unknown(self):
        return self.text is None


def _option_debug(option):