python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2025-12-14 02:52:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

PoC Scenes (#1280)

Browse source 
* Base implementation

* Small refactoring + added possibility to specify post-action on handlers

* Move scene properties to config object

* Revise aiogram/scenes with wizard-based design pattern

Modified files in aiogram/scenes to incorporate the Wizard design pattern. Files affected are _marker.py, _registry.py, _wizard.py and __init__.py. The changes introduced a SceneWizard Class and ScenesManager, both of which aid in controlling navigation between different scenes or states. This helps clarifying the codebase, streamline scene transitions and offer more control over the app flow.

* Added example

* Small optimizations

* Replace ValueError with SceneException in scenes. Added error safety in scene resolver.

* str

* Added possibility to reset context on scene entered and to handle callback query in any state

* Remove inline markup in example

* Small changes

* Docs + example

* Small refactoring

* Remove scene inclusion methods from router

The methods for including scenes as sub-routers have been removed from the router.py file. Instead, the SceneRegistry class is now set to register scenes by default upon initializing. This streamlines the scene management process by removing redundant routers and making registration automatic.

* Init tests

* Small fix in tests

* Add support for State instance in the scene

The aiogram FSM scene now allows the use of State instance as an argument, enabling more customization. Modified the 'as_handler' method to receive **kwargs arguments, allowing passing of attributes to the handler. An additional type check has been also added to ensure the 'scene' is either a subclass of Scene or a string.

* Fixed test

* Expand test coverage for test_fsm module

The commit enhances tests for the test_fsm module to improve code reliability. It includes additional unit tests for the ObserverDecorator and ActionContainer classes and introduces new tests for the SceneHandlerWrapper class. This ensures the correct functionality of the decorator methods, the action container execution, and the handler wrapper.

* Reformat code

* Fixed long line in the example

* Skip some tests on PyPy

* Change mock return_value

* Compatibility...

* Compatibility...

* Compatibility...

* Added base changes description

* Scenes Tests (#1369)

* ADD tests for `SceneRegistry`

* ADD tests for `ScenesManager`

* ADD Changelog

* Revert "ADD Changelog"

This reverts commit 6dd9301252.

* Remove `@pytest.mark.asyncio`, Reformat code

* Scenes Tests. Part 2 (#1371)

* ADD tests for `SceneWizard`

* ADD tests for `Scene`

* Refactor ObserverDecorator to use on.message syntax in test_scene.py
Cover `Scene::__init_subclass__::if isinstance(value, ObserverDecorator):`

* Refactor `HistoryManager` in `aiogram/fsm/scene.py`
Removed condition that checked if 'history' is empty before calling 'update_data' in 'Scene'.

* ADD tests for `HistoryManager`

* Small changes in the documentation

* Small changes in the documentation

* Small changes in the documentation

---------

Co-authored-by: Andrew <11490628+andrew000@users.noreply.github.com>
This commit is contained in:
Alex Root Junior 2023-11-23 00:41:21 +02:00 • committed by GitHub
parent ce4e1a706d
commit 3d63bf3b99
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 3234 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

2
CHANGES/1280.feature.rst Normal file
View file

@ -0,0 +1,2 @@
Introduced Scenes feature that helps you to simplify user interactions using Finite State Machines.
Read more about 👉 :ref:`Scenes <Scenes>`.

5
aiogram/__init__.py
View file

@ -1,3 +1,4 @@
import asyncio as _asyncio
from contextlib import suppress
from aiogram.dispatcher.flags import FlagGenerator
@ -14,11 +15,9 @@ from .utils.text_decorations import html_decoration as html
from .utils.text_decorations import markdown_decoration as md
with suppress(ImportError):
import asyncio
import uvloop as _uvloop
asyncio.set_event_loop_policy(_uvloop.EventLoopPolicy())
_asyncio.set_event_loop_policy(_uvloop.EventLoopPolicy())
F = MagicFilter()

6
aiogram/dispatcher/event/handler.py
View file

@ -18,7 +18,7 @@ CallbackType = Callable[..., Any]
@dataclass
class CallableMixin:
class CallableObject:
callback: CallbackType
awaitable: bool = field(init=False)
params: Set[str] = field(init=False)
@ -49,7 +49,7 @@ class CallableMixin:
@dataclass
class FilterObject(CallableMixin):
class FilterObject(CallableObject):
magic: Optional[MagicFilter] = None
def __post_init__(self) -> None:
@ -76,7 +76,7 @@ class FilterObject(CallableMixin):
@dataclass
class HandlerObject(CallableMixin):
class HandlerObject(CallableObject):
filters: Optional[List[FilterObject]] = None
flags: Dict[str, Any] = field(default_factory=dict)

6
aiogram/exceptions.py
View file

@ -37,6 +37,12 @@ class CallbackAnswerException(AiogramError):
"""
class SceneException(AiogramError):
"""
Exception for scenes.
"""
class UnsupportedKeywordArgument(DetailedAiogramError):
"""
Exception raised when a keyword argument is passed as filter.

912
aiogram/fsm/scene.py Normal file
View file

@ -0,0 +1,912 @@
from __future__ import annotations
import inspect
from collections import defaultdict
from dataclasses import dataclass, replace
from enum import Enum, auto
from typing import Any, ClassVar, Dict, List, Optional, Tuple, Type, Union
from typing_extensions import Self
from aiogram import loggers
from aiogram.dispatcher.dispatcher import Dispatcher
from aiogram.dispatcher.event.bases import NextMiddlewareType
from aiogram.dispatcher.event.handler import CallableObject, CallbackType
from aiogram.dispatcher.flags import extract_flags_from_object
from aiogram.dispatcher.router import Router
from aiogram.exceptions import SceneException
from aiogram.filters import StateFilter
from aiogram.fsm.context import FSMContext
from aiogram.fsm.state import State
from aiogram.fsm.storage.memory import MemoryStorageRecord
from aiogram.types import TelegramObject, Update
class HistoryManager:
def __init__(self, state: FSMContext, destiny: str = "scenes_history", size: int = 10):
self._size = size
self._state = state
self._history_state = FSMContext(
storage=state.storage, key=replace(state.key, destiny=destiny)
)
async def push(self, state: Optional[str], data: Dict[str, Any]) -> None:
history_data = await self._history_state.get_data()
history = history_data.setdefault("history", [])
history.append({"state": state, "data": data})
if len(history) > self._size:
history = history[-self._size :]
loggers.scene.debug("Push state=%s data=%s to history", state, data)
await self._history_state.update_data(history=history)
async def pop(self) -> Optional[MemoryStorageRecord]:
history_data = await self._history_state.get_data()
history = history_data.setdefault("history", [])
if not history:
return None
record = history.pop()
state = record["state"]
data = record["data"]
if not history:
await self._history_state.set_data({})
else:
await self._history_state.update_data(history=history)
loggers.scene.debug("Pop state=%s data=%s from history", state, data)
return MemoryStorageRecord(state=state, data=data)
async def get(self) -> Optional[MemoryStorageRecord]:
history_data = await self._history_state.get_data()
history = history_data.setdefault("history", [])
if not history:
return None
return MemoryStorageRecord(**history[-1])
async def all(self) -> List[MemoryStorageRecord]:
history_data = await self._history_state.get_data()
history = history_data.setdefault("history", [])
return [MemoryStorageRecord(**item) for item in history]
async def clear(self) -> None:
loggers.scene.debug("Clear history")
await self._history_state.set_data({})
async def snapshot(self) -> None:
state = await self._state.get_state()
data = await self._state.get_data()
await self.push(state, data)
async def _set_state(self, state: Optional[str], data: Dict[str, Any]) -> None:
await self._state.set_state(state)
await self._state.set_data(data)
async def rollback(self) -> Optional[str]:
previous_state = await self.pop()
if not previous_state:
await self._set_state(None, {})
return None
loggers.scene.debug(
"Rollback to state=%s data=%s",
previous_state.state,
previous_state.data,
)
await self._set_state(previous_state.state, previous_state.data)
return previous_state.state
class ObserverDecorator:
def __init__(
self,
name: str,
filters: tuple[CallbackType, ...],
action: SceneAction | None = None,
after: Optional[After] = None,
) -> None:
self.name = name
self.filters = filters
self.action = action
self.after = after
def _wrap_filter(self, target: Type[Scene] | CallbackType) -> None:
handlers = getattr(target, "__aiogram_handler__", None)
if not handlers:
handlers = []
setattr(target, "__aiogram_handler__", handlers)
handlers.append(
HandlerContainer(
name=self.name,
handler=target,
filters=self.filters,
after=self.after,
)
)
def _wrap_action(self, target: CallbackType) -> None:
assert self.action is not None, "Scene action is not specified"
action = getattr(target, "__aiogram_action__", None)
if action is None:
action = defaultdict(dict)
setattr(target, "__aiogram_action__", action)
action[self.action][self.name] = CallableObject(target)
def __call__(self, target: CallbackType) -> CallbackType:
if inspect.isfunction(target):
if self.action is None:
self._wrap_filter(target)
else:
self._wrap_action(target)
else:
raise TypeError("Only function or method is allowed")
return target
def leave(self) -> ActionContainer:
return ActionContainer(self.name, self.filters, SceneAction.leave)
def enter(self, target: Type[Scene]) -> ActionContainer:
return ActionContainer(self.name, self.filters, SceneAction.enter, target)
def exit(self) -> ActionContainer:
return ActionContainer(self.name, self.filters, SceneAction.exit)
def back(self) -> ActionContainer:
return ActionContainer(self.name, self.filters, SceneAction.back)
class SceneAction(Enum):
enter = auto()
leave = auto()
exit = auto()
back = auto()
class ActionContainer:
def __init__(
self,
name: str,
filters: Tuple[CallbackType, ...],
action: SceneAction,
target: Optional[Union[Type[Scene], str]] = None,
) -> None:
self.name = name
self.filters = filters
self.action = action
self.target = target
async def execute(self, wizard: SceneWizard) -> None:
if self.action == SceneAction.enter and self.target is not None:
await wizard.goto(self.target)
elif self.action == SceneAction.leave:
await wizard.leave()
elif self.action == SceneAction.exit:
await wizard.exit()
elif self.action == SceneAction.back:
await wizard.back()
class HandlerContainer:
def __init__(
self,
name: str,
handler: CallbackType,
filters: Tuple[CallbackType, ...],
after: Optional[After] = None,
) -> None:
self.name = name
self.handler = handler
self.filters = filters
self.after = after
@dataclass()
class SceneConfig:
state: Optional[str]
"""Scene state"""
handlers: List[HandlerContainer]
"""Scene handlers"""
actions: Dict[SceneAction, Dict[str, CallableObject]]
"""Scene actions"""
reset_data_on_enter: Optional[bool] = None
"""Reset scene data on enter"""
reset_history_on_enter: Optional[bool] = None
"""Reset scene history on enter"""
callback_query_without_state: Optional[bool] = None
"""Allow callback query without state"""
async def _empty_handler(*args: Any, **kwargs: Any) -> None:
pass
class SceneHandlerWrapper:
def __init__(
self,
scene: Type[Scene],
handler: CallbackType,
after: Optional[After] = None,
) -> None:
self.scene = scene
self.handler = CallableObject(handler)
self.after = after
async def __call__(
self,
event: TelegramObject,
**kwargs: Any,
) -> Any:
state: FSMContext = kwargs["state"]
scenes: ScenesManager = kwargs["scenes"]
event_update: Update = kwargs["event_update"]
scene = self.scene(
wizard=SceneWizard(
scene_config=self.scene.__scene_config__,
manager=scenes,
state=state,
update_type=event_update.event_type,
event=event,
data=kwargs,
)
)
result = await self.handler.call(scene, event, **kwargs)
if self.after:
action_container = ActionContainer(
"after",
(),
self.after.action,
self.after.scene,
)
await action_container.execute(scene.wizard)
return result
def __await__(self) -> Self:
return self
def __str__(self) -> str:
result = f"SceneHandlerWrapper({self.scene}, {self.handler.callback}"
if self.after:
result += f", after={self.after}"
result += ")"
return result
class Scene:
"""
Represents a scene in a conversation flow.
A scene is a specific state in a conversation where certain actions can take place.
Each scene has a set of filters that determine when it should be triggered,
and a set of handlers that define the actions to be executed when the scene is active.
.. note::
This class is not meant to be used directly. Instead, it should be subclassed
to define custom scenes.
"""
__scene_config__: ClassVar[SceneConfig]
"""Scene configuration."""
def __init__(
self,
wizard: SceneWizard,
) -> None:
self.wizard = wizard
self.wizard.scene = self
def __init_subclass__(cls, **kwargs: Any) -> None:
state_name = kwargs.pop("state", None)
reset_data_on_enter = kwargs.pop("reset_data_on_enter", None)
reset_history_on_enter = kwargs.pop("reset_history_on_enter", None)
callback_query_without_state = kwargs.pop("callback_query_without_state", None)
super().__init_subclass__(**kwargs)
handlers: list[HandlerContainer] = []
actions: defaultdict[SceneAction, Dict[str, CallableObject]] = defaultdict(dict)
for base in cls.__bases__:
if not issubclass(base, Scene):
continue
parent_scene_config = getattr(base, "__scene_config__", None)
if not parent_scene_config:
continue
handlers.extend(parent_scene_config.handlers)
for action, action_handlers in parent_scene_config.actions.items():
actions[action].update(action_handlers)
if reset_data_on_enter is None:
reset_data_on_enter = parent_scene_config.reset_data_on_enter
if reset_history_on_enter is None:
reset_history_on_enter = parent_scene_config.reset_history_on_enter
if callback_query_without_state is None:
callback_query_without_state = parent_scene_config.callback_query_without_state
for name in vars(cls):
value = getattr(cls, name)
if scene_handlers := getattr(value, "__aiogram_handler__", None):
handlers.extend(scene_handlers)
if isinstance(value, ObserverDecorator):
handlers.append(
HandlerContainer(
value.name,
_empty_handler,
value.filters,
after=value.after,
)
)
if hasattr(value, "__aiogram_action__"):
for action, action_handlers in value.__aiogram_action__.items():
actions[action].update(action_handlers)
cls.__scene_config__ = SceneConfig(
state=state_name,
handlers=handlers,
actions=dict(actions),
reset_data_on_enter=reset_data_on_enter,
reset_history_on_enter=reset_history_on_enter,
callback_query_without_state=callback_query_without_state,
)
@classmethod
def add_to_router(cls, router: Router) -> None:
"""
Adds the scene to the given router.
:param router:
:return:
"""
scene_config = cls.__scene_config__
used_observers = set()
for handler in scene_config.handlers:
router.observers[handler.name].register(
SceneHandlerWrapper(
cls,
handler.handler,
after=handler.after,
),
*handler.filters,
flags=extract_flags_from_object(handler.handler),
)
used_observers.add(handler.name)
for observer_name in used_observers:
if scene_config.callback_query_without_state and observer_name == "callback_query":
continue
router.observers[observer_name].filter(StateFilter(scene_config.state))
@classmethod
def as_router(cls, name: Optional[str] = None) -> Router:
"""
Returns the scene as a router.
:return: new router
"""
if name is None:
name = (
f"Scene '{cls.__module__}.{cls.__qualname__}' "
f"for state {cls.__scene_config__.state!r}"
)
router = Router(name=name)
cls.add_to_router(router)
return router
@classmethod
def as_handler(cls, **kwargs: Any) -> CallbackType:
"""
Create an entry point handler for the scene, can be used to simplify the handler
that starts the scene.
>>> router.message.register(MyScene.as_handler(), Command("start"))
"""
async def enter_to_scene_handler(event: TelegramObject, scenes: ScenesManager) -> None:
await scenes.enter(cls, **kwargs)
return enter_to_scene_handler
class SceneWizard:
"""
A class that represents a wizard for managing scenes in a Telegram bot.
Instance of this class is passed to each scene as a parameter.
So, you can use it to transition between scenes, get and set data, etc.
.. note::
This class is not meant to be used directly. Instead, it should be used
as a parameter in the scene constructor.
"""
def __init__(
self,
scene_config: SceneConfig,
manager: ScenesManager,
state: FSMContext,
update_type: str,
event: TelegramObject,
data: Dict[str, Any],
):
"""
A class that represents a wizard for managing scenes in a Telegram bot.
:param scene_config: The configuration of the scene.
:param manager: The scene manager.
:param state: The FSMContext object for storing the state of the scene.
:param update_type: The type of the update event.
:param event: The TelegramObject represents the event.
:param data: Additional data for the scene.
"""
self.scene_config = scene_config
self.manager = manager
self.state = state
self.update_type = update_type
self.event = event
self.data = data
self.scene: Optional[Scene] = None
async def enter(self, **kwargs: Any) -> None:
"""
Enter method is used to transition into a scene in the SceneWizard class.
It sets the state, clears data and history if specified,
and triggers entering event of the scene.
:param kwargs: Additional keyword arguments.
:return: None
"""
loggers.scene.debug("Entering scene %r", self.scene_config.state)
if self.scene_config.reset_data_on_enter:
await self.state.set_data({})
if self.scene_config.reset_history_on_enter:
await self.manager.history.clear()
await self.state.set_state(self.scene_config.state)
await self._on_action(SceneAction.enter, **kwargs)
async def leave(self, _with_history: bool = True, **kwargs: Any) -> None:
"""
Leaves the current scene.
This method is used to exit a scene and transition to the next scene.
:param _with_history: Whether to include history in the snapshot. Defaults to True.
:param kwargs: Additional keyword arguments.
:return: None
"""
loggers.scene.debug("Leaving scene %r", self.scene_config.state)
if _with_history:
await self.manager.history.snapshot()
await self._on_action(SceneAction.leave, **kwargs)
async def exit(self, **kwargs: Any) -> None:
"""
Exit the current scene and enter the default scene/state.
:param kwargs: Additional keyword arguments.
:return: None
"""
loggers.scene.debug("Exiting scene %r", self.scene_config.state)
await self.manager.history.clear()
await self._on_action(SceneAction.exit, **kwargs)
await self.manager.enter(None, _check_active=False, **kwargs)
async def back(self, **kwargs: Any) -> None:
"""
This method is used to go back to the previous scene.
:param kwargs: Keyword arguments that can be passed to the method.
:return: None
"""
loggers.scene.debug("Back to previous scene from scene %s", self.scene_config.state)
await self.leave(_with_history=False, **kwargs)
new_scene = await self.manager.history.rollback()
await self.manager.enter(new_scene, _check_active=False, **kwargs)
async def retake(self, **kwargs: Any) -> None:
"""
This method allows to re-enter the current scene.
:param kwargs: Additional keyword arguments to pass to the scene.
:return: None
"""
assert self.scene_config.state is not None, "Scene state is not specified"
await self.goto(self.scene_config.state, **kwargs)
async def goto(self, scene: Union[Type[Scene], str], **kwargs: Any) -> None:
"""
The `goto` method transitions to a new scene.
It first calls the `leave` method to perform any necessary cleanup
in the current scene, then calls the `enter` event to enter the specified scene.
:param scene: The scene to transition to. Can be either a `Scene` instance
or a string representing the scene.
:param kwargs: Additional keyword arguments to pass to the `enter`
method of the scene manager.
:return: None
"""
await self.leave(**kwargs)
await self.manager.enter(scene, _check_active=False, **kwargs)
async def _on_action(self, action: SceneAction, **kwargs: Any) -> bool:
if not self.scene:
raise SceneException("Scene is not initialized")
loggers.scene.debug("Call action %r in scene %r", action.name, self.scene_config.state)
action_config = self.scene_config.actions.get(action, {})
if not action_config:
loggers.scene.debug(
"Action %r not found in scene %r", action.name, self.scene_config.state
)
return False
event_type = self.update_type
if event_type not in action_config:
loggers.scene.debug(
"Action %r for event %r not found in scene %r",
action.name,
event_type,
self.scene_config.state,
)
return False
await action_config[event_type].call(self.scene, self.event, **{**self.data, **kwargs})
return True
async def set_data(self, data: Dict[str, Any]) -> None:
"""
Sets custom data in the current state.
:param data: A dictionary containing the custom data to be set in the current state.
:return: None
"""
await self.state.set_data(data=data)
async def get_data(self) -> Dict[str, Any]:
"""
This method returns the data stored in the current state.
:return: A dictionary containing the data stored in the scene state.
"""
return await self.state.get_data()
async def update_data(
self, data: Optional[Dict[str, Any]] = None, **kwargs: Any
) -> Dict[str, Any]:
"""
This method updates the data stored in the current state
:param data: Optional dictionary of data to update.
:param kwargs: Additional key-value pairs of data to update.
:return: Dictionary of updated data
"""
if data:
kwargs.update(data)
return await self.state.update_data(data=kwargs)
async def clear_data(self) -> None:
"""
Clears the data.
:return: None
"""
await self.set_data({})
class ScenesManager:
"""
The ScenesManager class is responsible for managing scenes in an application.
It provides methods for entering and exiting scenes, as well as retrieving the active scene.
"""
def __init__(
self,
registry: SceneRegistry,
update_type: str,
event: TelegramObject,
state: FSMContext,
data: Dict[str, Any],
) -> None:
self.registry = registry
self.update_type = update_type
self.event = event
self.state = state
self.data = data
self.history = HistoryManager(self.state)
async def _get_scene(self, scene_type: Optional[Union[Type[Scene], str]]) -> Scene:
scene_type = self.registry.get(scene_type)
return scene_type(
wizard=SceneWizard(
scene_config=scene_type.__scene_config__,
manager=self,
state=self.state,
update_type=self.update_type,
event=self.event,
data=self.data,
),
)
async def _get_active_scene(self) -> Optional[Scene]:
state = await self.state.get_state()
try:
return await self._get_scene(state)
except SceneException:
return None
async def enter(
self,
scene_type: Optional[Union[Type[Scene], str]],
_check_active: bool = True,
**kwargs: Any,
) -> None:
"""
Enters the specified scene.
:param scene_type: Optional Type[Scene] or str representing the scene type to enter.
:param _check_active: Optional bool indicating whether to check if
there is an active scene to exit before entering the new scene. Defaults to True.
:param kwargs: Additional keyword arguments to pass to the scene's wizard.enter() method.
:return: None
"""
if _check_active:
active_scene = await self._get_active_scene()
if active_scene is not None:
await active_scene.wizard.exit(**kwargs)
try:
scene = await self._get_scene(scene_type)
except SceneException:
if scene_type is not None:
raise
await self.state.set_state(None)
else:
await scene.wizard.enter(**kwargs)
async def close(self, **kwargs: Any) -> None:
"""
Close method is used to exit the currently active scene in the ScenesManager.
:param kwargs: Additional keyword arguments passed to the scene's exit method.
:return: None
"""
scene = await self._get_active_scene()
if not scene:
return
await scene.wizard.exit(**kwargs)
class SceneRegistry:
"""
A class that represents a registry for scenes in a Telegram bot.
"""
def __init__(self, router: Router, register_on_add: bool = True) -> None:
"""
Initialize a new instance of the SceneRegistry class.
:param router: The router instance used for scene registration.
:param register_on_add: Whether to register the scenes to the router when they are added.
"""
self.router = router
self.register_on_add = register_on_add
self._scenes: Dict[Optional[str], Type[Scene]] = {}
self._setup_middleware(router)
def _setup_middleware(self, router: Router) -> None:
if isinstance(router, Dispatcher):
# Small optimization for Dispatcher
# - we don't need to set up middleware for all observers
router.update.outer_middleware(self._update_middleware)
return
for observer in router.observers.values():
if observer.event_name in {"update", "error"}:
continue
observer.outer_middleware(self._middleware)
async def _update_middleware(
self,
handler: NextMiddlewareType[TelegramObject],
event: TelegramObject,
data: Dict[str, Any],
) -> Any:
assert isinstance(event, Update), "Event must be an Update instance"
data["scenes"] = ScenesManager(
registry=self,
update_type=event.event_type,
event=event.event,
state=data["state"],
data=data,
)
return await handler(event, data)
async def _middleware(
self,
handler: NextMiddlewareType[TelegramObject],
event: TelegramObject,
data: Dict[str, Any],
) -> Any:
update: Update = data["event_update"]
data["scenes"] = ScenesManager(
registry=self,
update_type=update.event_type,
event=event,
state=data["state"],
data=data,
)
return await handler(event, data)
def add(self, *scenes: Type[Scene], router: Optional[Router] = None) -> None:
"""
This method adds the specified scenes to the registry
and optionally registers it to the router.
If a scene with the same state already exists in the registry, a SceneException is raised.
.. warning::
If the router is not specified, the scenes will not be registered to the router.
You will need to include the scenes manually to the router or use the register method.
:param scenes: A variable length parameter that accepts one or more types of scenes.
These scenes are instances of the Scene class.
:param router: An optional parameter that specifies the router
to which the scenes should be added.
:return: None
"""
if not scenes:
raise ValueError("At least one scene must be specified")
for scene in scenes:
if scene.__scene_config__.state in self._scenes:
raise SceneException(
f"Scene with state {scene.__scene_config__.state!r} already exists"
)
self._scenes[scene.__scene_config__.state] = scene
if router:
router.include_router(scene.as_router())
elif self.register_on_add:
self.router.include_router(scene.as_router())
def register(self, *scenes: Type[Scene]) -> None:
"""
Registers one or more scenes to the SceneRegistry.
:param scenes: One or more scene classes to register.
:return: None
"""
self.add(*scenes, router=self.router)
def get(self, scene: Optional[Union[Type[Scene], str]]) -> Type[Scene]:
"""
This method returns the registered Scene object for the specified scene.
The scene parameter can be either a Scene object or a string representing
the name of the scene. If a Scene object is provided, the state attribute
of the SceneConfig object associated with the Scene object will be used as the scene name.
If None or an invalid type is provided, a SceneException will be raised.
If the specified scene is not registered in the SceneRegistry object,
a SceneException will be raised.
:param scene: A Scene object or a string representing the name of the scene.
:return: The registered Scene object corresponding to the given scene parameter.
"""
if inspect.isclass(scene) and issubclass(scene, Scene):
scene = scene.__scene_config__.state
if isinstance(scene, State):
scene = scene.state
if scene is not None and not isinstance(scene, str):
raise SceneException("Scene must be a subclass of Scene or a string")
try:
return self._scenes[scene]
except KeyError:
raise SceneException(f"Scene {scene!r} is not registered")
@dataclass
class After:
action: SceneAction
scene: Optional[Union[Type[Scene], str]] = None
@classmethod
def exit(cls) -> After:
return cls(action=SceneAction.exit)
@classmethod
def back(cls) -> After:
return cls(action=SceneAction.back)
@classmethod
def goto(cls, scene: Optional[Union[Type[Scene], str]]) -> After:
return cls(action=SceneAction.enter, scene=scene)
class ObserverMarker:
def __init__(self, name: str) -> None:
self.name = name
def __call__(
self,
*filters: CallbackType,
after: Optional[After] = None,
) -> ObserverDecorator:
return ObserverDecorator(
self.name,
filters,
after=after,
)
def enter(self, *filters: CallbackType) -> ObserverDecorator:
return ObserverDecorator(self.name, filters, action=SceneAction.enter)
def leave(self) -> ObserverDecorator:
return ObserverDecorator(self.name, (), action=SceneAction.leave)
def exit(self) -> ObserverDecorator:
return ObserverDecorator(self.name, (), action=SceneAction.exit)
def back(self) -> ObserverDecorator:
return ObserverDecorator(self.name, (), action=SceneAction.back)
class OnMarker:
"""
The `OnMarker` class is used as a marker class to define different
types of events in the Scenes.
Attributes:
- :code:`message`: Event marker for handling `Message` events.
- :code:`edited_message`: Event marker for handling edited `Message` events.
- :code:`channel_post`: Event marker for handling channel `Post` events.
- :code:`edited_channel_post`: Event marker for handling edited channel `Post` events.
- :code:`inline_query`: Event marker for handling `InlineQuery` events.
- :code:`chosen_inline_result`: Event marker for handling chosen `InlineResult` events.
- :code:`callback_query`: Event marker for handling `CallbackQuery` events.
- :code:`shipping_query`: Event marker for handling `ShippingQuery` events.
- :code:`pre_checkout_query`: Event marker for handling `PreCheckoutQuery` events.
- :code:`poll`: Event marker for handling `Poll` events.
- :code:`poll_answer`: Event marker for handling `PollAnswer` events.
- :code:`my_chat_member`: Event marker for handling my chat `Member` events.
- :code:`chat_member`: Event marker for handling chat `Member` events.
- :code:`chat_join_request`: Event marker for handling chat `JoinRequest` events.
- :code:`error`: Event marker for handling `Error` events.
.. note::
This is a marker class and does not contain any methods or implementation logic.
"""
message = ObserverMarker("message")
edited_message = ObserverMarker("edited_message")
channel_post = ObserverMarker("channel_post")
edited_channel_post = ObserverMarker("edited_channel_post")
inline_query = ObserverMarker("inline_query")
chosen_inline_result = ObserverMarker("chosen_inline_result")
callback_query = ObserverMarker("callback_query")
shipping_query = ObserverMarker("shipping_query")
pre_checkout_query = ObserverMarker("pre_checkout_query")
poll = ObserverMarker("poll")
poll_answer = ObserverMarker("poll_answer")
my_chat_member = ObserverMarker("my_chat_member")
chat_member = ObserverMarker("chat_member")
chat_join_request = ObserverMarker("chat_join_request")
on = OnMarker()

1
aiogram/loggers.py
View file

@ -4,3 +4,4 @@ dispatcher = logging.getLogger("aiogram.dispatcher")
event = logging.getLogger("aiogram.event")
middlewares = logging.getLogger("aiogram.middlewares")
webhook = logging.getLogger("aiogram.webhook")
scene = logging.getLogger("aiogram.scene")

8
docs/api/download_file.rst
View file

@ -31,9 +31,7 @@ Download file by `file_path` to destination.
If you want to automatically create destination (:obj:`io.BytesIO`) use default
value of destination and handle result of this method.
.. autoclass:: aiogram.client.bot.Bot
:members: download_file
:exclude-members: __init__
.. automethod:: aiogram.client.bot.Bot.download_file
There are two options where you can download the file: to **disk** or to **binary I/O object**.
@ -81,9 +79,7 @@ Download file by `file_id` or `Downloadable` object to destination.
If you want to automatically create destination (:obj:`io.BytesIO`) use default
value of destination and handle result of this method.
.. autoclass:: aiogram.client.bot.Bot
:members: download
:exclude-members: __init__
.. automethod:: aiogram.client.bot.Bot.download
It differs from `download_file <#download-file>`__ **only** in that it accepts `file_id`
or an `Downloadable` object (object that contains the `file_id` attribute) instead of `file_path`.

1
docs/dispatcher/finite_state_machine/index.rst
View file

@ -95,6 +95,7 @@ Read more
.. toctree::
storages
scene
.. _wiki: https://en.wikipedia.org/wiki/Finite-state_machine

243
docs/dispatcher/finite_state_machine/scene.rst Normal file
View file

@ -0,0 +1,243 @@
.. _Scenes:
=============
Scenes Wizard
=============
.. versionadded:: 3.2
.. warning::
This feature is experimental and may be changed in future versions.
**aiogram's** basics API is easy to use and powerful,
allowing the implementation of simple interactions such as triggering a command or message
for a response.
However, certain tasks require a dialogue between the user and the bot.
This is where Scenes come into play.
Understanding Scenes
====================
A Scene in **aiogram** is like an abstract, isolated namespace or room that a user can be
ushered into via the code. When a user is inside a Scene, all other global commands or
message handlers are isolated, and they stop responding to user actions.
Scenes provide a structure for more complex interactions,
effectively isolating and managing contexts for different stages of the conversation.
They allow you to control and manage the flow of the conversation in a more organized manner.
Scene Lifecycle
---------------
Each Scene can be "entered", "left" of "exited", allowing for clear transitions between different
stages of the conversation.
For instance, in a multi-step form filling interaction, each step could be a Scene -
the bot guides the user from one Scene to the next as they provide the required information.
Scene Listeners
---------------
Scenes have their own hooks which are command or message listeners that only act while
the user is within the Scene.
These hooks react to user actions while the user is 'inside' the Scene,
providing the responses or actions appropriate for that context.
When the user is ushered from one Scene to another, the actions and responses change
accordingly as the user is now interacting with the set of listeners inside the new Scene.
These 'Scene-specific' hooks or listeners, detached from the global listening context,
allow for more streamlined and organized bot-user interactions.
Scene Interactions
------------------
Each Scene is like a self-contained world, with interactions defined within the scope of that Scene.
As such, only the handlers defined within the specific Scene will react to user's input during
the lifecycle of that Scene.
Scene Benefits
--------------
Scenes can help manage more complex interaction workflows and enable more interactive and dynamic
dialogs between the user and the bot.
This offers great flexibility in handling multi-step interactions or conversations with the users.
How to use Scenes
=================
For example we have a quiz bot, which asks the user a series of questions and then displays the results.
Lets start with the data models, in this example simple data models are used to represent
the questions and answers, in real life you would probably use a database to store the data.
.. literalinclude:: ../../../examples/quiz_scene.py
:language: python
:lines: 18-94
:caption: Questions list
Then, we need to create a Scene class that will represent the quiz game scene:
.. note::
Keyword argument passed into class definition describes the scene name - is the same as state of the scene.
.. literalinclude:: ../../../examples/quiz_scene.py
:language: python
:pyobject: QuizScene
:emphasize-lines: 1
:lines: -7
:caption: Quiz Scene
Also we need to define a handler that helps to start the quiz game:
.. literalinclude:: ../../../examples/quiz_scene.py
:language: python
:caption: Start command handler
:lines: 260-262
Once the scene is defined, we need to register it in the SceneRegistry:
.. literalinclude:: ../../../examples/quiz_scene.py
:language: python
:pyobject: create_dispatcher
:caption: Registering the scene
So, now we can implement the quiz game logic, each question is sent to the user one by one,
and the user's answer is checked at the end of all questions.
Now we need to write an entry point for the question handler:
.. literalinclude:: ../../../examples/quiz_scene.py
:language: python
:caption: Question handler entry point
:pyobject: QuizScene.on_enter
Once scene is entered, we should expect the user's answer, so we need to write a handler for it,
this handler should expect the text message, save the answer and retake
the question handler for the next question:
.. literalinclude:: ../../../examples/quiz_scene.py
:language: python
:caption: Answer handler
:pyobject: QuizScene.answer
When user answer with unknown message, we should expect the text message again:
.. literalinclude:: ../../../examples/quiz_scene.py
:language: python
:caption: Unknown message handler
:pyobject: QuizScene.unknown_message
When all questions are answered, we should show the results to the user, as you can see in the code below,
we use `await self.wizard.exit()` to exit from the scene when questions list is over in the `QuizScene.on_enter` handler.
Thats means that we need to write an exit handler to show the results to the user:
.. literalinclude:: ../../../examples/quiz_scene.py
:language: python
:caption: Show results handler
:pyobject: QuizScene.on_exit
Also we can implement a actions to exit from the quiz game or go back to the previous question:
.. literalinclude:: ../../../examples/quiz_scene.py
:language: python
:caption: Exit handler
:pyobject: QuizScene.exit
.. literalinclude:: ../../../examples/quiz_scene.py
:language: python
:caption: Back handler
:pyobject: QuizScene.back
Now we can run the bot and test the quiz game:
.. literalinclude:: ../../../examples/quiz_scene.py
:language: python
:caption: Run the bot
:lines: 291-
Complete them all
.. literalinclude:: ../../../examples/quiz_scene.py
:language: python
:caption: Quiz Example
Components
==========
- :class:`aiogram.fsm.scene.Scene` - represents a scene, contains handlers
- :class:`aiogram.fsm.scene.SceneRegistry` - container for all scenes in the bot, used to register scenes and resolve them by name
- :class:`aiogram.fsm.scene.ScenesManager` - manages scenes for each user, used to enter, leave and resolve current scene for user
- :class:`aiogram.fsm.scene.SceneConfig` - scene configuration, used to configure scene
- :class:`aiogram.fsm.scene.SceneWizard` - scene wizard, used to interact with user in scene from active scene handler
- Markers - marker for scene handlers, used to mark scene handlers
.. autoclass:: aiogram.fsm.scene.Scene
:members:
.. autoclass:: aiogram.fsm.scene.SceneRegistry
:members:
.. autoclass:: aiogram.fsm.scene.ScenesManager
:members:
.. autoclass:: aiogram.fsm.scene.SceneConfig
:members:
.. autoclass:: aiogram.fsm.scene.SceneWizard
:members:
Markers
-------
Markers are similar to the Router event registering mechanism,
but they are used to mark scene handlers in the Scene class.
It can be imported from :code:`from aiogram.fsm.scene import on` and should be used as decorator.
Allowed event types:
- message
- edited_message
- channel_post
- edited_channel_post
- inline_query
- chosen_inline_result
- callback_query
- shipping_query
- pre_checkout_query
- poll
- poll_answer
- my_chat_member
- chat_member
- chat_join_request
Each event type can be filtered in the same way as in the Router.
Also each event type can be marked as scene entry point, exit point or leave point.
If you want to mark the scene can be entered from message or inline query,
you should use :code:`on.message` or :code:`on.inline_query` marker:
.. code-block:: python
class MyScene(Scene, name="my_scene"):
@on.message.enter()
async def on_enter(self, message: types.Message):
pass
@on.callback_query.enter()
async def on_enter(self, callback_query: types.CallbackQuery):
pass
Scene has only tree points for transitions:
- enter point - when user enters to the scene
- leave point - when user leaves the scene and the enter another scene
- exit point - when user exits from the scene

301
examples/quiz_scene.py Normal file
View file

@ -0,0 +1,301 @@
import asyncio
import logging
from dataclasses import dataclass, field
from os import getenv
from typing import Any
from aiogram import Bot, Dispatcher, F, Router, html
from aiogram.filters import Command
from aiogram.fsm.context import FSMContext
from aiogram.fsm.scene import Scene, SceneRegistry, ScenesManager, on
from aiogram.fsm.storage.memory import SimpleEventIsolation
from aiogram.types import KeyboardButton, Message, ReplyKeyboardRemove
from aiogram.utils.formatting import (
Bold,
as_key_value,
as_list,
as_numbered_list,
as_section,
)
from aiogram.utils.keyboard import ReplyKeyboardBuilder
TOKEN = getenv("BOT_TOKEN")
@dataclass
class Answer:
"""
Represents an answer to a question.
"""
text: str
"""The answer text"""
is_correct: bool = False
"""Indicates if the answer is correct"""
@dataclass
class Question:
"""
Class representing a quiz with a question and a list of answers.
"""
text: str
"""The question text"""
answers: list[Answer]
"""List of answers"""
correct_answer: str = field(init=False)
def __post_init__(self):
self.correct_answer = next(answer.text for answer in self.answers if answer.is_correct)
# Fake data, in real application you should use a database or something else
QUESTIONS = [
Question(
text="What is the capital of France?",
answers=[
Answer("Paris", is_correct=True),
Answer("London"),
Answer("Berlin"),
Answer("Madrid"),
],
),
Question(
text="What is the capital of Spain?",
answers=[
Answer("Paris"),
Answer("London"),
Answer("Berlin"),
Answer("Madrid", is_correct=True),
],
),
Question(
text="What is the capital of Germany?",
answers=[
Answer("Paris"),
Answer("London"),
Answer("Berlin", is_correct=True),
Answer("Madrid"),
],
),
Question(
text="What is the capital of England?",
answers=[
Answer("Paris"),
Answer("London", is_correct=True),
Answer("Berlin"),
Answer("Madrid"),
],
),
Question(
text="What is the capital of Italy?",
answers=[
Answer("Paris"),
Answer("London"),
Answer("Berlin"),
Answer("Rome", is_correct=True),
],
),
]
class QuizScene(Scene, state="quiz"):
"""
This class represents a scene for a quiz game.
It inherits from Scene class and is associated with the state "quiz".
It handles the logic and flow of the quiz game.
"""
@on.message.enter()
async def on_enter(self, message: Message, state: FSMContext, step: int | None = 0) -> Any:
"""
Method triggered when the user enters the quiz scene.
It displays the current question and answer options to the user.
:param message:
:param state:
:param step: Scene argument, can be passed to the scene using the wizard
:return:
"""
if not step:
# This is the first step, so we should greet the user
await message.answer("Welcome to the quiz!")
try:
quiz = QUESTIONS[step]
except IndexError:
# This error means that the question's list is over
return await self.wizard.exit()
markup = ReplyKeyboardBuilder()
markup.add(*[KeyboardButton(text=answer.text) for answer in quiz.answers])
if step > 0:
markup.button(text="🔙 Back")
markup.button(text="🚫 Exit")
await state.update_data(step=step)
return await message.answer(
text=QUESTIONS[step].text,
reply_markup=markup.adjust(2).as_markup(resize_keyboard=True),
)
@on.message.exit()
async def on_exit(self, message: Message, state: FSMContext) -> None:
"""
Method triggered when the user exits the quiz scene.
It calculates the user's answers, displays the summary, and clears the stored answers.
:param message:
:param state:
:return:
"""
data = await state.get_data()
answers = data.get("answers", {})
correct = 0
incorrect = 0
user_answers = []
for step, quiz in enumerate(QUESTIONS):
answer = answers.get(step)
is_correct = answer == quiz.correct_answer
if is_correct:
correct += 1
icon = "✅"
else:
incorrect += 1
icon = "❌"
if answer is None:
answer = "no answer"
user_answers.append(f"{quiz.text} ({icon} {html.quote(answer)})")
content = as_list(
as_section(
Bold("Your answers:"),
as_numbered_list(*user_answers),
),
"",
as_section(
Bold("Summary:"),
as_list(
as_key_value("Correct", correct),
as_key_value("Incorrect", incorrect),
),
),
)
await message.answer(**content.as_kwargs(), reply_markup=ReplyKeyboardRemove())
await state.set_data({})
@on.message(F.text == "🔙 Back")
async def back(self, message: Message, state: FSMContext) -> None:
"""
Method triggered when the user selects the "Back" button.
It allows the user to go back to the previous question.
:param message:
:param state:
:return:
"""
data = await state.get_data()
step = data["step"]
previous_step = step - 1
if previous_step < 0:
# In case when the user tries to go back from the first question,
# we just exit the quiz
return await self.wizard.exit()
return await self.wizard.back(step=previous_step)
@on.message(F.text == "🚫 Exit")
async def exit(self, message: Message) -> None:
"""
Method triggered when the user selects the "Exit" button.
It exits the quiz.
:param message:
:return:
"""
await self.wizard.exit()
@on.message(F.text)
async def answer(self, message: Message, state: FSMContext) -> None:
"""
Method triggered when the user selects an answer.
It stores the answer and proceeds to the next question.
:param message:
:param state:
:return:
"""
data = await state.get_data()
step = data["step"]
answers = data.get("answers", {})
answers[step] = message.text
await state.update_data(answers=answers)
await self.wizard.retake(step=step + 1)
@on.message()
async def unknown_message(self, message: Message) -> None:
"""
Method triggered when the user sends a message that is not a command or an answer.
It asks the user to select an answer.
:param message: The message received from the user.
:return: None
"""
await message.answer("Please select an answer.")
quiz_router = Router(name=__name__)
# Add handler that initializes the scene
quiz_router.message.register(QuizScene.as_handler(), Command("quiz"))
@quiz_router.message(Command("start"))
async def command_start(message: Message, scenes: ScenesManager):
await scenes.close()
await message.answer(
"Hi! This is a quiz bot. To start the quiz, use the /quiz command.",
reply_markup=ReplyKeyboardRemove(),
)
def create_dispatcher():
# Event isolation is needed to correctly handle fast user responses
dispatcher = Dispatcher(
events_isolation=SimpleEventIsolation(),
)
dispatcher.include_router(quiz_router)
# To use scenes, you should create a SceneRegistry and register your scenes there
scene_registry = SceneRegistry(dispatcher)
# ... and then register a scene in the registry
# by default, Scene will be mounted to the router that passed to the SceneRegistry,
# but you can specify the router explicitly using the `router` argument
scene_registry.add(QuizScene)
return dispatcher
async def main():
dispatcher = create_dispatcher()
bot = Bot(TOKEN)
await dispatcher.start_polling(bot)
if __name__ == "__main__":
logging.basicConfig(level=logging.INFO)
asyncio.run(main())
# Alternatively, you can use aiogram-cli:
# `aiogram run polling quiz_scene:create_dispatcher --log-level info --token BOT_TOKEN`

203
examples/scene.py Normal file
View file

@ -0,0 +1,203 @@
from __future__ import annotations
from os import getenv
from typing import TypedDict
from aiogram import Bot, Dispatcher, F, html
from aiogram.filters import Command
from aiogram.fsm.scene import After, Scene, SceneRegistry, on
from aiogram.types import (
CallbackQuery,
InlineKeyboardButton,
InlineKeyboardMarkup,
KeyboardButton,
Message,
ReplyKeyboardMarkup,
ReplyKeyboardRemove,
)
BUTTON_CANCEL = KeyboardButton(text="❌ Cancel")
BUTTON_BACK = KeyboardButton(text="🔙 Back")
class FSMData(TypedDict, total=False):
name: str
language: str
class CancellableScene(Scene):
"""
This scene is used to handle cancel and back buttons,
can be used as a base class for other scenes that needs to support cancel and back buttons.
"""
@on.message(F.text.casefold() == BUTTON_CANCEL.text.casefold(), after=After.exit())
async def handle_cancel(self, message: Message):
await message.answer("Cancelled.", reply_markup=ReplyKeyboardRemove())
@on.message(F.text.casefold() == BUTTON_BACK.text.casefold(), after=After.back())
async def handle_back(self, message: Message):
await message.answer("Back.")
class LanguageScene(CancellableScene, state="language"):
"""
This scene is used to ask user what language he prefers.
"""
@on.message.enter()
async def on_enter(self, message: Message):
await message.answer(
"What language do you prefer?",
reply_markup=ReplyKeyboardMarkup(
keyboard=[[BUTTON_BACK, BUTTON_CANCEL]],
resize_keyboard=True,
),
)
@on.message(F.text.casefold() == "python", after=After.exit())
async def process_python(self, message: Message):
await message.answer(
"Python, you say? That's the language that makes my circuits light up! 😉"
)
await self.input_language(message)
@on.message(after=After.exit())
async def input_language(self, message: Message):
data: FSMData = await self.wizard.get_data()
await self.show_results(message, language=message.text, **data)
async def show_results(self, message: Message, name: str, language: str) -> None:
await message.answer(
text=f"I'll keep in mind that, {html.quote(name)}, "
f"you like to write bots with {html.quote(language)}.",
reply_markup=ReplyKeyboardRemove(),
)
class LikeBotsScene(CancellableScene, state="like_bots"):
"""
This scene is used to ask user if he likes to write bots.
"""
@on.message.enter()
async def on_enter(self, message: Message):
await message.answer(
"Did you like to write bots?",
reply_markup=ReplyKeyboardMarkup(
keyboard=[
[KeyboardButton(text="Yes"), KeyboardButton(text="No")],
[BUTTON_BACK, BUTTON_CANCEL],
],
resize_keyboard=True,
),
)
@on.message(F.text.casefold() == "yes", after=After.goto(LanguageScene))
async def process_like_write_bots(self, message: Message):
await message.reply("Cool! I'm too!")
@on.message(F.text.casefold() == "no", after=After.exit())
async def process_dont_like_write_bots(self, message: Message):
await message.answer(
"Not bad not terrible.\nSee you soon.",
reply_markup=ReplyKeyboardRemove(),
)
@on.message()
async def input_like_bots(self, message: Message):
await message.answer("I don't understand you :(")
class NameScene(CancellableScene, state="name"):
"""
This scene is used to ask user's name.
"""
@on.message.enter() # Marker for handler that should be called when a user enters the scene.
async def on_enter(self, message: Message):
await message.answer(
"Hi there! What's your name?",
reply_markup=ReplyKeyboardMarkup(keyboard=[[BUTTON_CANCEL]], resize_keyboard=True),
)
@on.callback_query.enter() # different types of updates that start the scene also supported.
async def on_enter_callback(self, callback_query: CallbackQuery):
await callback_query.answer()
await self.on_enter(callback_query.message)
@on.message.leave() # Marker for handler that should be called when a user leaves the scene.
async def on_leave(self, message: Message):
data: FSMData = await self.wizard.get_data()
name = data.get("name", "Anonymous")
await message.answer(f"Nice to meet you, {html.quote(name)}!")
@on.message(after=After.goto(LikeBotsScene))
async def input_name(self, message: Message):
await self.wizard.update_data(name=message.text)
class DefaultScene(
Scene,
reset_data_on_enter=True, # Reset state data
reset_history_on_enter=True, # Reset history
callback_query_without_state=True, # Handle callback queries even if user in any scene
):
"""
Default scene for the bot.
This scene is used to handle all messages that are not handled by other scenes.
"""
start_demo = on.message(F.text.casefold() == "demo", after=After.goto(NameScene))
@on.message(Command("demo"))
async def demo(self, message: Message):
await message.answer(
"Demo started",
reply_markup=InlineKeyboardMarkup(
inline_keyboard=[[InlineKeyboardButton(text="Go to form", callback_data="start")]]
),
)
@on.callback_query(F.data == "start", after=After.goto(NameScene))
async def demo_callback(self, callback_query: CallbackQuery):
await callback_query.answer(cache_time=0)
await callback_query.message.delete_reply_markup()
@on.message.enter() # Mark that this handler should be called when a user enters the scene.
@on.message()
async def default_handler(self, message: Message):
await message.answer(
"Start demo?\nYou can also start demo via command /demo",
reply_markup=ReplyKeyboardMarkup(
keyboard=[[KeyboardButton(text="Demo")]],
resize_keyboard=True,
),
)
def create_dispatcher() -> Dispatcher:
dispatcher = Dispatcher()
# Scene registry should be the only one instance in your application for proper work.
# It stores all available scenes.
# You can use any router for scenes, not only `Dispatcher`.
registry = SceneRegistry(dispatcher)
# All scenes at register time converts to Routers and includes into specified router.
registry.add(
DefaultScene,
NameScene,
LikeBotsScene,
LanguageScene,
)
return dispatcher
if __name__ == "__main__":
# Recommended to use CLI instead of this snippet.
# `aiogram run polling scene_example:create_dispatcher --token BOT_TOKEN --log-level info`
dp = create_dispatcher()
bot = Bot(token=getenv("TELEGRAM_TOKEN"))
dp.run_polling()

2
tests/test_dispatcher/test_event/test_event.py
View file

@ -46,7 +46,7 @@ class TestEventObserver:
assert observer.handlers[2].awaitable
with patch(
"aiogram.dispatcher.event.handler.CallableMixin.call",
"aiogram.dispatcher.event.handler.CallableObject.call",
new_callable=AsyncMock,
) as mocked_my_handler:
results = await observer.trigger("test")

20
tests/test_dispatcher/test_event/test_handler.py
View file

@ -5,7 +5,7 @@ import pytest
from magic_filter import F as A
from aiogram import F
from aiogram.dispatcher.event.handler import CallableMixin, FilterObject, HandlerObject
from aiogram.dispatcher.event.handler import CallableObject, FilterObject, HandlerObject
from aiogram.filters import Filter
from aiogram.handlers import BaseHandler
from aiogram.types import Update
@ -38,16 +38,16 @@ class SyncCallable:
return locals()
class TestCallableMixin:
class TestCallableObject:
@pytest.mark.parametrize("callback", [callback2, TestFilter()])
def test_init_awaitable(self, callback):
obj = CallableMixin(callback)
obj = CallableObject(callback)
assert obj.awaitable
assert obj.callback == callback
@pytest.mark.parametrize("callback", [callback1, SyncCallable()])
def test_init_not_awaitable(self, callback):
obj = CallableMixin(callback)
obj = CallableObject(callback)
assert not obj.awaitable
assert obj.callback == callback
@ -62,7 +62,7 @@ class TestCallableMixin:
],
)
def test_init_args_spec(self, callback: Callable, args: Set[str]):
obj = CallableMixin(callback)
obj = CallableObject(callback)
assert set(obj.params) == args
def test_init_decorated(self):
@ -82,8 +82,8 @@ class TestCallableMixin:
def callback2(foo, bar, baz):
pass
obj1 = CallableMixin(callback1)
obj2 = CallableMixin(callback2)
obj1 = CallableObject(callback1)
obj2 = CallableObject(callback2)
assert set(obj1.params) == {"foo", "bar", "baz"}
assert obj1.callback == callback1
@ -127,17 +127,17 @@ class TestCallableMixin:
def test_prepare_kwargs(
self, callback: Callable, kwargs: Dict[str, Any], result: Dict[str, Any]
):
obj = CallableMixin(callback)
obj = CallableObject(callback)
assert obj._prepare_kwargs(kwargs) == result
async def test_sync_call(self):
obj = CallableMixin(callback1)
obj = CallableObject(callback1)
result = await obj.call(foo=42, bar="test", baz="fuz", spam=True)
assert result == {"foo": 42, "bar": "test", "baz": "fuz"}
async def test_async_call(self):
obj = CallableMixin(callback2)
obj = CallableObject(callback2)
result = await obj.call(foo=42, bar="test", baz="fuz", spam=True)
assert result == {"foo": 42, "bar": "test", "baz": "fuz"}

1547
tests/test_fsm/test_scene.py Normal file
View file

File diff suppressed because it is too large Load diff