Написание информации об авторских правах в коде python

каков стандартный способ написания "информации об авторских правах" в коде python? Должен ли он быть внутри docstring или в комментариях блока? Я не мог найти его в ПД.

22
coding-style copyright-display python

4 ответов

некоторые проекты используют переменные модуля как __license__, например:

__author__ = "Software Authors Name"
__copyright__ = "Copyright (C) 2004 Author Name"
__license__ = "Public Domain"
__version__ = "1.0"

кажется мне довольно чистым решением (если вы не переусердствуете и не сбросите эпические тексты в эти переменные), но только __version__ Кажется, широко используется, как указано в PEP 8.

22
# Comment in the beginning of the file

по крайней мере, встроенные модули python делают это. (узнал, сделав grep 'Copyright' /usr/lib64/python2.4/*.py)

12

мы следуем рекомендациям, найденным (где-то) в центре программного обеспечениясайт. здесь является примером простого файла GPL'Ed.

3

насколько я знаю, в настоящее время нет стандартного способа. Каждая компания / организация будет иметь свой собственный шаблон для документирования информации об авторских правах. Если это ваш личный проект, то просто не стесняйтесь документировать его так, как вы чувствуете себя наиболее комфортно. Добавление LICENSE file-очень распространенный способ для проектов со многими исходными файлами. Даже в Python в настоящее время нет стандарта на структуру docstrings.

Python предоставляет много свободы, так что пусть это будет чувак;)

2