1Git: код бота під контролем версій

121 Зайти на сервер і переконатися, що бот живий

ssh bohdan.g9@91.219.61.4
cd ~/app
pwd
systemctl --user is-active club-bot
python3 try_bot.py "/start"

pwd має надрукувати /home/bohdan.g9/app — git працюватиме саме з цим репозиторієм. systemctl --user is-active club-bot відповідає active: служба з ботом працює. try_bot.py друкує привітання бота, наприклад Привіт, Тест! Я бот проєкту «…». Напиши /help. Ім’я «Тест» підставляє try_bot.py.

Якщо служба failed або try_bot.py друкує помилку, бот із заняття 02 зламаний, і спершу його треба полагодити: tail -n 30 ~/logs/club-bot.log покаже причину. Починати історію змін зі зламаного бота не варто.

132 Підписати свої коміти

Git записує в кожен коміт ім’я й пошту автора. Перевір, чи вони вже задані:

git config --global user.name
git config --global user.email

Якщо обидві команди щось надрукували — пропусти наступний блок. Якщо у відповідь порожньо, назви себе. Ім’я пиши без прізвища: історію бачить викладач, а на GitHub — кожен, кому ти покажеш репозиторій.

git config --global user.name "Богдан"
git config --global user.email "$(whoami)@club.local"

$(whoami) термінал замінить твоїм логіном, як на занятті 02. Пошту git нікуди не надсилає, це лише підпис; адреса club.local вигадана навмисно, а справжню пошту сюди не пиши — вона потрапила б у кожен коміт. --global означає «для всіх репозиторіїв твого акаунта», тому робиться це один раз. І ще одне налаштування — щоб git, коли йому знадобиться редактор, відкривав знайомий тобі nano:

git config --global core.editor nano
git config --global --list

Перша команда нічого не друкує — так і має бути. Друга показує все разом: рядки user.name=…, user.email=… і core.editor=nano.

143 Подивитися, що вже є в репозиторії

ls -a
git status
git log --oneline
git branch --show-current
git remote -v

• ls -a покаже й приховані файли, чиї назви починаються з крапки: .git (це історія), .gitignore, .env, .env.example. Серед звичайних буде ще тека __pycache__ — її створив Python, коли запускав try_bot.py;
• git status має сказати On branch master і nothing to commit, working tree clean — усе із заняття 02 збережено комітами. Може бути ще рядок Your branch is up to date with 'github/master': GitHub знає ті самі коміти;
• git log --oneline покаже кілька рядків: унизу «Заготовка проєкту», вище — коміти заняття 02. Якщо ти вже працював з git раніше, рядків буде більше — нічого страшного, нові коміти ляжуть зверху;
• git branch --show-current надрукує назву основної гілки — master. Якщо в тебе main, далі скрізь пиши main замість master;
• git remote -v — чотири рядки: github з адресою git@github.com:…/club-app.git і origin зі шляхом /home/bohdan.g9/repo.git, кожен двічі — (fetch) і (push). Це ті два віддалені репозиторії з теорії. Якщо на занятті 02 ти не заводив GitHub (немає 13 років або дозволу батьків), рядків буде два, лише origin, — і це нормально: працюй з ~/repo.git, а кроки з github пропускай.

Якщо git status показує змінені файли (modified), щось із заняття 02 лишилося без коміту. Подивись git diff і, якщо все гаразд, збережи комітом: git add -A, потім git commit -m "Заняття 02: бот відповідає на /start і /help".

154 Перевірити, що токен не потрапить у Git

cat .gitignore
git check-ignore -v .env __pycache__ app.db

У .gitignore є рядки .env, *.db, venv/ і __pycache__/. Друга команда для кожного імені друкує правило, яке його приховує:

.gitignore:12:.env	.env
.gitignore:4:__pycache__/	__pycache__
.gitignore:8:*.db	app.db

Читається так: файл із правилами, номер рядка в ньому, саме правило, а після проміжку — ім’я, яке воно приховує. Номери рядків у тебе можуть бути інші. Файлу app.db ще немає, але правило *.db уже на нього чекає.

Якщо для якогось імені рядка немає або в cat .gitignore бракує .env, *.db чи venv/ (так буває в тих, хто починав курс раніше й писав .gitignore сам), — зупинись і допиши відсутні правила в кінець файлу, кожне окремим рядком, наприклад echo "venv/" >> .gitignore (два знаки >> дописують рядок у кінець). Потім знову запусти git check-ignore -v і збережи комітом: git add .gitignore, git commit -m "доповнив .gitignore: .env, база й venv не потрапляють у Git". Автоперевірка L03.2 дивиться саме на ці три правила.

