Дата публикации: 16.04.2025

Пеп8 для Python: руководство по стилю кодирования

Содержимое статьи:

Общие правила
Импорт
Имена переменных
Функции
Классы
Документация

Общие правила

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

Импорт
Использовать явные импорты (например, import os)
Группировать импорты по типу (например, библиотечные импорты, пользовательские импорты)
Использовать as для переименования импортов (например, import os as os_utils)

Имена переменных
Использовать дескриптивные имена переменных
Использовать соглашения об именовании (например, нижнее подчеркивание для частных переменных)
Избегать использования специальных символов (например, %, $)

Функции
Называть функции в соответствии с их функциональностью
Использовать соглашения об именовании функций (например, snake_case)
Аргументы функций должны быть документированы в начале функции с помощью строк документации
Возвращаемое значение функции должно быть указано в строке документации

Классы
Называть классы в соответствии с их функциональностью
Использовать соглашения об именовании классов (например, PascalCase)
Классы должны быть документированы с помощью строк документации
Методы класса должны быть документированы с помощью строк документации

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

Закулисы интернета SEO блог

SEO эксперименты, продвижение и монетизация сайтов, интернет-маркетинг, заработок в сети

Пеп8 для Python: руководство по стилю кодирования

Содержимое статьи:

Общие правила

Импорт

Имена переменных

Функции

Классы

Документация