Módulo Docopt en Python

Docopt es un módulo de descripción de interfaz de línea de comandos. Le ayuda a definir una interfaz para una aplicación de línea de comandos y genera un analizador para ella. El mensaje de interfaz en docopt es un mensaje de ayuda formalizado.

Instalación

Puede instalar el módulo docopt de varias maneras, pip es una de las mejores formas de instalar docopt.

$pip install docopt

Nota: docopt se prueba con Python 2.5, 2.6, 2.7, 3.2, 3.3 y PyPy también.

Inicialización

docopt se usa más comúnmente para mostrar los mensajes de ayuda y se invoca con la opción -h o –help. Puede importar y llamar a este módulo con el siguiente comando.

from docopt import docopt
  
docopt(doc, argv = None, version = None,
       help = True, options = False)

Los parámetros del módulo son los que se muestran a continuación:

• doc : Es un docstring (__doc__) que contiene el mensaje de ayuda.
• argv: es un vector de argumento opcional que contiene una lista de strings.
• version : Es un argumento opcional que menciona la versión del programa.
• ayuda: Responsable de mostrar el mensaje de ayuda. Es Verdadero por defecto.
• options_first : esto no permite mezclar argumentos posicionales y argumentos opcionales. Por defecto es Falso.

Patrón de uso

docopt le brinda un fuerte control sobre su página de ayuda y consiste en la palabra clave de uso que no distingue entre mayúsculas y minúsculas seguida de su nombre_programa. Un patrón de uso se puede describir con varios elementos, como se menciona a continuación:

usage =
'''
Usage : 
  program_name.py command --option
  program_name.py [optional argument]
  program_name.py --another-option =<argument>
  program_name.py (--option1 | --option2 )
  program_name.py  <argument>...
  
'''

<argumento> argumento: El elemento que comienza con «<» y termina con «>» se denomina argumento posicional. Es sensible a la posición.

–opción -o: El elemento que comienza con “–” o “-” se llama opción larga o corta. Puede mencionarse como --optiono -o.

  -h, --help     Display help
  -o, --option   Display options
  -l, --all      List all
  -q, --quit     exit
  --version      Version 3.6.1 

[argumento opcional]: el elemento que comienza con «[» y termina con «]» se denomina argumento opcional. Se considera opcional.

< argumento >… : Los puntos suspensivos “…” se utilizan cuando el elemento presente a la izquierda puede repetirse más de una vez.

(argumentos requeridos): los elementos que comienzan con «(» y terminan con «)» son un elemento requerido. (--option1 | --option2)dice que se requiere cualquiera de –option1 o –option2.

Ejemplo :

# filename ='docopt_example.py"
  
usage ='''
Usage:
    
  docopt_example.py  [(<name1>|<name2>)] <name3>...
  docopt_example.py  mov <name1> <name2>
  docopt_example.py  (--h|--q) [<name1> -l]
  docopt_example.py  --version
  
Options:
  
  -l, --all      List all.
  -q, --quit     exit.
  --version      Version 3.6.1 
  -h --help      Show this screen.
  --version      Show version.
  --speed =<kn>   Speed in knots [default: 10].
  --moored       Moored (anchored) mine.
  --drifting     Drifting mine.   
    
'''  
    
from docopt import docopt
args = docopt(usage)
print(args)

Producción :