Инструменты пользователя

Инструменты сайта


courses:python-formatting-guide

Содержание

python-formatting-guide

Предупреждения Pylint (W)

W0301: Unnecessary semicolon (unnecessary-semicolon)

Точка с запятой в конце инструкции не требуется. В Python символ ; используют для разделения нескольких инструкций в одной строке, но обычно каждую инструкцию записывают отдельно.

W0311: Bad indentation. Found %s %s, expected %s (bad-indentation)

Отступ не соответствует принятому формату: используется количество пробелов, не кратное четырем, или табуляция. В текущей конфигурации каждый уровень вложенности должен составлять ровно четыре пробела.

W0702: No exception type(s) specified (bare-except)

Конструкция except: перехватывает исключения всех типов, в том числе KeyboardInterrupt и SystemExit. Из-за этого может быть сложно прервать выполнение программы, а важные ошибки могут остаться незамеченными. Перехватывайте исключения конкретных типов. Используйте except Exception, только если действительно необходимо обработать широкий набор обычных ошибок.

W0706: The except handler raises immediately (try-except-raise)

Блок except только повторно возбуждает перехваченное исключение с помощью raise и не выполняет никаких других действий. Такой блок try/except не приносит пользы. Удалите try/except либо добавьте обработку исключения - например, логирование или преобразование в исключение другого типа.

W0717: try clause contains 8 statements, expected at most 7 (too-many-try-statements)

В блоке try больше операторов, чем допускает настройка. В данном примере максимальное количество - семь. Оставляйте в блоке try только те операции, которые могут вызвать исключение, обрабатываемое в соответствующем except. Это поможет точнее определить, на каком участке кода произошла ошибка.

W0718: Catching too general exception %s (broad-exception-caught)

Обработчик перехватывает слишком общий тип исключения, например Exception или BaseException. Из-за этого он может скрыть ошибки, которые код не должен обрабатывать. Указывайте конкретные типы исключений, с которыми умеет работать обработчик.

W1401: Anomalous backslash in string: '%s'. String constant might be missing an r prefix. (anomalous-backslash-in-string)

В обычной строке используется обратная косая черта (), за которой следует последовательность, не распознаваемая Python как управляющая последовательность. Например, \d в регулярном выражении. Python сохранит такую последовательность, но выдаст предупреждение SyntaxWarning. Чтобы избежать предупреждения, используйте raw-строки с префиксом r - например, r«…» - или экранируйте обратную косую черту (\). Для путей и регулярных выражений обычно удобнее использовать raw-строки.

W1402: Anomalous Unicode escape in byte string: '%s'. String constant might be missing an r or u prefix. (anomalous-unicode-escape-in-string)

В байтовой строке используется Unicode escape-последовательность, например \N{…} или \uXXXX. Если требуется получить Unicode-символ, используйте обычную строку без префикса b. Если обратную косую черту нужно сохранить как обычный символ, используйте raw-строку с префиксом rb или экранируйте ее (\).

Соглашения Pylint (C)

C0104: Disallowed name "%s" (disallowed-name)

Используется имя, характерное для примеров кода в документации, например foo, bar или baz. Такие имена не отражают назначение переменных/функций/методов и затрудняют понимание кода. Замените имя на более информативное, соответствующее назначению переменной, функции или класса. Например: total, file_path, student_names.

C0114: Missing module docstring (missing-module-docstring)

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

C0116: Missing function or method docstring (missing-function-docstring)

У функции или метода отсутствует docstring — строка документации в тройных кавычках, которая кратко описывает назначение функции, её основные действия и, при необходимости, входные и возвращаемые значения. Добавьте docstring сразу после объявления функции или метода.

C0301: Line too long (%s/%s) (line-too-long)

Длина строки превышает установленный лимит. В текущей конфигурации он составляет 79 символов. Разбейте выражение на несколько строк, используя скобки, или вынесите часть выражения в отдельную переменную. Отдельные строки с URL могут быть исключены из проверки настройкой ignore-long-lines.

C0321: More than one statement on a single line (multiple-statements)

В одной строке записано несколько инструкций, разделенных символом ;, либо тело if, while и другого управляющего оператора размещено в той же строке. Перенесите инструкции на отдельные строки и оформите блоки с соответствующими отступами.

C0411: %s should be placed before %s (wrong-import-order)

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

  1. Модули стандартной библиотеки.
  2. Сторонние пакеты.
  3. Модули проекта.

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

C0412: Imports from package %s are not grouped (ungrouped-imports)

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

C0413: Import "%s" should be placed at the top of the module (wrong-import-position)

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

Рефакторинг Pylint (R)

R2004: Consider using a named constant or an enum instead of '%s'. (magic-value-comparison)

В условии сравнения используется «магическое» значение - литерал без поясняющего имени. Из-за этого назначение значения может быть непонятно из контекста. Вынесите его в именованную константу или используйте элемент Enum, чтобы сделать смысл значения очевидным.

flake8

E301: expected 1 blank line, found 0 (expected-1-blank-line)

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

E302: expected 2 blank lines, found N (expected-2-blank-lines)

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

E303: too many blank lines (too-many-blank-lines)

Между блоками кода слишком много пустых строк. На уровне модуля допускается не более двух пустых строк подряд, внутри класса - не более одной.

E304: blank lines found after function decorator (blank-lines-after-decorator)

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

E305: expected 2 blank lines after class or function definition (expected-2-blank-lines-after-definition)

После определения функции или класса верхнего уровня оставьте две пустые строки перед следующим объявлением верхнего уровня.

E306: expected 1 blank line before a nested definition (expected-1-blank-line-before-nested-definition)

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

CCR001: Cognitive complexity is too high (SCORE > 15) (cognitive-complexity-is-too-high)

Когнитивная сложность функции превышает допустимый порог - 15. Эта метрика оценивает, насколько сложно проследить логику выполнения функции. На нее влияют количество ветвлений, глубина вложенности условий и циклов, а также сложность логических выражений. Чтобы снизить когнитивную сложность: - Разделите большую функцию на несколько небольших. - Вынесите сложные условия в переменные с понятными именами. - Используйте ранний выход (return или continue), чтобы уменьшить вложенность. - Упрощайте логические выражения и по возможности избегайте глубокой вложенности.

courses/python-formatting-guide.txt · Последнее изменение: — d.s.butenko