Class Option

explainshell/models.py:47–76

An extracted command-line option from a man page. short - a list of short options (-a, -b, ..) long - a list of long options (--a, --b) has_argument - specifies if one of the short/long options expects an additional argument positional - specifies if to consider this as positional a

class Option(BaseModel):
    """An extracted command-line option from a man page.

    short - a list of short options (-a, -b, ..)
    long - a list of long options (--a, --b)
    has_argument - specifies if one of the short/long options expects an additional argument
    positional - specifies if to consider this as positional arguments
    prefix - literal sigil a token must start with for this positional to claim
        it (e.g. '@' in dig's '[@server]'); only meaningful when positional is set
    nested_cmd - specifies if the arguments to this option can start a nested command
    """

    text: str
    short: list[str] = []
    long: list[str] = []
    has_argument: bool | list[str] = False
    positional: str | bool | None = None
    prefix: str | None = None
    nested_cmd: bool | list[str] = False
    meta: dict | None = None

    @property
    def opts(self) -> list[str]:
        return self.short + self.long

    def __str__(self):
        return "(" + ", ".join([str(x) for x in self.opts]) + ")"

    def __repr__(self):
        return f"<option {self}>"


class ParsedManpage(BaseModel):