Class ParsedManpage

explainshell/models.py:79–207

processed man page source - the path to the original source man page name - the name of this man page as extracted by manpage.manpage synopsis - the synopsis of this man page as extracted by manpage.manpage options - a list of options extracted from this man page aliases - a lis

class ParsedManpage(BaseModel):
    """processed man page

    source - the path to the original source man page
    name - the name of this man page as extracted by manpage.manpage
    synopsis - the synopsis of this man page as extracted by manpage.manpage
    options - a list of options extracted from this man page
    aliases - a list of aliases found for this man page
    dashless_opts - allow interpreting options without a leading '-'
    subcommands - list of subcommand names extracted from the manpage; when non-empty,
        the matcher looks ahead for e.g. "git commit" and resolves it to the git-commit manpage
    updated - whether this man page was manually updated
    nested_cmd - specifies if positional arguments to this program can start a nested command,
        e.g. sudo, xargs
    """

    source: str
    name: str
    synopsis: str | None = None
    options: list[Option] = []
    aliases: list[tuple[str, int]] = []
    dashless_opts: bool = False
    subcommands: list[str] = []
    updated: bool = False
    nested_cmd: bool | str = False
    extractor: str | None = None
    extraction_meta: ExtractionMeta | None = None

    @property
    def name_section(self):
        name, section = util.name_section(os.path.basename(self.source)[:-3])
        return f"{name}({section})"

    @property
    def section(self):
        name, section = util.name_section(os.path.basename(self.source)[:-3])
        return section

    @property
    def positionals(self):
        # go over all options and look for those with the same 'positional'
        # field; prefix-bearing positionals are excluded from ordered
        # consumption — they can only be claimed by a token carrying their
        # prefix (see prefixed_positionals)
        groups = collections.OrderedDict()
        for opt in self.options:
            if opt.positional and not opt.prefix:
                groups.setdefault(opt.positional, []).append(opt)

        # merge all the options under the same argument to a single string
        for k, ln in groups.items():
            groups[k] = "\n\n".join([p.text for p in ln])

        return groups

    @property
    def prefixed_positionals(self):
        """ordered mapping of positional name -> (prefix, merged help text)