Стандартный формат заголовков в Python

Стандартное оформление заголовков в файлах Python — это тема, которая часто вызывает вопросы у начинающих программистов. Давайте посмотрим на типичный пример заголовка Python и разберем его по частям:

#!/usr/bin/env python

"""Module.py: Описание того, что делает модуль."""

__author__      = "Имя Автора"
__copyright__   = "Copyright 2021, Название компании"

Первая строка #!/usr/bin/env python — это так называемая «ше-банг» строка. Она используется в Unix-подобных системах и указывает, какой интерпретатор использовать для выполнения скрипта. В этом случае, она говорит системе использовать Python.

Следующая строка — это строка документации модуля или «docstring». Она обычно содержит краткое описание того, что делает модуль.

__author__ и __copyright__ — это так называемые «магические» атрибуты или «dunder» атрибуты (от «double underscore»). Они обычно содержат информацию о том, кто написал модуль и информацию о правах на использование и копирование модуля.

Это лишь основные элементы, которые обычно присутствуют в заголовках Python. Однако, в зависимости от конкретных требований проекта, в заголовок могут быть добавлены и другие элементы. Например, в некоторых проектах могут быть указаны дополнительные «dunder» атрибуты, такие как __license__, __version__ или __maintainer__.

Важно понимать, что нет строгого стандарта оформления заголовков, и в разных проектах они могут выглядеть по-разному. Однако, приведенный выше формат является наиболее общим и широко используется в сообществе Python.