diff options
author | Helmut Grohne <helmut@subdivi.de> | 2023-01-14 07:40:31 +0100 |
---|---|---|
committer | Helmut Grohne <helmut@subdivi.de> | 2023-01-14 07:40:31 +0100 |
commit | 3a85824c3a5b88ae5de1842ef2e7a759ed9ed481 (patch) | |
tree | 9d78cc0c9c65b5b358422fba79dd09e22e14bb04 /setup_docs.py | |
parent | ecdf54b89da43811a37cbb5832571f57d7744bfb (diff) |
New upstream version 2.0.0b4
Diffstat (limited to 'setup_docs.py')
-rw-r--r-- | setup_docs.py | 377 |
1 files changed, 194 insertions, 183 deletions
diff --git a/setup_docs.py b/setup_docs.py index 9513604b..a9a77d3a 100644 --- a/setup_docs.py +++ b/setup_docs.py @@ -12,36 +12,34 @@ from setuptools import Command def long_desc_from_readme(): - with open('README.rst') as fd: + with open("README.rst") as fd: long_description = fd.read() # remove header, but have one \n before first headline - start = long_description.find('What is BorgBackup?') + start = long_description.find("What is BorgBackup?") assert start >= 0 - long_description = '\n' + long_description[start:] + long_description = "\n" + long_description[start:] # remove badges - long_description = re.compile(r'^\.\. start-badges.*^\.\. end-badges', re.M | re.S).sub('', long_description) + long_description = re.compile(r"^\.\. start-badges.*^\.\. end-badges", re.M | re.S).sub("", long_description) # remove unknown directives - long_description = re.compile(r'^\.\. highlight:: \w+$', re.M).sub('', long_description) + long_description = re.compile(r"^\.\. highlight:: \w+$", re.M).sub("", long_description) return long_description def format_metavar(option): - if option.nargs in ('*', '...'): - return '[%s...]' % option.metavar - elif option.nargs == '?': - return '[%s]' % option.metavar + if option.nargs in ("*", "..."): + return "[%s...]" % option.metavar + elif option.nargs == "?": + return "[%s]" % option.metavar elif option.nargs is None: return option.metavar else: - raise ValueError(f'Can\'t format metavar {option.metavar}, unknown nargs {option.nargs}!') + raise ValueError(f"Can't format metavar {option.metavar}, unknown nargs {option.nargs}!") class build_usage(Command): description = "generate usage for each command" - user_options = [ - ('output=', 'O', 'output directory'), - ] + user_options = [("output=", "O", "output directory")] def initialize_options(self): pass @@ -50,17 +48,19 @@ class build_usage(Command): pass def run(self): - print('generating usage docs') + print("generating usage docs") import borg - borg.doc_mode = 'build_man' - if not os.path.exists('docs/usage'): - os.mkdir('docs/usage') + + borg.doc_mode = "build_man" + if not os.path.exists("docs/usage"): + os.mkdir("docs/usage") # allows us to build docs without the C modules fully loaded during help generation from borg.archiver import Archiver - parser = Archiver(prog='borg').build_parser() + + parser = Archiver(prog="borg").build_parser() # borgfs has a separate man page to satisfy debian's "every program from a package # must have a man page" requirement, but it doesn't need a separate HTML docs page - #borgfs_parser = Archiver(prog='borgfs').build_parser() + # borgfs_parser = Archiver(prog='borgfs').build_parser() self.generate_level("", parser, Archiver) @@ -68,7 +68,7 @@ class build_usage(Command): is_subcommand = False choices = {} for action in parser._actions: - if action.choices is not None and 'SubParsersAction' in str(action.__class__): + if action.choices is not None and "SubParsersAction" in str(action.__class__): is_subcommand = True for cmd, parser in action.choices.items(): choices[prefix + cmd] = parser @@ -76,32 +76,37 @@ class build_usage(Command): choices.update(extra_choices) if prefix and not choices: return - print('found commands: %s' % list(choices.keys())) + print("found commands: %s" % list(choices.keys())) for command, parser in sorted(choices.items()): - if command.startswith('debug'): - print('skipping', command) + if command.startswith("debug"): + print("skipping", command) continue - print('generating help for %s' % command) + print("generating help for %s" % command) if self.generate_level(command + " ", parser, Archiver): continue - with open('docs/usage/%s.rst.inc' % command.replace(" ", "_"), 'w') as doc: + with open("docs/usage/%s.rst.inc" % command.replace(" ", "_"), "w") as doc: doc.write(".. IMPORTANT: this file is auto-generated from borg's built-in help, do not edit!\n\n") - if command == 'help': + if command == "help": for topic in Archiver.helptext: - params = {"topic": topic, - "underline": '~' * len('borg help ' + topic)} + params = {"topic": topic, "underline": "~" * len("borg help " + topic)} doc.write(".. _borg_{topic}:\n\n".format(**params)) doc.write("borg help {topic}\n{underline}\n\n".format(**params)) doc.write(Archiver.helptext[topic]) else: - params = {"command": command, - "command_": command.replace(' ', '_'), - "underline": '-' * len('borg ' + command)} + params = { + "command": command, + "command_": command.replace(" ", "_"), + "underline": "-" * len("borg " + command), + } doc.write(".. _borg_{command_}:\n\n".format(**params)) - doc.write("borg {command}\n{underline}\n.. code-block:: none\n\n borg [common options] {command}".format(**params)) + doc.write( + "borg {command}\n{underline}\n.. code-block:: none\n\n borg [common options] {command}".format( + **params + ) + ) self.write_usage(parser, doc) epilog = parser.epilog parser.epilog = None @@ -109,21 +114,21 @@ class build_usage(Command): doc.write("\n\nDescription\n~~~~~~~~~~~\n") doc.write(epilog) - if 'create' in choices: - common_options = [group for group in choices['create']._action_groups if group.title == 'Common options'][0] - with open('docs/usage/common-options.rst.inc', 'w') as doc: + if "create" in choices: + common_options = [group for group in choices["create"]._action_groups if group.title == "Common options"][0] + with open("docs/usage/common-options.rst.inc", "w") as doc: self.write_options_group(common_options, doc, False, base_indent=0) return is_subcommand def write_usage(self, parser, fp): if any(len(o.option_strings) for o in parser._actions): - fp.write(' [options]') + fp.write(" [options]") for option in parser._actions: if option.option_strings: continue - fp.write(' ' + format_metavar(option)) - fp.write('\n\n') + fp.write(" " + format_metavar(option)) + fp.write("\n\n") def write_options(self, parser, fp): def is_positional_group(group): @@ -134,58 +139,58 @@ class build_usage(Command): def html_write(s): for line in s.splitlines(): - fp.write(' ' + line + '\n') + fp.write(" " + line + "\n") rows = [] for group in parser._action_groups: - if group.title == 'Common options': + if group.title == "Common options": # (no of columns used, columns, ...) - rows.append((1, '.. class:: borg-common-opt-ref\n\n:ref:`common_options`')) + rows.append((1, ".. class:: borg-common-opt-ref\n\n:ref:`common_options`")) else: if not group._group_actions: continue - group_header = '**%s**' % group.title + group_header = "**%s**" % group.title if group.description: - group_header += ' — ' + group.description + group_header += " — " + group.description rows.append((1, group_header)) if is_positional_group(group): for option in group._group_actions: - rows.append((3, '', '``%s``' % option.metavar, option.help or '')) + rows.append((3, "", "``%s``" % option.metavar, option.help or "")) else: for option in group._group_actions: if option.metavar: - option_fmt = '``%s ' + option.metavar + '``' + option_fmt = "``%s " + option.metavar + "``" else: - option_fmt = '``%s``' - option_str = ', '.join(option_fmt % s for s in option.option_strings) - option_desc = textwrap.dedent((option.help or '') % option.__dict__) - rows.append((3, '', option_str, option_desc)) + option_fmt = "``%s``" + option_str = ", ".join(option_fmt % s for s in option.option_strings) + option_desc = textwrap.dedent((option.help or "") % option.__dict__) + rows.append((3, "", option_str, option_desc)) - fp.write('.. only:: html\n\n') + fp.write(".. only:: html\n\n") table = io.StringIO() - table.write('.. class:: borg-options-table\n\n') + table.write(".. class:: borg-options-table\n\n") self.rows_to_table(rows, table.write) - fp.write(textwrap.indent(table.getvalue(), ' ' * 4)) + fp.write(textwrap.indent(table.getvalue(), " " * 4)) # LaTeX output: # Regular rST option lists (irregular column widths) latex_options = io.StringIO() for group in parser._action_groups: - if group.title == 'Common options': - latex_options.write('\n\n:ref:`common_options`\n') - latex_options.write(' |') + if group.title == "Common options": + latex_options.write("\n\n:ref:`common_options`\n") + latex_options.write(" |") else: self.write_options_group(group, latex_options) - fp.write('\n.. only:: latex\n\n') - fp.write(textwrap.indent(latex_options.getvalue(), ' ' * 4)) + fp.write("\n.. only:: latex\n\n") + fp.write(textwrap.indent(latex_options.getvalue(), " " * 4)) def rows_to_table(self, rows, write): def write_row_separator(): - write('+') + write("+") for column_width in column_widths: - write('-' * (column_width + 1)) - write('+') - write('\n') + write("-" * (column_width + 1)) + write("+") + write("\n") # Find column count and width column_count = max(columns for columns, *_ in rows) @@ -201,22 +206,22 @@ class build_usage(Command): # where each cell contains no newline. rowspanning_cells = [] original_cells = list(original_cells) - while any('\n' in cell for cell in original_cells): + while any("\n" in cell for cell in original_cells): cell_bloc = [] for i, cell in enumerate(original_cells): - pre, _, original_cells[i] = cell.partition('\n') + pre, _, original_cells[i] = cell.partition("\n") cell_bloc.append(pre) rowspanning_cells.append(cell_bloc) rowspanning_cells.append(original_cells) for cells in rowspanning_cells: for i, column_width in enumerate(column_widths): if i < columns: - write('| ') + write("| ") write(cells[i].ljust(column_width)) else: - write(' ') - write(''.ljust(column_width)) - write('|\n') + write(" ") + write("".ljust(column_width)) + write("|\n") write_row_separator() # This bit of JavaScript kills the <colgroup> that is invariably inserted by docutils, @@ -224,7 +229,9 @@ class build_usage(Command): # with CSS alone. # Since this is HTML-only output, it would be possible to just generate a <table> directly, # but then we'd lose rST formatting. - write(textwrap.dedent(""" + write( + textwrap.dedent( + """ .. raw:: html <script type='text/javascript'> @@ -232,86 +239,87 @@ class build_usage(Command): $('.borg-options-table colgroup').remove(); }) </script> - """)) + """ + ) + ) def write_options_group(self, group, fp, with_title=True, base_indent=4): def is_positional_group(group): return any(not o.option_strings for o in group._group_actions) - indent = ' ' * base_indent + indent = " " * base_indent if is_positional_group(group): for option in group._group_actions: - fp.write(option.metavar + '\n') - fp.write(textwrap.indent(option.help or '', ' ' * base_indent) + '\n') + fp.write(option.metavar + "\n") + fp.write(textwrap.indent(option.help or "", " " * base_indent) + "\n") return if not group._group_actions: return if with_title: - fp.write('\n\n') - fp.write(group.title + '\n') + fp.write("\n\n") + fp.write(group.title + "\n") opts = OrderedDict() for option in group._group_actions: if option.metavar: - option_fmt = '%s ' + option.metavar + option_fmt = "%s " + option.metavar else: - option_fmt = '%s' - option_str = ', '.join(option_fmt % s for s in option.option_strings) - option_desc = textwrap.dedent((option.help or '') % option.__dict__) - opts[option_str] = textwrap.indent(option_desc, ' ' * 4) + option_fmt = "%s" + option_str = ", ".join(option_fmt % s for s in option.option_strings) + option_desc = textwrap.dedent((option.help or "") % option.__dict__) + opts[option_str] = textwrap.indent(option_desc, " " * 4) padding = len(max(opts)) + 1 for option, desc in opts.items(): - fp.write(indent + option.ljust(padding) + desc + '\n') + fp.write(indent + option.ljust(padding) + desc + "\n") class build_man(Command): - description = 'build man pages' + description = "build man pages" user_options = [] see_also = { - 'create': ('delete', 'prune', 'check', 'patterns', 'placeholders', 'compression'), - 'recreate': ('patterns', 'placeholders', 'compression'), - 'list': ('info', 'diff', 'prune', 'patterns'), - 'info': ('list', 'diff'), - 'init': ('create', 'delete', 'check', 'list', 'key-import', 'key-export', 'key-change-passphrase'), - 'key-import': ('key-export', ), - 'key-export': ('key-import', ), - 'mount': ('umount', 'extract'), # Would be cooler if these two were on the same page - 'umount': ('mount', ), - 'extract': ('mount', ), - 'delete': ('compact', ), - 'prune': ('compact', ), + "create": ("delete", "prune", "check", "patterns", "placeholders", "compression"), + "recreate": ("patterns", "placeholders", "compression"), + "list": ("info", "diff", "prune", "patterns"), + "info": ("list", "diff"), + "rcreate": ("rdelete", "rlist", "check", "key-import", "key-export", "key-change-passphrase"), + "key-import": ("key-export",), + "key-export": ("key-import",), + "mount": ("umount", "extract"), # Would be cooler if these two were on the same page + "umount": ("mount",), + "extract": ("mount",), + "delete": ("compact",), + "prune": ("compact",), } - rst_prelude = textwrap.dedent(""" + rst_prelude = textwrap.dedent( + """ .. role:: ref(title) .. |project_name| replace:: Borg - """) + """ + ) usage_group = { - 'break-lock': 'lock', - 'with-lock': 'lock', - - 'key_change-passphrase': 'key', - 'key_export': 'key', - 'key_import': 'key', - 'key_migrate-to-repokey': 'key', - - 'export-tar': 'tar', - 'import-tar': 'tar', - - 'benchmark_crud': 'benchmark', - - 'umount': 'mount', + "break-lock": "lock", + "with-lock": "lock", + "key_change-passphrase": "key", + "key_change-location": "key", + "key_export": "key", + "key_import": "key", + "export-tar": "tar", + "import-tar": "tar", + "benchmark_crud": "benchmark", + "benchmark_cpu": "benchmark", + "umount": "mount", } def initialize_options(self): @@ -321,16 +329,18 @@ class build_man(Command): pass def run(self): - print('building man pages (in docs/man)', file=sys.stderr) + print("building man pages (in docs/man)", file=sys.stderr) import borg - borg.doc_mode = 'build_man' - os.makedirs('docs/man', exist_ok=True) + + borg.doc_mode = "build_man" + os.makedirs("docs/man", exist_ok=True) # allows us to build docs without the C modules fully loaded during help generation from borg.archiver import Archiver - parser = Archiver(prog='borg').build_parser() - borgfs_parser = Archiver(prog='borgfs').build_parser() - self.generate_level('', parser, Archiver, {'borgfs': borgfs_parser}) + parser = Archiver(prog="borg").build_parser() + borgfs_parser = Archiver(prog="borgfs").build_parser() + + self.generate_level("", parser, Archiver, {"borgfs": borgfs_parser}) self.build_topic_pages(Archiver) self.build_intro_page() @@ -338,7 +348,7 @@ class build_man(Command): is_subcommand = False choices = {} for action in parser._actions: - if action.choices is not None and 'SubParsersAction' in str(action.__class__): + if action.choices is not None and "SubParsersAction" in str(action.__class__): is_subcommand = True for cmd, parser in action.choices.items(): choices[prefix + cmd] = parser @@ -348,50 +358,50 @@ class build_man(Command): return for command, parser in sorted(choices.items()): - if command.startswith('debug') or command == 'help': + if command.startswith("debug") or command == "help": continue if command == "borgfs": man_title = command else: - man_title = 'borg-' + command.replace(' ', '-') - print('building man page', man_title + '(1)', file=sys.stderr) + man_title = "borg-" + command.replace(" ", "-") + print("building man page", man_title + "(1)", file=sys.stderr) - is_intermediary = self.generate_level(command + ' ', parser, Archiver) + is_intermediary = self.generate_level(command + " ", parser, Archiver) doc, write = self.new_doc() self.write_man_header(write, man_title, parser.description) - self.write_heading(write, 'SYNOPSIS') + self.write_heading(write, "SYNOPSIS") if is_intermediary: - subparsers = [action for action in parser._actions if 'SubParsersAction' in str(action.__class__)][0] + subparsers = [action for action in parser._actions if "SubParsersAction" in str(action.__class__)][0] for subcommand in subparsers.choices: - write('| borg', '[common options]', command, subcommand, '...') - self.see_also.setdefault(command, []).append(f'{command}-{subcommand}') + write("| borg", "[common options]", command, subcommand, "...") + self.see_also.setdefault(command, []).append(f"{command}-{subcommand}") else: if command == "borgfs": - write(command, end='') + write(command, end="") else: - write('borg', '[common options]', command, end='') + write("borg", "[common options]", command, end="") self.write_usage(write, parser) - write('\n') + write("\n") - description, _, notes = parser.epilog.partition('\n.. man NOTES') + description, _, notes = parser.epilog.partition("\n.. man NOTES") if description: - self.write_heading(write, 'DESCRIPTION') + self.write_heading(write, "DESCRIPTION") write(description) if not is_intermediary: - self.write_heading(write, 'OPTIONS') - write('See `borg-common(1)` for common options of Borg commands.') + self.write_heading(write, "OPTIONS") + write("See `borg-common(1)` for common options of Borg commands.") write() self.write_options(write, parser) self.write_examples(write, command) if notes: - self.write_heading(write, 'NOTES') + self.write_heading(write, "NOTES") write(notes) self.write_see_also(write, man_title) @@ -399,14 +409,14 @@ class build_man(Command): self.gen_man_page(man_title, doc.getvalue()) # Generate the borg-common(1) man page with the common options. - if 'create' in choices: + if "create" in choices: doc, write = self.new_doc() - man_title = 'borg-common' - self.write_man_header(write, man_title, 'Common options of Borg commands') + man_title = "borg-common" + self.write_man_header(write, man_title, "Common options of Borg commands") - common_options = [group for group in choices['create']._action_groups if group.title == 'Common options'][0] + common_options = [group for group in choices["create"]._action_groups if group.title == "Common options"][0] - self.write_heading(write, 'SYNOPSIS') + self.write_heading(write, "SYNOPSIS") self.write_options_group(write, common_options) self.write_see_also(write, man_title) self.gen_man_page(man_title, doc.getvalue()) @@ -416,20 +426,20 @@ class build_man(Command): def build_topic_pages(self, Archiver): for topic, text in Archiver.helptext.items(): doc, write = self.new_doc() - man_title = 'borg-' + topic - print('building man page', man_title + '(1)', file=sys.stderr) + man_title = "borg-" + topic + print("building man page", man_title + "(1)", file=sys.stderr) - self.write_man_header(write, man_title, 'Details regarding ' + topic) - self.write_heading(write, 'DESCRIPTION') + self.write_man_header(write, man_title, "Details regarding " + topic) + self.write_heading(write, "DESCRIPTION") write(text) self.gen_man_page(man_title, doc.getvalue()) def build_intro_page(self): doc, write = self.new_doc() - man_title = 'borg' - print('building man page borg(1)', file=sys.stderr) + man_title = "borg" + print("building man page borg(1)", file=sys.stderr) - with open('docs/man_intro.rst') as fd: + with open("docs/man_intro.rst") as fd: man_intro = fd.read() self.write_man_header(write, man_title, "deduplicating and encrypting backup tool") @@ -444,9 +454,10 @@ class build_man(Command): def printer(self, fd): def write(*args, **kwargs): print(*args, file=fd, **kwargs) + return write - def write_heading(self, write, header, char='-', double_sided=False): + def write_heading(self, write, header, char="-", double_sided=False): write() if double_sided: write(char * len(header)) @@ -455,43 +466,43 @@ class build_man(Command): write() def write_man_header(self, write, title, description): - self.write_heading(write, title, '=', double_sided=True) + self.write_heading(write, title, "=", double_sided=True) self.write_heading(write, description, double_sided=True) # man page metadata - write(':Author: The Borg Collective') - write(':Date:', datetime.utcnow().date().isoformat()) - write(':Manual section: 1') - write(':Manual group: borg backup tool') + write(":Author: The Borg Collective") + write(":Date:", datetime.utcnow().date().isoformat()) + write(":Manual section: 1") + write(":Manual group: borg backup tool") write() def write_examples(self, write, command): - command = command.replace(' ', '_') - with open('docs/usage/%s.rst' % self.usage_group.get(command, command)) as fd: + command = command.replace(" ", "_") + with open("docs/usage/%s.rst" % self.usage_group.get(command, command)) as fd: usage = fd.read() - usage_include = '.. include:: %s.rst.inc' % command + usage_include = ".. include:: %s.rst.inc" % command begin = usage.find(usage_include) - end = usage.find('.. include', begin + 1) + end = usage.find(".. include", begin + 1) # If a command has a dedicated anchor, it will occur before the command's include. - if 0 < usage.find('.. _', begin + 1) < end: - end = usage.find('.. _', begin + 1) + if 0 < usage.find(".. _", begin + 1) < end: + end = usage.find(".. _", begin + 1) examples = usage[begin:end] - examples = examples.replace(usage_include, '') - examples = examples.replace('Examples\n~~~~~~~~', '') - examples = examples.replace('Miscellaneous Help\n------------------', '') - examples = examples.replace('``docs/misc/prune-example.txt``:', '``docs/misc/prune-example.txt``.') - examples = examples.replace('.. highlight:: none\n', '') # we don't support highlight - examples = re.sub('^(~+)$', lambda matches: '+' * len(matches.group(0)), examples, flags=re.MULTILINE) + examples = examples.replace(usage_include, "") + examples = examples.replace("Examples\n~~~~~~~~", "") + examples = examples.replace("Miscellaneous Help\n------------------", "") + examples = examples.replace("``docs/misc/prune-example.txt``:", "``docs/misc/prune-example.txt``.") + examples = examples.replace(".. highlight:: none\n", "") # we don't support highlight + examples = re.sub("^(~+)$", lambda matches: "+" * len(matches.group(0)), examples, flags=re.MULTILINE) examples = examples.strip() if examples: - self.write_heading(write, 'EXAMPLES', '-') + self.write_heading(write, "EXAMPLES", "-") write(examples) def write_see_also(self, write, man_title): - see_also = self.see_also.get(man_title.replace('borg-', ''), ()) - see_also = ['`borg-%s(1)`' % s for s in see_also] - see_also.insert(0, '`borg-common(1)`') - self.write_heading(write, 'SEE ALSO') - write(', '.join(see_also)) + see_also = self.see_also.get(man_title.replace("borg-", ""), ()) + see_also = ["`borg-%s(1)`" % s for s in see_also] + see_also.insert(0, "`borg-common(1)`") + self.write_heading(write, "SEE ALSO") + write(", ".join(see_also)) def gen_man_page(self, name, rst): from docutils.writers import manpage @@ -500,29 +511,29 @@ class build_man(Command): from docutils.parsers.rst import roles def issue(name, rawtext, text, lineno, inliner, options={}, content=[]): - return [inline(rawtext, '#' + text)], [] + return [inline(rawtext, "#" + text)], [] - roles.register_local_role('issue', issue) + roles.register_local_role("issue", issue) # We give the source_path so that docutils can find relative includes # as-if the document where located in the docs/ directory. - man_page = publish_string(source=rst, source_path='docs/%s.rst' % name, writer=manpage.Writer()) - with open('docs/man/%s.1' % name, 'wb') as fd: + man_page = publish_string(source=rst, source_path="docs/%s.rst" % name, writer=manpage.Writer()) + with open("docs/man/%s.1" % name, "wb") as fd: fd.write(man_page) def write_usage(self, write, parser): if any(len(o.option_strings) for o in parser._actions): - write(' [options] ', end='') + write(" [options] ", end="") for option in parser._actions: if option.option_strings: continue - write(format_metavar(option), end=' ') + write(format_metavar(option), end=" ") def write_options(self, write, parser): for group in parser._action_groups: - if group.title == 'Common options' or not group._group_actions: + if group.title == "Common options" or not group._group_actions: continue - title = 'arguments' if group.title == 'positional arguments' else group.title - self.write_heading(write, title, '+') + title = "arguments" if group.title == "positional arguments" else group.title + self.write_heading(write, title, "+") self.write_options_group(write, group) def write_options_group(self, write, group): @@ -532,19 +543,19 @@ class build_man(Command): if is_positional_group(group): for option in group._group_actions: write(option.metavar) - write(textwrap.indent(option.help or '', ' ' * 4)) + write(textwrap.indent(option.help or "", " " * 4)) return opts = OrderedDict() for option in group._group_actions: if option.metavar: - option_fmt = '%s ' + option.metavar + option_fmt = "%s " + option.metavar else: - option_fmt = '%s' - option_str = ', '.join(option_fmt % s for s in option.option_strings) - option_desc = textwrap.dedent((option.help or '') % option.__dict__) - opts[option_str] = textwrap.indent(option_desc, ' ' * 4) + option_fmt = "%s" + option_str = ", ".join(option_fmt % s for s in option.option_strings) + option_desc = textwrap.dedent((option.help or "") % option.__dict__) + opts[option_str] = textwrap.indent(option_desc, " " * 4) padding = len(max(opts)) + 1 |