Style Guide for Python Code: Naming Conventions

В качестве первого аргумента метода экземпляра всегда используется 'self'.

rnd0011 05.03.11 в 18:15

В качестве первого аргумента классового метода всегда используется 'cls'.

rnd0011 05.03.11 в 18:16

Если имя аргумента функции совпадает с зарезервированным ключевым словом, как правило, лучше добавить одно нижнее подчеркивание, чем использовать сокращение или орфографические коррупции. Таким образом, "print_" лучше, чем "prnt". (Возможно, лучше избегать таких совпадений, используя синонимы.)

Equilibrious 22.06.11 в 15:13

Имена методов и переменные экземпляров

rnd0011 05.03.11 в 18:17

Используйте правила именования функций: слова состоящие из строчных букв, разделенные символом подчеркивания, в количестве необходимом для повышения читабельности.

Equilibrious 22.06.11 в 15:22

Символ подчеркивания в начале (имени, прим. пер.) используйте только для непубличных методов и переменных экземпляра.

Equilibrious 22.06.11 в 16:04

Python обрабатывает эти имена с именем класса: если класс Foo имеет атрибут с именем __a, он не будет доступен по (вызову, прим. пер.) Foo.__a. (Упорный пользователь может получить доступ вызовом Foo._Foo__a.)

Equilibrious 22.06.11 в 16:26

Как правило, двойные подчеркивания в начале (имени, прим. пер.) должны использоваться только, чтобы избежать конфликтов имен с атрибутами внутри классов наследников.

Equilibrious 22.06.11 в 16:45

Константы

rnd0011 05.03.11 в 18:17

Константы обычно определяются на уровне модуля и пишутся целиком прописными буквами с символом подчеркивания в качестве разделителя слов. Как пример: MAX_OVERFLOW и TOTAL.

Equilibrious 22.06.11 в 16:55

Наследование

Equilibrious 22.06.11 в 16:58

Всегда (необходимо, прим. пер.) решить, публичными или не публичными должны быть методы класса и переменные экземпляра (далее: "атрибуты"). В случае сомнений, выберите не публичный, ведь проще потом сделать его публичным, чем публичный атрибут не публичным.

Equilibrious 23.06.11 в 08:08