Mostra la descrizione di pydoc come parte di argparse '--help'

Question

Sto usando argparse.ArgumentParser() nel mio script, vorrei visualizzare la descrizione pydoc del mio script come parte dell'opzione '--help' dell'argparse.

Una possibilmente soluzione può essere quella di utilizzare il formatter_class o l'attributo description di ArgumentParser per configurare la visualizzazione di aiuto. Ma in questo caso, dobbiamo usare il comando 'pydoc' internamente per recuperare la descrizione.

Abbiamo altri modi (possibilmente eleganti) per farlo?

Answer 1

È possibile recuperare la docstring del proprio script dal __doc__ globale. Per aggiungerlo alla guida dello script, è possibile impostare l'argomento description del parser.

"""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() 

Poi l'aiuto sarà simile:

$ 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 

È possibile utilizzare l'argomento epilog parola chiave invece di description per spostare il docstring alla fine del aiuto, invece di subito dopo la stringa di utilizzo.