python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2026-04-08 16:37:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Update docs

Browse source
This commit is contained in:
Alex Root Junior 2020-09-14 22:56:11 +03:00
parent 7c65344dcd
commit 7b33e5c68a
8 changed files with 55 additions and 38 deletions
Download patch file Download diff file Expand all files Collapse all files

4
aiogram/contrib/fsm_storage/mongo.py
View file

@ -5,9 +5,9 @@ This module has mongo storage for finite-state machine
from typing import Union, Dict, Optional, List, Tuple, AnyStr from typing import Union, Dict, Optional, List, Tuple, AnyStr
import pymongo
try: try:
import pymongo
import motor import motor
from motor.motor_asyncio import AsyncIOMotorClient, AsyncIOMotorDatabase from motor.motor_asyncio import AsyncIOMotorClient, AsyncIOMotorDatabase
except ModuleNotFoundError as e: except ModuleNotFoundError as e:
@ -26,6 +26,7 @@ COLLECTIONS = (STATE, DATA, BUCKET)
class MongoStorage(BaseStorage): class MongoStorage(BaseStorage):
""" """
Mongo-based storage for FSM. Mongo-based storage for FSM.
Usage: Usage:
.. code-block:: python3 .. code-block:: python3
@ -39,7 +40,6 @@ class MongoStorage(BaseStorage):
await dp.storage.close() await dp.storage.close()
await dp.storage.wait_closed() await dp.storage.wait_closed()
""" """
def __init__(self, host='localhost', port=27017, db_name='aiogram_fsm', uri=None, def __init__(self, host='localhost', port=27017, db_name='aiogram_fsm', uri=None,

5
aiogram/contrib/fsm_storage/rethinkdb.py
View file

@ -19,16 +19,17 @@ class RethinkDBStorage(BaseStorage):
Usage: Usage:
..code-block:: python3 .. code-block:: python3
storage = RethinkDBStorage(db='aiogram', table='aiogram', user='aiogram', password='aiogram_secret') storage = RethinkDBStorage(db='aiogram', table='aiogram', user='aiogram', password='aiogram_secret')
dispatcher = Dispatcher(bot, storage=storage) dispatcher = Dispatcher(bot, storage=storage)
And need to close connection when shutdown And need to close connection when shutdown
..code-clock:: python3 .. code-block:: python3
await storage.close() await storage.close()
await storage.wait_closed()
""" """

1
dev_requirements.txt
View file

@ -16,3 +16,4 @@ sphinxcontrib-programoutput>=0.14
aiohttp-socks>=0.3.4 aiohttp-socks>=0.3.4
rethinkdb>=2.4.1 rethinkdb>=2.4.1
coverage==4.5.3 coverage==4.5.3
motor>=2.2.0

50
docs/source/dispatcher/filters.rst
View file

@ -10,7 +10,7 @@ Filter factory greatly simplifies the reuse of filters when registering handlers
Filters factory Filters factory
=============== ===============
.. autoclass:: aiogram.dispatcher.filters.factory.FiltersFactory .. autoclass:: aiogram.dispatcher.filters.FiltersFactory
:members: :members:
:show-inheritance: :show-inheritance:
@ -21,28 +21,28 @@ Builtin filters
Command Command
------- -------
.. autoclass:: aiogram.dispatcher.filters.builtin.Command .. autoclass:: aiogram.dispatcher.filters.Command
:members: :members:
:show-inheritance: :show-inheritance:
CommandStart CommandStart
------------ ------------
.. autoclass:: aiogram.dispatcher.filters.builtin.CommandStart .. autoclass:: aiogram.dispatcher.filters.CommandStart
:members: :members:
:show-inheritance: :show-inheritance:
CommandHelp CommandHelp
----------- -----------
.. autoclass:: aiogram.dispatcher.filters.builtin.CommandHelp .. autoclass:: aiogram.dispatcher.filters.CommandHelp
:members: :members:
:show-inheritance: :show-inheritance:
CommandSettings CommandSettings
--------------- ---------------
.. autoclass:: aiogram.dispatcher.filters.builtin.CommandSettings .. autoclass:: aiogram.dispatcher.filters.CommandSettings
:members: :members:
:show-inheritance: :show-inheritance:
@ -50,7 +50,7 @@ CommandSettings
CommandPrivacy CommandPrivacy
-------------- --------------
.. autoclass:: aiogram.dispatcher.filters.builtin.CommandPrivacy .. autoclass:: aiogram.dispatcher.filters.CommandPrivacy
:members: :members:
:show-inheritance: :show-inheritance:
@ -58,7 +58,7 @@ CommandPrivacy
Text Text
---- ----
.. autoclass:: aiogram.dispatcher.filters.builtin.Text .. autoclass:: aiogram.dispatcher.filters.Text
:members: :members:
:show-inheritance: :show-inheritance:
@ -66,7 +66,7 @@ Text
HashTag HashTag
------- -------
.. autoclass:: aiogram.dispatcher.filters.builtin.HashTag .. autoclass:: aiogram.dispatcher.filters.HashTag
:members: :members:
:show-inheritance: :show-inheritance:
@ -74,7 +74,7 @@ HashTag
Regexp Regexp
------ ------
.. autoclass:: aiogram.dispatcher.filters.builtin.Regexp .. autoclass:: aiogram.dispatcher.filters.Regexp
:members: :members:
:show-inheritance: :show-inheritance:
@ -82,7 +82,7 @@ Regexp
RegexpCommandsFilter RegexpCommandsFilter
-------------------- --------------------
.. autoclass:: aiogram.dispatcher.filters.builtin.RegexpCommandsFilter .. autoclass:: aiogram.dispatcher.filters.RegexpCommandsFilter
:members: :members:
:show-inheritance: :show-inheritance:
@ -90,21 +90,21 @@ RegexpCommandsFilter
ContentTypeFilter ContentTypeFilter
----------------- -----------------
.. autoclass:: aiogram.dispatcher.filters.builtin.ContentTypeFilter .. autoclass:: aiogram.dispatcher.filters.ContentTypeFilter
:members: :members:
:show-inheritance: :show-inheritance:
IsSenderContact IsSenderContact
--------------- ---------------
.. autoclass:: aiogram.dispatcher.filters.builtin.IsSenderContact .. autoclass:: aiogram.dispatcher.filters.IsSenderContact
:members: :members:
:show-inheritance: :show-inheritance:
StateFilter StateFilter
----------- -----------
.. autoclass:: aiogram.dispatcher.filters.builtin.StateFilter .. autoclass:: aiogram.dispatcher.filters.StateFilter
:members: :members:
:show-inheritance: :show-inheritance:
@ -112,13 +112,13 @@ StateFilter
ExceptionsFilter ExceptionsFilter
---------------- ----------------
.. autoclass:: aiogram.dispatcher.filters.builtin.ExceptionsFilter .. autoclass:: aiogram.dispatcher.filters.ExceptionsFilter
:members: :members:
:show-inheritance: :show-inheritance:
IDFilter IDFilter
---------------- --------
.. autoclass:: aiogram.dispatcher.filters.builtin.IDFilter .. autoclass:: aiogram.dispatcher.filters.builtin.IDFilter
:members: :members:
@ -126,9 +126,9 @@ IDFilter
AdminFilter AdminFilter
---------------- -----------
.. autoclass:: aiogram.dispatcher.filters.builtin.AdminFilter .. autoclass:: aiogram.dispatcher.filters.AdminFilter
:members: :members:
:show-inheritance: :show-inheritance:
@ -136,23 +136,23 @@ AdminFilter
IsReplyFilter IsReplyFilter
------------- -------------
.. autoclass:: aiogram.dispatcher.filters.filters.IsReplyFilter .. autoclass:: aiogram.dispatcher.filters.IsReplyFilter
:members: :members:
:show-inheritance: :show-inheritance:
ForwardedMessageFilter ForwardedMessageFilter
------------- ----------------------
.. autoclass:: aiogram.dispatcher.filters.filters.ForwardedMessageFilter .. autoclass:: aiogram.dispatcher.filters.ForwardedMessageFilter
:members: :members:
:show-inheritance: :show-inheritance:
ChatTypeFilter ChatTypeFilter
------------- --------------
.. autoclass:: aiogram.dispatcher.filters.filters.ChatTypeFilter .. autoclass:: aiogram.dispatcher.filters.ChatTypeFilter
:members: :members:
:show-inheritance: :show-inheritance:
@ -170,19 +170,19 @@ Own filter can be:
AbstractFilter AbstractFilter
-------------- --------------
.. autoclass:: aiogram.dispatcher.filters.filters.AbstractFilter .. autoclass:: aiogram.dispatcher.filters.AbstractFilter
:members: :members:
:show-inheritance: :show-inheritance:
Filter Filter
------ ------
.. autoclass:: aiogram.dispatcher.filters.filters.Filter .. autoclass:: aiogram.dispatcher.filters.Filter
:members: :members:
:show-inheritance: :show-inheritance:
BoundFilter BoundFilter
----------- -----------
.. autoclass:: aiogram.dispatcher.filters.filters.BoundFilter .. autoclass:: aiogram.dispatcher.filters.BoundFilter
:members: :members:
:show-inheritance: :show-inheritance:

20
docs/source/dispatcher/fsm.rst
View file

@ -12,15 +12,29 @@ Coming soon...
Memory storage Memory storage
~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~
Coming soon...
.. autoclass:: aiogram.contrib.fsm_storage.memory.MemoryStorage
:show-inheritance:
Redis storage 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 Rethink DB storage
~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~
Coming soon...
.. autoclass:: aiogram.contrib.fsm_storage.rethinkdb.RethinkDBStorage
:show-inheritance:
Making own storage's Making own storage's
~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~

4
docs/source/examples/throtling_example.rst
View file

@ -7,8 +7,8 @@ Throtling example
Example for throttling manager. Example for throttling manager.
You can use that for flood controlling. You can use that for flood controlling.
.. literalinclude:: ../../../examples/throtling_example.py .. literalinclude:: ../../../examples/throttling_example.py
:caption: throtling_example.py :caption: throttling_example.py
:language: python :language: python
:linenos: :linenos:
:lines: 7- :lines: 7-

8
docs/source/examples/webhook_example_2.rst
View file

@ -1,10 +1,10 @@
.. Autogenerated file at 2018-09-08 02:07:37.576034 .. 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 :caption: webhook_example_2.py
:language: python :language: python
:linenos: :linenos:

1
docs/source/utils/index.rst
View file

@ -13,3 +13,4 @@ Utils
parts parts
json json
emoji emoji
deep_linking