Method find_man_page

explainshell/store.py:151–254

find a man page by its name, everything following the last dot (.) in name, is taken as the section of the man page we return the man page found with the highest score, and a list of suggestions that also matched the given name (only the first item is prepopulated wi

(
        self, name: str, distro: str | None = None, release: str | None = None
    )

        self._conn.commit()

    def find_man_page(
        self, name: str, distro: str | None = None, release: str | None = None
    ) -> list[ParsedManpage]:
        """find a man page by its name, everything following the last dot (.) in name,
        is taken as the section of the man page

        we return the man page found with the highest score, and a list of
        suggestions that also matched the given name (only the first item
        is prepopulated with the option data)

        when distro and release are set, filter results to manpages whose
        source starts with ``distro/release/``."""
        if name.endswith(".gz"):
            logger.debug("name ends with .gz, looking up an exact match by source")
            row = self._conn.execute(
                "SELECT * FROM parsed_manpages WHERE source = ?", (name,)
            ).fetchone()
            if not row:
                raise errors.ProgramDoesNotExist(name)
            m = ParsedManpage.from_store(dict(row))
            logger.debug("returning %s", m)
            return [m]

        section = None
        orig_name = name

        # don't try to look for a section if it's . (source)
        if name != ".":
            splitted = name.rsplit(".", 1)
            name = splitted[0]
            if len(splitted) > 1:
                section = splitted[1]

        logger.debug("looking up manpage in mappings with src %r", name)
        mapping_rows = self._conn.execute(
            "SELECT dst, score FROM mappings WHERE src = ?", (name,)
        ).fetchall()

        if not mapping_rows:
            raise errors.ProgramDoesNotExist(name)

        dsts = {row["dst"]: row["score"] for row in mapping_rows}

        placeholders = ",".join("?" * len(dsts))
        manpage_rows = self._conn.execute(
            f"SELECT name, source FROM parsed_manpages WHERE source IN ({placeholders})",
            list(dsts.keys()),
        ).fetchall()

        if len(manpage_rows) != len(dsts):
            logger.error(
                "one of %r mappings is missing in parsed_manpages table "
                "(%d mappings, %d found)",
                dsts,
                len(dsts),
                len(manpage_rows),
            )