- en
- Language: ru
- Documentation version: latest
Соглашение об именах
В Python есть определенные соглашения об именовании объектов.
В целом, лучше придерживаться этих соглашений. Однако, если в определенной библиотеке или модуле используются другие соглашения, то стоит придерживаться того стиля, который используется в них.
В этом разделе описаны не все правила. Подробнее можно почитать в документе PEP8 на английском или на русском.
Имена переменных
Имена переменных не должны пересекаться с операторами и названиями модулей или других зарезервированных значений.
Имена переменных обычно пишутся полностью большими или маленькими буквами. В пределах одного скрипта/модуля/пакета лучше придерживаться одного из вариантов.
Если переменные - константы для модуля, то лучше использовать имена, написанные заглавными буквами:
DB_NAME = 'dhcp_snooping.db'
TESTING = True
Для обычных переменных лучше использовать имена в нижнем регистре:
db_name = 'dhcp_snooping.db'
testing = True
Имена модулей и пакетов
Имена модулей и пакетов задаются маленькими буквами.
Модули могут использовать подчеркивания между словами для того, чтобы имена были более понятными. Для пакетов лучше выбирать короткие имена.
Имена функций
Имена функций задаются маленькими буквами, с подчеркиваниями между словами.
def ignore_command(command, ignore):
ignore_command = False
for word in ignore:
if word in command:
return True
return ignore_command
Имена классов
Имена классов задаются словами с заглавными буквами, без пробелов.
class CiscoSwitch:
def __init__(self, name, vendor = 'cisco', model = '3750'):
self.name = name
self.vendor = vendor
self.model = model