mirror of
https://github.com/LonamiWebs/Telethon.git
synced 2024-09-21 11:18:50 +03:00
255 lines
9.5 KiB
Python
255 lines
9.5 KiB
Python
import itertools
|
|
|
|
from async_generator import async_generator, yield_
|
|
|
|
from .users import UserMethods
|
|
from .. import utils, helpers
|
|
from ..tl import types, functions, custom
|
|
|
|
|
|
class DialogMethods(UserMethods):
|
|
|
|
# region Public methods
|
|
|
|
@async_generator
|
|
async def iter_dialogs(
|
|
self, limit=None, *, offset_date=None, offset_id=0,
|
|
offset_peer=types.InputPeerEmpty(), ignore_migrated=False,
|
|
_total=None):
|
|
"""
|
|
Returns an iterator over the dialogs, yielding 'limit' at most.
|
|
Dialogs are the open "chats" or conversations with other people,
|
|
groups you have joined, or channels you are subscribed to.
|
|
|
|
Args:
|
|
limit (`int` | `None`):
|
|
How many dialogs to be retrieved as maximum. Can be set to
|
|
``None`` to retrieve all dialogs. Note that this may take
|
|
whole minutes if you have hundreds of dialogs, as Telegram
|
|
will tell the library to slow down through a
|
|
``FloodWaitError``.
|
|
|
|
offset_date (`datetime`, optional):
|
|
The offset date to be used.
|
|
|
|
offset_id (`int`, optional):
|
|
The message ID to be used as an offset.
|
|
|
|
offset_peer (:tl:`InputPeer`, optional):
|
|
The peer to be used as an offset.
|
|
|
|
ignore_migrated (`bool`, optional):
|
|
Whether :tl:`Chat` that have ``migrated_to`` a :tl:`Channel`
|
|
should be included or not. By default all the chats in your
|
|
dialogs are returned, but setting this to ``True`` will hide
|
|
them in the same way official applications do.
|
|
|
|
_total (`list`, optional):
|
|
A single-item list to pass the total parameter by reference.
|
|
|
|
Yields:
|
|
Instances of `telethon.tl.custom.dialog.Dialog`.
|
|
"""
|
|
limit = float('inf') if limit is None else int(limit)
|
|
if limit == 0:
|
|
if not _total:
|
|
return
|
|
# Special case, get a single dialog and determine count
|
|
dialogs = await self(functions.messages.GetDialogsRequest(
|
|
offset_date=offset_date,
|
|
offset_id=offset_id,
|
|
offset_peer=offset_peer,
|
|
limit=1,
|
|
hash=0
|
|
))
|
|
_total[0] = getattr(dialogs, 'count', len(dialogs.dialogs))
|
|
return
|
|
|
|
seen = set()
|
|
req = functions.messages.GetDialogsRequest(
|
|
offset_date=offset_date,
|
|
offset_id=offset_id,
|
|
offset_peer=offset_peer,
|
|
limit=0,
|
|
hash=0
|
|
)
|
|
while len(seen) < limit:
|
|
req.limit = min(limit - len(seen), 100)
|
|
r = await self(req)
|
|
|
|
if _total:
|
|
_total[0] = getattr(r, 'count', len(r.dialogs))
|
|
|
|
entities = {utils.get_peer_id(x): x
|
|
for x in itertools.chain(r.users, r.chats)}
|
|
|
|
messages = {}
|
|
for m in r.messages:
|
|
m._finish_init(self, entities, None)
|
|
messages[m.id] = m
|
|
|
|
# Happens when there are pinned dialogs
|
|
if len(r.dialogs) > limit:
|
|
r.dialogs = r.dialogs[:limit]
|
|
|
|
for d in r.dialogs:
|
|
if offset_date:
|
|
date = getattr(messages.get(
|
|
d.top_message, None), 'date', None)
|
|
|
|
if not date or date.timestamp() > offset_date.timestamp():
|
|
continue
|
|
|
|
peer_id = utils.get_peer_id(d.peer)
|
|
if peer_id not in seen:
|
|
seen.add(peer_id)
|
|
cd = custom.Dialog(self, d, entities, messages)
|
|
if cd.dialog.pts:
|
|
self._channel_pts[cd.id] = cd.dialog.pts
|
|
|
|
if not ignore_migrated or getattr(
|
|
cd.entity, 'migrated_to', None) is None:
|
|
await yield_(cd)
|
|
|
|
if len(r.dialogs) < req.limit\
|
|
or not isinstance(r, types.messages.DialogsSlice):
|
|
# Less than we requested means we reached the end, or
|
|
# we didn't get a DialogsSlice which means we got all.
|
|
break
|
|
|
|
req.offset_date = r.messages[-1].date
|
|
req.offset_peer = entities[utils.get_peer_id(r.dialogs[-1].peer)]
|
|
if req.offset_id == r.messages[-1].id:
|
|
# In some very rare cases this will get stuck in an infinite
|
|
# loop, where the offsets will get reused over and over. If
|
|
# the new offset is the same as the one before, break already.
|
|
break
|
|
|
|
req.offset_id = r.messages[-1].id
|
|
req.exclude_pinned = True
|
|
|
|
async def get_dialogs(self, *args, **kwargs):
|
|
"""
|
|
Same as `iter_dialogs`, but returns a
|
|
`TotalList <telethon.helpers.TotalList>` instead.
|
|
"""
|
|
total = [0]
|
|
kwargs['_total'] = total
|
|
dialogs = helpers.TotalList()
|
|
async for x in self.iter_dialogs(*args, **kwargs):
|
|
dialogs.append(x)
|
|
dialogs.total = total[0]
|
|
return dialogs
|
|
|
|
@async_generator
|
|
async def iter_drafts(self):
|
|
"""
|
|
Iterator over all open draft messages.
|
|
|
|
Instances of `telethon.tl.custom.draft.Draft` are yielded.
|
|
You can call `telethon.tl.custom.draft.Draft.set_message`
|
|
to change the message or `telethon.tl.custom.draft.Draft.delete`
|
|
among other things.
|
|
"""
|
|
r = await self(functions.messages.GetAllDraftsRequest())
|
|
for update in r.updates:
|
|
await yield_(custom.Draft._from_update(self, update))
|
|
|
|
async def get_drafts(self):
|
|
"""
|
|
Same as :meth:`iter_drafts`, but returns a list instead.
|
|
"""
|
|
result = []
|
|
async for x in self.iter_drafts():
|
|
result.append(x)
|
|
return result
|
|
|
|
def conversation(
|
|
self, entity,
|
|
*, timeout=60, total_timeout=None, max_messages=100,
|
|
exclusive=True, replies_are_responses=True):
|
|
"""
|
|
Creates a `Conversation <telethon.tl.custom.conversation.Conversation>`
|
|
with the given entity so you can easily send messages and await for
|
|
responses or other reactions. Refer to its documentation for more.
|
|
|
|
Args:
|
|
entity (`entity`):
|
|
The entity with which a new conversation should be opened.
|
|
|
|
timeout (`int` | `float`, optional):
|
|
The default timeout *per action* to be used. You may also
|
|
override this timeout on a per-method basis. By default each
|
|
action can take up to 60 seconds (the value of this timeout).
|
|
|
|
total_timeout (`int` | `float`, optional):
|
|
The total timeout to use for the whole conversation. This
|
|
takes priority over per-action timeouts. After these many
|
|
seconds pass, subsequent actions will result in
|
|
``asyncio.TimeoutError``.
|
|
|
|
max_messages (`int`, optional):
|
|
The maximum amount of messages this conversation will
|
|
remember. After these many messages arrive in the
|
|
specified chat, subsequent actions will result in
|
|
``ValueError``.
|
|
|
|
exclusive (`bool`, optional):
|
|
By default, conversations are exclusive within a single
|
|
chat. That means that while a conversation is open in a
|
|
chat, you can't open another one in the same chat, unless
|
|
you disable this flag.
|
|
|
|
If you try opening an exclusive conversation for
|
|
a chat where it's already open, it will raise
|
|
``AlreadyInConversationError``.
|
|
|
|
replies_are_responses (`bool`, optional):
|
|
Whether replies should be treated as responses or not.
|
|
|
|
If the setting is enabled, calls to `conv.get_response
|
|
<telethon.tl.custom.conversation.Conversation.get_response>`
|
|
and a subsequent call to `conv.get_reply
|
|
<telethon.tl.custom.conversation.Conversation.get_reply>`
|
|
will return different messages, otherwise they may return
|
|
the same message.
|
|
|
|
Consider the following scenario with one outgoing message,
|
|
1, and two incoming messages, the second one replying::
|
|
|
|
Hello! <1
|
|
2> (reply to 1) Hi!
|
|
3> (reply to 1) How are you?
|
|
|
|
And the following code:
|
|
|
|
.. code-block:: python
|
|
|
|
async with client.conversation(chat) as conv:
|
|
msg1 = await conv.send_message('Hello!')
|
|
msg2 = await conv.get_response()
|
|
msg3 = await conv.get_reply()
|
|
|
|
With the setting enabled, ``msg2`` will be ``'Hi!'`` and
|
|
``msg3`` be ``'How are you?'`` since replies are also
|
|
responses, and a response was already returned.
|
|
|
|
With the setting disabled, both ``msg2`` and ``msg3`` will
|
|
be ``'Hi!'`` since one is a response and also a reply.
|
|
|
|
Returns:
|
|
A `Conversation <telethon.tl.custom.conversation.Conversation>`.
|
|
"""
|
|
return custom.Conversation(
|
|
self,
|
|
entity,
|
|
timeout=timeout,
|
|
total_timeout=total_timeout,
|
|
max_messages=max_messages,
|
|
exclusive=exclusive,
|
|
replies_are_responses=replies_are_responses
|
|
|
|
)
|
|
|
|
# endregion
|