From 6d979ad61e5d26233d6a39d02863a8d9370805d7 Mon Sep 17 00:00:00 2001 From: Egor Date: Sun, 14 Jun 2020 17:16:24 +0500 Subject: [PATCH] feat: docs --- aiogram/dispatcher/dispatcher.py | 4 ++-- aiogram/dispatcher/filters/__init__.py | 9 ++++++--- aiogram/dispatcher/filters/builtin.py | 2 +- docs/source/dispatcher/filters.rst | 8 ++++++++ 4 files changed, 17 insertions(+), 6 deletions(-) diff --git a/aiogram/dispatcher/dispatcher.py b/aiogram/dispatcher/dispatcher.py index 322a0696..53eda83b 100644 --- a/aiogram/dispatcher/dispatcher.py +++ b/aiogram/dispatcher/dispatcher.py @@ -9,7 +9,7 @@ import aiohttp from aiohttp.helpers import sentinel from aiogram.utils.deprecated import renamed_argument -from .filters import Command, ContentTypeFilter, ExceptionsFilter, FiltersFactory, HashTag, Regexp, \ +from .filters import Command, ContentTypesFilter, ExceptionsFilter, FiltersFactory, HashTag, Regexp, \ RegexpCommandsFilter, StateFilter, Text, IDFilter, AdminFilter, IsReplyFilter, ForwardedMessageFilter from .filters.builtin import IsSenderContact, ChatTypesFilter from .handler import Handler @@ -91,7 +91,7 @@ class Dispatcher(DataMixin, ContextInstanceMixin): self.poll_handlers, self.poll_answer_handlers, ]) - filters_factory.bind(ContentTypeFilter, event_handlers=[ + filters_factory.bind(ContentTypesFilter, event_handlers=[ self.message_handlers, self.edited_message_handlers, self.channel_post_handlers, diff --git a/aiogram/dispatcher/filters/__init__.py b/aiogram/dispatcher/filters/__init__.py index edd1959a..9d27bfbd 100644 --- a/aiogram/dispatcher/filters/__init__.py +++ b/aiogram/dispatcher/filters/__init__.py @@ -1,6 +1,7 @@ -from .builtin import Command, CommandHelp, CommandPrivacy, CommandSettings, CommandStart, ContentTypeFilter, \ +from .builtin import Command, CommandHelp, CommandPrivacy, CommandSettings, CommandStart, ContentTypesFilter, \ ExceptionsFilter, HashTag, Regexp, RegexpCommandsFilter, StateFilter, \ - Text, IDFilter, AdminFilter, IsReplyFilter, IsSenderContact, ForwardedMessageFilter + Text, IDFilter, AdminFilter, IsReplyFilter, IsSenderContact, ForwardedMessageFilter, \ + ContentTypesFilter from .factory import FiltersFactory from .filters import AbstractFilter, BoundFilter, Filter, FilterNotPassed, FilterRecord, execute_filter, \ check_filters, get_filter_spec, get_filters_spec @@ -13,7 +14,7 @@ __all__ = [ 'CommandHelp', 'CommandPrivacy', 'CommandSettings', - 'ContentTypeFilter', + 'ContentTypesFilter', 'ExceptionsFilter', 'HashTag', 'Filter', @@ -33,4 +34,6 @@ __all__ = [ 'execute_filter', 'check_filters', 'ForwardedMessageFilter', + 'ContentTypesFilter', + ] diff --git a/aiogram/dispatcher/filters/builtin.py b/aiogram/dispatcher/filters/builtin.py index 97e8739f..1e487eda 100644 --- a/aiogram/dispatcher/filters/builtin.py +++ b/aiogram/dispatcher/filters/builtin.py @@ -447,7 +447,7 @@ class RegexpCommandsFilter(BoundFilter): return False -class ContentTypeFilter(BoundFilter): +class ContentTypesFilter(BoundFilter): """ Check message content type """ diff --git a/docs/source/dispatcher/filters.rst b/docs/source/dispatcher/filters.rst index 3681dfcb..c94d4eb0 100644 --- a/docs/source/dispatcher/filters.rst +++ b/docs/source/dispatcher/filters.rst @@ -149,6 +149,14 @@ ForwardedMessageFilter :show-inheritance: +ChatTypesFilter +------------- + +.. autoclass:: aiogram.dispatcher.filters.filters.ChatTypesFilter + :members: + :show-inheritance: + + Making own filters (Custom filters) ===================================