Тепер спробуй навмисно додати токен у Git. Це безпечно: git не дасть.

git add .env

The following paths are ignored by one of your .gitignore files:
.env
hint: Use -f if you really want to add them.

Git відмовився й нічого не додав (нижче може бути ще рядок-підказка, як вимкнути це повідомлення). Параметр -f з підказки для .env не використовуй ніколи. Ще дві перевірки:

git ls-files
git log --all --oneline -- .env

git ls-files друкує повний список файлів, за якими стежить git: bot.py, env.py, run.py, try_bot.py, .env.example, README.md та інші. Серед них не має бути .env і файлів .db. (.env.example — інший файл, токена в ньому немає, і в репозиторії йому саме місце: з нього видно, які налаштування потрібні боту.)

Друга команда шукає в усіх гілках коміти, у яких хоч раз був файл .env, і має не надрукувати нічого. Порожньо — токен ніколи не потрапляв у Git. Якщо з’явився хоч один рядок, переходь до розділу «Якщо щось не працює», останній пункт.

165 Додати боту команду /fact

nano bot.py

Знайди підказку HELP і допиши один рядок про нову команду — між рядком про /about і рядком про відлуння. Решту рядків не чіпай: кожен із них уже закінчується на \n (так у тексті підказки позначають перехід на новий рядок), тому змінюється лише один рядок:

HELP = ("Що я вмію:\n"
        "/start — привітання\n"
        "/help — ця підказка\n"
        "/about — хто мене зробив\n"
        "/fact — цікавий факт\n"
        "будь-який інший текст — повторю його")

Тепер у функції handle_update знайди перевірку /about (її ти додав на занятті 02) і одразу під її return встав два нові рядки — перед рядком if text.startswith("/"):. Факт вигадай свій, про тему твого проєкту; нижче приклад для бота про космос:

    if text.startswith("/about"):
        return f"Проєкт «{PRODUCT}», автор — {CFG['product']['author']}."
    if text.startswith("/fact"):
        return "Цікавий факт: на Венері доба довша за рік."
    if text.startswith("/"):
        return "Не знаю такої команди. Напиши /help."

Що тут відбувається. Кожна команда — це перевірка «якщо повідомлення починається з такого-то слова, поверни такий-то текст». Відступи — рівно 4 і 8 пробілів, як у сусідніх рядках, а текст відповіді — у лапках, які треба закрити.

Чому саме тут, а не в кінці функції? Python перевіряє умови згори вниз і виконує першу, яка підійшла. Рядок if text.startswith("/") ловить будь-яку команду, якої бот не знає. Якщо поставити /fact нижче за нього, до /fact черга не дійде ніколи.

Збережи (Ctrl+O, Enter) і вийди (Ctrl+X). Перевір бота й подивись, що змінилося:

python3 try_bot.py "/fact"
python3 try_bot.py "/help"
git diff

/fact відповідає твоїм фактом. /help показує шість рядків, серед них новий. git diff показує три рядки з плюсом і жодного з мінусом: один у HELP і два в handle_update. Старих рядків ти не міняв, тож їх diff не позначає.

Якщо замість відповіді бачиш SyntaxError, Python пише номер рядка й ставить знак ^ під місцем помилки: найчастіше там загублена лапка, дужка або двокрапка. Якщо два рядки підказки злилися в один (/about — хто мене зробив/fact — …), ти забув \n. Відповідь Не знаю такої команди на /fact означає, що команду вставлено нижче за перевірку /.

Усе працює — записуємо в історію й оновлюємо живого бота:

git add bot.py
git commit -m "додав команду /fact: бот розповідає цікавий факт про тему проєкту"
systemctl --user restart club-bot
systemctl --user is-active club-bot

git commit відповідає приблизно так: [master 58d966e] додав команду /fact: бот розповідає цікавий факт про тему проєкту і нижче 1 file changed, 3 insertions(+). Це гілка, короткий хеш (у тебе свій), твоє повідомлення і скільки рядків додано й прибрано. Служба — active. Напиши боту в Telegram /fact — він відповість так само, як try_bot.py.

