selfrotgram 0.1.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- selfrotgram-0.1.1/LICENSE +21 -0
- selfrotgram-0.1.1/PKG-INFO +243 -0
- selfrotgram-0.1.1/README.md +214 -0
- selfrotgram-0.1.1/pyproject.toml +58 -0
- selfrotgram-0.1.1/selfrot/__init__.py +40 -0
- selfrotgram-0.1.1/selfrot/__main__.py +3 -0
- selfrotgram-0.1.1/selfrot/callback_data.py +116 -0
- selfrotgram-0.1.1/selfrot/cli/__init__.py +248 -0
- selfrotgram-0.1.1/selfrot/cli/add.py +121 -0
- selfrotgram-0.1.1/selfrot/cli/analysis.py +87 -0
- selfrotgram-0.1.1/selfrot/cli/check.py +179 -0
- selfrotgram-0.1.1/selfrot/cli/init.py +62 -0
- selfrotgram-0.1.1/selfrot/cli/templates.py +210 -0
- selfrotgram-0.1.1/selfrot/cli/tree.py +157 -0
- selfrotgram-0.1.1/selfrot/client/__init__.py +7 -0
- selfrotgram-0.1.1/selfrot/client/bot.py +115 -0
- selfrotgram-0.1.1/selfrot/client/defaults.py +84 -0
- selfrotgram-0.1.1/selfrot/client/methods.py +5163 -0
- selfrotgram-0.1.1/selfrot/client/session.py +125 -0
- selfrotgram-0.1.1/selfrot/client/telegram.py +15 -0
- selfrotgram-0.1.1/selfrot/command_args.py +80 -0
- selfrotgram-0.1.1/selfrot/config/__init__.py +1 -0
- selfrotgram-0.1.1/selfrot/config/config.py +20 -0
- selfrotgram-0.1.1/selfrot/config/parser.py +29 -0
- selfrotgram-0.1.1/selfrot/context/__init__.py +4 -0
- selfrotgram-0.1.1/selfrot/context/accessors.py +224 -0
- selfrotgram-0.1.1/selfrot/context/context.py +75 -0
- selfrotgram-0.1.1/selfrot/context/helpers.py +135 -0
- selfrotgram-0.1.1/selfrot/context/methods.py +4849 -0
- selfrotgram-0.1.1/selfrot/deferred.py +168 -0
- selfrotgram-0.1.1/selfrot/dispatcher/__init__.py +3 -0
- selfrotgram-0.1.1/selfrot/dispatcher/dispatcher.py +356 -0
- selfrotgram-0.1.1/selfrot/dispatcher/ordering.py +22 -0
- selfrotgram-0.1.1/selfrot/dispatcher/runner.py +93 -0
- selfrotgram-0.1.1/selfrot/dispatcher/webhook.py +90 -0
- selfrotgram-0.1.1/selfrot/exceptions.py +173 -0
- selfrotgram-0.1.1/selfrot/filter/__init__.py +25 -0
- selfrotgram-0.1.1/selfrot/filter/base.py +145 -0
- selfrotgram-0.1.1/selfrot/filter/callback.py +122 -0
- selfrotgram-0.1.1/selfrot/filter/command.py +253 -0
- selfrotgram-0.1.1/selfrot/filter/has.py +1668 -0
- selfrotgram-0.1.1/selfrot/filter/member.py +102 -0
- selfrotgram-0.1.1/selfrot/filter/state.py +41 -0
- selfrotgram-0.1.1/selfrot/filter/strings.py +99 -0
- selfrotgram-0.1.1/selfrot/filter/text.py +41 -0
- selfrotgram-0.1.1/selfrot/filter/user.py +27 -0
- selfrotgram-0.1.1/selfrot/fsm/__init__.py +6 -0
- selfrotgram-0.1.1/selfrot/fsm/context.py +81 -0
- selfrotgram-0.1.1/selfrot/fsm/state.py +55 -0
- selfrotgram-0.1.1/selfrot/fsm/storage.py +74 -0
- selfrotgram-0.1.1/selfrot/handlers/__init__.py +2 -0
- selfrotgram-0.1.1/selfrot/handlers/base.py +133 -0
- selfrotgram-0.1.1/selfrot/handlers/kinds.py +253 -0
- selfrotgram-0.1.1/selfrot/keyboard.py +124 -0
- selfrotgram-0.1.1/selfrot/methods/__init__.py +2 -0
- selfrotgram-0.1.1/selfrot/methods/base.py +39 -0
- selfrotgram-0.1.1/selfrot/methods/generated.py +4130 -0
- selfrotgram-0.1.1/selfrot/middleware/__init__.py +7 -0
- selfrotgram-0.1.1/selfrot/middleware/base.py +22 -0
- selfrotgram-0.1.1/selfrot/middleware/logging.py +28 -0
- selfrotgram-0.1.1/selfrot/py.typed +0 -0
- selfrotgram-0.1.1/selfrot/router/__init__.py +1 -0
- selfrotgram-0.1.1/selfrot/router/base.py +226 -0
- selfrotgram-0.1.1/selfrot/types/__init__.py +3 -0
- selfrotgram-0.1.1/selfrot/types/generated.py +10201 -0
- selfrotgram-0.1.1/selfrot/types/input_file.py +36 -0
- selfrotgram-0.1.1/selfrot/types/narrowed.py +1376 -0
- selfrotgram-0.1.1/selfrot/utils/__init__.py +0 -0
- selfrotgram-0.1.1/selfrot/utils/narrowing.py +54 -0
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 CheStor
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,243 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: selfrotgram
|
|
3
|
+
Version: 0.1.1
|
|
4
|
+
Summary: Async Python library for Telegram Bot API: types and methods generated from the spec, filters, routers, webhooks
|
|
5
|
+
License: MIT
|
|
6
|
+
License-File: LICENSE
|
|
7
|
+
Keywords: async,telegram,bot,api
|
|
8
|
+
Author: CheStor
|
|
9
|
+
Author-email: selftopic@gmail.com
|
|
10
|
+
Requires-Python: >=3.11
|
|
11
|
+
Classifier: Development Status :: 3 - Alpha
|
|
12
|
+
Classifier: Framework :: AsyncIO
|
|
13
|
+
Classifier: Intended Audience :: Developers
|
|
14
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
18
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
19
|
+
Classifier: Typing :: Typed
|
|
20
|
+
Requires-Dist: aiohttp (>=3.12)
|
|
21
|
+
Requires-Dist: pydantic (>=2.11)
|
|
22
|
+
Requires-Dist: typing_extensions (>=4.14)
|
|
23
|
+
Project-URL: Changelog, https://github.com/SelfTopic/selfrotgram/blob/main/CHANGELOG.md
|
|
24
|
+
Project-URL: Documentation, https://github.com/SelfTopic/selfrotgram/tree/main/docs
|
|
25
|
+
Project-URL: Issues, https://github.com/SelfTopic/selfrotgram/issues
|
|
26
|
+
Project-URL: Repository, https://github.com/SelfTopic/selfrotgram
|
|
27
|
+
Description-Content-Type: text/markdown
|
|
28
|
+
|
|
29
|
+
# selfrotgram
|
|
30
|
+
|
|
31
|
+
[](https://github.com/SelfTopic/selfrotgram/actions/workflows/ci.yml)
|
|
32
|
+
|
|
33
|
+
Асинхронная библиотека для Telegram Bot API на `aiohttp` и `pydantic`, где **типы говорят
|
|
34
|
+
правду**: если хендлер обещает, что у сообщения есть текст, то фильтр это проверил, а
|
|
35
|
+
`message.text` в редакторе это `str`, а не `str | None`. Без `assert`, без `cast`, без
|
|
36
|
+
скрытых аргументов.
|
|
37
|
+
|
|
38
|
+
> Статус: альфа. Работает на реальном боте, покрыта тестами (200+), но API ещё может
|
|
39
|
+
> меняться. Поддерживает Bot API 10.3. Python 3.11, 3.12 и 3.13 (проверяется в CI).
|
|
40
|
+
|
|
41
|
+
```python
|
|
42
|
+
class Echo(MessageHandler[BaseContext[TextMessage]]): # обещаю: у сообщения есть текст
|
|
43
|
+
query = HasText() # проверяю: текст есть
|
|
44
|
+
|
|
45
|
+
async def handle(self) -> None:
|
|
46
|
+
await self.ctx.message.answer(self.ctx.message.text) # text: str, проверять нечего
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Забыли `HasText()`? Библиотека скажет об этом при запуске, а не сломается у пользователя.
|
|
50
|
+
|
|
51
|
+
## Чем это отличается
|
|
52
|
+
|
|
53
|
+
- **Ничего неявного.** Всё, что нужно хендлеру, лежит в `self.ctx`. Нет аргументов, которые
|
|
54
|
+
«волшебно» появляются по имени, нет прокси `F`. Откуда что взялось, видно в коде.
|
|
55
|
+
- **Фильтр гарантирует, тип обещает, библиотека сверяет** (при импорте, а не в проде).
|
|
56
|
+
- **Всё, что скучно, уже есть.** Типы (400), методы (185), фильтры на каждое поле,
|
|
57
|
+
ярлыки `ctx.answer_photo(...)`, методы на объектах (`message.edit_text(...)`) генерируются
|
|
58
|
+
из официальной спецификации Telegram. Вышла новая версия Bot API, значит перегенерировали.
|
|
59
|
+
- **Типизированные диалоги и кнопки:** данные шага FSM и `callback_data` это модели с
|
|
60
|
+
типами, а не словари и склеенные строки.
|
|
61
|
+
|
|
62
|
+
Знаете aiogram? [Сравнение с ним](https://github.com/SelfTopic/selfrotgram/blob/main/docs/from-aiogram.md) с парами «было / стало».
|
|
63
|
+
|
|
64
|
+
## Установка
|
|
65
|
+
|
|
66
|
+
```bash
|
|
67
|
+
pip install selfrotgram
|
|
68
|
+
poetry add selfrotgram
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
Обновить: `pip install -U selfrotgram` или `poetry update selfrotgram`. Poetry запишет `^0.1.1`,
|
|
72
|
+
то есть `>=0.1.1,<0.2.0`: пока версия `0.x`, ломающие изменения увеличивают минор (см.
|
|
73
|
+
[CHANGELOG.md](https://github.com/SelfTopic/selfrotgram/blob/main/CHANGELOG.md)).
|
|
74
|
+
|
|
75
|
+
Свежий коммит, ещё не вышедший на PyPI, или закреплённый тег ставятся прямо из git:
|
|
76
|
+
|
|
77
|
+
```bash
|
|
78
|
+
pip install "selfrotgram @ git+https://github.com/SelfTopic/selfrotgram.git"
|
|
79
|
+
poetry add "git+https://github.com/SelfTopic/selfrotgram.git#v0.1.1"
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
Ставится как `selfrotgram`, импортируется как `selfrot`. Зависимости (`aiohttp>=3.12`,
|
|
83
|
+
`pydantic>=2.11`, `typing_extensions>=4.14`) совместимы с `aiogram 3.x`, поэтому обе
|
|
84
|
+
библиотеки могут жить в одном окружении во время переезда.
|
|
85
|
+
|
|
86
|
+
## Минимальный бот
|
|
87
|
+
|
|
88
|
+
```python
|
|
89
|
+
import os
|
|
90
|
+
|
|
91
|
+
from selfrot import BaseContext, BaseDispatcher, Bot, MessageHandler
|
|
92
|
+
from selfrot.filter import Command
|
|
93
|
+
from selfrot.types import TextMessage
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
class Start(MessageHandler[BaseContext[TextMessage]]):
|
|
97
|
+
query = Command("start")
|
|
98
|
+
|
|
99
|
+
async def handle(self) -> None:
|
|
100
|
+
await self.ctx.message.answer(f"Привет! Ты написал: {self.ctx.message.text}")
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
class Dispatcher(BaseDispatcher[BaseContext]):
|
|
104
|
+
bot = Bot
|
|
105
|
+
context = BaseContext
|
|
106
|
+
handlers = (Start,)
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
if __name__ == "__main__":
|
|
110
|
+
Dispatcher(token=os.environ["BOT_TOKEN"]).start_polling()
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
Токен передаётся диспетчеру откуда угодно: переменная окружения, `pydantic-settings`. Без
|
|
114
|
+
него читается `bot_token` из `bot_cfg.cfg` в текущей папке. Настройки бота (`defaults`,
|
|
115
|
+
`proxy`, таймауты) задаются в подклассе `Bot`.
|
|
116
|
+
|
|
117
|
+
## Заготовка проекта: `selfrot init`
|
|
118
|
+
|
|
119
|
+
Библиотека ставит команду `selfrot`. В существующем проекте (там уже стоит `selfrotgram`):
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
selfrot init # создаёт src/bot (или selfrot init app/bot, другой путь)
|
|
123
|
+
selfrot init --dry-run # только показать, что будет создано
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
```
|
|
127
|
+
.env.example BOT_TOKEN=...
|
|
128
|
+
src/bot/
|
|
129
|
+
__main__.py диспетчер и запуск (on_startup, on_shutdown, логирование)
|
|
130
|
+
bot.py AppBot: настройки бота (defaults, proxy, таймауты) в комментариях
|
|
131
|
+
context.py AppContext: сюда добавляются ваши зависимости
|
|
132
|
+
routers/__init__.py RootRouter: сюда подключаются остальные роутеры
|
|
133
|
+
routers/start.py стартовый /start, чтобы бот сразу отвечал
|
|
134
|
+
keyboards/ middlewares/ filters/ пустые места под ваш код
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
Новый роутер: `selfrot add router` создаёт его и подключает в `RootRouter`:
|
|
138
|
+
|
|
139
|
+
```bash
|
|
140
|
+
selfrot add router profile # routers/profile.py с примером хендлера
|
|
141
|
+
selfrot add router profile --module # папка routers/profile/ с пустым роутером в __init__.py,
|
|
142
|
+
# готовым принимать хендлеры из соседних модулей
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
Что уже есть в проекте, показывает `selfrot tree`: роутеры с мидлварями, хендлеры с видом
|
|
146
|
+
апдейта, обещанным типом и фильтром (сверху вниз это порядок проверки):
|
|
147
|
+
|
|
148
|
+
```
|
|
149
|
+
$ selfrot tree
|
|
150
|
+
Dispatcher (мидлвари: LoggingMiddleware)
|
|
151
|
+
└─ RootRouter
|
|
152
|
+
├─ StartRouter
|
|
153
|
+
│ └─ Start message: TextMessage Command('start')
|
|
154
|
+
└─ AdminRouter (мидлвари: OnlyAdmins)
|
|
155
|
+
├─ BanUser message: TextMessage (FromUser(1, 2) & Command('ban', Ban))
|
|
156
|
+
├─ Anything message без фильтра: ловит всё этого вида
|
|
157
|
+
├─ Never message: TextMessage HasText() ! недостижим: выше Anything ...
|
|
158
|
+
└─ Joined chat_member: ChatMemberUpdated MemberJoined()
|
|
159
|
+
|
|
160
|
+
Роутеров: 3 (без корня), хендлеров: 4. allowed_updates: chat_member, message
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
Хендлер без фильтра ловит всё своего вида, и следующие за ним того же вида команда помечает как
|
|
164
|
+
недостижимые. Флаги: `-v` (переопределённые методы и описания), `--ascii`, `--package`.
|
|
165
|
+
|
|
166
|
+
Перед запуском или в CI `selfrot check` находит то, что при запуске не видно: собирает **все**
|
|
167
|
+
ошибки описания и импорта разом (обычный запуск остановился бы на первой), а ещё хендлер или
|
|
168
|
+
роутер, который нигде не подключён, хендлеры-дубли и недостижимые. `--strict` считает
|
|
169
|
+
предупреждения ошибками (код выхода 1).
|
|
170
|
+
|
|
171
|
+
```
|
|
172
|
+
$ selfrot check
|
|
173
|
+
Проверка src/bot: модулей 10, роутеров 3, хендлеров 6.
|
|
174
|
+
ошибка: src.bot.filters.oops: ModuleNotFoundError: No module named 'nonexistent_thing'
|
|
175
|
+
ошибка: src.bot.routers.broken: DefinitionError: NoGuarantee: в заголовке обещан TextMessage, но query None не гарантирует поля: text
|
|
176
|
+
предупреждение: src.bot.routers.admin: BanAgain недостижим: выше Ban тот же фильтр Command('ban')
|
|
177
|
+
предупреждение: src.bot.routers.admin: хендлер Forgotten нигде не подключён: добавьте его в handlers роутера
|
|
178
|
+
предупреждение: src.bot.routers.admin: роутер LostRouter не подключён: добавьте его в routers родителя ...
|
|
179
|
+
Итог: 2 ошибки, 4 предупреждения.
|
|
180
|
+
```
|
|
181
|
+
|
|
182
|
+
Создаётся только то, что касается самой библиотеки. Сервисы, база данных и структура бизнес-логики
|
|
183
|
+
остаются вашим делом. Существующие файлы команда **никогда не перезаписывает**. Запуск:
|
|
184
|
+
`BOT_TOKEN=... python -m src.bot`.
|
|
185
|
+
|
|
186
|
+
## Документация
|
|
187
|
+
|
|
188
|
+
| Что | Где |
|
|
189
|
+
|---|---|
|
|
190
|
+
| Каждый пример по шагам, простыми словами | [docs/examples.md](https://github.com/SelfTopic/selfrotgram/blob/main/docs/examples.md) |
|
|
191
|
+
| Как устроена библиотека | [docs/design.md](https://github.com/SelfTopic/selfrotgram/blob/main/docs/design.md) |
|
|
192
|
+
| Отличия от aiogram и что там было / что здесь | [docs/from-aiogram.md](https://github.com/SelfTopic/selfrotgram/blob/main/docs/from-aiogram.md) |
|
|
193
|
+
| Работающие примеры (запуск: `python -m examples.echo_bot`) | [examples/](https://github.com/SelfTopic/selfrotgram/tree/main/examples) |
|
|
194
|
+
| История изменений и правила версий | [CHANGELOG.md](https://github.com/SelfTopic/selfrotgram/blob/main/CHANGELOG.md) |
|
|
195
|
+
| Как выпускать версии на PyPI | [docs/releasing.md](https://github.com/SelfTopic/selfrotgram/blob/main/docs/releasing.md) |
|
|
196
|
+
| Журнал решений (для любопытных) | [docs/decisions.md](https://github.com/SelfTopic/selfrotgram/blob/main/docs/decisions.md) |
|
|
197
|
+
|
|
198
|
+
## Что умеет
|
|
199
|
+
|
|
200
|
+
- **Фильтры:** `Text*`, `Command`, `CallbackData*`, `CallbackPayload` (типизированные данные
|
|
201
|
+
кнопок, `pressed_by`), `Has*` (по одному на каждое поле), `MemberJoined`/`MemberLeft`,
|
|
202
|
+
`FromUser`, `InState`; комбинаторы `&`, `|`, `~`.
|
|
203
|
+
- **Аргументы команд как данные:** `CommandArgs` (типы, `Literal`, необязательные, `Rest`) и
|
|
204
|
+
`CommandArgsError` с готовой подсказкой.
|
|
205
|
+
- **Отложенные действия:** `self.defer(fn, delay=...)` и `after_handle()`: сделать позже, уже после
|
|
206
|
+
закрытия хендлера, не занимая слот и сессию БД.
|
|
207
|
+
- **Диспетчер:** long polling и вебхуки, параллельная обработка апдейтов, `on_startup` и
|
|
208
|
+
`on_shutdown`, `on_error` на хендлере и диспетчере, остановка по SIGTERM.
|
|
209
|
+
- **Роутеры и мидлвари:** дерево роутеров (`auto_connect`), мидлвари с `pre_handle` и
|
|
210
|
+
`post_handle(exc)`.
|
|
211
|
+
- **Диалоги (FSM):** `States`, `State(Model)` с типизированными данными, `ctx.fsm`,
|
|
212
|
+
`MemoryStorage(ttl=...)`.
|
|
213
|
+
- **Клавиатуры:** `InlineKeyboard` с проверкой лимитов Telegram.
|
|
214
|
+
- **Транспорт:** таймауты, повтор при 429, понятные ошибки сети, прокси, `Bot.defaults`.
|
|
215
|
+
|
|
216
|
+
## Чего пока нет
|
|
217
|
+
|
|
218
|
+
Локализации, сцен, готового хранилища FSM в Redis, скачивания файлов и загрузки файлов
|
|
219
|
+
внутри альбомов, сборщика reply-клавиатур. Подробнее и честно:
|
|
220
|
+
[docs/from-aiogram.md](https://github.com/SelfTopic/selfrotgram/blob/main/docs/from-aiogram.md#чего-здесь-нет-а-в-aiogram-есть).
|
|
221
|
+
|
|
222
|
+
## Разработка
|
|
223
|
+
|
|
224
|
+
```bash
|
|
225
|
+
poetry install # библиотека и dev-зависимости (pytest)
|
|
226
|
+
poetry run pytest # 200+ тестов, около 15 секунд, без сети
|
|
227
|
+
python -m examples.echo_bot # живой запуск примера, см. examples/README.md
|
|
228
|
+
|
|
229
|
+
python scripts/generate_types.py # перегенерировать типы и методы из scripts/spec
|
|
230
|
+
python scripts/generate_types.py --fetch # скачать свежую спецификацию
|
|
231
|
+
```
|
|
232
|
+
|
|
233
|
+
На каждый пуш и pull request GitHub Actions запускает тесты на Python 3.11–3.13, проверку
|
|
234
|
+
типов (`pyright`), актуальность сгенерированного кода и установку пакета с командой `selfrot`.
|
|
235
|
+
|
|
236
|
+
Тесты не ходят в Telegram: `tests/conftest.py` поднимает на localhost фейковый сервер Bot API,
|
|
237
|
+
записывающий все вызовы. Каждый пример из `examples/` дополнительно собирается в диспетчер в
|
|
238
|
+
`tests/test_examples.py`, чтобы не устаревать.
|
|
239
|
+
|
|
240
|
+
## Лицензия
|
|
241
|
+
|
|
242
|
+
[MIT](https://github.com/SelfTopic/selfrotgram/blob/main/LICENSE).
|
|
243
|
+
|
|
@@ -0,0 +1,214 @@
|
|
|
1
|
+
# selfrotgram
|
|
2
|
+
|
|
3
|
+
[](https://github.com/SelfTopic/selfrotgram/actions/workflows/ci.yml)
|
|
4
|
+
|
|
5
|
+
Асинхронная библиотека для Telegram Bot API на `aiohttp` и `pydantic`, где **типы говорят
|
|
6
|
+
правду**: если хендлер обещает, что у сообщения есть текст, то фильтр это проверил, а
|
|
7
|
+
`message.text` в редакторе это `str`, а не `str | None`. Без `assert`, без `cast`, без
|
|
8
|
+
скрытых аргументов.
|
|
9
|
+
|
|
10
|
+
> Статус: альфа. Работает на реальном боте, покрыта тестами (200+), но API ещё может
|
|
11
|
+
> меняться. Поддерживает Bot API 10.3. Python 3.11, 3.12 и 3.13 (проверяется в CI).
|
|
12
|
+
|
|
13
|
+
```python
|
|
14
|
+
class Echo(MessageHandler[BaseContext[TextMessage]]): # обещаю: у сообщения есть текст
|
|
15
|
+
query = HasText() # проверяю: текст есть
|
|
16
|
+
|
|
17
|
+
async def handle(self) -> None:
|
|
18
|
+
await self.ctx.message.answer(self.ctx.message.text) # text: str, проверять нечего
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Забыли `HasText()`? Библиотека скажет об этом при запуске, а не сломается у пользователя.
|
|
22
|
+
|
|
23
|
+
## Чем это отличается
|
|
24
|
+
|
|
25
|
+
- **Ничего неявного.** Всё, что нужно хендлеру, лежит в `self.ctx`. Нет аргументов, которые
|
|
26
|
+
«волшебно» появляются по имени, нет прокси `F`. Откуда что взялось, видно в коде.
|
|
27
|
+
- **Фильтр гарантирует, тип обещает, библиотека сверяет** (при импорте, а не в проде).
|
|
28
|
+
- **Всё, что скучно, уже есть.** Типы (400), методы (185), фильтры на каждое поле,
|
|
29
|
+
ярлыки `ctx.answer_photo(...)`, методы на объектах (`message.edit_text(...)`) генерируются
|
|
30
|
+
из официальной спецификации Telegram. Вышла новая версия Bot API, значит перегенерировали.
|
|
31
|
+
- **Типизированные диалоги и кнопки:** данные шага FSM и `callback_data` это модели с
|
|
32
|
+
типами, а не словари и склеенные строки.
|
|
33
|
+
|
|
34
|
+
Знаете aiogram? [Сравнение с ним](https://github.com/SelfTopic/selfrotgram/blob/main/docs/from-aiogram.md) с парами «было / стало».
|
|
35
|
+
|
|
36
|
+
## Установка
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
pip install selfrotgram
|
|
40
|
+
poetry add selfrotgram
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
Обновить: `pip install -U selfrotgram` или `poetry update selfrotgram`. Poetry запишет `^0.1.1`,
|
|
44
|
+
то есть `>=0.1.1,<0.2.0`: пока версия `0.x`, ломающие изменения увеличивают минор (см.
|
|
45
|
+
[CHANGELOG.md](https://github.com/SelfTopic/selfrotgram/blob/main/CHANGELOG.md)).
|
|
46
|
+
|
|
47
|
+
Свежий коммит, ещё не вышедший на PyPI, или закреплённый тег ставятся прямо из git:
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
pip install "selfrotgram @ git+https://github.com/SelfTopic/selfrotgram.git"
|
|
51
|
+
poetry add "git+https://github.com/SelfTopic/selfrotgram.git#v0.1.1"
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
Ставится как `selfrotgram`, импортируется как `selfrot`. Зависимости (`aiohttp>=3.12`,
|
|
55
|
+
`pydantic>=2.11`, `typing_extensions>=4.14`) совместимы с `aiogram 3.x`, поэтому обе
|
|
56
|
+
библиотеки могут жить в одном окружении во время переезда.
|
|
57
|
+
|
|
58
|
+
## Минимальный бот
|
|
59
|
+
|
|
60
|
+
```python
|
|
61
|
+
import os
|
|
62
|
+
|
|
63
|
+
from selfrot import BaseContext, BaseDispatcher, Bot, MessageHandler
|
|
64
|
+
from selfrot.filter import Command
|
|
65
|
+
from selfrot.types import TextMessage
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
class Start(MessageHandler[BaseContext[TextMessage]]):
|
|
69
|
+
query = Command("start")
|
|
70
|
+
|
|
71
|
+
async def handle(self) -> None:
|
|
72
|
+
await self.ctx.message.answer(f"Привет! Ты написал: {self.ctx.message.text}")
|
|
73
|
+
|
|
74
|
+
|
|
75
|
+
class Dispatcher(BaseDispatcher[BaseContext]):
|
|
76
|
+
bot = Bot
|
|
77
|
+
context = BaseContext
|
|
78
|
+
handlers = (Start,)
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
if __name__ == "__main__":
|
|
82
|
+
Dispatcher(token=os.environ["BOT_TOKEN"]).start_polling()
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Токен передаётся диспетчеру откуда угодно: переменная окружения, `pydantic-settings`. Без
|
|
86
|
+
него читается `bot_token` из `bot_cfg.cfg` в текущей папке. Настройки бота (`defaults`,
|
|
87
|
+
`proxy`, таймауты) задаются в подклассе `Bot`.
|
|
88
|
+
|
|
89
|
+
## Заготовка проекта: `selfrot init`
|
|
90
|
+
|
|
91
|
+
Библиотека ставит команду `selfrot`. В существующем проекте (там уже стоит `selfrotgram`):
|
|
92
|
+
|
|
93
|
+
```bash
|
|
94
|
+
selfrot init # создаёт src/bot (или selfrot init app/bot, другой путь)
|
|
95
|
+
selfrot init --dry-run # только показать, что будет создано
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
```
|
|
99
|
+
.env.example BOT_TOKEN=...
|
|
100
|
+
src/bot/
|
|
101
|
+
__main__.py диспетчер и запуск (on_startup, on_shutdown, логирование)
|
|
102
|
+
bot.py AppBot: настройки бота (defaults, proxy, таймауты) в комментариях
|
|
103
|
+
context.py AppContext: сюда добавляются ваши зависимости
|
|
104
|
+
routers/__init__.py RootRouter: сюда подключаются остальные роутеры
|
|
105
|
+
routers/start.py стартовый /start, чтобы бот сразу отвечал
|
|
106
|
+
keyboards/ middlewares/ filters/ пустые места под ваш код
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
Новый роутер: `selfrot add router` создаёт его и подключает в `RootRouter`:
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
selfrot add router profile # routers/profile.py с примером хендлера
|
|
113
|
+
selfrot add router profile --module # папка routers/profile/ с пустым роутером в __init__.py,
|
|
114
|
+
# готовым принимать хендлеры из соседних модулей
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
Что уже есть в проекте, показывает `selfrot tree`: роутеры с мидлварями, хендлеры с видом
|
|
118
|
+
апдейта, обещанным типом и фильтром (сверху вниз это порядок проверки):
|
|
119
|
+
|
|
120
|
+
```
|
|
121
|
+
$ selfrot tree
|
|
122
|
+
Dispatcher (мидлвари: LoggingMiddleware)
|
|
123
|
+
└─ RootRouter
|
|
124
|
+
├─ StartRouter
|
|
125
|
+
│ └─ Start message: TextMessage Command('start')
|
|
126
|
+
└─ AdminRouter (мидлвари: OnlyAdmins)
|
|
127
|
+
├─ BanUser message: TextMessage (FromUser(1, 2) & Command('ban', Ban))
|
|
128
|
+
├─ Anything message без фильтра: ловит всё этого вида
|
|
129
|
+
├─ Never message: TextMessage HasText() ! недостижим: выше Anything ...
|
|
130
|
+
└─ Joined chat_member: ChatMemberUpdated MemberJoined()
|
|
131
|
+
|
|
132
|
+
Роутеров: 3 (без корня), хендлеров: 4. allowed_updates: chat_member, message
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
Хендлер без фильтра ловит всё своего вида, и следующие за ним того же вида команда помечает как
|
|
136
|
+
недостижимые. Флаги: `-v` (переопределённые методы и описания), `--ascii`, `--package`.
|
|
137
|
+
|
|
138
|
+
Перед запуском или в CI `selfrot check` находит то, что при запуске не видно: собирает **все**
|
|
139
|
+
ошибки описания и импорта разом (обычный запуск остановился бы на первой), а ещё хендлер или
|
|
140
|
+
роутер, который нигде не подключён, хендлеры-дубли и недостижимые. `--strict` считает
|
|
141
|
+
предупреждения ошибками (код выхода 1).
|
|
142
|
+
|
|
143
|
+
```
|
|
144
|
+
$ selfrot check
|
|
145
|
+
Проверка src/bot: модулей 10, роутеров 3, хендлеров 6.
|
|
146
|
+
ошибка: src.bot.filters.oops: ModuleNotFoundError: No module named 'nonexistent_thing'
|
|
147
|
+
ошибка: src.bot.routers.broken: DefinitionError: NoGuarantee: в заголовке обещан TextMessage, но query None не гарантирует поля: text
|
|
148
|
+
предупреждение: src.bot.routers.admin: BanAgain недостижим: выше Ban тот же фильтр Command('ban')
|
|
149
|
+
предупреждение: src.bot.routers.admin: хендлер Forgotten нигде не подключён: добавьте его в handlers роутера
|
|
150
|
+
предупреждение: src.bot.routers.admin: роутер LostRouter не подключён: добавьте его в routers родителя ...
|
|
151
|
+
Итог: 2 ошибки, 4 предупреждения.
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
Создаётся только то, что касается самой библиотеки. Сервисы, база данных и структура бизнес-логики
|
|
155
|
+
остаются вашим делом. Существующие файлы команда **никогда не перезаписывает**. Запуск:
|
|
156
|
+
`BOT_TOKEN=... python -m src.bot`.
|
|
157
|
+
|
|
158
|
+
## Документация
|
|
159
|
+
|
|
160
|
+
| Что | Где |
|
|
161
|
+
|---|---|
|
|
162
|
+
| Каждый пример по шагам, простыми словами | [docs/examples.md](https://github.com/SelfTopic/selfrotgram/blob/main/docs/examples.md) |
|
|
163
|
+
| Как устроена библиотека | [docs/design.md](https://github.com/SelfTopic/selfrotgram/blob/main/docs/design.md) |
|
|
164
|
+
| Отличия от aiogram и что там было / что здесь | [docs/from-aiogram.md](https://github.com/SelfTopic/selfrotgram/blob/main/docs/from-aiogram.md) |
|
|
165
|
+
| Работающие примеры (запуск: `python -m examples.echo_bot`) | [examples/](https://github.com/SelfTopic/selfrotgram/tree/main/examples) |
|
|
166
|
+
| История изменений и правила версий | [CHANGELOG.md](https://github.com/SelfTopic/selfrotgram/blob/main/CHANGELOG.md) |
|
|
167
|
+
| Как выпускать версии на PyPI | [docs/releasing.md](https://github.com/SelfTopic/selfrotgram/blob/main/docs/releasing.md) |
|
|
168
|
+
| Журнал решений (для любопытных) | [docs/decisions.md](https://github.com/SelfTopic/selfrotgram/blob/main/docs/decisions.md) |
|
|
169
|
+
|
|
170
|
+
## Что умеет
|
|
171
|
+
|
|
172
|
+
- **Фильтры:** `Text*`, `Command`, `CallbackData*`, `CallbackPayload` (типизированные данные
|
|
173
|
+
кнопок, `pressed_by`), `Has*` (по одному на каждое поле), `MemberJoined`/`MemberLeft`,
|
|
174
|
+
`FromUser`, `InState`; комбинаторы `&`, `|`, `~`.
|
|
175
|
+
- **Аргументы команд как данные:** `CommandArgs` (типы, `Literal`, необязательные, `Rest`) и
|
|
176
|
+
`CommandArgsError` с готовой подсказкой.
|
|
177
|
+
- **Отложенные действия:** `self.defer(fn, delay=...)` и `after_handle()`: сделать позже, уже после
|
|
178
|
+
закрытия хендлера, не занимая слот и сессию БД.
|
|
179
|
+
- **Диспетчер:** long polling и вебхуки, параллельная обработка апдейтов, `on_startup` и
|
|
180
|
+
`on_shutdown`, `on_error` на хендлере и диспетчере, остановка по SIGTERM.
|
|
181
|
+
- **Роутеры и мидлвари:** дерево роутеров (`auto_connect`), мидлвари с `pre_handle` и
|
|
182
|
+
`post_handle(exc)`.
|
|
183
|
+
- **Диалоги (FSM):** `States`, `State(Model)` с типизированными данными, `ctx.fsm`,
|
|
184
|
+
`MemoryStorage(ttl=...)`.
|
|
185
|
+
- **Клавиатуры:** `InlineKeyboard` с проверкой лимитов Telegram.
|
|
186
|
+
- **Транспорт:** таймауты, повтор при 429, понятные ошибки сети, прокси, `Bot.defaults`.
|
|
187
|
+
|
|
188
|
+
## Чего пока нет
|
|
189
|
+
|
|
190
|
+
Локализации, сцен, готового хранилища FSM в Redis, скачивания файлов и загрузки файлов
|
|
191
|
+
внутри альбомов, сборщика reply-клавиатур. Подробнее и честно:
|
|
192
|
+
[docs/from-aiogram.md](https://github.com/SelfTopic/selfrotgram/blob/main/docs/from-aiogram.md#чего-здесь-нет-а-в-aiogram-есть).
|
|
193
|
+
|
|
194
|
+
## Разработка
|
|
195
|
+
|
|
196
|
+
```bash
|
|
197
|
+
poetry install # библиотека и dev-зависимости (pytest)
|
|
198
|
+
poetry run pytest # 200+ тестов, около 15 секунд, без сети
|
|
199
|
+
python -m examples.echo_bot # живой запуск примера, см. examples/README.md
|
|
200
|
+
|
|
201
|
+
python scripts/generate_types.py # перегенерировать типы и методы из scripts/spec
|
|
202
|
+
python scripts/generate_types.py --fetch # скачать свежую спецификацию
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
На каждый пуш и pull request GitHub Actions запускает тесты на Python 3.11–3.13, проверку
|
|
206
|
+
типов (`pyright`), актуальность сгенерированного кода и установку пакета с командой `selfrot`.
|
|
207
|
+
|
|
208
|
+
Тесты не ходят в Telegram: `tests/conftest.py` поднимает на localhost фейковый сервер Bot API,
|
|
209
|
+
записывающий все вызовы. Каждый пример из `examples/` дополнительно собирается в диспетчер в
|
|
210
|
+
`tests/test_examples.py`, чтобы не устаревать.
|
|
211
|
+
|
|
212
|
+
## Лицензия
|
|
213
|
+
|
|
214
|
+
[MIT](https://github.com/SelfTopic/selfrotgram/blob/main/LICENSE).
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["poetry-core>=2.0.0,<3.0.0"]
|
|
3
|
+
build-backend = "poetry.core.masonry.api"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "selfrotgram"
|
|
7
|
+
version = "0.1.1"
|
|
8
|
+
description = "Async Python library for Telegram Bot API: types and methods generated from the spec, filters, routers, webhooks"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.11"
|
|
11
|
+
license = {text = "MIT"}
|
|
12
|
+
authors = [
|
|
13
|
+
{name = "CheStor", email = "selftopic@gmail.com"}
|
|
14
|
+
]
|
|
15
|
+
keywords = ["async", "telegram", "bot", "api"]
|
|
16
|
+
classifiers = [
|
|
17
|
+
"Development Status :: 3 - Alpha",
|
|
18
|
+
"Framework :: AsyncIO",
|
|
19
|
+
"Intended Audience :: Developers",
|
|
20
|
+
"License :: OSI Approved :: MIT License",
|
|
21
|
+
"Programming Language :: Python :: 3",
|
|
22
|
+
"Programming Language :: Python :: 3.11",
|
|
23
|
+
"Programming Language :: Python :: 3.12",
|
|
24
|
+
"Programming Language :: Python :: 3.13",
|
|
25
|
+
"Typing :: Typed",
|
|
26
|
+
]
|
|
27
|
+
|
|
28
|
+
dependencies = [
|
|
29
|
+
"aiohttp>=3.12",
|
|
30
|
+
"pydantic>=2.11",
|
|
31
|
+
"typing_extensions>=4.14",
|
|
32
|
+
]
|
|
33
|
+
|
|
34
|
+
[project.scripts]
|
|
35
|
+
selfrot = "selfrot.cli:main"
|
|
36
|
+
|
|
37
|
+
[project.urls]
|
|
38
|
+
Repository = "https://github.com/SelfTopic/selfrotgram"
|
|
39
|
+
Documentation = "https://github.com/SelfTopic/selfrotgram/tree/main/docs"
|
|
40
|
+
Changelog = "https://github.com/SelfTopic/selfrotgram/blob/main/CHANGELOG.md"
|
|
41
|
+
Issues = "https://github.com/SelfTopic/selfrotgram/issues"
|
|
42
|
+
|
|
43
|
+
# Ставится как selfrotgram, импортируется как selfrot (py.typed внутри пакета).
|
|
44
|
+
[tool.poetry]
|
|
45
|
+
packages = [{include = "selfrot"}]
|
|
46
|
+
|
|
47
|
+
[dependency-groups]
|
|
48
|
+
dev = [
|
|
49
|
+
"pytest (>=9.1.1,<10.0.0)",
|
|
50
|
+
"pytest-asyncio (>=1.4.0,<2.0.0)",
|
|
51
|
+
# для примеров (db_bot, bot_command)
|
|
52
|
+
"sqlalchemy (>=2.0.41,<3.0.0)",
|
|
53
|
+
"aiosqlite (>=0.22.1,<0.23.0)",
|
|
54
|
+
]
|
|
55
|
+
|
|
56
|
+
[tool.pytest.ini_options]
|
|
57
|
+
testpaths = ["tests"]
|
|
58
|
+
asyncio_mode = "auto"
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
from importlib.metadata import PackageNotFoundError, version
|
|
2
|
+
|
|
3
|
+
from .callback_data import CallbackPayload
|
|
4
|
+
from .client import Bot, BotDefaults
|
|
5
|
+
from .command_args import CommandArgs, Rest
|
|
6
|
+
from .context import BaseContext, TEvent
|
|
7
|
+
from .deferred import Deferred
|
|
8
|
+
from .dispatcher import BaseDispatcher
|
|
9
|
+
from .fsm import MemoryStorage, State, States
|
|
10
|
+
from .handlers import BaseHandler, MessageHandler
|
|
11
|
+
from .keyboard import InlineKeyboard, button
|
|
12
|
+
from .middleware import BaseMiddleware
|
|
13
|
+
from .router import BaseRouter
|
|
14
|
+
|
|
15
|
+
try:
|
|
16
|
+
__version__ = version("selfrotgram")
|
|
17
|
+
except PackageNotFoundError: # запуск из исходников без установки
|
|
18
|
+
__version__ = "0.0.0+source"
|
|
19
|
+
|
|
20
|
+
__all__ = [
|
|
21
|
+
"BaseContext",
|
|
22
|
+
"BaseDispatcher",
|
|
23
|
+
"BaseHandler",
|
|
24
|
+
"BaseMiddleware",
|
|
25
|
+
"BaseRouter",
|
|
26
|
+
"Bot",
|
|
27
|
+
"BotDefaults",
|
|
28
|
+
"CallbackPayload",
|
|
29
|
+
"CommandArgs",
|
|
30
|
+
"Deferred",
|
|
31
|
+
"InlineKeyboard",
|
|
32
|
+
"MemoryStorage",
|
|
33
|
+
"MessageHandler",
|
|
34
|
+
"Rest",
|
|
35
|
+
"State",
|
|
36
|
+
"States",
|
|
37
|
+
"TEvent",
|
|
38
|
+
"__version__",
|
|
39
|
+
"button"
|
|
40
|
+
]
|