Class MatchGroup

explainshell/matcher.py:13–31

a class to group matchresults together we group all shell results in one group and create a new group for every command

@dataclass
class MatchGroup:
    """a class to group matchresults together

    we group all shell results in one group and create a new group for every
    command"""

    name: str
    results: list = field(default_factory=list)
    manpage: object = None
    suggestions: list | None = None
    error: Exception | None = None
    # Tracks how many ordered positional arguments have been consumed for
    # this command group.  Each unmatched word advances the index so the
    # next positional definition is used; once exhausted, the last
    # positional is reused (variadic).
    positional_index: int = field(default=0, repr=False)

    def __repr__(self):
        return "<matchgroup %r with %d results>" % (self.name, len(self.results))


@dataclass(frozen=True, slots=True)