FSM middleware for using with pybotx
Project description
pybotx-fsm
Конечный автомат (Finite state machine) для ботов на базе библиотеки pybotx.
Возможности
- Лёгкое создание графа состояний и их переключений.
- Передача данных в следующее состояние при явном вызове перехода.
Подготовка к установке
Для работы библиотеки необходим Redis, который уже встроен в последние версии коробки.
Установка
Добавьте эту строку в зависимости проекта в pyproject.toml
:
botx-fsm = { git = "https://github.com/ExpressApp/pybotx-fsm", rev = "0.2.0" }
Работа с графом состояний
- Добавьте экземпляр автомата в мидлвари для того, чтобы бот мог использовать его:
Bot(
collectors=...,
bot_accounts=...,
middlewares=[FSMMiddleware([myfile.fsm], state_repo_key="redis_repo")],
)
- Добавьте в
bot.state.{state_repo_key}
совместимый redis репозиторий:
bot.state.redis_repo = await RedisRepo.init(...)
- Создайте
enum
для возможных состояний автомата:
from enum import Enum, auto
from pybotx_fsm import FSMCollector
class LoginStates(Enum):
enter_email = auto()
enter_password = auto()
fsm = FSMCollector(LoginStates)
- Создайте обработчики конкретных состояний:
@fsm.on(LoginStates.enter_email)
async def enter_email(message: IncomingMessage, bot: Bot) -> None:
email = message.body
if not check_user_exist(email):
await bot.answer_message("Wrong email, try again")
return
await message.state.fsm.change_state(LoginStates.enter_password, email=email)
await bot.answer_message("Enter your password")
@fsm.on(LoginStates.enter_password)
async def enter_password(message: IncomingMessage, bot: Bot) -> None:
email = message.state.fsm_storage.email
password = message.body
try:
login(email, password)
except IncorrectPasswordError:
await bot.answer_message("Wrong password, try again")
return
await message.state.fsm.drop_state()
await bot.answer_message("Success!")
- Передайте управление обработчику состояний из любого обработчика сообщений:
@collector.handler(command="/login")
async def start_login(message: IncomingMessage, bot: Bot) -> None:
await bot.answer_message("Enter your email")
await fsm.change_state(LoginStates.enter_email)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
pybotx-fsm-0.3.4.tar.gz
(6.3 kB
view hashes)
Built Distribution
Close
Hashes for pybotx_fsm-0.3.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9188ee049ba9c9559e034b4b226ba045f495262fa275b8035491e44a7dbe2b96 |
|
MD5 | 29e07341faf824807a5b44755d8fbd98 |
|
BLAKE2b-256 | 1f1274254fd5c8abe2ac9ccd99bb43b6ba557130f98c6e481489c718563a4a41 |