Как писать код на Python: руководство для начинающих
Основные принципы написания кода на Python
При создании программ на Python важно придерживаться единого стиля, чтобы код был читаемым, понятным и легко поддерживаемым. Основные правила описаны в документе PEP8, который рекомендуется соблюдать.
Эффективный подход: следование PEP8
Главное правило - использовать отступы из 4 пробелов, избегать табуляции, правильно именовать переменные и функции, добавлять комментарии и строки документации. Ниже приведён пример корректно оформленного кода:
def calculate_area(radius):
"""Вычисление площади круга."""
pi = 3.14159
area = pi * radius ** 2
return area
if __name__ == "__main__":
r = 5
result = calculate_area(r)
print(f"Площадь круга радиусом {r} равна {result:.2f}")Python arguments types (типы аргументов в python)
Площадь круга радиусом 5 равна 78.54
Python load module (загрузка модуля в python)
В этом примере соблюдены отступы, использованы комментарии и docstring, имена переменных написаны в snake_case.
Как избежать проблем с отступами?
Python чувствителен к отступам. Для обозначения блоков кода используются пробелы или табуляция, но их смешение приводит к ошибке IndentationError. Рекомендуется всегда применять 4 пробела. Большинство редакторов кода автоматически заменяют табуляцию на пробелы.
def greet(name):
print("Привет,", name)Pd pandas python (импорт пакетов python)
Типичная ошибка:
Если в одном месте использовать табуляцию, а в другом - пробелы, интерпретатор выдаст TabError: inconsistent use of tabs and spaces in indentation. Для исправления стоит преобразовать весь файл к единому стилю (обычно через команду редактора «Convert Indentation to Spaces»).
Как правильно писать комментарии?
Комментарии поясняют код, но не должны дублировать его. Однострочный комментарий начинается с #, многострочный - с тройных кавычек (обычно это docstring). Комментарии располагаются перед кодом или на той же строке (с отступом).
# Константа ускорения свободного падения (м/с²)
G = 9.81
"""
Функция вычисляет время падения с высоты h
с учётом сопротивления воздуха (упрощённая модель).
"""
def fall_time(height):
return (2 * height / G) ** 0.5How to use python (как использовать python)
Распространённая ошибка:
Избыточные комментарии вроде # прибавляем единицу для очевидного кода x += 1 засоряют текст. Комментарии должны объяснять почему сделано так, а не что делает код. Также стоит избегать комментариев, которые устаревают после изменения кода.
Как именовать переменные и функции?
Python использует стиль snake_case (слова разделяются подчёркиваниями) для переменных и функций. Константы записываются заглавными буквами с подчёркиваниями. Имена классов - CamelCase. Имена должны быть осмысленными и отражать назначение.
# переменные
user_name = "Alice"
item_count = 10
# константа
MAX_RETRIES = 3
# функция
def get_average(data_list):
return sum(data_list) / len(data_list)
# класс (пример)
class DataProcessor:
passкак писать код на python (как писать код на python)
Типичная ошибка:
Использование однобуквенных имён (кроме счётчиков в коротких циклах). Имя l (строчная L) легко спутать с цифрой 1. Следует избегать зарезервированных слов (class, for и т.д.).
Как оформить строку документации (docstring)?
Docstring помещается сразу после объявления функции, класса или модуля. Для многострочных docstring используются тройные двойные кавычки. Первая строка - краткое описание, затем пустая строка и подробности.
def multiply(a, b):
"""Умножает два числа.
Args:
a (int или float): первый множитель.
b (int или float): второй множитель.
Returns:
int или float: произведение a и b.
"""
return a * bPython log 2 (логарифм по основанию 2 в python)
Типичная ошибка:
Пустой docstring или docstring, не соответствующий действительности (например, после изменения параметров функции строку документации забывают обновить).
Как избежать ошибки с изменяемыми аргументами по умолчанию?
Использование изменяемых объектов (список, словарь) в качестве значения по умолчанию для параметра функции приводит к накоплению данных между вызовами. Рекомендуется использовать None и создавать изменяемый объект внутри функции.
# Опасный вариант
def add_item(item, lst=[]):
lst.append(item)
return lst
# Безопасный вариант
def add_item_safe(item, lst=None):
if lst is None:
lst = []
lst.append(item)
return lstPython data model (модель данных python)
print(add_item(1)) # [1] print(add_item(2)) # [1, 2] - неожиданно! print(add_item_safe(1)) # [1] print(add_item_safe(2)) # [2] - корректно
Ошибка:
Многие новички удивляются, что второй вызов add_item возвращает уже два элемента. Это происходит потому, что список [] создаётся один раз при определении функции и сохраняется в атрибуте __defaults__.
Расширенные примеры оформления кода на Python
Пример 1: Полный скрипт с комментариями и docstring
Данный скрипт считывает список чисел, вычисляет среднее и выводит результат. Обратите внимание на использование docstring модуля и функций, а также на комментарии, объясняющие сложные моменты.
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
"""
Модуль для статистической обработки данных.
Содержит функции вычисления среднего арифметического.
"""
import sys
def calculate_mean(numbers):
"""Вычисляет среднее арифметическое.
Функция принимает список чисел и возвращает
значение среднего. При пустом списке возвращает 0.
Args:
numbers (list): список чисел (int или float).
Returns:
float: среднее арифметическое, 0 если список пуст.
"""
if not numbers:
return 0.0
total = sum(numbers)
count = len(numbers)
return total / count
def main():
"""Главная функция: читает числа из stdin, выводит среднее."""
# Чтение строки, разбиение по пробелам, преобразование в числа
input_line = sys.stdin.read().strip()
if not input_line:
print("Нет входных данных.")
return
# Используем list comprehension для извлечения чисел
try:
data = [float(x) for x in input_line.split()]
except ValueError as e:
print(f"Ошибка преобразования: {e}")
sys.exit(1)
mean = calculate_mean(data)
print(f"Среднее арифметическое: {mean:.3f}")
if __name__ == "__main__":
main()Ввод: 10 20 30 Вывод: Среднее арифметическое: 20.000
Пояснение: модуль содержит описание, функция имеет полный docstring, обработка ошибок вынесена в отдельный блок, а конструкция if __name__ == "__main__" позволяет импортировать модуль без выполнения главной функции.
Пример 2: Правильное форматирование длинных строк
Строки, превышающие 79 символов, рекомендуется разбивать. Используется неявная конкатенация строк в скобках или явный перенос с обратной косой чертой.
# Неявная конкатенация в круглых скобках
long_string = (
"Это очень длинная строка, которую необходимо "
"разбить на несколько строк для улучшения "
"читаемости кода."
)
# Явный перенос с обратным слешем (менее предпочтительно)
other_string = "Это альтернативный способ, " \
"но его реже используют."
print(long_string)
print(other_string)Это очень длинная строка, которую необходимо разбить на несколько строк для улучшения читаемости кода. Это альтернативный способ, но его реже используют.
Пояснение: круглые скобки объединяют смежные строковые литералы в одну строку без лишних пробелов. Обратный слеш может быть не замечен, поэтому первый способ предпочтительнее.
Пример 3: Использование type hints (подсказок типов)
Аннотации типов помогают статическим анализаторам (mypy) и улучшают документирование. Они не влияют на выполнение кода, но повышают читаемость.
from typing import List, Optional
def find_max(numbers: List[float]) -> Optional[float]:
"""Возвращает максимальное число из списка."""
if not numbers:
return None
return max(numbers)
# Пример вызова
values = [4.5, 3.2, 9.1, 1.7]
max_val = find_max(values)
print(f"Максимум: {max_val}")Максимум: 9.1
Пояснение: List[float] означает список чисел с плавающей точкой, Optional[float] - что функция может вернуть float или None. Такие аннотации помогают IDE подсвечивать ошибки.
Пример 4: Контекстный менеджер (with) для автоматического закрытия ресурсов
Использование with гарантирует корректное освобождение ресурсов (файлы, соединения) даже при возникновении исключения.
# Чтение файла с помощью контекстного менеджера
with open("example.txt", "r", encoding="utf-8") as f:
content = f.read()
# Запись с обработкой ошибок
with open("output.txt", "w", encoding="utf-8") as f:
f.write("Строка для записи\n")
print(content)(содержимое файла example.txt)
Пояснение: после выхода из блока with файл автоматически закрывается, даже если внутри произошла ошибка. Не нужно вызывать f.close() явно, что уменьшает вероятность утечки ресурсов.