Anzeige pydocs Beschreibung als Teil von argparse '--help'

Question

Ich benutze argparse.ArgumentParser() in meinem Skript möchte ich die pydoc Beschreibung meines Skripts als Teil der Option '--help' anzeigen der Argarse.

Eine eventuelle Lösung kann die formatter_class oder das description Attribut ArgumentParser zu verwenden, um die Anzeige von Hilfe zu konfigurieren. In diesem Fall müssen wir intern den Befehl 'pydoc' verwenden, um die Beschreibung abzurufen.

Haben wir andere (vielleicht elegante) Möglichkeiten, es zu tun?

Answer 1

Sie können den Docstring Ihres Skripts aus dem globalen Verzeichnis __doc__ abrufen. Um es der Hilfe Ihres Skripts hinzuzufügen, können Sie das Argument description des Parsers festlegen.

"""My python script 

Script to process a file 
""" 

p = argparse.ArgumentParser(description=__doc__, 
          formatter_class=argparse.RawDescriptionHelpFormatter) 
p.add_argument('foo', help="Name of file to process") 
p.parse_args() 

Dann wird die Hilfe wie folgt aussehen:

$ python tmp.py --help 
usage: tmp.py [-h] foo 

My python script 

Script to process a file 

positional arguments: 
    foo   Name of file to process 

optional arguments: 
    -h, --help show this help message and exit 

Sie die statt descriptionepilog Schlüsselwort-Argument verwenden, um die docstring bis zum Ende der Hilfe, statt unmittelbar nach der Nutzung Zeichenfolge zu bewegen.