Vorrei aggiungere alcune meta informazioni alle docstring dei miei moduli Python, come autore, email, versione. C'è un modo canonico per farlo? Ho cercato un po ', ma non ho trovato nulla con un'autorità definita, qui o sul web.Modo canonico in Python per aggiungere o recuperare le meta informazioni da/per docstring?
PEP 426 -- Metadata for Python Software Packages 2.0 ne parla un po '. E sembra __author__, __version__ e alcuni altri sono riconosciuti da pydoc (V2.7). Inoltre, c'è epydoc e sphinx-doc.
Esiste un modo standard per includere tali informazioni nella docstring? O come variabili globali? In tal caso, esiste un elenco di parole chiave/nomi di variabili accettati?
Esempio:
#########
# Parts
# <description>
#
"""Helper module for selling car parts on the web.
Author: Sue Baru
EMail: [email protected]
Version: 1.0
"""
Aggiornamento
Questo non è davvero una risposta, ma ho finito per usare la 'parola chiave' __author__ e nient'altro. Il controllo delle versioni si ottiene effettuando il check in un repository git.
Per amore di dio, non utilizzare variabili globali :). –
@BhavishAgarwal - cose come '__version__' sono usate da * LOTS * di pacchetti. Non è il massimo, ma non penso ci sia niente di meglio. È anche menzionato in [PEP3001] (http://www.python.org/dev/peps/pep-3001/#unification-of-module-metadata). In definitiva, tuttavia, quando si parla di docstring, non sono a conoscenza dei vari strumenti che seguono una convenzione specifica. – mgilson
@ mgilson, per la mancanza di standard e supponendo che questo sia per uso interno, perché non memorizzare queste informazioni come stringa json? –