Синтаксис Python и основные правила PEP 8

Обновлено:

1. Что такое синтаксис

Синтаксис — это правила, по которым записывается код.

Если нарушить синтаксис Python, программа не сможет правильно прочитать код и завершится с ошибкой.

Например, неправильно:

first_name = 'Anna

В строке не хватает закрывающей кавычки, поэтому программа не запустится.


2. Что такое PEP 8

PEP 8 — это руководство по оформлению кода на Python.

Правила PEP 8 помогают писать код:

  • аккуратно;
  • понятно;
  • единообразно;
  • удобно для чтения другими программистами.

Нарушение PEP 8 не всегда приводит к ошибке. Программа может работать, но код будет оформлен неправильно или неудобно для чтения. (Python Enhancement Proposals (PEPs))


3. Пробелы при обычном присваивании

При создании переменной с обеих сторон оператора присваивания = ставится по одному пробелу.

Правильно:

age = 25
price = 99.5
message = 'Hello'

Неправильно:

age=25
price= 99.5
message ='Hello'

Правило:

переменная пробел = пробел объект

4. Пробелы при перезаписи переменной

При перезаписи переменной используются те же правила:

age = 25
age = 26

Неправильно:

age=25
age =26

5. Пробелы при каскадном присваивании

При каскадном присваивании с обеих сторон каждого оператора = ставится по одному пробелу.

Правильно:

a = b = 10
first_text = second_text = third_text = 'Hello'
a = b = len('Python')

Неправильно:

a=b=10
a =b= 10

6. Пробелы при множественном присваивании

При множественном присваивании:

  • перед запятой пробел не ставится;
  • после запятой ставится один пробел;
  • с обеих сторон = ставится по одному пробелу.

Правильно:

a, b = 10, 20
a, b, c = 10, 20, 30
language, age, price = 'Python', 25, 99.5

Неправильно:

a,b=10,20
a , b = 10 , 20
a, b= 10, 20

7. Пробелы при сокращённом присваивании

С обеих сторон сокращённого оператора присваивания ставится по одному пробелу.

Правильно:

a += b
a -= b
a *= b
a /= b

Неправильно:

a+=b
a *=b
a/= b

8. Оформление списков

При создании списка:

  • после открывающей квадратной скобки пробел не ставится;
  • перед закрывающей квадратной скобкой пробел не ставится;
  • перед запятой пробел не ставится;
  • после запятой ставится один пробел.

Правильно:

numbers = [10, 20, 30]
languages = ['Python', 'Java', 'JavaScript']
data = [10, 3.14, 'Hello']

Неправильно:

numbers = [ 10, 20, 30 ]
numbers = [10,20,30]
numbers = [10 , 20 , 30]

Лишние пробелы сразу после открывающей скобки и перед закрывающей скобкой не ставятся. (Python Enhancement Proposals (PEPs))


9. Пустой список

Внутри пустого списка пробелов быть не должно.

Правильно:

numbers = []

Неправильно:

numbers = [ ]

10. Список с одним объектом

Список с одним объектом также записывается без лишних пробелов:

numbers = [10]
messages = ['Hello']

Неправильно:

numbers = [ 10 ]
messages = [ 'Hello' ]

11. Оформление кортежей

Для кортежей используются те же основные правила, что и для списков:

  • сразу после открывающей скобки пробел не ставится;
  • перед закрывающей скобкой пробел не ставится;
  • после каждой запятой ставится один пробел.

Правильно:

numbers = (10, 20, 30)
languages = ('Python', 'Java', 'JavaScript')
data = (10, 3.14, 'Hello')

Неправильно:

numbers = ( 10, 20, 30 )
numbers = (10,20,30)
numbers = (10 , 20 , 30)

12. Пустой кортеж

Пустой кортеж записывается без пробелов:

numbers = ()

Неправильно:

numbers = ( )

13. Кортеж с одним объектом

В кортеже с одним объектом после объекта обязательно ставится запятая.

Пробел между запятой и закрывающей скобкой не ставится.

Правильно:

number = (10,)
message = ('Hello',)

Неправильно:

number = (10, )
message = ('Hello', )

Запятая ставится сразу после объекта, а закрывающая скобка — сразу после запятой. (Python Enhancement Proposals (PEPs))


14. Вызов функции с одним аргументом

Между именем функции и открывающей круглой скобкой пробел не ставится.

Сразу после открывающей скобки и перед закрывающей скобкой пробелы тоже не ставятся.

Правильно:

print('Hello')
print(25)
len('Python')

Неправильно:

