PEP8 Рекомендации Python

foo = long_function_name(var_one, var_two,
                         var_three, var_four)


def long_function_name(
        var_one, var_two, var_three,
        var_four):
    print(var_one)

foo = long_function_name(var_one, var_two,
    var_three, var_four)


def long_function_name(
    var_one, var_two, var_three,
    var_four):
    print(var_one)

foo = long_function_name(
  var_one, var_two,
  var_three, var_four)

my_list = [
    1, 2, 3,
    4, 5, 6,
    ]
result = some_function_that_takes_arguments(
    'a', 'b', 'c',
    'd', 'e', 'f',
    )

my_list = [
    1, 2, 3,
    4, 5, 6,
]
result = some_function_that_takes_arguments(
    'a', 'b', 'c',
    'd', 'e', 'f',
)

with open('/path/to/some/file/you/want/to/read') as file_1, \
        open('/path/to/some/file/being/written', 'w') as file_2:
    file_2.write(file_1.read())

class Rectangle(Blob):

    def __init__(self, width, height,
                 color='black', emphasis=None, highlight=0):
        if (width <mark> 0 and height </mark> 0 and
            color <mark> 'red' and emphasis </mark> 'strong' or
            highlight > 100):
            raise ValueError("sorry, you lose")
        if width <mark> 0 and height </mark> 0 and (color == 'red' or
                                           emphasis is None):
            raise ValueError("I don't think so -- values are %s, %s" <

### Отступы


Используйте 4 пробела на каждом уровне отступа.


Для действительно старых кодов, которые вы не хотите портить, вы можете продолжать использовать табуляцию в 8 пробелов.


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


Да:

Нет:

Опционально:

Закрывающая скобка/квадратная скобка/скобка в многострочных конструкциях может быть выровнена либо под первым непробельным символом последней строки списка, как в:

либо она может быть выровнена под первым символом строки, начинающей многострочную конструкцию, как в:

### Табы или пробелы?


Никогда не смешивайте табы и пробелы.


Самый популярный способ отступов в Python — это использование только пробелов. Второй по популярности способ — это использование только табов. Код, в котором смешаны табы и пробелы, должен быть преобразован в использование только пробелов. При вызове интерпретатора командной строки Python с опцией `-t`, он выдает предупреждения о коде, который незаконно смешивает табы и пробелы. При использовании `-tt` эти предупреждения становятся ошибками. Эти опции настоятельно рекомендуются!


Для новых проектов настоятельно рекомендуется использовать только пробелы вместо табов. Большинство редакторов имеют функции, которые облегчают этот процесс.




### Максимальная длина строки


Ограничьте длину всех строк максимум 79 символами.


Во многих устройствах все еще ограничена длина строк в 80 символов; кроме того, ограничение окон до 80 символов позволяет размещать несколько окон рядом. Стандартное перенос на таких устройствах нарушает визуальную структуру кода, что затрудняет его понимание. Поэтому, пожалуйста, ограничьте длину всех строк максимум 79 символами. Для длинных блоков текста (документационных строк или комментариев) рекомендуется ограничивать длину до 72 символов.


Предпочтительный способ переноса длинных строк — использование неявного продолжения строки в Python внутри круглых, квадратных и фигурных скобок. Длинные строки можно разбивать на несколько строк, заключая выражения в скобки. Этот метод следует использовать в предпочтение к использованию обратного слэша для продолжения строки.


Обратные слэши могут быть все еще уместны в некоторых случаях. Например, длинные, множественные `with`-операторы не могут использовать неявное продолжение, поэтому обратные слэши приемлемы:

Другой такой случай — это операторы `assert`.


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

### Пустые строки


Отделяйте определения функций верхнего уровня и классов двумя пустыми
строками.


Определения методов внутри класса разделяются одной пустой
строкой.


Дополнительные пустые строки могут использоваться (экономно) для разделения групп
связанных функций. Пустые строки могут быть опущены между кучей
связанных однострочников (например, набором фиктивных реализаций).


Используйте пустые строки в функциях, экономно, для обозначения логических разделов.


Python принимает символ подачи страницы в виде управляющего символа (т.е. ^L) как
пробел; Многие инструменты рассматривают эти символы как разделители страниц, поэтому
вы можете использовать их для разделения страниц связанных разделов вашего файла.
Обратите внимание, что некоторые редакторы и веб-основанные средства просмотра кода могут не распознавать
управляющий символ ^L как подачу страницы и могут отображать другой глиф на его месте.




### Кодировки (PEP 263)


Код в основном дистрибутиве Python должен всегда использовать кодировку ASCII или
Latin-1 (также известную как ISO-8859-1). Для Python 3.0 и далее,
UTF-8 предпочтительнее Latin-1, см. PEP 3120.


Файлы, использующие ASCII, не должны иметь куки кодировки. Latin-1 (или UTF-8)
должны использоваться только тогда, когда комментарий или строка документации нуждается в упоминании
имени автора, требующего Latin-1; в противном случае, использование `\x`, `\u` или
`\U` экранирования является предпочтительным способом включения не-ASCII данных в
строковые литералы.


Для Python 3.0 и далее, следующая политика предписывается для
стандартной библиотеки (см. PEP 3131): Все идентификаторы в стандартной библиотеке Python
ДОЛЖНЫ использовать только идентификаторы ASCII, и ДОЛЖНЫ использовать английские слова везде, где это возможно
(во многих случаях используются аббревиатуры и технические термины, которые не являются английскими). Кроме того,
строковые литералы и комментарии также должны быть в ASCII. Единственными исключениями являются
(a) тестовые случаи, тестирующие не-ASCII функции, и
(b) имена авторов. Авторы, чьи имена не основаны на латинском алфавите,
ДОЛЖНЫ предоставить латинскую транслитерацию своих имен.


Открытые исходные проекты с глобальной аудиторией призываются принять
подобную политику.




### Импорты


* Импорты обычно должны быть на отдельных строках, например:

Но можно и так:

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


Импорты должны быть сгруппированы в следующем порядке:


	1. импорты стандартной библиотеки
	2. импорты связанных сторонних библиотек
	3. импорты локальных приложений/библиотекМежду каждой группой импортов должна быть пустая строка.


Разместите любую соответствующую спецификацию `__all__` после импортов.
* Относительные импорты для внутрипакетных импортов настоятельно не рекомендуются. Всегда используйте абсолютный путь к пакету для всех импортов. Даже после полного внедрения PEP 328 в Python 2.5, его стиль явных относительных импортов активно не рекомендуется; абсолютные импорты более переносимы и обычно более читаемы.
* При импорте класса из модуля, содержащего классы, обычно допустимо писать так:

Если это вызывает конфликты локальных имен, то пишите их так:

и используйте “myclass.MyClass” и “foo.bar.yourclass.YourClass”.




## Пробелы в выражениях и операторах



### Частые недочеты


Избегайте лишних пробелов в следующих ситуациях:


* Непосредственно внутри круглых, квадратных или фигурных скобок.

* Непосредственно перед запятой, точкой с запятой или двоеточием:

* Непосредственно перед открывающей скобкой, начинающей список аргументов вызова функции: