Рекомендации по именованию переменных в Python

Мы считаем, что написание понятного, лаконичного и читаемого кода является основой создания надёжных и поддерживаемых приложений. Одним из ключевых аспектов программирования на Python является именование переменных. В этой статье мы поделимся лучшими практиками именования переменных в Python и покажем, как сделать ваш код более читаемым и понятным.

Почему именование переменных важно в Python?

Python — это высокоуровневый язык программирования с динамической типизацией, известный своей простотой и читаемостью. Одним из способов достижения такой читаемости является использование содержательных и описательных имён переменных. Применяя описательные имена, вы делаете код более понятным, удобным для поддержки и упрощаете процесс отладки.

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

Рекомендации по именованию переменных в Python

Вот наши рекомендации по именованию переменных в Python:

1. Используйте описательные и содержательные имена

Имена переменных должны быть описательными и содержательными. Они должны отражать, что представляет собой переменная или какие данные содержит. Например, если вы пишете программу для вычисления площади круга, вы можете назвать переменную radius или area. Избегайте использования общих или бессмысленных имён, таких как temp. Однако однобуквенные переменные, такие как x, y или i, широко приняты в коротких циклах, математических контекстах или когда их смысл очевиден из окружающего кода.

2. Следуйте единому соглашению об именовании

Важно придерживаться единого соглашения об именовании, чтобы сделать код более читаемым и понятным. Существует несколько соглашений, которым можно следовать, но наиболее распространёнными являются:

• lowerCamelCase: В этом соглашении первая буква каждого слова, кроме первого, пишется с заглавной буквы. Например, firstName или lastName. (Примечание: PEP 8 рекомендует CapWords для имён классов, но настоятельно предпочитает snake_case для переменных и функций.)
• snake_case: В этом соглашении слова разделяются символами подчёркивания. Например, first_name или last_name. (Это официальный стандарт Python для переменных.)

Python чувствителен к регистру, что означает, что UserName, username и USERNAME рассматриваются как три разные переменные. Выберите соглашение об именовании и придерживайтесь его во всём коде.

3. Избегайте зарезервированных ключевых слов

Избегайте использования зарезервированных ключевых слов в качестве имён переменных. В Python есть несколько ключевых слов, имеющих специальное значение в языке. Использование зарезервированных слов в качестве имён переменных может привести к синтаксическим ошибкам и затруднить чтение кода. Некоторые примеры зарезервированных слов: if, while, for и class.

4. Избегайте ненужных сокращений

Избегайте использования сокращений в именах переменных, если они не являются широко признанными и однозначными, такими как url, id или count. В остальных случаях используйте полные и описательные имена, чтобы избежать путаницы.

5. Учитывайте область видимости переменных

Обращайте внимание на область видимости ваших переменных. Переменные следует определять в максимально узкой области, чтобы избежать конфликтов имён и повысить читаемость. Например, если функция использует переменную, определите её внутри функции, а не на глобальном уровне.

6. Используйте подчёркивания для особых случаев

Python использует подчёркивания для передачи специальных значений. Одиночное подчёркивание в начале имени (например, _internal_var) указывает, что переменная предназначена для внутреннего использования внутри модуля. Двойные подчёркивания в начале и в конце имени (например, __init__) зарезервированы для специальных «дандер»-методов и атрибутов Python.

Примеры хороших имён переменных в Python

Вот несколько примеров хороших имён переменных в Python:

Хорошее именование переменных в Python

# Example 1: Calculating the area of a circle
radius = 5          # Descriptive name
pi = 3.14           # Follows snake_case convention
area = pi * radius ** 2

# Example 2: Storing a person's information
first_name = "John" # snake_case for variables
last_name = "Doe"
age = 30

В этих примерах имена переменных описательные, содержательные и соответствуют единому соглашению об именовании.

Заключение

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

Практика

В Python какие из следующих правил являются допустимыми для именования переменных?

Имена переменных могут начинаться с буквы или символа подчёркивания.Имена переменных могут начинаться с цифры.Имена переменных могут содержать буквы, цифры и символы подчёркивания.Имена переменных могут содержать специальные символы, такие как %, #, @.Python — язык, чувствительный к регистру, что означает, что VAR и var будут разными переменными.