From 7b33e5c68a5cdf2de54e6e27c8bf65a20716ceb2 Mon Sep 17 00:00:00 2001 From: Alex Root Junior Date: Mon, 14 Sep 2020 22:56:11 +0300 Subject: [PATCH] Update docs --- aiogram/contrib/fsm_storage/mongo.py | 4 +- aiogram/contrib/fsm_storage/rethinkdb.py | 5 ++- dev_requirements.txt | 1 + docs/source/dispatcher/filters.rst | 50 +++++++++++----------- docs/source/dispatcher/fsm.rst | 20 +++++++-- docs/source/examples/throtling_example.rst | 4 +- docs/source/examples/webhook_example_2.rst | 8 ++-- docs/source/utils/index.rst | 1 + 8 files changed, 55 insertions(+), 38 deletions(-) diff --git a/aiogram/contrib/fsm_storage/mongo.py b/aiogram/contrib/fsm_storage/mongo.py index a7601cc4..f810a3eb 100644 --- a/aiogram/contrib/fsm_storage/mongo.py +++ b/aiogram/contrib/fsm_storage/mongo.py @@ -5,9 +5,9 @@ This module has mongo storage for finite-state machine from typing import Union, Dict, Optional, List, Tuple, AnyStr -import pymongo try: + import pymongo import motor from motor.motor_asyncio import AsyncIOMotorClient, AsyncIOMotorDatabase except ModuleNotFoundError as e: @@ -26,6 +26,7 @@ COLLECTIONS = (STATE, DATA, BUCKET) class MongoStorage(BaseStorage): """ Mongo-based storage for FSM. + Usage: .. code-block:: python3 @@ -39,7 +40,6 @@ class MongoStorage(BaseStorage): await dp.storage.close() await dp.storage.wait_closed() - """ def __init__(self, host='localhost', port=27017, db_name='aiogram_fsm', uri=None, diff --git a/aiogram/contrib/fsm_storage/rethinkdb.py b/aiogram/contrib/fsm_storage/rethinkdb.py index a9d822d5..b19327ca 100644 --- a/aiogram/contrib/fsm_storage/rethinkdb.py +++ b/aiogram/contrib/fsm_storage/rethinkdb.py @@ -19,16 +19,17 @@ class RethinkDBStorage(BaseStorage): Usage: - ..code-block:: python3 + .. code-block:: python3 storage = RethinkDBStorage(db='aiogram', table='aiogram', user='aiogram', password='aiogram_secret') dispatcher = Dispatcher(bot, storage=storage) And need to close connection when shutdown - ..code-clock:: python3 + .. code-block:: python3 await storage.close() + await storage.wait_closed() """ diff --git a/dev_requirements.txt b/dev_requirements.txt index c0c2a39d..0252e7e1 100644 --- a/dev_requirements.txt +++ b/dev_requirements.txt @@ -16,3 +16,4 @@ sphinxcontrib-programoutput>=0.14 aiohttp-socks>=0.3.4 rethinkdb>=2.4.1 coverage==4.5.3 +motor>=2.2.0 diff --git a/docs/source/dispatcher/filters.rst b/docs/source/dispatcher/filters.rst index f53a4c95..b8f4962e 100644 --- a/docs/source/dispatcher/filters.rst +++ b/docs/source/dispatcher/filters.rst @@ -10,7 +10,7 @@ Filter factory greatly simplifies the reuse of filters when registering handlers Filters factory =============== -.. autoclass:: aiogram.dispatcher.filters.factory.FiltersFactory +.. autoclass:: aiogram.dispatcher.filters.FiltersFactory :members: :show-inheritance: @@ -21,28 +21,28 @@ Builtin filters Command ------- -.. autoclass:: aiogram.dispatcher.filters.builtin.Command +.. autoclass:: aiogram.dispatcher.filters.Command :members: :show-inheritance: CommandStart ------------ -.. autoclass:: aiogram.dispatcher.filters.builtin.CommandStart +.. autoclass:: aiogram.dispatcher.filters.CommandStart :members: :show-inheritance: CommandHelp ----------- -.. autoclass:: aiogram.dispatcher.filters.builtin.CommandHelp +.. autoclass:: aiogram.dispatcher.filters.CommandHelp :members: :show-inheritance: CommandSettings --------------- -.. autoclass:: aiogram.dispatcher.filters.builtin.CommandSettings +.. autoclass:: aiogram.dispatcher.filters.CommandSettings :members: :show-inheritance: @@ -50,7 +50,7 @@ CommandSettings CommandPrivacy -------------- -.. autoclass:: aiogram.dispatcher.filters.builtin.CommandPrivacy +.. autoclass:: aiogram.dispatcher.filters.CommandPrivacy :members: :show-inheritance: @@ -58,7 +58,7 @@ CommandPrivacy Text ---- -.. autoclass:: aiogram.dispatcher.filters.builtin.Text +.. autoclass:: aiogram.dispatcher.filters.Text :members: :show-inheritance: @@ -66,7 +66,7 @@ Text HashTag ------- -.. autoclass:: aiogram.dispatcher.filters.builtin.HashTag +.. autoclass:: aiogram.dispatcher.filters.HashTag :members: :show-inheritance: @@ -74,7 +74,7 @@ HashTag Regexp ------ -.. autoclass:: aiogram.dispatcher.filters.builtin.Regexp +.. autoclass:: aiogram.dispatcher.filters.Regexp :members: :show-inheritance: @@ -82,7 +82,7 @@ Regexp RegexpCommandsFilter -------------------- -.. autoclass:: aiogram.dispatcher.filters.builtin.RegexpCommandsFilter +.. autoclass:: aiogram.dispatcher.filters.RegexpCommandsFilter :members: :show-inheritance: @@ -90,21 +90,21 @@ RegexpCommandsFilter ContentTypeFilter ----------------- -.. autoclass:: aiogram.dispatcher.filters.builtin.ContentTypeFilter +.. autoclass:: aiogram.dispatcher.filters.ContentTypeFilter :members: :show-inheritance: IsSenderContact --------------- -.. autoclass:: aiogram.dispatcher.filters.builtin.IsSenderContact +.. autoclass:: aiogram.dispatcher.filters.IsSenderContact :members: :show-inheritance: StateFilter ----------- -.. autoclass:: aiogram.dispatcher.filters.builtin.StateFilter +.. autoclass:: aiogram.dispatcher.filters.StateFilter :members: :show-inheritance: @@ -112,13 +112,13 @@ StateFilter ExceptionsFilter ---------------- -.. autoclass:: aiogram.dispatcher.filters.builtin.ExceptionsFilter +.. autoclass:: aiogram.dispatcher.filters.ExceptionsFilter :members: :show-inheritance: IDFilter ----------------- +-------- .. autoclass:: aiogram.dispatcher.filters.builtin.IDFilter :members: @@ -126,9 +126,9 @@ IDFilter AdminFilter ----------------- +----------- -.. autoclass:: aiogram.dispatcher.filters.builtin.AdminFilter +.. autoclass:: aiogram.dispatcher.filters.AdminFilter :members: :show-inheritance: @@ -136,23 +136,23 @@ AdminFilter IsReplyFilter ------------- -.. autoclass:: aiogram.dispatcher.filters.filters.IsReplyFilter +.. autoclass:: aiogram.dispatcher.filters.IsReplyFilter :members: :show-inheritance: ForwardedMessageFilter -------------- +---------------------- -.. autoclass:: aiogram.dispatcher.filters.filters.ForwardedMessageFilter +.. autoclass:: aiogram.dispatcher.filters.ForwardedMessageFilter :members: :show-inheritance: ChatTypeFilter -------------- +-------------- -.. autoclass:: aiogram.dispatcher.filters.filters.ChatTypeFilter +.. autoclass:: aiogram.dispatcher.filters.ChatTypeFilter :members: :show-inheritance: @@ -170,19 +170,19 @@ Own filter can be: AbstractFilter -------------- -.. autoclass:: aiogram.dispatcher.filters.filters.AbstractFilter +.. autoclass:: aiogram.dispatcher.filters.AbstractFilter :members: :show-inheritance: Filter ------ -.. autoclass:: aiogram.dispatcher.filters.filters.Filter +.. autoclass:: aiogram.dispatcher.filters.Filter :members: :show-inheritance: BoundFilter ----------- -.. autoclass:: aiogram.dispatcher.filters.filters.BoundFilter +.. autoclass:: aiogram.dispatcher.filters.BoundFilter :members: :show-inheritance: diff --git a/docs/source/dispatcher/fsm.rst b/docs/source/dispatcher/fsm.rst index 93c94aa6..1b00e81e 100644 --- a/docs/source/dispatcher/fsm.rst +++ b/docs/source/dispatcher/fsm.rst @@ -12,15 +12,29 @@ Coming soon... Memory storage ~~~~~~~~~~~~~~ -Coming soon... + +.. autoclass:: aiogram.contrib.fsm_storage.memory.MemoryStorage + :show-inheritance: Redis storage ~~~~~~~~~~~~~ -Coming soon... + +.. autoclass:: aiogram.contrib.fsm_storage.redis.RedisStorage + :show-inheritance: + +Mongo storage +~~~~~~~~~~~~~ + +.. autoclass:: aiogram.contrib.fsm_storage.mongo.MongoStorage + :show-inheritance: + Rethink DB storage ~~~~~~~~~~~~~~~~~~ -Coming soon... + +.. autoclass:: aiogram.contrib.fsm_storage.rethinkdb.RethinkDBStorage + :show-inheritance: + Making own storage's ~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/source/examples/throtling_example.rst b/docs/source/examples/throtling_example.rst index eaeb337e..f64eaccc 100644 --- a/docs/source/examples/throtling_example.rst +++ b/docs/source/examples/throtling_example.rst @@ -7,8 +7,8 @@ Throtling example Example for throttling manager. You can use that for flood controlling. -.. literalinclude:: ../../../examples/throtling_example.py - :caption: throtling_example.py +.. literalinclude:: ../../../examples/throttling_example.py + :caption: throttling_example.py :language: python :linenos: :lines: 7- diff --git a/docs/source/examples/webhook_example_2.rst b/docs/source/examples/webhook_example_2.rst index 2ffdfed9..025264e4 100644 --- a/docs/source/examples/webhook_example_2.rst +++ b/docs/source/examples/webhook_example_2.rst @@ -1,10 +1,10 @@ .. Autogenerated file at 2018-09-08 02:07:37.576034 -================= -Webhook example 2 -================= +=================== +Webhook example old +=================== -.. literalinclude:: ../../../examples/webhook_example_2.py +.. literalinclude:: ../../../examples/webhook_example_old.py :caption: webhook_example_2.py :language: python :linenos: diff --git a/docs/source/utils/index.rst b/docs/source/utils/index.rst index 1ac3777c..4865518e 100644 --- a/docs/source/utils/index.rst +++ b/docs/source/utils/index.rst @@ -13,3 +13,4 @@ Utils parts json emoji + deep_linking