argparse subparser aide monolithique sortie

Voici soulution complète avec aide personnalisée handler (presque tout le code de @Adaephon réponse):

import argparse


class _HelpAction(argparse._HelpAction):

    def __call__(self, parser, namespace, values, option_string=None):
        parser.print_help()

        # retrieve subparsers from parser
        subparsers_actions = [
            action for action in parser._actions
            if isinstance(action, argparse._SubParsersAction)]
        # there will probably only be one subparser_action,
        # but better save than sorry
        for subparsers_action in subparsers_actions:
            # get all subparsers and print help
            for choice, subparser in subparsers_action.choices.items():
                print("Subparser '{}'".format(choice))
                print(subparser.format_help())

        parser.exit()

# create the top-level parser
parser = argparse.ArgumentParser(prog='PROG', add_help=False)  # here we turn off default help action

parser.add_argument('--help', action=_HelpAction, help='help for help if you need some help')  # add custom help

parser.add_argument('--foo', action='store_true', help='foo help')
subparsers = parser.add_subparsers(help='sub-command help')

# create the parser for the "a" command
parser_a = subparsers.add_parser('a', help='a help')
parser_a.add_argument('bar', type=int, help='bar help')

# create the parser for the "b" command
parser_b = subparsers.add_parser('b', help='b help')
parser_b.add_argument('--baz', choices='XYZ', help='baz help')

parsed_args = parser.parse_args()

une façon plus simple d'itérer sur les sous-répertoires dans L'exemple D'Adaephon est

for subparser in [parser_a, parser_b]:
   subparser.format_help()

Python vous permet d'accéder à des attributs cachés comme parser._actions, mais ce n'est pas encouragée. Il est tout aussi facile de construire votre propre liste tout en définissant l'analyseur. En va de même pour faire des choses spéciales avec les arguments. add_argument et add_subparser retourner leurAction et Parser objets pour une raison.

si je faisais une sous-classe de ArgumentParser je me sentirais libre à utilisez _actions. Mais pour une application unique, construire ma propre liste serait plus clair.

Un exemple:

import argparse

parser = argparse.ArgumentParser()
parser.add_argument('mainpos')
parser.add_argument('--mainopt')
sp = parser.add_subparsers()
splist = []   # list to collect subparsers
sp1 = sp.add_parser('cmd1')
splist.append(sp1)
sp1.add_argument('--sp1opt')
sp2 = sp.add_parser('cmd2')
splist.append(sp2)
sp2.add_argument('--sp2opt')

# collect and display for helps    
helps = []
helps.append(parser.format_help())
for p in splist:
   helps.append(p.format_help())
print('\n'.join(helps))

# or to show just the usage
helps = []
helps.append(parser.format_usage())
for p in splist:
   helps.append(p.format_usage())
print(''.join(helps))

Le combiné à l'utilisation de l'affichage est le suivant:

usage: stack32607706.py [-h] [--mainopt MAINOPT] mainpos {cmd1,cmd2} ...
usage: stack32607706.py mainpos cmd1 [-h] [--sp1opt SP1OPT]
usage: stack32607706.py mainpos cmd2 [-h] [--sp2opt SP2OPT]

l'affichage des aides combinées est long et redondant. Il peut être édité de différentes manières, soit après le formatage, soit avec des formateuses spéciales d'aide. Mais qui va faire de tels choix?

j'ai aussi pu imprimer une courte aide pour les commandes utilisant _choices_actions.

def print_help(parser):
  print(parser.description)
  print('\ncommands:\n')

  # retrieve subparsers from parser
  subparsers_actions = [
      action for action in parser._actions 
      if isinstance(action, argparse._SubParsersAction)]
  # there will probably only be one subparser_action,
  # but better save than sorry
  for subparsers_action in subparsers_actions:
      # get all subparsers and print help
      for choice in subparsers_action._choices_actions:
          print('    {:<19} {}'.format(choice.dest, choice.help))

j'ai quelques wrappers simples qui stockent de diverses références (Analyseur, sous-Analyseur, StoreAction) séquentiellement, pour une itération facile pendant la génération d'aide.

je suis maintenant organisé, verbeux, sortie d'aide générée automatiquement. Je vais poster un aperçu quand j'ai une chance.

il y a un inconvénient, et qui a à voir avec le contenu d'aide généré sur les Arguments optionnels: il n'est pas très bon. L'amélioration de ces sorties d'aide nécessitera plus qu'une enveloppe (si nous tu veux le garder propre). Mais si vous voulez une bonne vue d'ensemble de l'aide pour les programmes en évolution, cela devrait satisfaire la plupart.