Articles of docstring

¿Por qué python docstring se interpreta de manera diferente del comentario?

Digamos, tengo una función como esta: def myFunc(): # useful function to calculate stuff Esto producirá un error de sangría, a menos que agregue un pass : def myFunc(): # useful function to calculate stuff pass Sin embargo, si sustituyo un comentario con docstring, no es necesario ningún pass : def myFunc(): “””useful function to […]

¿Cuál es la ventaja de tener literales de cadena multilínea y de una sola línea en python?

Sé que las cadenas de comillas triples se utilizan como cadenas de documentación, pero ¿hay una necesidad real de tener dos literales de cadena? ¿Hay algún caso de uso cuando la identificación entre una línea y una línea múltiple sea útil? en Clojure tenemos 1 cadena literal, es multilínea y la usamos como cadena de […]

Implementando una propiedad de clase que preserva la cadena de documentos.

Tengo un descriptor que convierte un método en una propiedad en el nivel de clase: class classproperty(object): def __init__(self, getter): self.getter = getter self.__doc__ = getter.__doc__ def __get__(self, instance, owner): return self.getter(owner) Utilizado de esta manera: class A(object): @classproperty def test(cls): “docstring” return “Test” Sin embargo, ahora no puedo acceder al atributo __doc__ (lo cual […]

Python establece la cadena de documentación y obtiene el nombre del método del método de clase generado dinámicamente

Intento obtener / establecer el nombre y la cadena de documentación de los métodos de clase creados dinámicamente de la siguiente manera, pero tengo problemas para averiguar exactamente cómo hacerlo: import sys import inspect class test(object): pass @classmethod def genericFunc(cls, **kwargs): print “function:”, (inspect.stack()[0][3]) print “kwargs:”, kwargs function_list = [‘myF1’, ‘myF2’] for func in function_list: […]

¿Se almacenan en la memoria las cadenas de documentación y los comentarios de Python cuando se carga un módulo?

¿Se almacenan en la memoria las cadenas de documentación y los comentarios de Python cuando se carga un módulo? Me he preguntado si esto es cierto, porque generalmente documento bien mi código; ¿Esto puede afectar el uso de la memoria? Por lo general, cada objeto de Python tiene un método __doc__ . ¿Son esas cadenas […]

sobre python __doc__ docstring

Quiero mostrar la cadena de documentos de mi función, pero si uso así @cost_time def func(): “define ….” blabla print func.__doc__ no mostrará la cadena de documentos, solo porque uso un poco de progtwigción meta complicada, ¿cómo puedo arreglar esto?

¿Qué significa estos formatos en la cadena de documentación de twisted?

En el código fuente de twisted, muchas cadenas de documentación contienen formatos como este: L {xxx} o C {xxx} o una línea que comienza con una ‘@’, ¿cuál es su significado? por ejemplo, en twisted / internet / interfaces.py: def registerProducer(producer, streaming): “”” Register to receive data from a producer. … For L{IPullProducer} providers, C{resumeProducing} […]

Pycharm: Generar automáticamente el campo `: type param:` en docstring

Cuando creo una función con parámetros, PyCharm me ofrece crear la cadena de documentos con el campo :param param_name: que es bastante bueno. Pero también necesito agregar el :type param_name: Así que a partir de eso: def foo(bar, xyz): return bar + xyz Con la opción generar cadena de documentos tengo eso (incluso con Insertar […]

¿Cómo escribir docstrings significativos?

¿Qué, en tu opinión es una cadena documental significativa? ¿Qué esperas para ser descrito allí? Por ejemplo, considere el __init__ esta clase de __init__ : def __init__(self, name, value, displayName=None, matchingRule=”strict”): “”” name – field name value – field value displayName – nice display name, if empty will be set to field name matchingRule – […]

Referencia a parámetros en una cadena de documentación de Python

Uso Sphinx y la función de autodocs para asegurar que tengamos buena documentación en nuestro proyecto. Así que estoy familiarizado con las listas de campos de información y estoy familiarizado con el uso de referencias cruzadas en nuestros documentos. Sin embargo, cuando escribo docstring para un método o función, me parece útil referirme a sus […]