gallery-dl/scripts/options.py

#!/usr/bin/env python3
# -*- coding: utf-8 -*-

# Copyright 2023 Mike Fährmann
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License version 2 as
# published by the Free Software Foundation.

"""Generate a Markdown document listing gallery-dl's command-line arguments"""

import os
import re
from argparse import SUPPRESS

import util
from gallery_dl import option


TEMPLATE = """# Command-Line Options

<!-- auto-generated by {} -->

{}
"""

TABLE = """
## {}

<table>
<tbody valign="top">
{}
</tbody>
</table>
""".format

ROW = """<tr>
    <td>{}</td>
    <td>{}</td>
    <td>{}</td>
    <td>{}</td>
</tr>""".format


tables = []
sub = re.compile(r"'([^']+)'").sub
nb_hyphen = "&#8209;"  # non-breaking hyphen

for group in option.build_parser()._action_groups[2:]:

    tbody = []

    for action in group._group_actions:
        help = action.help
        if help == SUPPRESS:
            continue
        meta = action.metavar or ""

        try:
            short, long = action.option_strings
        except ValueError:
            try:
                long = action.option_strings[0]
            except IndexError:
                continue
            short = ""

        if short:
            short = "<code>" + short.replace("-", nb_hyphen) + "</code>"
        if long:
            long = "<code>" + long.replace("-", nb_hyphen) + "</code>"
        if meta:
            meta = "<code>" + meta.partition("[")[0] + "</code>"
        if help:
            help = help.replace("<", "&lt;").replace(">", "&gt;")
            if "Example: " in help:
                help, sep, example = help.partition("Example: ")
                help = sub("<code>\\1</code>", help) + "<br />" + sep + example
            else:
                help = sub("<code>\\1</code>", help)

        tbody.append(ROW(short, long, meta, help))

    tables.append(TABLE(group.title, "\n".join(tbody)))


with open(util.path("docs", "options.md"), "w", encoding="utf-8") as fp:
    fp.write(TEMPLATE.format(
        "/".join(os.path.normpath(__file__).split(os.sep)[-2:]),
        "\n".join(tables),
    ))