Dev 3.x flat package (#961)

* Move packages

* Added changelog

* Update examples/echo_bot.py

Co-authored-by: Oleg A. <t0rr@mail.ru>

* Rename `handler` -> `handlers`

* Update __init__.py

Co-authored-by: Oleg A. <t0rr@mail.ru>
This commit is contained in:
Alex Root Junior 2022-08-14 01:07:52 +03:00 committed by GitHub
parent 5e7932ca20
commit 4315ecf1a2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
111 changed files with 376 additions and 390 deletions

View file

@ -39,8 +39,9 @@ rst_prolog = f"""
:language: python3
"""
language = None
locale_dirs = ["locales"]
# language = None
locale_dirs = ["locale/"]
gettext_compact = False
exclude_patterns = []
source_suffix = ".rst"

View file

@ -3,7 +3,7 @@ CallbackQueryHandler
####################
.. automodule:: aiogram.dispatcher.handler.callback_query
.. automodule:: aiogram.handler.callback_query
:members:
:member-order: bysource
:undoc-members: True

View file

@ -2,7 +2,7 @@
Callback Data Factory & Filter
==============================
.. autoclass:: aiogram.dispatcher.filters.callback_data.CallbackData
.. autoclass:: aiogram.filters.callback_data.CallbackData
:members:
:member-order: bysource
:undoc-members: False

View file

@ -2,12 +2,12 @@
ChatMemberUpdated
=================
.. autoclass:: aiogram.dispatcher.filters.chat_member_updated.ChatMemberUpdatedFilter
.. autoclass:: aiogram.filters.chat_member_updated.ChatMemberUpdatedFilter
:members:
:member-order: bysource
:undoc-members: False
You can import from :code:`aiogram.dispatcher.filters` all available
You can import from :code:`aiogram.filters` all available
variants of `statuses`_, `status groups`_ or `transitions`_:
Statuses
@ -84,7 +84,7 @@ Handle user leave or join events
.. code-block:: python
from aiogram.dispatcher.filters import IS_MEMBER, IS_NOT_MEMBER
from aiogram.filters import IS_MEMBER, IS_NOT_MEMBER
@router.chat_member(member_status_changed=IS_MEMBER >> IS_NOT_MEMBER)
async def on_user_leave(event: ChatMemberUpdated): ...

View file

@ -2,14 +2,14 @@
Command
=======
.. autoclass:: aiogram.dispatcher.filters.command.Command
.. autoclass:: aiogram.filters.command.Command
:members:
:member-order: bysource
:undoc-members: False
When filter is passed the :class:`aiogram.dispatcher.filters.command.CommandObject` will be passed to the handler argument :code:`command`
When filter is passed the :class:`aiogram.filters.command.CommandObject` will be passed to the handler argument :code:`command`
.. autoclass:: aiogram.dispatcher.filters.command.CommandObject
.. autoclass:: aiogram.filters.command.CommandObject
:members:
:member-order: bysource
:undoc-members: False

View file

@ -2,15 +2,14 @@
ContentTypesFilter
==================
.. autoclass:: aiogram.dispatcher.filters.content_types.ContentTypesFilter
.. autoclass:: aiogram.filters.content_types.ContentTypesFilter
:members:
:member-order: bysource
:undoc-members: False
Can be imported:
- :code:`from aiogram.dispatcher.filters.content_types import ContentTypesFilter`
- :code:`from aiogram.dispatcher.filters import ContentTypesFilter`
- :code:`from aiogram.filters.content_types import ContentTypesFilter`
- :code:`from aiogram.filters import ContentTypesFilter`
Or used from filters factory by passing corresponding arguments to handler registration line

View file

@ -4,12 +4,12 @@ Exceptions
This filters can be helpful for handling errors from the text messages.
.. autoclass:: aiogram.dispatcher.filters.exception.ExceptionTypeFilter
.. autoclass:: aiogram.filters.exception.ExceptionTypeFilter
:members:
:member-order: bysource
:undoc-members: False
.. autoclass:: aiogram.dispatcher.filters.exception.ExceptionMessageFilter
.. autoclass:: aiogram.filters.exception.ExceptionMessageFilter
:members:
:member-order: bysource
:undoc-members: False

View file

@ -37,7 +37,7 @@ Filters can be:
- Any awaitable object
- Subclass of :class:`aiogram.dispatcher.filters.base.BaseFilter`
- Subclass of :class:`aiogram.filters.base.BaseFilter`
- Instances of :ref:`MagicFilter <magic-filters>`
@ -48,7 +48,7 @@ filters and handler as keywords arguments.
Writing bound filters
=====================
.. autoclass:: aiogram.dispatcher.filters.base.BaseFilter
.. autoclass:: aiogram.filters.base.BaseFilter
:members: __call__
:member-order: bysource
:undoc-members: False
@ -57,7 +57,7 @@ For example if you need to make simple text filter:
.. code-block:: python
from aiogram.dispatcher.filters import BaseFilter
from aiogram.filters import BaseFilter
class MyText(BaseFilter):

View file

@ -2,15 +2,14 @@
MagicData
====
.. autoclass:: aiogram.dispatcher.filters.magic_data.MagicData
.. autoclass:: aiogram.filters.magic_data.MagicData
:members:
:member-order: bysource
:undoc-members: False
Can be imported:
- :code:`from aiogram.dispatcher.filters.magic_data import MagicData`
- :code:`from aiogram.dispatcher.filters import MagicData`
- :code:`from aiogram.filters.magic_data import MagicData`
- :code:`from aiogram.filters import MagicData`
Or used from filters factory by passing corresponding arguments to handler registration line

View file

@ -2,16 +2,16 @@
Text
====
.. autoclass:: aiogram.dispatcher.filters.text.Text
.. autoclass:: aiogram.filters.text.Text
:members:
:member-order: bysource
:undoc-members: False
Can be imported:
- :code:`from aiogram.dispatcher.filters.text import Text`
- :code:`from aiogram.dispatcher.filters import Text`
- :code:`from aiogram.filters.text import Text`
- :code:`from aiogram.filters import Text`
- :code:`from.filters import Text`
Or used from filters factory by passing corresponding arguments to handler registration line

View file

@ -8,24 +8,24 @@ Storages out of the box
MemoryStorage
-------------
.. autoclass:: aiogram.dispatcher.fsm.storage.memory.MemoryStorage
.. autoclass:: aiogram.fsm.storage.memory.MemoryStorage
:members: __init__
:member-order: bysource
RedisStorage
------------
.. autoclass:: aiogram.dispatcher.fsm.storage.redis.RedisStorage
.. autoclass:: aiogram.fsm.storage.redis.RedisStorage
:members: __init__, from_url
:member-order: bysource
Keys inside storage can be customized via key builders:
.. autoclass:: aiogram.dispatcher.fsm.storage.redis.KeyBuilder
.. autoclass:: aiogram.fsm.storage.redis.KeyBuilder
:members:
:member-order: bysource
.. autoclass:: aiogram.dispatcher.fsm.storage.redis.DefaultKeyBuilder
.. autoclass:: aiogram.fsm.storage.redis.DefaultKeyBuilder
:members:
:member-order: bysource
@ -33,6 +33,6 @@ Keys inside storage can be customized via key builders:
Writing own storages
====================
.. autoclass:: aiogram.dispatcher.fsm.storage.base.BaseStorage
.. autoclass:: aiogram.fsm.storage.base.BaseStorage
:members:
:member-order: bysource

View file

@ -54,7 +54,7 @@ Via filters
Use in middlewares
==================
.. automodule:: aiogram.dispatcher.flags.getter
.. automodule:: aiogram.flags.getter
:members:
Example in middlewares

View file

@ -45,7 +45,7 @@ Message
(For example text, sticker and document are always of different content types of message)
Recommended way to check field availability before usage or use
:class:`aiogram.dispatcher.filters.content_types.ContentTypesFilter`
:class:`aiogram.filters.content_types.ContentTypesFilter`
.. code-block:: python