print ('Hello')
print( 'Hello' )
len ('Python')

15. Вызов класса

При вызове класса используются те же правила:

number = int('25')
price = float('99.5')
text = str(1234)
symbols = list('Hello')
symbols = tuple('Hello')

Неправильно:

number = int ( '25' )
text = str (1234)

16. Вызов функции с несколькими аргументами

Если в функцию передаётся несколько позиционных аргументов:

  • перед запятой пробел не ставится;
  • после запятой ставится один пробел.

Правильно:

print(10, 20, 30)
print('Hello', 'World')
print('Python', 25, 3.14)

Неправильно:

print(10,20,30)
print(10 , 20 , 30)
print( 10, 20, 30 )

17. Обычное присваивание и именованный аргумент

При обычном создании переменной с обеих сторон = ставятся пробелы:

separator = '*'

Здесь separator — переменная, поэтому используется обычное присваивание.

Но внутри вызова функции именованные аргументы записываются без пробелов вокруг =:

print(10, 20, 30, sep='*')

Правильно:

separator = '*'

print(10, 20, 30, sep=separator)

В строке:

separator = '*'

используется обычное присваивание, поэтому пробелы нужны.

В строке:

print(10, 20, 30, sep=separator)

sep является именованным аргументом, поэтому пробелы вокруг = не ставятся. (Python Enhancement Proposals (PEPs))


18. Оформление sep и end

Именованные аргументы sep и end пишутся без пробелов вокруг =.

Правильно:

print(10, 20, 30, sep='*')
print('Hello', end=' ')
print(10, 20, 30, sep=', ', end='!')

Неправильно:

print(10, 20, 30, sep = '*')
print('Hello', end = ' ')

Если после одного именованного аргумента идёт другой, между ними ставится запятая и один пробел:

print(10, 20, 30, sep='*', end='!')

19. Переменная для sep

Можно заранее создать переменную:

sep = ' | '

И передать её в функцию:

print(10, 20, 30, sep=sep)

В записи:

sep=sep

первый sep — имя именованного аргумента.

Второй sep — имя переменной.

Пробелы вокруг = внутри вызова функции не ставятся.


20. Вложенные вызовы

Функции и классы можно вызывать внутри других функций.

Например:

print(len(str(1234)))

Пробелы между именами функций, классов и круглыми скобками не ставятся.

Правильно:

print(len(str(1234)))

Неправильно:

print (len (str (1234)))

Неправильно:

print( len( str( 1234 ) ) )

Все скобки открываются и закрываются без лишних пробелов:

print(
    len(
        str(
            1234
        )
    )
)

В одну строку:

print(len(str(1234)))

21. Пробелы вокруг математических операторов

При обычной математической операции с обеих сторон оператора обычно ставится по одному пробелу.

Правильно:

result = 10 + 5
result = 10 - 5
result = 10 * 5
result = 10 / 5

Неправильно:

result=10+5
result = 10+ 5
result = 10 *5

22. Операторы с разным приоритетом

Некоторые математические операторы имеют разный приоритет.

Например, умножение выполняется раньше сложения:

result = 10 + 5 * 2

По правилам PEP 8 при использовании операторов с разным приоритетом можно выделить пробелами оператор с более низким приоритетом.

Пример:

result = 10 + 5*2

Здесь:

  • * имеет более высокий приоритет и записан без пробелов;
  • + имеет более низкий приоритет и выделен пробелами.

Ещё пример:

result = a*b + c*d

Сначала выполняются умножения, а затем сложение.

PEP 8 предлагает использовать такое оформление, когда оно помогает визуально показать порядок математических действий. (Python Enhancement Proposals (PEPs))


23. Выражения со скобками

Скобки могут изменять порядок выполнения операций.

Пример:

result = (a+b) * (c-d)

По стилю PEP 8 внутри скобок можно не ставить пробелы вокруг операций с более высоким приоритетом, а оператор между скобками выделить пробелами.

Ещё пример:

result = (10+5) * (20-4)

Сначала выполняются действия внутри скобок, затем умножение.


24. Современное оформление математических выражений

Автоматический форматтер Black ставит одиночные пробелы вокруг почти всех бинарных операторов. Поэтому он оформит выражение так:

result = 10 + 5 * 2
result = a * b + c * d
result = (a + b) * (c - d)

Такой стиль широко используется в современных Python-проектах. Он не показывает приоритет операторов с помощью пробелов, но остаётся понятным и единообразным. (black.readthedocs.io)

Поэтому на практике можно встретить два варианта.

Вариант, подчёркивающий приоритет операций:

result = a*b + c*d

