Articles of cadena de documentación de

¿Por qué no se escapa automáticamente Python ‘\’ en __doc__?

Parece que algunos caracteres de escape aún son importantes en la cadena de documentación. Por ejemplo, si ejecutamos python foo.py ( Python 2.7.10 ), emitirá un error como ValueError: invalid \x escape . def f(): “”” do not deal with ‘\x0’ “”” pass Y en efecto, parece que la documentación correcta debería ser: “”” do […]

Más de 1 docstrings para un solo módulo / función, etc.

Estoy usando python 3.1. ¿Es posible crear más de 1 cadena de documentos para un solo módulo o función? Estoy creando un progtwig, y ​​tengo la intención de tener varias cadenas de documentos con una categoría para cada uno. Tengo la intención de darles el progtwig a otras personas para que puedan usarlo, y para […]

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

Tengo un script en Python con un docstring. Cuando el análisis de los argumentos de la línea de comando no tiene éxito, quiero imprimir la cadena de documentos para la información del usuario. ¿Hay alguna manera de hacer esto? Ejemplo minimo #!/usr/bin/env python “”” Usage: script.py This describes the script. “”” import sys if len(sys.argv) […]

¿Por qué no se imprimió la cadena en la parte superior de esta función?

Encontré la siguiente función en un tutorial. Cuando llamo a la función, “This prints a passed string into this function” no se imprime. ¿Por qué la función no imprime este texto cuando se llama? def printme(str): “This prints a passed string into this function” print str return # Now you can call printme function printme(“I’m […]

Imprimir (__ doc__) en el script Python 3

No puedo entender qué hace la print(__doc__) al principio de un script, como en este ejemplo de Scikit . He estado buscando las cadenas de documentación de Python en google, y parece que __doc__ es útil para proporcionar alguna documentación en, digamos, funciones. Pero no puedo ver qué hace __doc__ en medio de un script.

Cómo poner una variable en la cadena de documentación de Python

Así que estoy tratando de crear una cadena de documentos “dinámica” que es algo como esto: ANIMAL_TYPES = [“mammals”, “reptiles”, “other”] def func(animalType): “”” This is a sample function. @param animalType: “It takes one of these animal types %s” % ANIMAL_TYPES “”” para que básicamente la cadena de documentos para @param animalType muestre lo que […]

Función de “ayuda” de Python: impresión de cadenas de documentación

¿Hay una opción para imprimir la salida de ayuda (‘myfun’). El comportamiento que estoy viendo es que la salida se imprime en std.out y la secuencia de comandos espera la entrada del usuario (es decir, escriba ‘q’ para continuar). Debe haber una configuración para configurar esto solo para volcar cadenas de documentos. Alternativamente, si pudiera […]

¿Cómo configuro mediante progtwigción la cadena de documentos?

Tengo una función de envoltorio que devuelve una función. ¿Hay una manera de establecer mediante progtwigción la cadena de documentos de la función devuelta? Si pudiera escribir a __doc__ , haría lo siguiente: def wrapper(a): def add_something(b): return a + b add_something.__doc__ = ‘Adds ‘ + str(a) + ‘ to `b`’ return add_something Entonces podria […]

Cómo comentar un bloque de código en Python

¿Existe un mecanismo para comentar grandes bloques de código Python? En este momento, las únicas formas que puedo ver de comentar un código es comenzar cada línea con un # o encerrar el código entre comillas triples: “”” . El problema con estos es que insertar # antes de cada línea es engorroso y “”” […]