Как их писать и как их использовать в соответствии с PEP 8

Как я написал на изображении выше, вы можете написать одну строку в Python по-разному, и каждый из них имеет свое применение. Как выбрать между ними? Давай узнаем это.

Во-первых: PEP 8

Согласно официальной документации Python, PEP 8 - это документ, написанный самим Гвидо ван Россум, который:

дает соглашения о кодировании для кода Python, составляющего стандартную библиотеку в основном дистрибутиве Python.

Другими словами, PEP 8 - это просто стилистические соглашения для написания Python. Вам не нужно следовать этим рекомендациям, ваш код все равно будет работать. Однако, согласно Дзену Python, удобочитаемость имеет значение. Итак, если вы и все сообщество Python будете следовать одним и тем же рекомендациям, это улучшит читаемость кода и упростит чтение чужого кода.

Соглашения об именах PEP 8

Даже если вы не применяете все рекомендации из PEP 8, только соглашения об именах могут сыграть значительную роль в том, насколько хорошо или плохо написан ваш код. Кроме того, я думаю, что это самое простое улучшение, которое вы можете получить из рекомендаций. Прочитав PEP 8, я выбрал наиболее распространенные случаи, в которых необходимо выбрать один из стилей корпуса:

  • Для переменных, функций, методов и модулей: Snake Case.
  • Для классов: Pascal Case.
  • Для констант: Змеиный регистр с заглавной буквы.

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

В любом случае, позвольте мне (наконец) объяснить случаи комбинирования слов, и в качестве примеров я буду использовать это:

База: first name

Случай верблюда

В этом случае слова объединяются путем добавления первой буквы каждого слова (кроме первого) с заглавной буквы и удаления пробела между ними:

Случай верблюда: firstName

Этот регистр очень часто используется во многих языках для самых разных целей, а в Python не так часто используется, потому что Pascal Case является подходом по умолчанию.

Паскаль Кейс

Этот регистр также называется верхним регистром верблюда, потому что объединяет слова, используя заглавные буквы всех слов (даже первое слово) и удаляя пробел между ними:

Случай Паскаля: FirstName

Этот тип очень часто используется в Python для имен классов: OverflowError или ValueError (исключения - классы).

Змеиный чехол

Это наиболее часто используемый в Python. Он объединяет слова, заменяя пробелы между словами подчеркиванием:

Чемодан для змеи: first_name

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

Постоянный регистр ( "Змеиный регистр с заглавной буквы" ): FIRST_NAME

Кебаб Кейс

Это похоже на Snake Case, но вместо подчеркивания используется тире для замены пробелов между словами:

Футляр для шашлыка: first-name

Этот случай редко встречается в Python, но, например, его часто можно найти в URL-адресах. Иногда этот стиль часто используется при написании имен URL-адресов с пространственными именами в Django (Python Framework).

Заключение

Как я уже сказал, вы можете выбирать между ними, но по моему опыту, попробуйте использовать то же, что и ваша команда. Это очень поможет при отладке или просто при чтении чьего-либо кода. Удачного кодирования.