Вариант в стиле Black:

result = a * b + c * d

Оба варианта работают одинаково.

Главное — не писать выражение полностью без пробелов:

result=a*b+c*d

И не использовать разное количество пробелов с разных сторон оператора:

result = a  + b
result = a +  b

25. Комментарий на отдельной строке

После символа # ставится один пробел.

Правильно:

# Это комментарий
# Стоимость урока
LESSON_PRICE = 1500

Неправильно:

#Это комментарий
#    Это комментарий

Каждая строка обычного комментария начинается с # и одного пробела. (Python Enhancement Proposals (PEPs))


26. Комментарий после кода

Комментарий после кода отделяется минимум двумя пробелами.

После символа # ставится один пробел.

Правильно:

age = 25  # Возраст пользователя
PI = 3.14  # Число пи
text_length = len('Hello')  # Длина строки

В рамках курса можно отделять комментарий двумя или четырьмя пробелами:

age = 25    # Возраст пользователя

Неправильно:

age = 25#Возраст пользователя
age = 25 # Возраст пользователя
age = 25  #Возраст пользователя

Комментарии после кода следует использовать только тогда, когда они действительно что-то поясняют. По PEP 8 такой комментарий отделяется от кода минимум двумя пробелами и начинается с # и одного пробела. (Python Enhancement Proposals (PEPs))


27. Висящие пробелы

В конце строк не должно быть лишних пробелов.

Правильно:

message = 'Hello'
print(message)

Неправильно:

message = 'Hello'····
print(message)··

Здесь точки условно показывают невидимые пробелы в конце строк.

Лишние пробелы в конце строки называются висящими или завершающими пробелами.

Их не должно быть:

  • после кода;
  • после комментария;
  • на пустой строке;
  • в конце файла.

PEP 8 рекомендует удалять завершающие пробелы, потому что они не видны, могут создавать путаницу и отклоняются инструментами проверки во многих проектах. (Python Enhancement Proposals (PEPs))


28. Пустая строка должна быть действительно пустой

Пустая строка не должна содержать пробелы.

Правильно:

first_name = 'Anna'

print(first_name)

Между созданием переменной и вызовом print() находится полностью пустая строка.

Неправильно:

first_name = 'Anna'
····
print(first_name)

Точки условно показывают пробелы на пустой строке.

Визуально строка выглядит пустой, но на самом деле в ней находятся лишние символы.


29. Конец Python-файла

После последней строки кода файл должен заканчиваться переносом строки.

Например, последняя строка программы:

print('Hello')

После неё нужно нажать Enter один раз.

В редакторе курсор окажется на следующей пустой строке:

print('Hello')
|

Символ | условно показывает положение курсора.

Это означает, что файл правильно заканчивается переносом строки.

Не нужно оставлять много пустых строк:

print('Hello')

Достаточно одного нажатия Enter после последней строки кода.


30. Пример правильно оформленного кода

# Основные настройки программы
PI = 3.14
LESSON_PRICE = 1500

first_name = 'Anna'
age = 25
price = 99.5

a = b = 10
first_number, second_number = 20, 30

numbers = [10, 20, 30]
data = ('Python', 25, 99.5)
single_number = (5,)

separator = ', '
text_length = len(str(12345))

result = first_number + second_number * 2

print(first_name)
print(age, price, sep=separator)
print(numbers, data, sep='\n', end='\nFinish')
print(text_length)  # Количество цифр в числе

В этом примере:

  • вокруг обычного = стоят пробелы;
  • после запятых стоят пробелы;
  • внутри скобок нет лишних пробелов;
  • именованные аргументы записаны без пробелов вокруг =;
  • комментарии начинаются с # и одного пробела;
  • комментарий после кода отделён двумя пробелами;
  • в конце строк нет лишних пробелов;
  • после последней строки файл заканчивается переносом строки.

31. Краткая памятка

Обычное присваивание:

age = 25

Каскадное присваивание:

a = b = 10

Множественное присваивание:

a, b = 10, 20

Список:

numbers = [10, 20, 30]

Кортеж:

numbers = (10, 20, 30)

Кортеж с одним объектом:

number = (10,)

Вызов функции:

print('Hello')

Несколько аргументов:

print(10, 20, 30)

Именованные аргументы:

print(10, 20, 30, sep='*', end='!')

Вложенные вызовы:

print(len(str(12345)))

Комментарий:

# Это комментарий

Комментарий после кода:

age = 25  # Возраст пользователя

Основное правило:

Пробелы должны помогать читать код, но не должны появляться там, где они не нужны.