Style Guide for Python Code: Naming Conventions

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

wuffur 21.03.09 в 14:03

Новые модули и пакеты (включая фреймворки от третьих лиц) следовало бы написать по этим стандартам, но когда существующая библиотека имеет отличный стиль написания, предпочтительнее чтобы было внутренне непротиворечиво.

wuffur 21.03.09 в 14:20

Описание стилей именования

rnd0011 07.03.11 в 19:47

Существует много различных стилей обозначения

wuffur 21.03.09 в 14:23

Они помогают в возможности разобраться, что же за стили обозначений используется, в зависимости от того, для чего они используются.

wuffur 21.03.09 в 14:25

Следующие стили обозначений широко известны:

wuffur 21.03.09 в 14:27

- b (одна буква в нижнем регистре)

wuffur 21.03.09 в 14:27

- B (одна буква в верхнем регистре)

wuffur 21.03.09 в 14:28

- нижнийрегистр

svartalf 17.02.09 в 14:35

- нижний_регистр_с_подчёркиваниями

svartalf 17.02.09 в 14:51

- ВЕРХНИЙРЕГИСТР

svartalf 17.02.09 в 14:36

- ВЕРХНИЙ_РЕГИСТР_С_ПОДЧЁРКИВАНИЯМИ

svartalf 17.02.09 в 14:51

- CapitalizedWords, CapWords, CamelCase, StudlyCaps (так называемый «верблюжий» регистр).

rnd0011 05.03.11 в 18:05

Примечание. В «верблюжьем» регистре буквы сокращений записываются в верхнем регистре.
Например, HTTPServerError вместо HttpServerError.

rnd0011 05.03.11 в 18:10

- mixedCase (отличается от «верблюжьего» регистра строчной первой буквой)

rnd0011 05.03.11 в 18:07

- Capitalized_Words_With_Underscores (некрасиво!)

rnd0011 05.03.11 в 18:11

Есть также стиль, при котором применяется короткий уникальный префикс для группировки имён.

rnd0011 05.03.11 в 18:12

Этот стиль очень редко используется в Python и упомянут здесь только для полноты.

rnd0011 05.03.11 в 18:13

К примеру, функция os.stat() возвращает именованный кортеж, атрибуты которого по традиции называются st_mode, st_size, st_mtime и так далее.

Gukoff 05.02.15 в 15:19

(Это сделано, чтобы подчеркнуть соответствие атрибутов системному вызову функции stat() из POSIX)

Gukoff 05.02.15 в 15:26

Рекомендуемые соглашения по именованию

rnd0011 07.03.11 в 19:48

Нежелательные имена

rnd0011 07.03.11 в 19:48

Никогда не используйте одиночные символы l' (строчная эль), O' (прописная буква о) или I' (прописная буква и) в качестве имени переменной.

rnd0011 07.03.11 в 19:50

В некоторых шрифтах эти символы неотличимы от символов нуля и единицы. Вместо строчной l' используйте прописную L'.

rnd0011 07.03.11 в 19:51

Имена пакетов и модулей

armagetron 31.10.10 в 10:17

Модули должны иметь короткие имена в нижнем регистре.

armagetron 31.10.10 в 10:21

Знак подчёркивания применяется только в том случае, если это улучшает читаемость.

armagetron 31.10.10 в 10:21

Пакеты должны иметь короткие имена в нижнем регистре, но использование подчеркиваний нежелательно.

rnd0011 05.03.11 в 17:57

Имена классов

svartalf 17.04.09 в 00:37

Почти без исключений имена классов используют стиль CapWords.

rnd0011 07.03.11 в 19:52

Классы для использования сугубо внутри модуля имеют подчеркивание в начале имени.

rnd0011 07.03.11 в 19:54

Имена исключений

rnd0011 05.03.11 в 17:51

Так как исключения должны быть классами, они используют тот же стиль именования.

rnd0011 07.03.11 в 19:53

Имена глобальных переменных.

armagetron 31.10.10 в 10:16

Имена функций

armagetron 31.10.10 в 10:16

Имена функций должны быть в нижнем регистре с разделением слов знаком подчёркивания для улучшен читаемости.

armagetron 31.10.10 в 10:20

Аргументы функций и методов

svartalf 17.02.09 в 14:26