- Python 100%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
Azer
1d71e0d89a
Only a refused photo was handled. A busy group reaches Telegram's limit of about twenty messages a minute even with each person held to one picture a second, and from then on the "Не так быстро" reply, /help, /start and the "unavailable" reply are refused too, as is an inline answer when the bot as a whole is over its limit. Each of those escaped its handler, and aiogram logged it at ERROR with a full traceback. Flood waits are now handled once, by an errors handler on the dispatcher: one warning line with the wait and what was dropped, e.g. flood control for 30 s, SendMessage to chat -100500 was dropped and nothing else is sent. The photo's flood wait goes the same way. The new test floods a chat with a burst, /help and an inline query; without the handler the first refused reply raises out of the dispatcher. |
||
| .forgejo/workflows | ||
| .github/workflows | ||
| screenshots | ||
| tests | ||
| .env.example | ||
| .gitignore | ||
| animals.py | ||
| config.py | ||
| lazy_models.py | ||
| LICENSE | ||
| main.py | ||
| README.md | ||
| requirements.txt | ||
| throttle.py | ||
Telegram Bot "Котики и не только" ("Cats & not only")
@randcatbot is a Telegram bot, written thanks to the Telegram Bot Api and the Python Aiogram framework. More information about this bot (in Russian) you can read here.
License: MIT
The code has NOT been polished and is provided "as is". There's a lot of code that is redundant and there are tons of improvements that can be made.
Using it
- котик or собачка in a private chat, or /cat and /dog anywhere: a random picture. In groups only the commands work, because a bot in Telegram's default privacy mode is not shown plain messages there. One picture a second per person and chat; the first request over that is told to slow down, the rest are ignored until the second is up.
- /help: how to use the bot. The commands are also in the menu next to the input field; the bot sets it on every start.
- Inline, in any chat: type
@randcatbotand pick one of two cats and two dogs.@randcatbot кот(orcat) offers four cats,@randcatbot собака(ordog) four dogs.
Running it
python -m venv .venv && . .venv/bin/activate
pip install -r requirements.txt
export BOT_TOKEN=... # from @BotFather; see .env.example
python main.py
Needs Python 3.10 - 3.14, the range aiogram 3 supports.
BOT_TOKEN is read from the environment and the bot refuses to start without
it. Nothing reads .env by itself; to use one, copy .env.example to .env,
put the token in, and load it with set -a; . ./.env; set +a before
python main.py, or hand it to systemd as below.
Only one copy of the bot can run per token: Telegram gives updates to one
poller, and a second one gets Conflict: terminated by other getUpdates request. Messages sent while the bot was down are dropped on start, not
answered all at once.
Inline mode is off for a new bot, and Telegram sends it no inline queries
until it is switched on: send /setinline to @BotFather, pick the bot and
give it a placeholder, e.g. кот или собака. The command menu needs nothing
there, since the bot sets it itself.
Keeping it running
The bot polls Telegram, so it needs no open port or domain, only outgoing
HTTPS. Logs go to stderr. A systemd unit for a checkout in
/opt/randcatbot-py owned by a randcatbot user, set up as above, with the
token in its .env:
# /etc/systemd/system/randcatbot.service
[Unit]
Description=@randcatbot
Wants=network-online.target
After=network-online.target
[Service]
User=randcatbot
WorkingDirectory=/opt/randcatbot-py
EnvironmentFile=/opt/randcatbot-py/.env
ExecStart=/opt/randcatbot-py/.venv/bin/python main.py
Restart=on-failure
RestartSec=10
[Install]
WantedBy=multi-user.target
sudo systemctl enable --now randcatbot
journalctl -u randcatbot -f
systemctl stop sends SIGTERM, which stops the polling and closes the
connections cleanly.
Tests
python -m unittest -v
They need neither a token nor the network. The handlers run through the real
dispatcher against a bot whose HTTP session records every Bot API call
instead of sending it (tests/helpers.py), and the animal APIs are mocked.
FAQ
Q: Where exactly does the bot take photos from?
A: Cats come from TheCatAPI and dogs from Dog CEO. When one of them is down, the bot falls back to Cat as a Service or random.dog on its own. Pictures are fetched ten at a time and kept ready, so a request does not wait on any of these APIs.
Q: Why are there no dogs in inline mode?
A: There are now. Inline mode used to send a single random cat; it offers two cats and two dogs, or four of either if the query asks for one.
Q: Is the author obsessed with cats?
A: No... At least I want to believe it....
Screenshots
Author
(C) 2020 by Azer Sadykhzadeh.