Насколько я понимаю, строка документации модуля должна просто предоставлять общее описание того, что делает модуль, а такие подробности, как автор и версия, должны содержаться только в комментариях к модулю.
Однако я видел следующее в комментариях и строк документации:
__author__ = "..."
__version__ = "..."
__date__ = "..."
Где правильно размещать такие предметы? Какие другие переменные __[name]__ обычно указываются в верхней части модулей?
Это просто условности, хотя и довольно широко используемые. См. это описание набора требований к метаданным Python.
__version__ упоминается в Руководстве по стилю Python.
Что касается строк документации, для вас есть PEP!
Строка документации для модуля обычно должна содержать список классов, исключений и функций (и любых других объектов), экспортируемых модулем, с однострочным описанием каждого из них. (Эти сводки обычно содержат меньше деталей, чем сводная строка в строке документации объекта.) Строка документации для пакета (т. е. строка документации модуля init.py пакета) также должна содержать список экспортированных модулей и подпакетов. по упаковке.
Я бы посоветовал не беспокоиться о __author__, __version__ и т. д. Эти атрибуты в любом случае обрабатываются любой приличной системой контроля версий. Добавляйте их только в том случае, если вам нужно иметь эту информацию в производственной системе, где исходный код уже был экспортирован из системы контроля версий.
