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

  1. Стиль
    • <!> Задача_1: программа, к которой применять flake8 и pydocstyle

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

      • лайфхак: pep8ify

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

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

      • Ах вот ты какая, каноническая строка документации
  2. Семестровый проект
    • Посчитаться
    • Для не-желающих выдумывать: написать «Демо для библиотеки»:
      1. Общее задание: примеры использования методов некоторого модуля python, с показом исходного кода этих примеров, небольшим пояснительным текстом как к примерам, так и к самим функциям, и возможностью запустить пример и посмотреть результаты его работы
      2. GUI:
        • выбор примеров из списка
        • небольшая помощь (на английском, потом будет перевод)
        • просмотр кода
        • окно для демонстрации примера
        • кнопки управления
        • Не обязательно использовать tkinter, можно что-нибудь другое
      3. Предусмотреть для каждого примера
        • ввод входных данных для примеров (если данные простые)
        • выбор из нескольких комплектов заранее подготовленных входных данных
      4. Всю логику вынести из GUI-модуля для того, чтобы была возможность проводить unit-тесты. В MVC модели этому соответствуют части Control и Model.
      5. … (что-то ещё, что возникнет по мере обсуждения)

Д/З

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

  2. Оформить логику приложения в виде отдельного модуля, а интерфейс — в виде другого или в виде основной программы.
  3. Добиться полного отсутствия претензий со стороны flake8/pydocstyle к Задаче_1, выложить её в отчётный репозиторий стандартным способом

LecturesCMC/PythonDevelopment2021/Prac/07_Style (последним исправлял пользователь FrBrGeorge 2021-04-06 12:55:14)