176 Переписати README: що це за бот і як його запустити

README.md — головний опис проєкту. Його першим бачить кожен, хто відкриває твій репозиторій на GitHub. Зараз у ньому текст заготовки.

nano README.md

Зроби три речі:

1. перший рядок # Мій сервіс заміни назвою свого бота;
2. у розділі ## Що це прибери службовий текст між знаками підкреслення — він починається словами «Заняття 01: опиши одним абзацом» — і напиши свій абзац: для кого бот, що він уже вміє і як його знайти в Telegram;
3. у розділі ## Як запустити допиши, що бот живе в службі club-bot, де лежить токен і як перевірити бота без Telegram. Команди, які там уже є, лиши.

Нижче зразок для чужого бота: він показує, з чого складаються розділи. У тебе інший бот і інший текст, тому пиши своє.

# Бот-помічник для походу

## Що це

Telegram-бот @bohdan_pohid_bot для однокласників, які вперше йдуть
у похід з ночівлею. Зараз він вітається (/start), показує свої
команди (/help), розповідає про проєкт (/about), ділиться
цікавим фактом (/fact) і повторює текст, який йому написали.

## Як запустити

Бот живе у службі club-bot на сервері (її запускає run.py), тому відповідає,
навіть коли мій комп'ютер вимкнено. Токен бота лежить у файлі .env,
якого в репозиторії немає навмисно: його роблять з .env.example
(cp .env.example .env && chmod 600 .env) і вписують токен від @BotFather.

    systemctl --user restart club-bot      # перезапуск після зміни коду
    tail -n 30 ~/logs/club-bot.log    # останні рядки журналу

Перевірити бота без Telegram:

    python3 try_bot.py "/start"

Заголовки лишай точно такими: два знаки решітки, пробіл, текст. Автоперевірка шукає саме ## Що це і ## Як запустити, а службового тексту заготовки там бути не має. Токена, паролів і свого прізвища в README не пиши: цей файл бачитимуть на GitHub. Збережи файл і збережи комітом:

git diff
git add README.md
git commit -m "переписав README: для кого бот і як його запустити"

git diff покаже рядки заготовки з мінусом і твій текст із плюсом. Коміт відповість рядком [master …] з твоїм повідомленням.

187 Дві зміни — два коміти

Вправа на індекс: ти зробиш дві різні зміни, а збережеш їх двома окремими комітами.

Перша — у bot.py. Перепиши привітання /start своїми словами: скажи, навіщо цей бот. {name} і {PRODUCT} лиши — це ім’я людини й назва проєкту. Наприклад:

    if text.startswith("/start"):
        return (f"Привіт, {name}! Я бот проєкту «{PRODUCT}». "
                "Я допомагаю зібратися в похід. Напиши /help.")

Друга — у README.md. Нижче, у розділі ## Структура, є таблиця файлів. Допиши рядки про файли бота одразу під її останнім рядком (з deploy.sh), без порожнього рядка між ними — інакше таблиця розірветься. Якщо такого розділу в тебе немає, допиши в кінець файлу рядок ## Структура, а під ним — ці рядки:

| `bot.py` | логіка бота: що він відповідає на кожне повідомлення |
| `env.py` | читає токен і налаштування з `.env` |
| `try_bot.py` | перевірка бота без Telegram |

Збережи обидва файли й подивись:

python3 try_bot.py "/start"
git status

Бот вітається по-новому. git status показує обидва файли в списку Changes not staged for commit. Покладемо в індекс лише один:

git add bot.py
git status
git diff --staged

Тепер bot.py стоїть угорі, під Changes to be committed, а README.md лишився нижче. git diff --staged показує тільки зміну привітання: саме вона піде в коміт. Записуємо одну зміну, потім другу:

git commit -m "переписав привітання /start: бот пояснює, навіщо він"
git add README.md
git commit -m "додав у README опис файлів бота"
git log --oneline

У git log --oneline зверху два нові рядки, кожен про своє. Перезапусти службу (systemctl --user restart club-bot) і напиши боту /start у Telegram.

198 Зламати бота й повернути, поки не зберіг комітом

Ламаємо навмисно — так, як ламається по-справжньому: одним пропущеним символом.

nano bot.py

Знайди рядок if text.startswith("/help"): і зітри двокрапку в кінці. Збережи й вийди. Перевір:

python3 try_bot.py "/help"

