Всем программистам хочется, чтобы их код был красивым, лаконичным и главное читабельным. Гуидо ван Россум выдвинул такую идею: код читается намного чаще, чем пишется. Да и порой читается отнюдь не тем, кто писал этот код.
Поэтому был придуман набор рекомендаций для разработчиков PEP 8. Он помогает унифицировать код среди большого количества разработчиков, и, как следствие, сделать его более читаемым. Это помогает эффективно работать в команде.
Расскажу немного, как правильно называть переменные, функции, классы в своих проектах. Тема будет актуальна начинающим разработчикам.
Названия переменных в Python
Переменную в Python принято именовать маленькими буквами. Если название переменной состоит из нескольких слов, то они разделяются нижним подчеркиванием.
Код:
# Имя переменной
name = "Python"
# Имя переменной с подчеркиванием
first_name = "Дмитрий"
# Имя переменной с подчеркиванием
my_countries_list = []
Если вы определяете переменную внутри класса и которая будет использоваться только внутри класса стоит дать ей префикс в виде одного нижнего подчеркивания. Для переменных внутри библиотек используется префикс в виде двух подчеркиваний.
Код:
# Имя приватной переменной внутри класса
_cars = []
# Имя переменной внутри библиотеки
__books = {}
Названия функций в Python
Функции, аналогично переменным, называются маленькими буквами с разделителем в виде нижнего подчеркивания. Если функция является приватной, то стоит также сделать префикс в виде одного подчеркивания.
Код:
# Имя функции
def my_func():
pass
# Имя приватной функции
def _my_func():
pass
Название классов в Python
Для классов ситуация другая. Первая буква в каждом слове начинается с большой буквы. Нижнее подчеркивание между словами не ставится. Просто каждое слово начинается с большой буквы. Этого достаточно.
Код:
# Имя класса
class UserInformation:
def get_user(user_id):
pass
Название констант
Имена констант пишутся капсом. Между словами ставится нижнее подчеркивание.
Код:
# Константы
TOTAL = 100
TIMEOUT = 10
MAX_OVERFLOW = 20
Надеюсь, было полезно. Если будет интересно, продолжу эту тему в следующих статьях.
У меня есть Telegram, в котором можно найти интересные задачки по Python, вопросы с собеседований и много другой полезной информации!
