Операторы, отступы и комментарии в Python: понятное руководство

Операторы, отступы и комментарии в Python

Это руководство объясняет операторы Python, важность последовательных отступов и как эффективно использовать комментарии и строки документации.

Операторы в Python

Инструкции Python, которые выполняет интерпретатор, называются операторами. Типичные примеры включают операторы присваивания вроде a = 1, операторы управления потоком, такие как if, for и while. Эти основы формируют строительные блоки любой программы на Python.

Многострочные операторы

По умолчанию новая строка завершает оператор. Чтобы разбить длинный оператор на несколько строк, можно использовать обратную косую черту (\) — символ продолжения строки:

a = 1 + 2 + 3 + \
4 + 5 + 6 + \
7 + 8 + 9

Более идиоматично Python позволяет неявное продолжение внутри круглых, квадратных или фигурных скобок:

a = (1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9)

Аналогично, списковые литералы могут занимать несколько строк:

colors = ['red', 'blue', 'green']

Также можно разместить несколько простых операторов в одной строке, разделяя их точкой с запятой:

a = 1; b = 2; c = 3

---

Отступы в Python

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

Хотя язык допускает любой согласованный уровень отступа, стандарт сообщества — четыре пробела. Табуляцию следует избегать, чтобы предотвратить путаницу.

for i in range(1, 11):
    print(i)
    if i == 5:
        break

Правильные отступы не только обеспечивают синтаксис, но и делают код сразу читаемым и поддерживаемым. Например:

if True:
    print('Hello')
    a = 5

против менее читаемой однострочной формы:

if True: print('Hello'); a = 5

Неверные отступы вызывают IndentationError и останавливают выполнение.

---

Комментарии в Python

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

# This is a comment
# Print greeting
print('Hello')

---

Многострочные комментарии

Чтобы охватить несколько строк, можно поставить # в начале каждой:

# This is a long comment
# that continues over several
# lines

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

"""This is a multi-line comment that spans several lines."""

---

Строки документации в Python

Docstring — это строковый литерал, следующий за определением функции, класса или модуля. Он документирует назначение элемента и хранится в его атрибуте __doc__. Тройные кавычки используются по соглашению:

def double(num):
    """Return twice the input value."""
    return 2 * num

К нему можно получить доступ программно:

print(double.__doc__)

Вывод:

Return twice the input value.

Для более подробных рекомендаций обратитесь к официальной документации Python по комментариям и docstrings.