Skip to content

Форматирование кода в соответствии с PEP 8 и Google Python Style Guide

Требования к форматированию

  1. Добавление Docstring:
  2. Для класса: описание назначения и атрибутов в Google-формате на русском языке
  3. Для методов: описание аргументов, возвращаемых значений и возможных исключений

  4. Сохранение комментариев:

  5. Разделительные комментарии (например, #actions:, # assertions:) остаются без изменений
  6. Закомментированный код сохраняется в оригинальном виде
  7. Технические комментарии в методах не изменяются

  8. Перевод комментариев:

  9. Разделительные комментарии переводятся (например, # Действия:, # Проверки:)
  10. Пояснительные комментарии к логике кода переводятся
  11. Не переводятся:

    • Технические сообщения в assert, raise и других системных конструкциях
    • Закомментированный код
    • Сообщения в логах и ошибках
  12. Форматирование кода:

  13. Соответствие PEP 8 (отступы, пробелы вокруг операторов)
  14. Сохранение исходной структуры кода
  15. Без изменений рабочей логики программы