Замість відповіді — повідомлення про помилку. Його кінець такий:

  File "/home/bohdan.g9/app/bot.py", line 61
    if text.startswith("/help")
                               ^
SyntaxError: expected ':'

Python не зміг навіть прочитати файл: expected ':' — «очікував двокрапку» в рядку 61 (у тебе номер може бути інший). Тепер подивись, що стане з живим ботом:

systemctl --user restart club-bot
tail -n 15 ~/logs/club-bot.log

У журналі той самий SyntaxError (якщо його ще немає, зачекай кілька секунд і повтори другу команду). Служба падає ще під час запуску, а systemd за правилом Restart=always кожні три секунди пробує запустити її знову — і знову марно. Напиши боту в Telegram /help: він мовчить. Ось чим небезпечна одна загублена двокрапка. Повертаємо:

git status
git diff
git restore bot.py
git diff

git status показує modified: bot.py. Перший git diff — рядок із двокрапкою з мінусом і без неї з плюсом: оце й уся поломка. Після git restore другий git diff не друкує нічого: файл знову такий, як в останньому коміті. Перезапускаємо:

python3 try_bot.py "/help"
systemctl --user restart club-bot
systemctl --user is-active club-bot

Підказка знову на місці, служба active. А повідомлення, які ти писав зламаному ботові, за кілька секунд отримають відповідь: Telegram тримав їх, доки бот не повернувся. Запам’ятай порядок: журнал → git diff → git restore → перезапуск.

209 Поганий коміт і git revert

Буває гірше: зміну вже зберегли комітом, а потім з’ясувалося, що вона ламає бота. Відтворимо це. Уяви, що ти вирішив «навести порядок» і перенести перевірку невідомих команд на самий верх.

nano bot.py

У handle_update постав курсор на рядок if text.startswith("/"): і двічі поспіль натисни Ctrl+K — виріжуться він і рядок під ним (return "Не знаю такої команди…"). Стрілками підніми курсор на рядок if text.startswith("/start"):, на самий його початок (клавіша Home), і натисни Ctrl+U — вирізане вставиться над ним. Якщо курсор стоятиме посеред рядка, вставка розріже рядок навпіл. Збережи, вийди й збережи комітом, ніби все гаразд:

git diff
git add bot.py
git commit -m "перемістив перевірку невідомих команд вище"
python3 try_bot.py "/help"
python3 try_bot.py "/about"

git diff показав, що два рядки зникли внизу й з’явилися вгорі. А бот і на /help, і на /about відповідає Не знаю такої команди. Напиши /help. Усі команди починаються з /, тож перша ж перевірка тепер ловить їх усі. Коміт поганий — скасовуємо:

git log --oneline -3
git show HEAD
git revert --no-edit HEAD

git show HEAD показує останній коміт: автора, дату, повідомлення й ті самі переставлені рядки. git revert відповідає:

[master 654d9b6] Revert "перемістив перевірку невідомих команд вище"
 Date: …
 1 file changed, 2 insertions(+), 2 deletions(-)

У рядку Date: — дата й час нового коміту. Перевір, що бот знову розуміє команди, і подивись історію:

python3 try_bot.py "/help"
git log --oneline -3
systemctl --user restart club-bot

Підказка знову працює. У git log видно обидва коміти: поганий і його скасування. Нічого не стерто, і через місяць буде зрозуміло, що тут сталося. Службу між цими кроками ти не перезапускав, тож живий бот увесь час працював зі старим, правильним кодом; перезапуск наприкінці — щоб служба точно взяла поточну версію файлу.

2110 Експеримент у гілці proba

git switch -c proba
git branch

Git відповідає Switched to a new branch 'proba', а git branch показує дві гілки, зірочка — проти proba. Тепер експеримент: хай бот на звичайний текст ще й рахує слова й символи. Відкрий nano bot.py і заміни останній рядок handle_update — return f"Ти написав: {text}" — на два:

    words = len(text.split())
    return f"Ти написав: {text}\nСлів: {words}, символів: {len(text)}."

text.split() розрізає текст на слова за пробілами, а len() рахує, скільки вийшло шматків (або скільки символів у рядку). Перевір і збережи комітом у гілку:

python3 try_bot.py "привіт, як справи"
git add bot.py
git commit -m "проба: бот рахує слова й символи в повідомленні"

