02.24 Использование pip и venv, редактирование истории в git

Упражнения с git делаем в отдельном репозитории — не в репозитории с Д/З.

Остальные — примерно так:

•    $ git clone репозиторий-с-доступом-на-запись
     $ cd репозиторий
     $ mkdir -p `date "+%Y%m%d"`/0
     $ cd `date "+%Y%m%d"`/0
     $ # hack-hack-hack
     $ git add .
     $ git commit -a -m "Classes (или что-то такое)"
     $ git push

pip и venv

• Работа с окружениями с помощью venv

  • структура каталога; что такое activate

• Pip

  • Работа с pip — pip install pip-search, pip list, pip show [-f] rich, pip uninstall rich

    • Ой! Замечание о бедности зависимостей

• Работа с pipenv (введение)

  • Создание, вход и установка

  • Найдите, где pipenv держит базовый каталог ☺

• ВНИМАНИЕ - при работе в созданном изолированном окружении не следует запускать программы из idle, т.к. эта среда написана на python и тянет с собой лишнее

• Использование стороннего пакета на примере python-cowsay

  • Установка и использование в программе

  • Документация vs исходный код

  • Написать примитивную утилиту (как в Д/З к лекции, но выводящую только корову по имени и сообщение)

  • Скачайте любимую корову отсюда, подсуньте её в соответствующий каталог убедитесь, что работает.

Редактирование истории (введение)

