2012-06-07 15 views
25

Estoy tratando de aprender a usar el módulo argparse de python. Actualmente mi script en Python es:Ejemplo de uso del programa de impresión con el módulo argparse

parser = argparse.ArgumentParser(description='My first argparse attempt', 
           add_help=True) 
parser.add_argument("-q", action ="store", dest='argument', 
        help="First argument") 
output = parser.parse_args() 

Y da la salida como:

usage: test.py [-h] [-q ARGUMENT] 

My first argparse attempt 

optional arguments: 
    -h, --help show this help message and exit 
    -q ARGUMENT First argument 

Ahora, vamos a suponer que quiero mi argumento -h or --help para imprimir una usage example también. Al igual que,

Usage: python test.py -q "First Argument for test.py" 

Mi propósito es imprimir el ejemplo anterior el uso junto con el contenido por defecto de -h argumento de modo que el usuario puede obtener una idea básica de cómo usar el script test.py pitón.

Por lo tanto, ¿esta función está incorporada en el módulo argparse? Si no, ¿cuál es la forma correcta de abordar este problema?

Respuesta

34

Utilice parser.epilog para mostrar algo después del texto generado -h.

parser = argparse.ArgumentParser(
    description='My first argparse attempt', 
    epilog='Example of use') 

output = parser.parse_args() 

impresiones:

My first argparse attempt 

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

Example of use 
+0

, gracias por la respuesta. – RanRag

+17

@Noob: tenga en cuenta que el espacio en blanco se eliminará de su descripción y epilog (que a menudo no es bueno para "Ejemplos de uso". Para permitir que desee el 'argparse.RawDescriptionHelpFormatter' (http://docs.python.org) /dev/library/argparse.html#argparse.RawDescriptionHelpFormatter) – mgilson

+1

¿Hay alguna manera de usar argparse.RawDescriptionHelpFormatter solo para el epilog y no para la descripción? Quiero que la descripción se ajuste automáticamente, pero quiero ocuparme de la formateo de epílogo. – user2015487

Cuestiones relacionadas