Бот відповідає двома рядками: Ти написав: привіт, як справи і Слів: 3, символів: 17. Відповідь git на коміт починається з [proba …]: коміт записано в гілку proba. Хочеш побачити експеримент у Telegram — перезапусти службу: вона візьме файли поточної гілки. Тепер повертайся:

git switch master
python3 try_bot.py "привіт, як справи"
git log --oneline --graph --all -4

У master бот відповідає по-старому, одним рядком. Остання команда малює історію всіх гілок:

* 51b16fb (proba) проба: бот рахує слова й символи в повідомленні
* 654d9b6 (HEAD -> master) Revert "перемістив перевірку невідомих команд вище"
* 389010d перемістив перевірку невідомих команд вище
* 7abcaeb додав у README опис файлів бота

Позначки в дужках показують, де закінчується кожна гілка: proba на один коміт попереду master, а HEAD -> master означає, що ти зараз на master. Хеші в тебе свої, і можуть бути ще позначки origin/master чи github/master — так git показує, до якого коміту дійшла кожна копія. Тепер вирішуй сам:

• експеримент сподобався — перенеси його в master: git merge --no-edit proba. Git відповість Fast-forward: master просто пересунувся до коміту proba;
• не сподобався — нічого не роби: master лишається без нього, а експеримент чекає в proba.

В обох випадках гілку proba не видаляй: автоперевірка шукає в репозиторії другу гілку. І перезапусти службу, щоб живий бот працював з кодом master:

systemctl --user restart club-bot

2211 Відправити історію в ~/repo.git

git branch --show-current
git push origin master
git push origin proba

Перша команда має надрукувати master: відправляємо з основної гілки. git push друкує кілька рядків підрахунку (Enumerating objects…, Writing objects…) — це git пакує коміти. Важливий останній рядок:

To /home/bohdan.g9/repo.git
   c255902..654d9b6  master -> master

Зліва — коміт, який був у ~/repo.git до команди, справа — який став після неї. Для proba буде * [new branch] proba -> proba: такої гілки там ще не було. Перевір, що коміти дійшли:

git log --oneline -1
git -C ~/repo.git log --oneline -1 master
git -C ~/repo.git branch

Параметр -C означає «виконай команду в іншій теці, не переходячи туди». Перші два рядки мають бути однакові — той самий хеш і те саме повідомлення: це й перевіряє критерій L03.4. Остання команда показує дві гілки, master і proba.

2312 Перевірити себе перед кінцем заняття

git status
git log --oneline
git ls-files
git log --all --oneline -- .env
git branch

• git status — nothing to commit, working tree clean;
• git log --oneline — над «Заготовкою проєкту» щонайменше п’ять твоїх комітів, і кожен ти можеш пояснити своїми словами;
• git ls-files — без .env і без файлів .db;
• git log --all --oneline -- .env — порожньо;
• git branch — master і proba, зірочка проти master. Якщо зірочка проти proba, виконай git switch master: автоперевірка дивиться на поточну гілку.

2513 Зберегти залишки комітом й відправити

cd ~/app
git switch master
git add -A
git commit -m "Заняття 03: команда /fact, відкат поломок і гілка proba"
git push origin master
git push github master
git push github proba

Якщо git switch каже Already on 'master' — ти вже на основній гілці. Якщо git commit відповідає nothing to commit, working tree clean, усе вже лежить у комітах — це добре, переходь до push. Перший push оновлює ~/repo.git (потрібен, якщо щойно з’явився новий коміт), два наступні — GitHub. Останній рядок кожного — стрілка master -> master або proba -> proba; для proba на GitHub — * [new branch]. Відповідь Everything up-to-date означає, що відправляти нічого: ця копія вже має всі твої коміти.

Наприкінці наступних занять роби так само: коміт, потім git push origin master і git push github master — тоді обидві копії знають усю твою роботу.

2614 Подивитися на результат на GitHub

Відкрий свій репозиторій club-app на github.com і онови сторінку. Має бути:

• над списком файлів — кількість комітів; натисни на неї, і побачиш свої повідомлення в тому самому порядку, що й у git log;
• у списку гілок (кнопка з назвою master) — ще й proba;
• серед файлів — bot.py, .env.example, а під списком — твій README.md з розділами «Що це» і «Як запустити». Файлу .env там немає — і не має бути.

Якщо push відповів Permission denied (publickey), GitHub не впізнав ключ сервера. Виконай ssh -T git@github.com і дивись розділ «Якщо щось не працює».