03.28 Стиль программирования, комментарии и строки документации

  1. Про стиль оформления в частности, и вообще дисциплину программирования
    • (повторение) Зачем нужно

    • Соблюдение дисциплины оформления VS переформатирование

      • Недостаток переформатирования — несоответствие с личными привычками (особенно в случае «тяжёлых» форматтеров типа yapf и black)

      • Альтернатива — autopep8, исправление только PEP8-несовместимостей

  2. {i} Установка и использование flake8

    • Настройка .flake8 (в частности, длины строк)

  3. {i} Установка и использование pydocstyle

    • Ах вот ты какая, каноническая строка документации

  4. <!> Задача_1: программа, к которой необходимо применить flake8 и pydocstyle

    • Взять решение из задачки про MUD (вы ведь наверняка её уже решили...)

    • Оформить (если ещё не) решение в виде пакета
    • Разделить логическую и интерфейсную части (если ещё не):
      • Логика в одном подмодуле
      • Cmdline-интерфейс — в другом

      • Общий запуск в __main__.py

    • Добиться полного отсутствия претензий со стороны flake8 и pydocstyle к содержимому модуля

      • Разрешается настраивать ☺

Д/З

Пример репозитория, соответствующего требованиям

  1. Доделать Задачу_1

  2. Выложить её в отчётный репозиторий стандартным способом

Напоминаю, что примерно те же требования относятся и к семестровому проекту.

LecturesCMC/PythonDevelopment2022/Prac/07_Style (последним исправлял пользователь FrBrGeorge 2022-03-28 13:15:28)