• Создание ветки от выбранного коммита

  • Создадим репозиторий, накидаем туда три коммита

  • Посмотрим историю (просто так и git log --graph --all --oneline)

  • Создадим ветку new из предпоследнего коммита (git checkout -b new ID (или HEAD~)

  • Добавим в ветку new ещё один коммит

  • Переключимся на основную ветку (git checkout …у кого как … master или main)

  • Должно получиться две ветки, в каждой по разному коммиту:

       1 $ git -P log --graph --all --oneline
       2 * 12b0622 (HEAD -> new) W added
       3 | * 044d183 (master) Whoami
       4 |/  
       5 * a585bf4 Date
       6 * 7fd566f Initial
       7 
    

• Просмотр веток с помощью qgit (git-cola, gitk — вот он есть часто)

  • Ещё есть tig --all

  • Есть какие-то встроенные в IDE…
• Редактирование истории

  • Поправить последний коммит: git commit --amend (или --amen ♱)

  • переключиться на соседнюю ветку. Изменить прошлое: git rebase -i HEAD~~ (с самого начала --root)

  • Объединить последний коммит с предпоследним (s или f)

  • Убедиться в том, что ветка «переотросла», и изменённые коммиты в ней другие:

       1 * 0557d03 (HEAD -> master) Date
       2 | * 12b0622 (new) W added
       3 | * a585bf4 Date
       4 |/  
       5 * 7fd566f Initial
       6 
    

• (если успеем) Переупорядочение коммитов

Д/З

Для решения задач заводите виртуальные окружения с помощью pipenv в каждом отдельном каталоге с решениями (1, 2 и т п.)

• Задача_1: напишите программу, реализующую простейший multi-user dungeon (по ходу практикума MUD будет усложняться)

  • имеется поле 10х10 клеток; рисовать поле и его наполнение - не нужно
    • по каждой оси нумерация с 0 по 9
    • первая координата задает координату по горизонтали, вторая - по вертикали
    • клетка (0, 0) находится в левом верхнем углу поля (важно для навигации)
  • в каждой клетке может либо быть пусто, либо находиться один монстр
  • по полю ходит игрок; когда он попадает на клетку с монстром, случается "происшествие" (encounter)
  • в начале игры игрок появляется в клетке (0, 0)
  • настройка поля и игровой процесс организованы при помощи командной строки

  • должен поддерживаться не только интерактивный режим (с консольным вводом), но и режим с получением команд из текстового файла (перенаправление ввода при помощи "<") - это нужно для автотестирования

  • начальная версия командного языка:

    • up, down, left, right

      • перемещение по полю на одну клетку в выбранном направлении

      • если игрок переходит через границу поля, он появляется у противоположной границы (например, left в позиции (0, 5) переводит в позицию (9, 5))

      • при выполнении команды выводится: "Moved to (<x>, <y>)", где <x>, <y> - координаты клетки, куда попал игрок

      • если игрок попал в клетку с монстром, случается "происшествие", логика которого описана ниже

    • addmon <x> <y> <hello>

      • добавление в клетку (x, y) монстра, при встрече говорящего слово-приветствие, заданное в <hello> (достаточно поддерживать слова без пробелов)

      • если в этой клетке уже есть монстр, новый монстр его заменяет (пока это сводится к замене слова-приветствия)
      • если в этой клетке находится игрок, происшествие при добавлении монстра не случается

      • при выполнении команды выводится: "Added monster to (<x>, <y>) saying <hello>"; если монстр заменяется, также выводится, с новой строки, "Replaced the old monster"

    • при вводе неверной команды должно выводиться "Invalid command"
    • при вводе команды с неверными аргументами должно выводиться "Invalid arguments", фанатично проверять корректность аргументов НЕ нужно
  • отработка происшествия (т.е. попадания игрока на клетку с монстром):

    • происшествие должно отрабатываться в функции encounter(x,y), вызываемой после вывода "Moved to ..."

    • вывести текстового монстра, произносящего слово-приветствие

    • для формирования монстра, говорящего текст, используется функция cowsay(text) из модуля python-cowsay

      • этот модуль нужно поставить в окружение с помощью pipenv install

      • для начала все монстры будут выглядеть как default'ная корова из cowsay

• Задача_2: заведите ветку named_monsters в репозитории Д/З и на ней добавьте в MUD (на параллельной ветке в git) поддержку именованных монстров, при этом пользуйтесь редактированием истории на ветке. Решение это задачи надо делать на ветку named_monsters.

  • Скопируйте решение Задачи_1.

  • новая функциональность (её нужно разбить на коммиты, как сказано ниже!):

    • поддержка команды addmon <name> <x> <y> <hello> , где <name> это имя монстра (строка без пробелов)

      • старый (без имени) формат команды больше не должен поддерживаться
    • для клетки (x, y) должно запоминаться имя монстра, в дополнение к строке-приветствию

    • строка, выводимая при успешном добавлении монстра, должна выглядеть так: "Added monster <name> to (<x>, <y>) saying <hello>"

    • когда игрок попадает на клетку с монстром, в функции encounter() должно выводиться существо из коллекции модуля python-cowsay, произносящее приветствие (использовать функцию cowsay(message, cow=name))

    • при выполнении команды addmon должно проверяться, что <name> это имя одного из "штатных" существ, доступных в python-cowsay (список имен см. list_cows). Если проверка неуспешна, добавление монстра не выполняется, и выводится "Cannot add unknown monster".

  • занесите новую функциональность на ветку named_monsters (создание ветки: git checkout -b) в виде следующих коммитов, именно в таком порядке:

    • а) доработка разбора и обработки команды addmon <x> <y> <name> <hello>, кроме проверки того, что <name> - имя "штатного" существа

      • порядок аргументов перепутан специально, чтобы потом редактировать историю

    • б) добавление передачи имени монстра в вызов cowsay() из функции encounter()

    • в) добавление в обработку команды addmon проверки того, что <name> - имя "штатного" существа

  • каждый коммит нужно выполнять после отладки соответствующей функциональности, удалив отладочный код; разработали+отладили а) => занесли а), потом переходим к б), и т.п.

  • отредактируйте историю (git rebase -i) на ветке named_monsters:

    • в коммите а) замените в разборе addmon порядок аргументов команды на правильный (опция edit)

    • переставьте местами коммиты б) и в)

    • содержание коммитов в истории удобно контролировать при помощи команды git log --patch

  • ещё раз отредактируйте историю на ветке named_monsters:

    • объедините коммиты а) и в)