Общий формат заголовка в Python

Заголовок - это блок комментариев в верхней части кода, который включает имя файла, автора, дату и некоторые другие сведения о файле и его содержимом. За этим следует импорт встроенных модулей и импорт сторонних производителей. Этот формат может отличаться от программиста к программисту.

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

В следующем коде показан общий формат заголовка, используемый в Python.

#!/usr/bin/env python3  Line 1
# -*- coding: utf-8 -*- Line 2
#----------------------------------------------------------------------------
# Created By  : name_of_the_creator   Line 3
# Created Date: date/month/time ..etc
# version ='1.0'
# ---------------------------------------------------------------------------
""" Details about the module and for what purpose it was built for"""  #Line 4
# ---------------------------------------------------------------------------
# Imports Line 5
# ---------------------------------------------------------------------------
from ... import ...  #Line 6

Первая строка, (#!/usr/bin/env python3 ), упрощает запуск файла как сценария путем неявного вызова интерпретатора, поскольку эта строка является исполняемым сценарием. Он также информирует пользователя о том, что код написан для определенного формата, в данном случае Python3.

Для кодирования используется строка ( -*- coding: utf-8 -*-). Это процесс преобразования данных из одной формы в другую. UTF означает формат преобразования Unicode, а 8 означает, что в процессе кодирования используются 8-битные значения. Существует несколько типов кодировок (UTF-16, UTF-34 и т. Д.), Но в Python 3 набором символов по умолчанию является UTF-8.

Третья строка содержит сведения об авторе, дате, номере версии, авторах, электронной почте, статусе, лицензии, авторских правах и т. Д.

Четвертая строка - это строка документации, обозначенная (""" """), которая документирует модуль и с какой целью он был создан. Это удобный способ связывания со всеми функциями, классами и методами. Он уникально указан для описания конкретного кода.

Следующая строка содержит импорт встроенных модулей, используемых в коде, например, os Module, sys Module, math Module и т. Д.

В последней строке указывается весь импорт сторонних модулей, например, NumPy, Matplotlib и т. Д.