Personnaliser le message d'aide argparse

tout d'abord: capitaliser ces phrases vole en face de la convention, et argparse n'est pas vraiment outillé pour vous aider à changer ces chaînes facilement. Vous avez trois classes différentes de chaînes ici: texte boilerplate de l'aide formatter, titres de section, et texte d'aide par option spécifique. Toutes ces chaînes sont localisables; vous pourrait juste fournir une traduction' capitalisée 'pour toutes ces chaînes via le module gettext() soutenez . Cela dit, Vous pouvez atteindre et remplacer toutes ces chaînes si vous êtes suffisamment déterminé et lire le code source un peu .

l'action version inclut un texte par défaut help , mais vous pouvez fournir le vôtre en paramétrant l'argument help . La même chose s'applique à l'action help ; si vous définissez add_help argument à False vous pouvez ajouter cette action manuellement:

parser = argparse.ArgumentParser(add_help=False)

parser.add_argument('-v', '--version', action='version',
                    version='%(prog)s 1.0', help="Show program's version number and exit.")
parser.add_argument('-h', '--help', action='help', default=argparse.SUPPRESS,
                    help='Show this help message and exit.')

ensuite, le message optional arguments est un group title ; chaque analyseur a deux groupes par défaut, l'un pour les arguments de position, l'autre pour optionnel. Vous pouvez les atteindre par les attributs _positionals et _optionals , qui ont tous deux un attribut title :

parser._positionals.title = 'Positional arguments'
parser._optionals.title = 'Optional arguments'

soyez averti , en accédant aux noms commençant par un underscore vous vous aventurez dans le API privée non documentée du module, et votre code peut se casser dans de futures mises à jour.

enfin, pour changer la chaîne de caractères usage , vous devrez sous-classe le formateurd'aide; passer la sous-classe en tant que formatter_class argument :

class CapitalisedHelpFormatter(argparse.HelpFormatter):
    def add_usage(self, usage, actions, groups, prefix=None):
        if prefix is None:
            prefix = 'Usage: '
        return super(CapitalisedHelpFormatter, self).add_usage(
            usage, actions, groups, prefix)

parser = argparse.ArgumentParser(formatter_class=CapitalisedHelpFormatter)

de Démonstration, la mise de ces tous ensemble:

>>> import argparse
>>> class CapitalisedHelpFormatter(argparse.HelpFormatter):
...     def add_usage(self, usage, actions, groups, prefix=None):
...         if prefix is None:
...             prefix = 'Usage: '
...         return super(CapitalisedHelpFormatter, self).add_usage(
...             usage, actions, groups, prefix)
...
>>> parser = argparse.ArgumentParser(add_help=False, formatter_class=CapitalisedHelpFormatter)
>>> parser._positionals.title = 'Positional arguments'
>>> parser._optionals.title = 'Optional arguments'
>>> parser.add_argument('-v', '--version', action='version',
...                     version='%(prog)s 1.0', help="Show program's version number and exit.")
_VersionAction(option_strings=['-v', '--version'], dest='version', nargs=0, const=None, default='==SUPPRESS==', type=None, choices=None, help="Show program's version number and exit.", metavar=None)
>>> parser.add_argument('-h', '--help', action='help', default=argparse.SUPPRESS,
...                     help='Show this help message and exit.')
_HelpAction(option_strings=['-h', '--help'], dest='help', nargs=0, const=None, default='==SUPPRESS==', type=None, choices=None, help='Show this help message and exit.', metavar=None)
>>> print(parser.format_help())
Usage: [-v] [-h]

Optional arguments:
  -v, --version  Show program's version number and exit.
  -h, --help     Show this help message and exit.