mirror of
https://github.com/LonamiWebs/Telethon.git
synced 2024-11-15 22:16:37 +03:00
76 lines
2.7 KiB
ReStructuredText
76 lines
2.7 KiB
ReStructuredText
Updates
|
|
=======
|
|
|
|
.. currentmodule:: telethon
|
|
|
|
Updates are an important topic in a messaging platform like Telegram.
|
|
After all, you want to be notified as soon as certain events happen, such as new message arrives.
|
|
|
|
Telethon abstracts away Telegram updates with :mod:`~telethon.events`.
|
|
|
|
.. important::
|
|
|
|
It is strongly advised to configure logging when working with events:
|
|
|
|
.. code-block:: python
|
|
|
|
import logging
|
|
logging.basicConfig(
|
|
format='[%(levelname) 5s/%(asctime)s] %(name)s: %(message)s',
|
|
level=logging.WARNING
|
|
)
|
|
|
|
With the above, you will see all warnings and errors and when they happened.
|
|
|
|
|
|
Filtering events
|
|
----------------
|
|
|
|
There is no way to tell Telegram to only send certain updates.
|
|
Telethon must be received and process all updates to ensure correct ordering.
|
|
|
|
Filters are not magic.
|
|
They work all the same as ``if`` conditions inside your event handlers.
|
|
However, they offer a more convenient and consistent way to check for certain conditions.
|
|
|
|
All built-in filters can be found in :mod:`telethon.events.filters`.
|
|
|
|
When registering an event handler, you can optionally define the filter to use.
|
|
You can retrieve a handler's filter with :meth:`~Client.get_handler_filter`.
|
|
You can set (and overwrite) a handler's filter with :meth:`~Client.set_handler_filter`.
|
|
|
|
Filters are meant to be fast and never raise exceptions.
|
|
For this reason, filters cannot be asynchronous.
|
|
This reduces the chance a filter will do slow IO and potentially fail.
|
|
|
|
A filter is simply a callable function that takes an event as input and returns a boolean.
|
|
If the filter returns ``True``, the handler will be called.
|
|
Using this knowledge, you can create custom filters too.
|
|
If you need state, you can use a class with a ``__call__`` method defined:
|
|
|
|
.. code-block:: python
|
|
|
|
def only_odd_messages(event):
|
|
"A filter that only handles messages when their ID is divisible by 2"
|
|
return event.id % 2 == 0
|
|
|
|
client.add_event_handler(handler, events.NewMessage, only_odd_messages)
|
|
|
|
# ...
|
|
|
|
class OnlyDivisibleMessages:
|
|
"A filter that only handles messages when their ID is divisible by some amount"
|
|
def __init__(self, divisible_by):
|
|
self.divisible_by = divisible_by
|
|
|
|
def __call__(self, event):
|
|
return event.id % self.divisible_by == 0
|
|
|
|
client.add_event_handler(handler, events.NewMessage, OnlyDivisibleMessages(7))
|
|
|
|
Custom filters should accept any :class:`~events.Event`.
|
|
You can use :func:`isinstance` if your filter can only deal with certain types of events.
|
|
|
|
If you need to perform asynchronous operations, you can't use a filter.
|
|
Instead, manually check for those conditions inside your handler.
|