Qual è il modo standard di scrivere "informazioni sul copyright" in codice Python? Dovrebbe essere all'interno di docstring o nei commenti di blocco? Non riuscivo a trovarlo nei PEP.Scrittura informazioni sul copyright in python code
Alcuni progetti utilizzano variabili di modulo come __license__, come in:
__author__ = "Software Authors Name"
__copyright__ = "Copyright (C) 2004 Author Name"
__license__ = "Public Domain"
__version__ = "1.0"
sembra una soluzione abbastanza pulito per me (a meno che non si esageri e si scarichi testi epici in queste variabili), ma solo il __version__ sembra essere ampiamente utilizzato, come menzionato in PEP 8.
Abbastanza pulito, ma nella maggior parte delle organizzazioni, mentre la ridistribuzione di un software, il copyright è un sacco di testo. Anche se mi chiedo perché non è incluso in PEP. – Shefali
Trovato qui una versione più elaborata: http://bayes.colorado.edu/PythonGuidelines.html#names – Shefali
@Shefali: collegamento interrotto –
# Comment in the beginning of the file
Almeno i moduli Python integrati fanno questo. (scoperto facendo grep 'Copyright' /usr/lib64/python2.4/*.py)
Eventuali puntatori che specificano il modo esatto? – Shefali
Questo non è un motivo (come il mio) -1 :) –
@Shefali chiedeva "il modo standard di scrivere" informazioni sul copyright "" non se è necessario scrivere le informazioni. Ecco perché penso che il mio downvote sia giustificato, mentre il tuo sembra una dispettosa vendetta. – Kimvais
Come noto, attualmente non esiste un modo standard. Ogni azienda/organizzazione avrà il proprio modello per documentare le informazioni sul copyright. Se questo è il tuo progetto personale, allora sentiti libero di documentarlo nel modo in cui ti senti più confortevole. L'aggiunta di un file LICENSE è un modo molto comune per progetti con molti file sorgente. Anche in Python, non esiste attualmente uno standard sulla struttura delle docstring.
Python fornisce un sacco di libertà, quindi basta avvenga tizio;)
Perché ritentare questo con licenza e non con copyright? – Kimvais
Hai ragione, tag modificati. –
@lutz: wtf? riguarda lo stile del messaggio di copyright in codice Python. non solo un messaggio di copyright in python. – SilentGhost