Small documentation improvements and texts update

This commit is contained in:
Alex Root Junior 2023-08-26 23:18:20 +03:00
parent 806f8f67d5
commit ca4c1b4b95
No known key found for this signature in database
GPG key ID: 074C1D455EBEA4AC
41 changed files with 2160 additions and 1167 deletions

View file

@ -6,8 +6,8 @@ Dispatcher is root :obj:`Router` and in code Dispatcher can be used directly for
Here is only listed base information about Dispatcher. All about writing handlers, filters and etc. you can found in next pages:
- `Router <router.html>`__
- `Observer <observer.html>`__
- :ref:`Router <Router>`
- :ref:`Filtering events`
.. autoclass:: aiogram.dispatcher.dispatcher.Dispatcher

View file

@ -1,4 +1,4 @@
.. _callback-data-factory
.. _Callback data factory:
==============================
Callback Data Factory & Filter

View file

@ -2,6 +2,27 @@
ChatMemberUpdated
=================
Usage
=====
Handle user leave or join events
.. code-block:: python
from aiogram.filters import IS_MEMBER, IS_NOT_MEMBER
@router.chat_member(ChatMemberUpdatedFilter(IS_MEMBER >> IS_NOT_MEMBER))
async def on_user_leave(event: ChatMemberUpdated): ...
@router.chat_member(ChatMemberUpdatedFilter(IS_NOT_MEMBER >> IS_MEMBER))
async def on_user_join(event: ChatMemberUpdated): ...
Or construct your own terms via using pre-defined set of statuses and transitions.
Explanation
===========
.. autoclass:: aiogram.filters.chat_member_updated.ChatMemberUpdatedFilter
:members:
:member-order: bysource
@ -77,22 +98,6 @@ will produce swap of old and new statuses.
Note that if you define the status unions (via :code:`|`) you will need to add brackets for the statement
before use shift operator in due to operator priorities.
Usage
=====
Handle user leave or join events
.. code-block:: python
from aiogram.filters import IS_MEMBER, IS_NOT_MEMBER
@router.chat_member(ChatMemberUpdatedFilter(IS_MEMBER >> IS_NOT_MEMBER))
async def on_user_leave(event: ChatMemberUpdated): ...
@router.chat_member(ChatMemberUpdatedFilter(IS_NOT_MEMBER >> IS_MEMBER))
async def on_user_join(event: ChatMemberUpdated): ...
Or construct your own terms via using pre-defined set of statuses and transitions.
Allowed handlers
================

View file

@ -2,19 +2,6 @@
Command
=======
.. autoclass:: aiogram.filters.command.Command
:members: __init__
:member-order: bysource
:undoc-members: False
When filter is passed the :class:`aiogram.filters.command.CommandObject` will be passed to the handler argument :code:`command`
.. autoclass:: aiogram.filters.command.CommandObject
:members:
:member-order: bysource
:undoc-members: False
Usage
=====
@ -28,6 +15,19 @@ Usage
Command cannot include spaces or any whitespace
.. autoclass:: aiogram.filters.command.Command
:members: __init__
:member-order: bysource
:undoc-members: False
When filter is passed the :class:`aiogram.filters.command.CommandObject` will be passed to the handler argument :code:`command`
.. autoclass:: aiogram.filters.command.CommandObject
:members:
:member-order: bysource
:undoc-members: False
Allowed handlers
================

View file

@ -1,3 +1,5 @@
.. _Filtering events:
================
Filtering events
================

View file

@ -2,6 +2,14 @@
MagicData
=========
Usage
=====
#. :code:`MagicData(F.event.from_user.id == F.config.admin_id)` (Note that :code:`config` should be passed from middleware)
Explanation
===========
.. autoclass:: aiogram.filters.magic_data.MagicData
:members:
:member-order: bysource
@ -11,11 +19,6 @@ Can be imported:
- :code:`from aiogram.filters import MagicData`
Usage
=====
#. :code:`MagicData(F.event.from_user.id == F.config.admin_id)` (Note that :code:`config` should be passed from middleware)
Allowed handlers
================

View file

@ -1,3 +1,5 @@
.. _Finite State Machine:
====================
Finite State Machine
====================

View file

@ -26,12 +26,12 @@ So, you can use both of them with *aiogram*.
router
dispatcher
class_based_handlers/index
dependency_injection
filters/index
middlewares
finite_state_machine/index
flags
errors
long_polling
webhook
dependency_injection
finite_state_machine/index
middlewares
errors
flags
class_based_handlers/index

View file

@ -1,7 +1,23 @@
.. _Router:
######
Router
######
Usage:
.. code-block:: python
from aiogram import Router
from aiogram.types import Message
my_router = Router(name=__name__)
@my_router.message()
async def message_handler(message: Message) -> Any:
await message.answer('Hello from my router!')
.. autoclass:: aiogram.dispatcher.router.Router
:members: __init__, include_router, include_routers, resolve_used_update_types
:show-inheritance: