mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
99fa2460da
* migrated mongo storage from using deprecated motor to PyMongo * added storages to __init__.py file to improve DX * changelog file created * Revert "added storages to __init__.py file to improve DX" This reverts commit5d0f6a9dfb. * added optional dependency to pymongo to pyproject.toml * Revert "migrated mongo storage from using deprecated motor to PyMongo" This reverts commit1c0207e1d1. * added deprecation warning to mongo storage * created pymongo storage * added entry for PyMongoStorage to documentation in fsm.storages * updated changelog to have information about how to migrate from MongoStorage to PyMongoStorage * added test for pymongo storage (copied from mongo storage test) * fixed formatting using black and isort * fixed bug in close method of PyMongoStorage (client close method was not awaited) * added test for PyMongoStorage that checks if storage could be properly closed * pymongo package changed to be lower case in PyMongoStorage * added fixture registration for pymongo storage * test for pymongo is now using proper test fixtures * removed redundant call to get_data, because we have checked this condition in the previous line * added more tests to pymongo test, to check for all possible cases of using update_data method * fixed PyMongoStorage update_data method implementation * added pymongo tests to test_storages * fixed pymongo tests, update_data method should not delete document when {} was passed * Revert "fixed PyMongoStorage update_data method implementation" This reverts commit86170e1cb9. * fixed linting issues in PyMongoStorage * changed allowed versions of pymongo, to be compatible with motor * pinned the upper version of pymongo to <4.11
52 lines
1 KiB
ReStructuredText
52 lines
1 KiB
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.pymongo.PyMongoStorage
|
|
:members: __init__, from_url
|
|
:member-order: bysource
|
|
|
|
.. 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
|