mirror of
https://github.com/LonamiWebs/Telethon.git
synced 2025-01-25 00:34:19 +03:00
Complete moving properties to the new message base
This commit is contained in:
Lonami Exo
parent
a3ac6d1645
commit
c4e94abcf0
|
|
@ -1,622 +0,0 @@
|
|||
from .. import types, functions
|
||||
from ...errors import BotTimeout
|
||||
from ...utils import get_input_peer, get_inner_text
|
||||
from .chatgetter import ChatGetter
|
||||
from .sendergetter import SenderGetter
|
||||
from .messagebutton import MessageButton
|
||||
from .forward import Forward
|
||||
|
||||
|
||||
class Message(ChatGetter, SenderGetter):
|
||||
"""
|
||||
Custom class that encapsulates a message providing an abstraction to
|
||||
easily access some commonly needed features (such as the markdown text
|
||||
or the text for a given message entity).
|
||||
|
||||
Remember that this class implements `ChatGetter
|
||||
<telethon.tl.custom.chatgetter.ChatGetter>` and `SenderGetter
|
||||
<telethon.tl.custom.sendergetter.SenderGetter>` which means you
|
||||
have access to all their sender and chat properties and methods.
|
||||
|
||||
Attributes:
|
||||
|
||||
original_message (:tl:`Message`):
|
||||
The original :tl:`Message` object.
|
||||
|
||||
Any other attribute:
|
||||
Attributes not described here are the same as those available
|
||||
in the original :tl:`Message`.
|
||||
"""
|
||||
def __init__(self, client, original, entities, input_chat):
|
||||
# Share the original dictionary. Modifications to this
|
||||
# object should also be reflected in the original one.
|
||||
# This way there's no need to worry about get/setattr.
|
||||
self.__dict__ = original.__dict__
|
||||
self.original_message = original
|
||||
self.stringify = original.stringify
|
||||
self.to_dict = original.to_dict
|
||||
self._client = client
|
||||
self._text = None
|
||||
self._reply_message = None
|
||||
self._buttons = None
|
||||
self._buttons_flat = None
|
||||
self._buttons_count = None
|
||||
|
||||
self._sender_id = original.from_id
|
||||
self._sender = entities.get(self._sender_id)
|
||||
if self._sender:
|
||||
self._input_sender = get_input_peer(self._sender)
|
||||
if not getattr(self._input_sender, 'access_hash', True):
|
||||
self._input_sender = None
|
||||
else:
|
||||
self._input_sender = None
|
||||
|
||||
# Determine the right chat where the message
|
||||
# was sent, not *to which ID* it was sent.
|
||||
if not original.out and isinstance(original.to_id, types.PeerUser):
|
||||
self._chat_peer = types.PeerUser(self._sender_id)
|
||||
else:
|
||||
self._chat_peer = original.to_id
|
||||
|
||||
self._broadcast = bool(original.post)
|
||||
self._chat = entities.get(self.chat_id)
|
||||
self._input_chat = input_chat
|
||||
if not self._input_chat and self._chat:
|
||||
self._input_chat = get_input_peer(self._chat)
|
||||
if not getattr(self._input_chat, 'access_hash', True):
|
||||
# Telegram may omit the hash in updates -> invalid peer
|
||||
# However things like InputPeerSelf() or InputPeerChat(id)
|
||||
# are still valid so default to getting "True" on not found
|
||||
self._input_chat = None
|
||||
|
||||
if getattr(original, 'fwd_from', None):
|
||||
self._forward = Forward(self._client, original.fwd_from, entities)
|
||||
else:
|
||||
self._forward = None
|
||||
|
||||
def __new__(cls, client, original, entities, input_chat):
|
||||
if isinstance(original, types.Message):
|
||||
return super().__new__(_CustomMessage)
|
||||
elif isinstance(original, types.MessageService):
|
||||
return super().__new__(_CustomMessageService)
|
||||
else:
|
||||
return cls
|
||||
|
||||
def __str__(self):
|
||||
return str(self.original_message)
|
||||
|
||||
def __repr__(self):
|
||||
return repr(self.original_message)
|
||||
|
||||
def __bytes__(self):
|
||||
return bytes(self.original_message)
|
||||
|
||||
@property
|
||||
def client(self):
|
||||
"""
|
||||
Returns the `telethon.telegram_client.TelegramClient` instance that
|
||||
created this instance.
|
||||
"""
|
||||
return self._client
|
||||
|
||||
@property
|
||||
def text(self):
|
||||
"""
|
||||
The message text, formatted using the client's default parse mode.
|
||||
Will be ``None`` for :tl:`MessageService`.
|
||||
"""
|
||||
if self._text is None and 'message' in self.__dict__:
|
||||
if not self._client.parse_mode:
|
||||
return self.__dict__['message']
|
||||
self._text = self._client.parse_mode.unparse(
|
||||
self.__dict__['message'], self.__dict__.get('entities'))
|
||||
|
||||
return self._text
|
||||
|
||||
@text.setter
|
||||
def text(self, value):
|
||||
if self._client.parse_mode:
|
||||
msg, ent = self._client.parse_mode.parse(value)
|
||||
else:
|
||||
msg, ent = value, []
|
||||
self.__dict__['message'] = msg
|
||||
self.entities = ent
|
||||
self._text = value
|
||||
|
||||
@property
|
||||
def raw_text(self):
|
||||
"""
|
||||
The raw message text, ignoring any formatting.
|
||||
Will be ``None`` for :tl:`MessageService`.
|
||||
"""
|
||||
return self.__dict__.get('message')
|
||||
|
||||
@raw_text.setter
|
||||
def raw_text(self, value):
|
||||
self.__dict__['message'] = value
|
||||
self.entities = []
|
||||
self._text = None
|
||||
|
||||
@property
|
||||
def message(self):
|
||||
"""
|
||||
The raw message text, ignoring any formatting.
|
||||
Will be ``None`` for :tl:`MessageService`.
|
||||
"""
|
||||
return self.raw_text
|
||||
|
||||
@message.setter
|
||||
def message(self, value):
|
||||
self.raw_text = value
|
||||
|
||||
@property
|
||||
def action(self):
|
||||
"""
|
||||
The :tl:`MessageAction` for the :tl:`MessageService`.
|
||||
Will be ``None`` for :tl:`Message`.
|
||||
"""
|
||||
return self.__dict__.get('action')
|
||||
|
||||
# TODO Make a property for via_bot and via_input_bot, as well as get_*
|
||||
async def _reload_message(self):
|
||||
"""
|
||||
Re-fetches this message to reload the sender and chat entities,
|
||||
along with their input versions.
|
||||
"""
|
||||
try:
|
||||
chat = await self.get_input_chat() if self.is_channel else None
|
||||
msg = await self._client.get_messages(chat, ids=self.id)
|
||||
except ValueError:
|
||||
return # We may not have the input chat/get message failed
|
||||
if not msg:
|
||||
return # The message may be deleted and it will be None
|
||||
|
||||
self._sender = msg._sender
|
||||
self._input_sender = msg._input_sender
|
||||
self._chat = msg._chat
|
||||
self._input_chat = msg._input_chat
|
||||
|
||||
async def _refetch_sender(self):
|
||||
await self._reload_message()
|
||||
|
||||
@property
|
||||
def is_reply(self):
|
||||
"""True if the message is a reply to some other or not."""
|
||||
return bool(self.reply_to_msg_id)
|
||||
|
||||
@property
|
||||
def forward(self):
|
||||
"""
|
||||
Returns `telethon.tl.custom.forward.Forward` if the message
|
||||
has been forwarded from somewhere else.
|
||||
"""
|
||||
return self._forward
|
||||
|
||||
def _set_buttons(self, chat, bot):
|
||||
"""
|
||||
Helper methods to set the buttons given the input sender and chat.
|
||||
"""
|
||||
if isinstance(self.reply_markup, (
|
||||
types.ReplyInlineMarkup, types.ReplyKeyboardMarkup)):
|
||||
self._buttons = [[
|
||||
MessageButton(self._client, button, chat, bot, self.id)
|
||||
for button in row.buttons
|
||||
] for row in self.reply_markup.rows]
|
||||
self._buttons_flat = [x for row in self._buttons for x in row]
|
||||
|
||||
def _needed_markup_bot(self):
|
||||
"""
|
||||
Returns the input peer of the bot that's needed for the reply markup.
|
||||
|
||||
This is necessary for :tl:`KeyboardButtonSwitchInline` since we need
|
||||
to know what bot we want to start. Raises ``ValueError`` if the bot
|
||||
cannot be found but is needed. Returns ``None`` if it's not needed.
|
||||
"""
|
||||
for row in self.reply_markup.rows:
|
||||
for button in row.buttons:
|
||||
if isinstance(button, types.KeyboardButtonSwitchInline):
|
||||
if button.same_peer:
|
||||
bot = self.input_sender
|
||||
if not bot:
|
||||
raise ValueError('No input sender')
|
||||
else:
|
||||
return self._client.session.get_input_entity(
|
||||
self.via_bot_id)
|
||||
|
||||
@property
|
||||
def buttons(self):
|
||||
"""
|
||||
Returns a matrix (list of lists) containing all buttons of the message
|
||||
as `telethon.tl.custom.messagebutton.MessageButton` instances.
|
||||
"""
|
||||
if not isinstance(self.original_message, types.Message):
|
||||
return # MessageService and MessageEmpty have no markup
|
||||
|
||||
if self._buttons is None and self.reply_markup:
|
||||
if not self.input_chat:
|
||||
return
|
||||
try:
|
||||
bot = self._needed_markup_bot()
|
||||
except ValueError:
|
||||
return
|
||||
else:
|
||||
self._set_buttons(self._input_chat, bot)
|
||||
|
||||
return self._buttons
|
||||
|
||||
async def get_buttons(self):
|
||||
"""
|
||||
Returns `buttons`, but will make an API call to find the
|
||||
input chat (needed for the buttons) unless it's already cached.
|
||||
"""
|
||||
if not self.buttons and isinstance(
|
||||
self.original_message, types.Message):
|
||||
chat = await self.get_input_chat()
|
||||
if not chat:
|
||||
return
|
||||
try:
|
||||
bot = self._needed_markup_bot()
|
||||
except ValueError:
|
||||
await self._reload_message()
|
||||
bot = self._needed_markup_bot() # TODO use via_input_bot
|
||||
|
||||
self._set_buttons(chat, bot)
|
||||
|
||||
return self._buttons
|
||||
|
||||
@property
|
||||
def button_count(self):
|
||||
"""
|
||||
Returns the total button count.
|
||||
"""
|
||||
if not isinstance(self.original_message, types.Message):
|
||||
return 0
|
||||
|
||||
if self._buttons_count is None and isinstance(
|
||||
self.reply_markup, (
|
||||
types.ReplyInlineMarkup, types.ReplyKeyboardMarkup
|
||||
)):
|
||||
self._buttons_count = sum(
|
||||
1
|
||||
for row in self.reply_markup.rows
|
||||
for _ in row.buttons
|
||||
)
|
||||
|
||||
return self._buttons_count or 0
|
||||
|
||||
@property
|
||||
def media(self):
|
||||
"""
|
||||
Returns the media of the message.
|
||||
"""
|
||||
if isinstance(self.original_message, types.Message):
|
||||
return self.__dict__['media']
|
||||
elif isinstance(self.original_message, types.MessageService):
|
||||
action = self.__dict__['action']
|
||||
if isinstance(action, types.MessageActionChatEditPhoto):
|
||||
return types.MessageMediaPhoto(action.photo)
|
||||
|
||||
@property
|
||||
def photo(self):
|
||||
"""
|
||||
If the message media is a photo,
|
||||
this returns the :tl:`Photo` object.
|
||||
"""
|
||||
if isinstance(self.media, types.MessageMediaPhoto):
|
||||
if isinstance(self.media.photo, types.Photo):
|
||||
return self.media.photo
|
||||
|
||||
@property
|
||||
def document(self):
|
||||
"""
|
||||
If the message media is a document,
|
||||
this returns the :tl:`Document` object.
|
||||
"""
|
||||
if isinstance(self.media, types.MessageMediaDocument):
|
||||
if isinstance(self.media.document, types.Document):
|
||||
return self.media.document
|
||||
|
||||
def _document_by_attribute(self, kind, condition=None):
|
||||
"""
|
||||
Helper method to return the document only if it has an attribute
|
||||
that's an instance of the given kind, and passes the condition.
|
||||
"""
|
||||
doc = self.document
|
||||
if doc:
|
||||
for attr in doc.attributes:
|
||||
if isinstance(attr, kind):
|
||||
if not condition or condition(doc):
|
||||
return doc
|
||||
|
||||
@property
|
||||
def audio(self):
|
||||
"""
|
||||
If the message media is a document with an Audio attribute,
|
||||
this returns the :tl:`Document` object.
|
||||
"""
|
||||
return self._document_by_attribute(types.DocumentAttributeAudio,
|
||||
lambda attr: not attr.voice)
|
||||
|
||||
@property
|
||||
def voice(self):
|
||||
"""
|
||||
If the message media is a document with a Voice attribute,
|
||||
this returns the :tl:`Document` object.
|
||||
"""
|
||||
return self._document_by_attribute(types.DocumentAttributeAudio,
|
||||
lambda attr: attr.voice)
|
||||
|
||||
@property
|
||||
def video(self):
|
||||
"""
|
||||
If the message media is a document with a Video attribute,
|
||||
this returns the :tl:`Document` object.
|
||||
"""
|
||||
return self._document_by_attribute(types.DocumentAttributeVideo)
|
||||
|
||||
@property
|
||||
def video_note(self):
|
||||
"""
|
||||
If the message media is a document with a Video attribute,
|
||||
this returns the :tl:`Document` object.
|
||||
"""
|
||||
return self._document_by_attribute(types.DocumentAttributeVideo,
|
||||
lambda attr: attr.round_message)
|
||||
|
||||
@property
|
||||
def gif(self):
|
||||
"""
|
||||
If the message media is a document with an Animated attribute,
|
||||
this returns the :tl:`Document` object.
|
||||
"""
|
||||
return self._document_by_attribute(types.DocumentAttributeAnimated)
|
||||
|
||||
@property
|
||||
def sticker(self):
|
||||
"""
|
||||
If the message media is a document with a Sticker attribute,
|
||||
this returns the :tl:`Document` object.
|
||||
"""
|
||||
return self._document_by_attribute(types.DocumentAttributeSticker)
|
||||
|
||||
@property
|
||||
def out(self):
|
||||
"""
|
||||
Whether the message is outgoing (i.e. you sent it from
|
||||
another session) or incoming (i.e. someone else sent it).
|
||||
|
||||
Note that messages in your own chat are always incoming,
|
||||
but this property will be ``True`` if you send a message
|
||||
to your own chat. Messages you forward to your chat are
|
||||
*not* considered outgoing, just like official clients
|
||||
display them.
|
||||
"""
|
||||
return self.__dict__['out']
|
||||
|
||||
async def get_reply_message(self):
|
||||
"""
|
||||
The `telethon.tl.custom.message.Message` that this message is replying
|
||||
to, or ``None``.
|
||||
|
||||
Note that this will make a network call to fetch the message and
|
||||
will later be cached.
|
||||
"""
|
||||
if self._reply_message is None:
|
||||
if not self.reply_to_msg_id:
|
||||
return None
|
||||
self._reply_message = await self._client.get_messages(
|
||||
await self.get_input_chat() if self.is_channel else None,
|
||||
ids=self.reply_to_msg_id
|
||||
)
|
||||
|
||||
return self._reply_message
|
||||
|
||||
async def respond(self, *args, **kwargs):
|
||||
"""
|
||||
Responds to the message (not as a reply). Shorthand for
|
||||
`telethon.telegram_client.TelegramClient.send_message` with
|
||||
``entity`` already set.
|
||||
"""
|
||||
return await self._client.send_message(
|
||||
await self.get_input_chat(), *args, **kwargs)
|
||||
|
||||
async def reply(self, *args, **kwargs):
|
||||
"""
|
||||
Replies to the message (as a reply). Shorthand for
|
||||
`telethon.telegram_client.TelegramClient.send_message` with
|
||||
both ``entity`` and ``reply_to`` already set.
|
||||
"""
|
||||
kwargs['reply_to'] = self.id
|
||||
return await self._client.send_message(
|
||||
await self.get_input_chat(), *args, **kwargs)
|
||||
|
||||
async def forward_to(self, *args, **kwargs):
|
||||
"""
|
||||
Forwards the message. Shorthand for
|
||||
`telethon.telegram_client.TelegramClient.forward_messages` with
|
||||
both ``messages`` and ``from_peer`` already set.
|
||||
|
||||
If you need to forward more than one message at once, don't use
|
||||
this `forward_to` method. Use a
|
||||
`telethon.telegram_client.TelegramClient` instance directly.
|
||||
"""
|
||||
kwargs['messages'] = self.id
|
||||
kwargs['from_peer'] = await self.get_input_chat()
|
||||
return await self._client.forward_messages(*args, **kwargs)
|
||||
|
||||
async def edit(self, *args, **kwargs):
|
||||
"""
|
||||
Edits the message iff it's outgoing. Shorthand for
|
||||
`telethon.telegram_client.TelegramClient.edit_message` with
|
||||
both ``entity`` and ``message`` already set.
|
||||
|
||||
Returns ``None`` if the message was incoming, or the edited
|
||||
:tl:`Message` otherwise.
|
||||
"""
|
||||
if self.fwd_from:
|
||||
return None
|
||||
if not self.__dict__['out']:
|
||||
if not isinstance(self._chat_peer, types.PeerUser):
|
||||
return None
|
||||
me = await self._client.get_me(input_peer=True)
|
||||
if self._chat_peer.user_id != me.user_id:
|
||||
return None
|
||||
|
||||
return await self._client.edit_message(
|
||||
await self.get_input_chat(), self.original_message,
|
||||
*args, **kwargs
|
||||
)
|
||||
|
||||
async def delete(self, *args, **kwargs):
|
||||
"""
|
||||
Deletes the message. You're responsible for checking whether you
|
||||
have the permission to do so, or to except the error otherwise.
|
||||
Shorthand for
|
||||
`telethon.telegram_client.TelegramClient.delete_messages` with
|
||||
``entity`` and ``message_ids`` already set.
|
||||
|
||||
If you need to delete more than one message at once, don't use
|
||||
this `delete` method. Use a
|
||||
`telethon.telegram_client.TelegramClient` instance directly.
|
||||
"""
|
||||
return await self._client.delete_messages(
|
||||
await self.get_input_chat(), [self.original_message],
|
||||
*args, **kwargs
|
||||
)
|
||||
|
||||
async def download_media(self, *args, **kwargs):
|
||||
"""
|
||||
Downloads the media contained in the message, if any.
|
||||
`telethon.telegram_client.TelegramClient.download_media` with
|
||||
the ``message`` already set.
|
||||
"""
|
||||
return await self._client.download_media(
|
||||
self.original_message, *args, **kwargs)
|
||||
|
||||
def get_entities_text(self, cls=None):
|
||||
"""
|
||||
Returns a list of tuples [(:tl:`MessageEntity`, `str`)], the string
|
||||
being the inner text of the message entity (like bold, italics, etc).
|
||||
|
||||
Args:
|
||||
cls (`type`):
|
||||
Returns entities matching this type only. For example,
|
||||
the following will print the text for all ``code`` entities:
|
||||
|
||||
>>> from telethon.tl.types import MessageEntityCode
|
||||
>>>
|
||||
>>> m = Message(...)
|
||||
>>> for _, inner_text in m.get_entities_text(MessageEntityCode):
|
||||
>>> print(inner_text)
|
||||
"""
|
||||
ent = self.__dict__.get('entities')
|
||||
if not ent:
|
||||
return []
|
||||
|
||||
if cls:
|
||||
ent = [c for c in ent if isinstance(c, cls)]
|
||||
|
||||
texts = get_inner_text(self.__dict__.get('message'), ent)
|
||||
return list(zip(ent, texts))
|
||||
|
||||
async def click(self, i=None, j=None,
|
||||
*, text=None, filter=None, data=None):
|
||||
"""
|
||||
Calls `telethon.tl.custom.messagebutton.MessageButton.click`
|
||||
for the specified button.
|
||||
|
||||
Does nothing if the message has no buttons.
|
||||
|
||||
Args:
|
||||
i (`int`):
|
||||
Clicks the i'th button (starting from the index 0).
|
||||
Will ``raise IndexError`` if out of bounds. Example:
|
||||
|
||||
>>> message = Message(...)
|
||||
>>> # Clicking the 3rd button
|
||||
>>> # [button1] [button2]
|
||||
>>> # [ button3 ]
|
||||
>>> # [button4] [button5]
|
||||
>>> message.click(2) # index
|
||||
|
||||
j (`int`):
|
||||
Clicks the button at position (i, j), these being the
|
||||
indices for the (row, column) respectively. Example:
|
||||
|
||||
>>> # Clicking the 2nd button on the 1st row.
|
||||
>>> # [button1] [button2]
|
||||
>>> # [ button3 ]
|
||||
>>> # [button4] [button5]
|
||||
>>> message.click(0, 1) # (row, column)
|
||||
|
||||
This is equivalent to ``message.buttons[0][1].click()``.
|
||||
|
||||
text (`str` | `callable`):
|
||||
Clicks the first button with the text "text". This may
|
||||
also be a callable, like a ``re.compile(...).match``,
|
||||
and the text will be passed to it.
|
||||
|
||||
filter (`callable`):
|
||||
Clicks the first button for which the callable
|
||||
returns ``True``. The callable should accept a single
|
||||
`telethon.tl.custom.messagebutton.MessageButton` argument.
|
||||
|
||||
data (`bytes`):
|
||||
This argument overrides the rest and will not search any
|
||||
buttons. Instead, it will directly send the request to
|
||||
behave as if it clicked a button with said data. Note
|
||||
that if the message does not have this data, it will
|
||||
``raise DataInvalidError``.
|
||||
"""
|
||||
if data:
|
||||
if not await self.get_input_chat():
|
||||
return None
|
||||
|
||||
try:
|
||||
return await self._client(
|
||||
functions.messages.GetBotCallbackAnswerRequest(
|
||||
peer=self._input_chat,
|
||||
msg_id=self.id,
|
||||
data=data
|
||||
)
|
||||
)
|
||||
except BotTimeout:
|
||||
return None
|
||||
|
||||
if sum(int(x is not None) for x in (i, text, filter)) >= 2:
|
||||
raise ValueError('You can only set either of i, text or filter')
|
||||
|
||||
if not await self.get_buttons():
|
||||
return # Accessing the property sets self._buttons[_flat]
|
||||
|
||||
if text is not None:
|
||||
if callable(text):
|
||||
for button in self._buttons_flat:
|
||||
if text(button.text):
|
||||
return await button.click()
|
||||
else:
|
||||
for button in self._buttons_flat:
|
||||
if button.text == text:
|
||||
return await button.click()
|
||||
return
|
||||
|
||||
if filter is not None:
|
||||
for button in self._buttons_flat:
|
||||
if filter(button):
|
||||
return await button.click()
|
||||
return
|
||||
|
||||
if i is None:
|
||||
i = 0
|
||||
if j is None:
|
||||
return await self._buttons_flat[i].click()
|
||||
else:
|
||||
return await self._buttons[i][j].click()
|
||||
|
||||
|
||||
class _CustomMessage(Message, types.Message):
|
||||
pass
|
||||
|
||||
|
||||
class _CustomMessageService(Message, types.MessageService):
|
||||
pass
|
||||
|
|
@ -1,13 +1,23 @@
|
|||
import abc
|
||||
from ..tlobject import TLObject
|
||||
from .chatgetter import ChatGetter
|
||||
from .sendergetter import SenderGetter
|
||||
from .messagebutton import MessageButton
|
||||
from .forward import Forward
|
||||
from .. import TLObject, types, functions
|
||||
from ... import utils, errors
|
||||
|
||||
# TODO Figure out a way to have the generator error on missing fields
|
||||
# TODO Figure out a way to have the code generator error on missing fields
|
||||
# Maybe parsing the init function alone if that's possible.
|
||||
class MessageBase(abc.ABC, TLObject):
|
||||
class MessageBase(abc.ABC, TLObject, ChatGetter, SenderGetter):
|
||||
"""
|
||||
This custom class aggregates both :tl:`Message` and
|
||||
This custom class aggregates both `MessageBase` and
|
||||
:tl:`MessageService` to ease accessing their members.
|
||||
|
||||
Remember that this class implements `ChatGetter
|
||||
<telethon.tl.custom.chatgetter.ChatGetter>` and `SenderGetter
|
||||
<telethon.tl.custom.sendergetter.SenderGetter>` which means you
|
||||
have access to all their sender and chat properties and methods.
|
||||
|
||||
Members:
|
||||
id (`int`):
|
||||
The ID of this message. This field is *always* present.
|
||||
|
|
@ -51,7 +61,7 @@ class MessageBase(abc.ABC, TLObject):
|
|||
messages.
|
||||
|
||||
message (`str`):
|
||||
The string text of the message for :tl:`Message` instances,
|
||||
The string text of the message for `MessageBase` instances,
|
||||
which will be ``None`` for other types of messages.
|
||||
|
||||
action (:tl:`MessageAction`):
|
||||
|
|
@ -105,6 +115,9 @@ class MessageBase(abc.ABC, TLObject):
|
|||
(photo albums or video albums), all of them will
|
||||
have the same value here.
|
||||
"""
|
||||
|
||||
# region Initialization
|
||||
|
||||
def __init__(
|
||||
# Common to all
|
||||
self, id,
|
||||
|
|
@ -126,6 +139,7 @@ class MessageBase(abc.ABC, TLObject):
|
|||
|
||||
# For MessageAction (mandatory)
|
||||
action=None):
|
||||
# Common properties to all messages
|
||||
self.id = id
|
||||
self.to_id = to_id
|
||||
self.date = date
|
||||
|
|
@ -147,3 +161,535 @@ class MessageBase(abc.ABC, TLObject):
|
|||
self.post_author = post_author
|
||||
self.grouped_id = grouped_id
|
||||
self.action = action
|
||||
|
||||
# Convenient storage for custom functions
|
||||
self._client = None
|
||||
self._text = None
|
||||
self._reply_message = None
|
||||
self._buttons = None
|
||||
self._buttons_flat = None
|
||||
self._buttons_count = None
|
||||
self._sender_id = from_id
|
||||
self._sender = None
|
||||
self._input_sender = None
|
||||
|
||||
if not out and isinstance(to_id, types.PeerUser):
|
||||
self._chat_peer = types.PeerUser(from_id)
|
||||
if from_id == to_id.user_id:
|
||||
self.out = not self.fwd_from # Patch out in our chat
|
||||
else:
|
||||
self._chat_peer = to_id
|
||||
|
||||
self._broadcast = post
|
||||
self._chat = None
|
||||
self._input_chat = None
|
||||
self._forward = None
|
||||
|
||||
def _finish_init(self, client, entities, input_chat):
|
||||
"""
|
||||
Finishes the initialization of this message by setting
|
||||
the client that sent the message and making use of the
|
||||
known entities.
|
||||
"""
|
||||
self._client = client
|
||||
self._sender = entities.get(self._sender_id)
|
||||
if self._sender:
|
||||
self._input_sender = utils.get_input_peer(self._sender)
|
||||
if not getattr(self._input_sender, 'access_hash', True):
|
||||
self._input_sender = None
|
||||
|
||||
self._chat = entities.get(self.chat_id)
|
||||
self._input_chat = input_chat
|
||||
if not self._input_chat and self._chat:
|
||||
self._input_chat = utils.get_input_peer(self._chat)
|
||||
if not getattr(self._input_chat, 'access_hash', True):
|
||||
# Telegram may omit the hash in updates -> invalid peer
|
||||
# However things like InputPeerSelf() or InputPeerChat(id)
|
||||
# are still valid so default to getting "True" on not found
|
||||
self._input_chat = None
|
||||
|
||||
if self.fwd_from:
|
||||
self._forward = Forward(self._client, self.fwd_from, entities)
|
||||
|
||||
# endregion Initialization
|
||||
|
||||
# region Public Properties
|
||||
|
||||
@property
|
||||
def client(self):
|
||||
"""
|
||||
Returns the `telethon.client.telegramclient.TelegramClient`
|
||||
that patched this message. This will only be present if you
|
||||
**use the friendly methods**, it won't be there if you invoke
|
||||
raw API methods manually, in which case you should only access
|
||||
members, not properties.
|
||||
"""
|
||||
return self._client
|
||||
|
||||
@property
|
||||
def text(self):
|
||||
"""
|
||||
The message text, formatted using the client's default
|
||||
parse mode. Will be ``None`` for :tl:`MessageService`.
|
||||
"""
|
||||
if self._text is None and self._client:
|
||||
self._text = self._client.parse_mode.unparse(
|
||||
self.message, self.entities)
|
||||
|
||||
return self._text
|
||||
|
||||
@text.setter
|
||||
def text(self, value):
|
||||
self._text = value
|
||||
if self._client and self._client.parse_mode:
|
||||
self.message, self.entities = self._client.parse_mode.parse(value)
|
||||
else:
|
||||
self.message, self.entities = value, []
|
||||
|
||||
@property
|
||||
def raw_text(self):
|
||||
"""
|
||||
The raw message text, ignoring any formatting.
|
||||
Will be ``None`` for :tl:`MessageService`.
|
||||
|
||||
Setting a value to this field will erase the
|
||||
`entities`, unlike changing the `message` member.
|
||||
"""
|
||||
return self.message
|
||||
|
||||
@raw_text.setter
|
||||
def raw_text(self, value):
|
||||
self.message = value
|
||||
self.entities = []
|
||||
self._text = None
|
||||
|
||||
@property
|
||||
def is_reply(self):
|
||||
"""
|
||||
True if the message is a reply to some other.
|
||||
|
||||
Remember that you can access the ID of the message
|
||||
this one is replying to through `reply_to_msg_id`,
|
||||
and the `MessageBase` object with `get_reply_message()`.
|
||||
"""
|
||||
return bool(self.reply_to_msg_id)
|
||||
|
||||
@property
|
||||
def forward(self):
|
||||
"""
|
||||
Returns `Forward <telethon.tl.custom.forward.Forward>`
|
||||
if the message has been forwarded from somewhere else.
|
||||
"""
|
||||
return self._forward
|
||||
|
||||
@property
|
||||
def buttons(self):
|
||||
"""
|
||||
Returns a matrix (list of lists) containing all buttons of the message
|
||||
as `MessageButton <telethon.tl.custom.messagebutton.MessageButton>`
|
||||
instances.
|
||||
"""
|
||||
if self._buttons is None and self.reply_markup:
|
||||
if not self.input_chat:
|
||||
return
|
||||
try:
|
||||
bot = self._needed_markup_bot()
|
||||
except ValueError:
|
||||
return
|
||||
else:
|
||||
self._set_buttons(self._input_chat, bot)
|
||||
|
||||
return self._buttons
|
||||
|
||||
async def get_buttons(self):
|
||||
"""
|
||||
Returns `buttons`, but will make an API call to find the
|
||||
input chat (needed for the buttons) unless it's already cached.
|
||||
"""
|
||||
if not self.buttons and self.reply_markup:
|
||||
chat = await self.get_input_chat()
|
||||
if not chat:
|
||||
return
|
||||
try:
|
||||
bot = self._needed_markup_bot()
|
||||
except ValueError:
|
||||
await self._reload_message()
|
||||
bot = self._needed_markup_bot() # TODO use via_input_bot
|
||||
|
||||
self._set_buttons(chat, bot)
|
||||
|
||||
return self._buttons
|
||||
|
||||
@property
|
||||
def button_count(self):
|
||||
"""
|
||||
Returns the total button count.
|
||||
"""
|
||||
if self._buttons_count is None:
|
||||
if isinstance(self.reply_markup, (
|
||||
types.ReplyInlineMarkup, types.ReplyKeyboardMarkup)):
|
||||
self._buttons_count = sum(
|
||||
len(row.buttons) for row in self.reply_markup.rows)
|
||||
else:
|
||||
self._buttons_count = 0
|
||||
|
||||
return self._buttons_count
|
||||
|
||||
@property
|
||||
def photo(self):
|
||||
"""
|
||||
If the message media is a photo, this returns the :tl:`Photo` object.
|
||||
This will also return the photo for :tl:`MessageService` if their
|
||||
action is :tl:`MessageActionChatEditPhoto`.
|
||||
"""
|
||||
if isinstance(self.media, types.MessageMediaPhoto):
|
||||
if isinstance(self.media.photo, types.Photo):
|
||||
return self.media.photo
|
||||
elif isinstance(self.action, types.MessageActionChatEditPhoto):
|
||||
return self.action.photo
|
||||
|
||||
@property
|
||||
def document(self):
|
||||
"""
|
||||
If the message media is a document,
|
||||
this returns the :tl:`Document` object.
|
||||
"""
|
||||
if isinstance(self.media, types.MessageMediaDocument):
|
||||
if isinstance(self.media.document, types.Document):
|
||||
return self.media.document
|
||||
|
||||
@property
|
||||
def audio(self):
|
||||
"""
|
||||
If the message media is a document with an Audio attribute,
|
||||
this returns the :tl:`Document` object.
|
||||
"""
|
||||
return self._document_by_attribute(types.DocumentAttributeAudio,
|
||||
lambda attr: not attr.voice)
|
||||
|
||||
@property
|
||||
def voice(self):
|
||||
"""
|
||||
If the message media is a document with a Voice attribute,
|
||||
this returns the :tl:`Document` object.
|
||||
"""
|
||||
return self._document_by_attribute(types.DocumentAttributeAudio,
|
||||
lambda attr: attr.voice)
|
||||
|
||||
@property
|
||||
def video(self):
|
||||
"""
|
||||
If the message media is a document with a Video attribute,
|
||||
this returns the :tl:`Document` object.
|
||||
"""
|
||||
return self._document_by_attribute(types.DocumentAttributeVideo)
|
||||
|
||||
@property
|
||||
def video_note(self):
|
||||
"""
|
||||
If the message media is a document with a Video attribute,
|
||||
this returns the :tl:`Document` object.
|
||||
"""
|
||||
return self._document_by_attribute(types.DocumentAttributeVideo,
|
||||
lambda attr: attr.round_message)
|
||||
|
||||
@property
|
||||
def gif(self):
|
||||
"""
|
||||
If the message media is a document with an Animated attribute,
|
||||
this returns the :tl:`Document` object.
|
||||
"""
|
||||
return self._document_by_attribute(types.DocumentAttributeAnimated)
|
||||
|
||||
@property
|
||||
def sticker(self):
|
||||
"""
|
||||
If the message media is a document with a Sticker attribute,
|
||||
this returns the :tl:`Document` object.
|
||||
"""
|
||||
return self._document_by_attribute(types.DocumentAttributeSticker)
|
||||
|
||||
# endregion Public Properties
|
||||
|
||||
# region Public Methods
|
||||
|
||||
def get_entities_text(self, cls=None):
|
||||
"""
|
||||
Returns a list of tuples [(:tl:`MessageEntity`, `str`)], the string
|
||||
being the inner text of the message entity (like bold, italics, etc).
|
||||
|
||||
Args:
|
||||
cls (`type`):
|
||||
Returns entities matching this type only. For example,
|
||||
the following will print the text for all ``code`` entities:
|
||||
|
||||
>>> from telethon.tl.types import MessageEntityCode
|
||||
>>>
|
||||
>>> m = ... # get the message
|
||||
>>> for _, inner_text in m.get_entities_text(MessageEntityCode):
|
||||
>>> print(inner_text)
|
||||
"""
|
||||
ent = self.entities
|
||||
if not ent:
|
||||
return []
|
||||
|
||||
if cls:
|
||||
ent = [c for c in ent if isinstance(c, cls)]
|
||||
|
||||
texts = utils.get_inner_text(self.message, ent)
|
||||
return list(zip(ent, texts))
|
||||
|
||||
async def get_reply_message(self):
|
||||
"""
|
||||
The `MessageBase` that this message is replying to, or ``None``.
|
||||
|
||||
The result will be cached after its first use.
|
||||
"""
|
||||
if self._reply_message is None:
|
||||
if not self.reply_to_msg_id:
|
||||
return None
|
||||
|
||||
self._reply_message = await self._client.get_messages(
|
||||
await self.get_input_chat() if self.is_channel else None,
|
||||
ids=self.reply_to_msg_id
|
||||
)
|
||||
|
||||
return self._reply_message
|
||||
|
||||
async def respond(self, *args, **kwargs):
|
||||
"""
|
||||
Responds to the message (not as a reply). Shorthand for
|
||||
`telethon.client.telegramclient.TelegramClient.send_message`
|
||||
with ``entity`` already set.
|
||||
"""
|
||||
return await self._client.send_message(
|
||||
await self.get_input_chat(), *args, **kwargs)
|
||||
|
||||
async def reply(self, *args, **kwargs):
|
||||
"""
|
||||
Replies to the message (as a reply). Shorthand for
|
||||
`telethon.client.telegramclient.TelegramClient.send_message`
|
||||
with both ``entity`` and ``reply_to`` already set.
|
||||
"""
|
||||
kwargs['reply_to'] = self.id
|
||||
return await self._client.send_message(
|
||||
await self.get_input_chat(), *args, **kwargs)
|
||||
|
||||
async def forward_to(self, *args, **kwargs):
|
||||
"""
|
||||
Forwards the message. Shorthand for
|
||||
`telethon.client.telegramclient.TelegramClient.forward_messages`
|
||||
with both ``messages`` and ``from_peer`` already set.
|
||||
|
||||
If you need to forward more than one message at once, don't use
|
||||
this `forward_to` method. Use a
|
||||
`telethon.client.telegramclient.TelegramClient` instance directly.
|
||||
"""
|
||||
kwargs['messages'] = self.id
|
||||
kwargs['from_peer'] = await self.get_input_chat()
|
||||
return await self._client.forward_messages(*args, **kwargs)
|
||||
|
||||
async def edit(self, *args, **kwargs):
|
||||
"""
|
||||
Edits the message iff it's outgoing. Shorthand for
|
||||
`telethon.client.telegramclient.TelegramClient.edit_message`
|
||||
with both ``entity`` and ``message`` already set.
|
||||
|
||||
Returns ``None`` if the message was incoming,
|
||||
or the edited `MessageBase` otherwise.
|
||||
"""
|
||||
if self.fwd_from or not self.out:
|
||||
return None # We assume self.out was patched for our chat
|
||||
|
||||
return await self._client.edit_message(
|
||||
await self.get_input_chat(), self.id,
|
||||
*args, **kwargs
|
||||
)
|
||||
|
||||
async def delete(self, *args, **kwargs):
|
||||
"""
|
||||
Deletes the message. You're responsible for checking whether you
|
||||
have the permission to do so, or to except the error otherwise.
|
||||
Shorthand for
|
||||
`telethon.client.telegramclient.TelegramClient.delete_messages` with
|
||||
``entity`` and ``message_ids`` already set.
|
||||
|
||||
If you need to delete more than one message at once, don't use
|
||||
this `delete` method. Use a
|
||||
`telethon.client.telegramclient.TelegramClient` instance directly.
|
||||
"""
|
||||
return await self._client.delete_messages(
|
||||
await self.get_input_chat(), [self.id],
|
||||
*args, **kwargs
|
||||
)
|
||||
|
||||
async def download_media(self, *args, **kwargs):
|
||||
"""
|
||||
Downloads the media contained in the message, if any. Shorthand
|
||||
for `telethon.client.telegramclient.TelegramClient.download_media`
|
||||
with the ``message`` already set.
|
||||
"""
|
||||
return await self._client.download_media(self, *args, **kwargs)
|
||||
|
||||
async def click(self, i=None, j=None,
|
||||
*, text=None, filter=None, data=None):
|
||||
"""
|
||||
Calls `telethon.tl.custom.messagebutton.MessageButton.click`
|
||||
for the specified button.
|
||||
|
||||
Does nothing if the message has no buttons.
|
||||
|
||||
Args:
|
||||
i (`int`):
|
||||
Clicks the i'th button (starting from the index 0).
|
||||
Will ``raise IndexError`` if out of bounds. Example:
|
||||
|
||||
>>> message = ... # get the message somehow
|
||||
>>> # Clicking the 3rd button
|
||||
>>> # [button1] [button2]
|
||||
>>> # [ button3 ]
|
||||
>>> # [button4] [button5]
|
||||
>>> message.click(2) # index
|
||||
|
||||
j (`int`):
|
||||
Clicks the button at position (i, j), these being the
|
||||
indices for the (row, column) respectively. Example:
|
||||
|
||||
>>> # Clicking the 2nd button on the 1st row.
|
||||
>>> # [button1] [button2]
|
||||
>>> # [ button3 ]
|
||||
>>> # [button4] [button5]
|
||||
>>> message.click(0, 1) # (row, column)
|
||||
|
||||
This is equivalent to ``message.buttons[0][1].click()``.
|
||||
|
||||
text (`str` | `callable`):
|
||||
Clicks the first button with the text "text". This may
|
||||
also be a callable, like a ``re.compile(...).match``,
|
||||
and the text will be passed to it.
|
||||
|
||||
filter (`callable`):
|
||||
Clicks the first button for which the callable
|
||||
returns ``True``. The callable should accept a single
|
||||
`telethon.tl.custom.messagebutton.MessageButton` argument.
|
||||
|
||||
data (`bytes`):
|
||||
This argument overrides the rest and will not search any
|
||||
buttons. Instead, it will directly send the request to
|
||||
behave as if it clicked a button with said data. Note
|
||||
that if the message does not have this data, it will
|
||||
``raise DataInvalidError``.
|
||||
"""
|
||||
if data:
|
||||
if not await self.get_input_chat():
|
||||
return None
|
||||
|
||||
try:
|
||||
return await self._client(
|
||||
functions.messages.GetBotCallbackAnswerRequest(
|
||||
peer=self._input_chat,
|
||||
msg_id=self.id,
|
||||
data=data
|
||||
)
|
||||
)
|
||||
except errors.BotTimeout:
|
||||
return None
|
||||
|
||||
if sum(int(x is not None) for x in (i, text, filter)) >= 2:
|
||||
raise ValueError('You can only set either of i, text or filter')
|
||||
|
||||
if not await self.get_buttons():
|
||||
return # Accessing the property sets self._buttons[_flat]
|
||||
|
||||
if text is not None:
|
||||
if callable(text):
|
||||
for button in self._buttons_flat:
|
||||
if text(button.text):
|
||||
return await button.click()
|
||||
else:
|
||||
for button in self._buttons_flat:
|
||||
if button.text == text:
|
||||
return await button.click()
|
||||
return
|
||||
|
||||
if filter is not None:
|
||||
for button in self._buttons_flat:
|
||||
if filter(button):
|
||||
return await button.click()
|
||||
return
|
||||
|
||||
if i is None:
|
||||
i = 0
|
||||
if j is None:
|
||||
return await self._buttons_flat[i].click()
|
||||
else:
|
||||
return await self._buttons[i][j].click()
|
||||
|
||||
# endregion Public Methods
|
||||
|
||||
# region Private Methods
|
||||
|
||||
# TODO Make a property for via_bot and via_input_bot, as well as get_*
|
||||
async def _reload_message(self):
|
||||
"""
|
||||
Re-fetches this message to reload the sender and chat entities,
|
||||
along with their input versions.
|
||||
"""
|
||||
try:
|
||||
chat = await self.get_input_chat() if self.is_channel else None
|
||||
msg = await self._client.get_messages(chat, ids=self.id)
|
||||
except ValueError:
|
||||
return # We may not have the input chat/get message failed
|
||||
if not msg:
|
||||
return # The message may be deleted and it will be None
|
||||
|
||||
self._sender = msg._sender
|
||||
self._input_sender = msg._input_sender
|
||||
self._chat = msg._chat
|
||||
self._input_chat = msg._input_chat
|
||||
|
||||
async def _refetch_sender(self):
|
||||
await self._reload_message()
|
||||
|
||||
def _set_buttons(self, chat, bot):
|
||||
"""
|
||||
Helper methods to set the buttons given the input sender and chat.
|
||||
"""
|
||||
if isinstance(self.reply_markup, (
|
||||
types.ReplyInlineMarkup, types.ReplyKeyboardMarkup)):
|
||||
self._buttons = [[
|
||||
MessageButton(self._client, button, chat, bot, self.id)
|
||||
for button in row.buttons
|
||||
] for row in self.reply_markup.rows]
|
||||
self._buttons_flat = [x for row in self._buttons for x in row]
|
||||
|
||||
def _needed_markup_bot(self):
|
||||
"""
|
||||
Returns the input peer of the bot that's needed for the reply markup.
|
||||
|
||||
This is necessary for :tl:`KeyboardButtonSwitchInline` since we need
|
||||
to know what bot we want to start. Raises ``ValueError`` if the bot
|
||||
cannot be found but is needed. Returns ``None`` if it's not needed.
|
||||
"""
|
||||
for row in self.reply_markup.rows:
|
||||
for button in row.buttons:
|
||||
if isinstance(button, types.KeyboardButtonSwitchInline):
|
||||
if button.same_peer:
|
||||
bot = self.input_sender
|
||||
if not bot:
|
||||
raise ValueError('No input sender')
|
||||
else:
|
||||
return self._client.session.get_input_entity(
|
||||
self.via_bot_id)
|
||||
|
||||
def _document_by_attribute(self, kind, condition=None):
|
||||
"""
|
||||
Helper method to return the document only if it has an attribute
|
||||
that's an instance of the given kind, and passes the condition.
|
||||
"""
|
||||
for attr in self.document.attributes:
|
||||
if isinstance(attr, kind):
|
||||
if not condition or condition(self.document):
|
||||
return self.document
|
||||
|
||||
# endregion Private Methods
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user