Я кодирующая около года в Python, и я только что через какой-то код в Theano tutorial, который объявляет переменную в верхней части файла:Что такое "__docformat__", используемый для Python?
__docformat__ = 'restructedtext en'
Поиск Интернет производится this PEP документации. Хотя он все еще не ясно объясняет, когда/почему вы хотите указать эту переменную.
Должен ли я объявлять его в верхней части всего моего кода на Python?
Пункт __docformat__ состоит в том, чтобы разрешить инструменты для создания документации python, такие как epydoc, чтобы знать, как правильно разбирать документацию модуля (например, какой язык разметки следует ожидать).
От epydoc docs:
Чтобы указать язык разметки для модуля, вы должны определить переменную __docformat__ струнного модуля уровня, содержащее название языка разметки модуля. Название языка разметки может сопровождаться кодом языка (например, en для английского). Обычно определение переменной __docformat__ непосредственно следует строка документации модуля
Однако многие инструменты, такие как epydoc также поддерживает определение языка разметки с помощью командной строки (например, epydoc --docformat restructuredtext), так что нет строгой необходимости включать DOCFORMAT. Это больше похоже на то, что касается кодирования для вашего проекта или организации.