¿Cómo puedo imprimir la cadena de documentación de un archivo de Python al ejecutarlo?

Tengo un script de Python con una cadena de documentación. Cuando el análisis de los argumentos de la línea de comandos no tiene éxito, quiero imprimir la cadena de documentación para la información del usuario.

¿Hay alguna manera de hacer esto?

Ejemplo mínimo

#!/usr/bin/env python
"""
Usage: script.py

This describes the script.
"""

import sys


if len(sys.argv) < 2:
    print("<here comes the docstring>")

El docstring se almacena en el módulo __doc__ global.

print(__doc__)

Por cierto, esto vale para cualquier módulo: import sys; print(sys.__doc__). Las cadenas de documentos de funciones y clases también están en su __doc__ atributo.

El análisis de argumentos siempre debe hacerse con argparse.

Puede mostrar la __doc__ cadena pasándola al description parámetro de Argparse:

#!/usr/bin/env python
"""
This describes the script.
"""


if __name__ == '__main__':
    from argparse import ArgumentParser
    parser = ArgumentParser(description=__doc__)
    # Add your arguments here
    parser.add_argument("-f", "--file", dest="myFilenameVariable",
                        required=True,
                        help="write report to FILE", metavar="FILE")
    args = parser.parse_args()
    print(args.myFilenameVariable)

Si llamas a esto misuperíndice.py y ejecutarlo se obtiene:

$ ./mysuperscript.py --help
usage: mysuperscript.py [-h] -f FILE

This describes the script.

optional arguments:
  -h, --help            show this help message and exit
  -f FILE, --file FILE  write report to FILE

Aquí hay una alternativa que no codifica el nombre de archivo del script, sino que usa sys.argv[0] para imprimirlo El uso de %(scriptName)s en lugar de %s mejora la legibilidad del código.

#!/usr/bin/env python
"""
Usage: %(scriptName)s

This describes the script.
"""

import sys
if len(sys.argv) < 2:
   print __doc__ % {'scriptName' : sys.argv[0].split("https://stackoverflow.com/")[-1]}
   sys.exit(0)

Esta voluntad imprimir el __doc__ cuerda cuando --help es el único argumento.

if __name__=='__main__':
 if len(sys.argv)==2 and sys.argv[1]=='--help':
    print(__doc__)

Funciona para ambos:

• ./yourscriptname.py --help
• python3 yourscriptname.py --help

Una mejora de la respuesta de @MartinThoma para que imprima cadenas de documentos de varias líneas inspiradas en Python argparse: ¿Cómo insertar una nueva línea en el texto de ayuda?

El análisis de argumentos siempre debe hacerse con argparse.

Puede mostrar la doc cadena pasándola al parámetro de descripción de Argparse:

#!/usr/bin/env python 
""" 
This summarizes the script.

Additional descriptive paragraph(s).
"""  # Edited this docstring


if __name__ == '__main__':
    from argparse import ArgumentParser, RawTextHelpFormatter  # Edited this line
    parser = ArgumentParser(description=__doc__
                            formatter_class=RawTextHelpFormatter)  # Added this line
    # Add your arguments here
    parser.add_argument("-f", "--file", dest="myFilenameVariable",
                        required=True,
                        help="write report to FILE", metavar="FILE")
    args = parser.parse_args()
    print(args.myFilenameVariable) 

Si llama a esto mysuperscript.py y lo ejecuta, obtiene:

$ ./mysuperscript.py --help
usage: mysuperscript.py [-h] -f FILE

This summarizes the script.

Additional descriptive paragraph(s).

optional arguments:
  -h, --help            show this help message and exit
  -f FILE, --file FILE  write report to FILE

Sin la adición de la formatter_class la salida no tendría el salto de línea en la cadena de documentación.