FSM middleware for using with pybotx
Project description
pybotx-fsm
Конечный автомат (Finite state machine) для ботов на базе библиотеки pybotx.
Возможности
- Лёгкое создание графа состояний и их переключений.
- Передача данных в следующее состояние при явном вызове перехода.
Подготовка к установке
Для работы библиотеки необходим Redis, который уже встроен в последние версии коробки.
Установка
Используя poetry
:
poetry add pybotx-fsm
Работа с графом состояний
- Создайте
enum
для возможных состояний автомата:
from enum import Enum, auto
from pybotx_fsm import FSMCollector
class LoginStates(Enum):
enter_email = auto()
enter_password = auto()
fsm = FSMCollector(LoginStates)
- Добавьте экземпляр автомата в мидлвари для того, чтобы бот мог использовать его:
Bot(
collectors=[
myfile.collector,
],
bot_accounts=[
BotAccountWithSecret(
# Не забудьте заменить эти учётные данные на настоящие,
# когда создадите бота в панели администратора.
id=UUID("123e4567-e89b-12d3-a456-426655440000"),
host="cts.example.com",
secret_key="e29b417773f2feab9dac143ee3da20c5",
),
],
middlewares=[
FSMMiddleware([myfile.fsm], state_repo_key="redis_repo"),
],
)
- Добавьте в
bot.state.{state_repo_key}
совместимый redis репозиторий:
bot.state.redis_repo = await RedisRepo.init(...)
- Создайте обработчики конкретных состояний:
@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.command("/login")
async def start_login(message: IncomingMessage, bot: Bot) -> None:
await bot.answer_message("Enter your email")
await message.state.fsm.change_state(LoginStates.enter_email)
Примеры
Минимальный пример бота с конечным автоматом
# Здесь и далее будут пропущены импорты и код, не затрагивающий
# непосредственно pybotx_fsm
class FsmStates(Enum):
EXAMPLE_STATE = auto()
fsm = FSMCollector(FsmStates)
@collector.command("/echo", description="Echo command")
async def help_command(message: IncomingMessage, bot: Bot) -> None:
await message.state.fsm.change_state(FsmStates.EXAMPLE_STATE)
await bot.answer_message("Input your text:")
@fsm.on(FsmStates.EXAMPLE_STATE)
async def example_state(message: IncomingMessage, bot: Bot) -> None:
user_text = message.body
await message.state.fsm.drop_state()
await bot.answer_message(f"Your text is {user_text}")
bot = Bot(
collectors=[
collector,
],
bot_accounts=[
BotAccountWithSecret(
# Не забудьте заменить эти учётные данные на настоящие,
# когда создадите бота в панели администратора.
id=UUID("123e4567-e89b-12d3-a456-426655440000"),
host="cts.example.com",
secret_key="e29b417773f2feab9dac143ee3da20c5",
),
],
middlewares=[
FSMMiddleware([fsm], state_repo_key="redis_repo"),
],
)
Передача данных между состояниями
@fsm.on(FsmStates.INPUT_FIRST_NAME)
async def input_first_name(message: IncomingMessage, bot: Bot) -> None:
first_name = message.body
await message.state.fsm.change_state(
FsmStates.INPUT_LAST_NAME,
first_name=first_name,
)
await bot.answer_message("Input your last name:")
@fsm.on(FsmStates.INPUT_LAST_NAME)
async def input_last_name(message: IncomingMessage, bot: Bot) -> None:
first_name = message.state.fsm_storage.first_name
last_name = message.body
await message.state.fsm.drop_state()
await bot.answer_message(f"Hello {first_name} {last_name}!")
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.4.12.tar.gz
(6.3 kB
view hashes)
Built Distribution
Close
Hashes for pybotx_fsm-0.4.12-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f55eb1275d29d8620867f8003671609efb60ea14e0329fc0457aaf54434902dc |
|
MD5 | 043c68e247843e21368023d8204bc431 |
|
BLAKE2b-256 | 47b22e54814850ec8f51a4a28473670f50292dfc8f85c3322c1db12d503ac573 |