mirror of
https://github.com/aiogram/aiogram.git
synced 2025-12-16 20:23:32 +00:00
1ef7655fd7
* Mongo storage included to storages test * Added few additional checks in storages test * Added MongoStorage for FSM * Added changes description * Fixed error message syntax Co-authored-by: Alex Root Junior <jroot.junior@gmail.com> * Resolved mypy check error * IF/ELSE statement simplified * Fix ruff linter error: RET505 Unnecessary `elif` after `return` statement * Fix ruff linter error: E501 Line too long (100 > 99) * Added mongo storage testing in CI * Refactoring while review * Refactoring while review * Storing FSM state and data together in MongoDB-storage * Fix CI - MongoDB container action is only supported on Linux * Refactoring while review * Enable Macos in pypy-tests section of CI * Refactoring while review * Makefile updated * redis and mongo storages tests do not run in pypy-tests job of CI * Fix docstring of DefaultKeyBuilder --------- Co-authored-by: Alex Root Junior <jroot.junior@gmail.com>
48 lines
932 B
ReStructuredText
48 lines
932 B
ReStructuredText
########
|
|
Storages
|
|
########
|
|
|
|
Storages out of the box
|
|
=======================
|
|
|
|
MemoryStorage
|
|
-------------
|
|
|
|
.. autoclass:: aiogram.fsm.storage.memory.MemoryStorage
|
|
:members: __init__
|
|
:member-order: bysource
|
|
|
|
RedisStorage
|
|
------------
|
|
|
|
.. autoclass:: aiogram.fsm.storage.redis.RedisStorage
|
|
:members: __init__, from_url
|
|
:member-order: bysource
|
|
|
|
MongoStorage
|
|
------------
|
|
|
|
.. autoclass:: aiogram.fsm.storage.mongo.MongoStorage
|
|
:members: __init__, from_url
|
|
:member-order: bysource
|
|
|
|
KeyBuilder
|
|
------------
|
|
|
|
Keys inside Redis and Mongo storages can be customized via key builders:
|
|
|
|
.. autoclass:: aiogram.fsm.storage.base.KeyBuilder
|
|
:members:
|
|
:member-order: bysource
|
|
|
|
.. autoclass:: aiogram.fsm.storage.base.DefaultKeyBuilder
|
|
:members:
|
|
:member-order: bysource
|
|
|
|
|
|
Writing own storages
|
|
====================
|
|
|
|
.. autoclass:: aiogram.fsm.storage.base.BaseStorage
|
|
:members:
|
|
:member-order: bysource
|