¿Cuál es la forma estándar de escribir "información de copyright" en el código python? ¿Debería estar dentro de docstring o en comentarios de bloque? No pude encontrarlo en PEP.Escribir información de copyright en código python
Algunos proyectos utilizan las variables de módulo como __license__, como en:
__author__ = "Software Authors Name"
__copyright__ = "Copyright (C) 2004 Author Name"
__license__ = "Public Domain"
__version__ = "1.0"
parece una solución bastante limpio para mí (a menos que exagere y descargue textos épicos en estas variables), pero solo __version__ parece tener un uso generalizado, como se menciona en PEP 8.
Bastante limpio, pero en la mayoría de las organizaciones, al redistribuir un software, el copyright es mucho texto. Aunque me pregunto por qué no está incluido en PEP. – Shefali
Encontré una versión más elaborada aquí: http://bayes.colorado.edu/PythonGuidelines.html#names – Shefali
@Shefali: enlace roto –
# Comment in the beginning of the file
Por lo menos, los módulos incorporados de Python lo hacen. (se descubrió haciendo grep 'Copyright' /usr/lib64/python2.4/*.py)
¿Alguna sugerencia que especifique la forma exacta? – Shefali
Eso no es motivo (como es el mío) -1 :) –
@Shefali estaba pidiendo 'la forma estándar de escribir' información de copyright '', no si era necesario escribir la información. Es por eso que creo que mi voto negativo está justificado, mientras que el tuyo parece una venganza rencorosa. – Kimvais
Como sé, actualmente no existe una forma estándar. Cada empresa/organización tendrá su propia plantilla para documentar la información de copyright. Si este es su proyecto personal, siéntase libre de hacerlo de la manera que se sienta más cómodo. Agregar un archivo LICENSE es una forma muy común para proyectos con muchos archivos fuente. Incluso en Python, actualmente no existe un estándar en la estructura de docstrings.
Python proporciona mucha libertad, por lo que sólo deja que sea loco;)
¿Por qué volver a etiquetar esto con licencia y sin derechos de autor? – Kimvais
Tienes razón, cambiaste las etiquetas. –
@lutz: wtf? se trata del estilo del mensaje de copyright en el código python. no solo mensajes de copyright en Python. – SilentGhost