🐍 Код-этикет: правила хорошего тона в Python для начинающих программистов

Написание кода — это не только про технологии, но и про общение с другими разработчиками. Следуй этим правилам этикета, и твой код всегда будут встречать с благодарностью!

snake_case (змеиный регистр) — слова пишутся маленькими буквами и разделяются нижними подчёркиваниями _, как будто это звенья змеи.Используется для: переменных, функций, методовПример: user_name, calculate_total, is_valid
CamelCase (верблюжий регистр) или (точнее, PascalCase)— каждое слово начинается с заглавной буквы, а пробелы между словами убираются. Выглядит как горбы верблюда.Используется для: названий классовПример: UserProfile, BankAccount, ElectricCar
UPPER_CASE (верхний регистр) — все буквы заглавные, слова разделяются подчёркиваниями. Так мы "кричим" в коде, что это что-то важное и неизменное.Используется для: констант (значений, которые не должныменяться)Пример: MAX_USERS, API_KEY, DEFAULT_TIMEO

#Культурно — сразу понятно назначение user_age = 25 is_logged_in = True total_price = calculate_order_total() # Некультурно — загадки для коллег a = 25 flag = True x = y + z

📋 Конкретные правила:

Называй переменные так, чтобы их назначение было очевидно без дополнительных комментариев. Код должен говорить сам за себя!

# Тактично x = 5 + 3 names = ["Anna", "Bob", "Charlie"] result = calculate(1, 2, 3) # Бестактно x=5+3 names=["Anna","Bob","Charlie"] result = calculate (1,2,3)

📋 Конкретные правила:

• Вокруг операторов: =, +, -, *, /, ==, !=

• После запятых: в списках, кортежах, аргументах функций

• Внутри скобок: без пробелов (так), а не ( так )

• Между функцией и скобками: func(), а не func ()

# Дурной тон (очевидно) count = count + 1 # увеличиваем счетчик на 1 # Хороший тон (объясняем причину) count = count + 1 # обход бага в API: система считает с 0

# Цивилизованно with open('file.txt', 'r') as file: content = file.read() # файл закроется автоматически # Некультурно file = open('file.txt', 'r') content = file.read() # а закроется ли?

«Одна строка ясности лучше трёх строк очевидности»

# Элегантно squares = [x**2 for x in range(10)] # Многословно squares = []for x in range(10): squares.append(x**2)

📋 Когда НЕ использовать:

Слишком сложная логика внутри
Множественные вложенные циклы
Нужны побочные эффекты

_variable — «не для чужих глаз» (внутреннее использование)
__variable — «строго конфиденциально» (защита от случайного доступа)
_ — «это неважно» (когда значение игнорируется)

# Тактично _, email = user_data # имя нам не важно for _ in range(5): # номер итерации не важен print("Hello")

«Неэтичный» код обладает удивительным свойством: уже через неделю ты сам не сможешь понять, что же ты имел в виду!

# Сегодня ты понимаешь этот код... a = b + c * d / f # Но через месяц он станет загадкой даже для тебя! total_price = base_price + tax_amount * discount_rate / conversion_factor

Помни: Ты пишешь код в первую очередь для людей, включая своего «будущего себя».

Типичные ошибки новичков

❌ Смешивать отступы (табы + пробелы = хаос)
❌ Давать непонятные имена (a, b, cвместо count, name, total)
❌ Растягивать строки на весь экран
❌ Усложнять простое — выпендрёж не приветствуется

В Python существует официальный стандарт PEP 8 — это как «Этикет для кода» от создателей языка. Он отвечает на все вопросы: от отступов до именования. Когда сомневаешься — загляни в PEP 8.

«Поступай с кодом других так, как хочешь, чтобы поступали с твоим»
«Чистота — залог успеха» — исправляй найденный беспорядок
«Простота — признак мастерства»
«Всегда оставляй код чище, чем нашёл»

Помни: хороший код — это не только работающая программа, но и уважение к тем, кто будет его читать после тебя, включая тебя самого через месяц!

А с какими проявлениями плохого тона в коде сталкивался ты? Поделись историями в комментариях! 👇

🐍 Код-этикет: правила хорошего тона в Python для начинающих программистов

🤝 Основы воспитанного кода

1 «Представься правильно». Как мы знакомимся с твоим кодом через имена

2 «Называй вещи своими именами». Осмысленные названия переменных

3 «Соблюдай дистанцию». Правила расстановки пробелов

4 «Не говори лишнего». Искусство комментариев

🎩 Продвинутый этикет

5 «Умей вовремя уйти». Использование менеджеров контекста

6 «Говори кратко и ясно». Списковые включения вместо многословия

7 «Знай, что скрывать». Магия нижнего подчёркивания

⚠ Важное предупреждение: код с истёкшим сроком годности

🚷 Что не принято в приличном обществе

📚 Официальный свод правил

💎 Золотые правила код-этикета