Function _run_lexgrog

explainshell/manpage.py:45–60

Run lexgrog on a man page and return the raw synopsis string. Raises FileNotFoundError if the file does not exist, and RuntimeError if lexgrog fails or produces no output.

(gz_path: str, name: str)

def _run_lexgrog(gz_path: str, name: str) -> str:
    """Run lexgrog on a man page and return the raw synopsis string.

    Raises FileNotFoundError if the file does not exist, and RuntimeError
    if lexgrog fails or produces no output.
    """
    if not os.path.isfile(gz_path):
        raise FileNotFoundError(f"manpage file not found: {gz_path}")
    proc = subprocess.run(
        ["lexgrog", gz_path], capture_output=True, text=True, timeout=300
    )
    if proc.stderr:
        logger.warning("lexgrog stderr for %s: %s", name, proc.stderr)
    if not proc.stdout or not proc.stdout.strip():
        raise RuntimeError(f"lexgrog produced no output for {gz_path}")
    return proc.stdout.rstrip()


def get_synopsis_and_aliases(gz_path: str) -> tuple[str | None, list[tuple[str, int]]]: