#!/usr/bin/env python # pylint: disable=R0902,R0912,R0913 # # A library that provides a Python interface to the Telegram Bot API # Copyright (C) 2015-2018 # Leandro Toledo de Souza # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Lesser Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Lesser Public License for more details. # # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains an object that represents a Telegram Message.""" import sys from html import escape from telegram import (Animation, Audio, Contact, Document, Chat, Location, PhotoSize, Sticker, TelegramObject, User, Video, Voice, Venue, MessageEntity, Game, Invoice, SuccessfulPayment, VideoNote, PassportData) from telegram import ParseMode from telegram.utils.helpers import escape_markdown, to_timestamp, from_timestamp _UNDEFINED = object() class Message(TelegramObject): """This object represents a message. Note: * In Python `from` is a reserved word, use `from_user` instead. Attributes: message_id (:obj:`int`): Unique message identifier inside this chat. from_user (:class:`telegram.User`): Optional. Sender. date (:class:`datetime.datetime`): Date the message was sent. chat (:class:`telegram.Chat`): Conversation the message belongs to. forward_from (:class:`telegram.User`): Optional. Sender of the original message. forward_from_chat (:class:`telegram.Chat`): Optional. Information about the original channel. forward_from_message_id (:obj:`int`): Optional. Identifier of the original message in the channel. forward_date (:class:`datetime.datetime`): Optional. Date the original message was sent. reply_to_message (:class:`telegram.Message`): Optional. The original message. edit_date (:class:`datetime.datetime`): Optional. Date the message was last edited. media_group_id (:obj:`str`): Optional. The unique identifier of a media message group this message belongs to. text (:obj:`str`): Optional. The actual UTF-8 text of the message. entities (List[:class:`telegram.MessageEntity`]): Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the text. See :attr:`Message.parse_entity` and :attr:`parse_entities` methods for how to use properly. caption_entities (List[:class:`telegram.MessageEntity`]): Optional. Special entities like usernames, URLs, bot commands, etc. that appear in the caption. See :attr:`Message.parse_caption_entity` and :attr:`parse_caption_entities` methods for how to use properly. audio (:class:`telegram.Audio`): Optional. Information about the file. document (:class:`telegram.Document`): Optional. Information about the file. animation (:class:`telegram.Animation`) Optional. Information about the file. For backward compatibility, when this field is set, the document field will also be set. game (:class:`telegram.Game`): Optional. Information about the game. photo (List[:class:`telegram.PhotoSize`]): Optional. Available sizes of the photo. sticker (:class:`telegram.Sticker`): Optional. Information about the sticker. video (:class:`telegram.Video`): Optional. Information about the video. voice (:class:`telegram.Voice`): Optional. Information about the file. video_note (:class:`telegram.VideoNote`): Optional. Information about the video message. new_chat_members (List[:class:`telegram.User`]): Optional. Information about new members to the chat. (the bot itself may be one of these members). caption (:obj:`str`): Optional. Caption for the document, photo or video, 0-1024 characters. contact (:class:`telegram.Contact`): Optional. Information about the contact. location (:class:`telegram.Location`): Optional. Information about the location. venue (:class:`telegram.Venue`): Optional. Information about the venue. left_chat_member (:class:`telegram.User`): Optional. Information about the user that left the group. (this member may be the bot itself). new_chat_title (:obj:`str`): Optional. A chat title was changed to this value. new_chat_photo (List[:class:`telegram.PhotoSize`]): Optional. A chat photo was changed to this value. delete_chat_photo (:obj:`bool`): Optional. The chat photo was deleted. group_chat_created (:obj:`bool`): Optional. The group has been created. supergroup_chat_created (:obj:`bool`): Optional. The supergroup has been created. channel_chat_created (:obj:`bool`): Optional. The channel has been created. migrate_to_chat_id (:obj:`int`): Optional. The group has been migrated to a supergroup with the specified identifier. migrate_from_chat_id (:obj:`int`): Optional. The supergroup has been migrated from a group with the specified identifier. pinned_message (:class:`telegram.message`): Optional. Specified message was pinned. invoice (:class:`telegram.Invoice`): Optional. Information about the invoice. successful_payment (:class:`telegram.SuccessfulPayment`): Optional. Information about the payment. connected_website (:obj:`str`): Optional. The domain name of the website on which the user has logged in. forward_signature (:obj:`str`): Optional. Signature of the post author for messages forwarded from channels. author_signature (:obj:`str`): Optional. Signature of the post author for messages in channels. passport_data (:class:`telegram.PassportData`): Optional. Telegram Passport data bot (:class:`telegram.Bot`): Optional. The Bot to use for instance methods. Args: message_id (:obj:`int`): Unique message identifier inside this chat. from_user (:class:`telegram.User`, optional): Sender, can be empty for messages sent to channels. date (:class:`datetime.datetime`): Date the message was sent in Unix time. Converted to :class:`datetime.datetime`. chat (:class:`telegram.Chat`): Conversation the message belongs to. forward_from (:class:`telegram.User`, optional): For forwarded messages, sender of the original message. forward_from_chat (:class:`telegram.Chat`, optional): For messages forwarded from a channel, information about the original channel. forward_from_message_id (:obj:`int`, optional): For forwarded channel posts, identifier of the original message in the channel. forward_date (:class:`datetime.datetime`, optional): For forwarded messages, date the original message was sent in Unix time. Converted to :class:`datetime.datetime`. reply_to_message (:class:`telegram.Message`, optional): For replies, the original message. Note that the Message object in this field will not contain further ``reply_to_message`` fields even if it itself is a reply. edit_date (:class:`datetime.datetime`, optional): Date the message was last edited in Unix time. Converted to :class:`datetime.datetime`. media_group_id (:obj:`str`, optional): The unique identifier of a media message group this message belongs to. text (str, optional): For text messages, the actual UTF-8 text of the message, 0-4096 characters. Also found as :attr:`telegram.constants.MAX_MESSAGE_LENGTH`. entities (List[:class:`telegram.MessageEntity`], optional): For text messages, special entities like usernames, URLs, bot commands, etc. that appear in the text. See attr:`parse_entity` and attr:`parse_entities` methods for how to use properly. caption_entities (List[:class:`telegram.MessageEntity`]): Optional. For Messages with a Caption. Special entities like usernames, URLs, bot commands, etc. that appear in the caption. See :attr:`Message.parse_caption_entity` and :attr:`parse_caption_entities` methods for how to use properly. audio (:class:`telegram.Audio`, optional): Message is an audio file, information about the file. document (:class:`telegram.Document`, optional): Message is a general file, information about the file. animation (:class:`telegram.Animation`, optional): Message is an animation, information about the animation. For backward compatibility, when this field is set, the document field will also be set. game (:class:`telegram.Game`, optional): Message is a game, information about the game. photo (List[:class:`telegram.PhotoSize`], optional): Message is a photo, available sizes of the photo. sticker (:class:`telegram.Sticker`, optional): Message is a sticker, information about the sticker. video (:class:`telegram.Video`, optional): Message is a video, information about the video. voice (:class:`telegram.Voice`, optional): Message is a voice message, information about the file. video_note (:class:`telegram.VideoNote`, optional): Message is a video note, information about the video message. new_chat_members (List[:class:`telegram.User`], optional): New members that were added to the group or supergroup and information about them (the bot itself may be one of these members). caption (:obj:`str`, optional): Caption for the document, photo or video, 0-1024 characters. contact (:class:`telegram.Contact`, optional): Message is a shared contact, information about the contact. location (:class:`telegram.Location`, optional): Message is a shared location, information about the location. venue (:class:`telegram.Venue`, optional): Message is a venue, information about the venue. left_chat_member (:class:`telegram.User`, optional): A member was removed from the group, information about them (this member may be the bot itself). new_chat_title (:obj:`str`, optional): A chat title was changed to this value. new_chat_photo (List[:class:`telegram.PhotoSize`], optional): A chat photo was change to this value. delete_chat_photo (:obj:`bool`, optional): Service message: The chat photo was deleted. group_chat_created (:obj:`bool`, optional): Service message: The group has been created. supergroup_chat_created (:obj:`bool`, optional): Service message: The supergroup has been created. This field can't be received in a message coming through updates, because bot can't be a member of a supergroup when it is created. It can only be found in :attr:`reply_to_message` if someone replies to a very first message in a directly created supergroup. channel_chat_created (:obj:`bool`, optional): Service message: The channel has been created. This field can't be received in a message coming through updates, because bot can't be a member of a channel when it is created. It can only be found in attr:`reply_to_message` if someone replies to a very first message in a channel. migrate_to_chat_id (:obj:`int`, optional): The group has been migrated to a supergroup with the specified identifier. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. migrate_from_chat_id (:obj:`int`, optional): The supergroup has been migrated from a group with the specified identifier. This number may be greater than 32 bits and some programming languages may have difficulty/silent defects in interpreting it. But it is smaller than 52 bits, so a signed 64 bit integer or double-precision float type are safe for storing this identifier. pinned_message (:class:`telegram.message`, optional): Specified message was pinned. Note that the Message object in this field will not contain further attr:`reply_to_message` fields even if it is itself a reply. invoice (:class:`telegram.Invoice`, optional): Message is an invoice for a payment, information about the invoice. successful_payment (:class:`telegram.SuccessfulPayment`, optional): Message is a service message about a successful payment, information about the payment. connected_website (:obj:`str`, optional): The domain name of the website on which the user has logged in. forward_signature (:obj:`str`, optional): Signature of the post author for messages forwarded from channels. author_signature (:obj:`str`, optional): Signature of the post author for messages in channels. passport_data (:class:`telegram.PassportData`, optional): Telegram Passport data """ _effective_attachment = _UNDEFINED ATTACHMENT_TYPES = ['audio', 'game', 'animation', 'document', 'photo', 'sticker', 'video', 'voice', 'video_note', 'contact', 'location', 'venue', 'invoice', 'successful_payment'] MESSAGE_TYPES = ['text', 'new_chat_members', 'left_chat_member', 'new_chat_title', 'new_chat_photo', 'delete_chat_photo', 'group_chat_created', 'supergroup_chat_created', 'channel_chat_created', 'migrate_to_chat_id', 'migrate_from_chat_id', 'pinned_message', 'passport_data'] + ATTACHMENT_TYPES def __init__(self, message_id, from_user, date, chat, forward_from=None, forward_from_chat=None, forward_from_message_id=None, forward_date=None, reply_to_message=None, edit_date=None, text=None, entities=None, caption_entities=None, audio=None, document=None, game=None, photo=None, sticker=None, video=None, voice=None, video_note=None, new_chat_members=None, caption=None, contact=None, location=None, venue=None, left_chat_member=None, new_chat_title=None, new_chat_photo=None, delete_chat_photo=False, group_chat_created=False, supergroup_chat_created=False, channel_chat_created=False, migrate_to_chat_id=None, migrate_from_chat_id=None, pinned_message=None, invoice=None, successful_payment=None, forward_signature=None, author_signature=None, media_group_id=None, connected_website=None, animation=None, passport_data=None, bot=None, **kwargs): # Required self.message_id = int(message_id) self.from_user = from_user self.date = date self.chat = chat # Optionals self.forward_from = forward_from self.forward_from_chat = forward_from_chat self.forward_date = forward_date self.reply_to_message = reply_to_message self.edit_date = edit_date self.text = text self.entities = entities or list() self.caption_entities = caption_entities or list() self.audio = audio self.game = game self.document = document self.photo = photo or list() self.sticker = sticker self.video = video self.voice = voice self.video_note = video_note self.caption = caption self.contact = contact self.location = location self.venue = venue self.new_chat_members = new_chat_members or list() self.left_chat_member = left_chat_member self.new_chat_title = new_chat_title self.new_chat_photo = new_chat_photo or list() self.delete_chat_photo = bool(delete_chat_photo) self.group_chat_created = bool(group_chat_created) self.supergroup_chat_created = bool(supergroup_chat_created) self.migrate_to_chat_id = migrate_to_chat_id self.migrate_from_chat_id = migrate_from_chat_id self.channel_chat_created = bool(channel_chat_created) self.pinned_message = pinned_message self.forward_from_message_id = forward_from_message_id self.invoice = invoice self.successful_payment = successful_payment self.connected_website = connected_website self.forward_signature = forward_signature self.author_signature = author_signature self.media_group_id = media_group_id self.animation = animation self.passport_data = passport_data self.bot = bot self._id_attrs = (self.message_id,) @property def chat_id(self): """:obj:`int`: Shortcut for :attr:`telegram.Chat.id` for :attr:`chat`.""" return self.chat.id @property def link(self): """:obj:`str`: Convenience property. If the chat of the message is a supergroup or a channel and has a :attr:`Chat.username`, returns a t.me link of the message.""" if self.chat.type in (Chat.SUPERGROUP, Chat.CHANNEL) and self.chat.username: return "https://t.me/{}/{}".format(self.chat.username, self.message_id) return None @classmethod def de_json(cls, data, bot): if not data: return None data = super(Message, cls).de_json(data, bot) data['from_user'] = User.de_json(data.get('from'), bot) data['date'] = from_timestamp(data['date']) data['chat'] = Chat.de_json(data.get('chat'), bot) data['entities'] = MessageEntity.de_list(data.get('entities'), bot) data['caption_entities'] = MessageEntity.de_list(data.get('caption_entities'), bot) data['forward_from'] = User.de_json(data.get('forward_from'), bot) data['forward_from_chat'] = Chat.de_json(data.get('forward_from_chat'), bot) data['forward_date'] = from_timestamp(data.get('forward_date')) data['reply_to_message'] = Message.de_json(data.get('reply_to_message'), bot) data['edit_date'] = from_timestamp(data.get('edit_date')) data['audio'] = Audio.de_json(data.get('audio'), bot) data['document'] = Document.de_json(data.get('document'), bot) data['animation'] = Animation.de_json(data.get('animation'), bot) data['game'] = Game.de_json(data.get('game'), bot) data['photo'] = PhotoSize.de_list(data.get('photo'), bot) data['sticker'] = Sticker.de_json(data.get('sticker'), bot) data['video'] = Video.de_json(data.get('video'), bot) data['voice'] = Voice.de_json(data.get('voice'), bot) data['video_note'] = VideoNote.de_json(data.get('video_note'), bot) data['contact'] = Contact.de_json(data.get('contact'), bot) data['location'] = Location.de_json(data.get('location'), bot) data['venue'] = Venue.de_json(data.get('venue'), bot) data['new_chat_members'] = User.de_list(data.get('new_chat_members'), bot) data['left_chat_member'] = User.de_json(data.get('left_chat_member'), bot) data['new_chat_photo'] = PhotoSize.de_list(data.get('new_chat_photo'), bot) data['pinned_message'] = Message.de_json(data.get('pinned_message'), bot) data['invoice'] = Invoice.de_json(data.get('invoice'), bot) data['successful_payment'] = SuccessfulPayment.de_json(data.get('successful_payment'), bot) data['passport_data'] = PassportData.de_json(data.get('passport_data'), bot) return cls(bot=bot, **data) @property def effective_attachment(self): """ :class:`telegram.Audio` or :class:`telegram.Contact` or :class:`telegram.Document` or :class:`telegram.Animation` or :class:`telegram.Game` or :class:`telegram.Invoice` or :class:`telegram.Location` or List[:class:`telegram.PhotoSize`] or :class:`telegram.Sticker` or :class:`telegram.SuccessfulPayment` or :class:`telegram.Venue` or :class:`telegram.Video` or :class:`telegram.VideoNote` or :class:`telegram.Voice`: The attachment that this message was sent with. May be ``None`` if no attachment was sent. """ if self._effective_attachment is not _UNDEFINED: return self._effective_attachment for i in Message.ATTACHMENT_TYPES: if getattr(self, i, None): self._effective_attachment = getattr(self, i) break else: self._effective_attachment = None return self._effective_attachment def __getitem__(self, item): if item in self.__dict__.keys(): return self.__dict__[item] elif item == 'chat_id': return self.chat.id def to_dict(self): data = super(Message, self).to_dict() # Required data['date'] = to_timestamp(self.date) # Optionals if self.forward_date: data['forward_date'] = to_timestamp(self.forward_date) if self.edit_date: data['edit_date'] = to_timestamp(self.edit_date) if self.photo: data['photo'] = [p.to_dict() for p in self.photo] if self.entities: data['entities'] = [e.to_dict() for e in self.entities] if self.caption_entities: data['caption_entities'] = [e.to_dict() for e in self.caption_entities] if self.new_chat_photo: data['new_chat_photo'] = [p.to_dict() for p in self.new_chat_photo] if self.new_chat_members: data['new_chat_members'] = [u.to_dict() for u in self.new_chat_members] return data def _quote(self, kwargs): """Modify kwargs for replying with or without quoting.""" if 'reply_to_message_id' in kwargs: if 'quote' in kwargs: del kwargs['quote'] elif 'quote' in kwargs: if kwargs['quote']: kwargs['reply_to_message_id'] = self.message_id del kwargs['quote'] else: if self.chat.type != Chat.PRIVATE: kwargs['reply_to_message_id'] = self.message_id def reply_text(self, *args, **kwargs): """Shortcut for:: bot.send_message(update.message.chat_id, *args, **kwargs) Keyword Args: quote (:obj:`bool`, optional): If set to ``True``, the message is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: ``True`` in group chats and ``False`` in private chats. """ self._quote(kwargs) return self.bot.send_message(self.chat_id, *args, **kwargs) def reply_markdown(self, *args, **kwargs): """Shortcut for:: bot.send_message(update.message.chat_id, parse_mode=ParseMode.MARKDOWN, *args, **kwargs) Sends a message with markdown formatting. Keyword Args: quote (:obj:`bool`, optional): If set to ``True``, the message is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: ``True`` in group chats and ``False`` in private chats. """ kwargs['parse_mode'] = ParseMode.MARKDOWN self._quote(kwargs) return self.bot.send_message(self.chat_id, *args, **kwargs) def reply_html(self, *args, **kwargs): """Shortcut for:: bot.send_message(update.message.chat_id, parse_mode=ParseMode.HTML, *args, **kwargs) Sends a message with HTML formatting. Keyword Args: quote (:obj:`bool`, optional): If set to ``True``, the message is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: ``True`` in group chats and ``False`` in private chats. """ kwargs['parse_mode'] = ParseMode.HTML self._quote(kwargs) return self.bot.send_message(self.chat_id, *args, **kwargs) def reply_media_group(self, *args, **kwargs): """Shortcut for:: bot.reply_media_group(update.message.chat_id, *args, **kwargs) Keyword Args: quote (:obj:`bool`, optional): If set to ``True``, the media group is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: ``True`` in group chats and ``False`` in private chats. Returns: List[:class:`telegram.Message`]: An array of the sent Messages. Raises: :class:`telegram.TelegramError` """ self._quote(kwargs) return self.bot.send_media_group(self.chat_id, *args, **kwargs) def reply_photo(self, *args, **kwargs): """Shortcut for:: bot.send_photo(update.message.chat_id, *args, **kwargs) Keyword Args: quote (:obj:`bool`, optional): If set to ``True``, the photo is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: ``True`` in group chats and ``False`` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ self._quote(kwargs) return self.bot.send_photo(self.chat_id, *args, **kwargs) def reply_audio(self, *args, **kwargs): """Shortcut for:: bot.send_audio(update.message.chat_id, *args, **kwargs) Keyword Args: quote (:obj:`bool`, optional): If set to ``True``, the photo is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: ``True`` in group chats and ``False`` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ self._quote(kwargs) return self.bot.send_audio(self.chat_id, *args, **kwargs) def reply_document(self, *args, **kwargs): """Shortcut for:: bot.send_document(update.message.chat_id, *args, **kwargs) Keyword Args: quote (:obj:`bool`, optional): If set to ``True``, the photo is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: ``True`` in group chats and ``False`` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ self._quote(kwargs) return self.bot.send_document(self.chat_id, *args, **kwargs) def reply_animation(self, *args, **kwargs): """Shortcut for:: bot.send_animation(update.message.chat_id, *args, **kwargs) Keyword Args: quote (:obj:`bool`, optional): If set to ``True``, the photo is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: ``True`` in group chats and ``False`` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ self._quote(kwargs) return self.bot.send_animation(self.chat_id, *args, **kwargs) def reply_sticker(self, *args, **kwargs): """Shortcut for:: bot.send_sticker(update.message.chat_id, *args, **kwargs) Keyword Args: quote (:obj:`bool`, optional): If set to ``True``, the photo is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: ``True`` in group chats and ``False`` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ self._quote(kwargs) return self.bot.send_sticker(self.chat_id, *args, **kwargs) def reply_video(self, *args, **kwargs): """Shortcut for:: bot.send_video(update.message.chat_id, *args, **kwargs) Keyword Args: quote (:obj:`bool`, optional): If set to ``True``, the photo is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: ``True`` in group chats and ``False`` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ self._quote(kwargs) return self.bot.send_video(self.chat_id, *args, **kwargs) def reply_video_note(self, *args, **kwargs): """Shortcut for:: bot.send_video_note(update.message.chat_id, *args, **kwargs) Keyword Args: quote (:obj:`bool`, optional): If set to ``True``, the photo is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: ``True`` in group chats and ``False`` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ self._quote(kwargs) return self.bot.send_video_note(self.chat_id, *args, **kwargs) def reply_voice(self, *args, **kwargs): """Shortcut for:: bot.send_voice(update.message.chat_id, *args, **kwargs) Keyword Args: quote (:obj:`bool`, optional): If set to ``True``, the photo is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: ``True`` in group chats and ``False`` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ self._quote(kwargs) return self.bot.send_voice(self.chat_id, *args, **kwargs) def reply_location(self, *args, **kwargs): """Shortcut for:: bot.send_location(update.message.chat_id, *args, **kwargs) Keyword Args: quote (:obj:`bool`, optional): If set to ``True``, the photo is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: ``True`` in group chats and ``False`` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ self._quote(kwargs) return self.bot.send_location(self.chat_id, *args, **kwargs) def reply_venue(self, *args, **kwargs): """Shortcut for:: bot.send_venue(update.message.chat_id, *args, **kwargs) Keyword Args: quote (:obj:`bool`, optional): If set to ``True``, the photo is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: ``True`` in group chats and ``False`` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ self._quote(kwargs) return self.bot.send_venue(self.chat_id, *args, **kwargs) def reply_contact(self, *args, **kwargs): """Shortcut for:: bot.send_contact(update.message.chat_id, *args, **kwargs) Keyword Args: quote (:obj:`bool`, optional): If set to ``True``, the photo is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: ``True`` in group chats and ``False`` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. """ self._quote(kwargs) return self.bot.send_contact(self.chat_id, *args, **kwargs) def forward(self, chat_id, disable_notification=False): """Shortcut for:: bot.forward_message(chat_id=chat_id, from_chat_id=update.message.chat_id, disable_notification=disable_notification, message_id=update.message.message_id) Returns: :class:`telegram.Message`: On success, instance representing the message forwarded. """ return self.bot.forward_message( chat_id=chat_id, from_chat_id=self.chat_id, disable_notification=disable_notification, message_id=self.message_id) def edit_text(self, *args, **kwargs): """Shortcut for:: bot.edit_message_text(chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs) Note: You can only edit messages that the bot sent itself, therefore this method can only be used on the return value of the ``bot.send_*`` family of methods. Returns: :class:`telegram.Message`: On success, instance representing the edited message. """ return self.bot.edit_message_text( chat_id=self.chat_id, message_id=self.message_id, *args, **kwargs) def edit_caption(self, *args, **kwargs): """Shortcut for:: bot.edit_message_caption(chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs) Note: You can only edit messages that the bot sent itself, therefore this method can only be used on the return value of the ``bot.send_*`` family of methods. Returns: :class:`telegram.Message`: On success, instance representing the edited message. """ return self.bot.edit_message_caption( chat_id=self.chat_id, message_id=self.message_id, *args, **kwargs) def edit_media(self, media, *args, **kwargs): """Shortcut for:: bot.edit_message_media(chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs) Note: You can only edit messages that the bot sent itself, therefore this method can only be used on the return value of the ``bot.send_*`` family of methods. Returns: :class:`telegram.Message`: On success, instance representing the edited message. """ return self.bot.edit_message_media( chat_id=self.chat_id, message_id=self.message_id, media=media, *args, **kwargs) def edit_reply_markup(self, *args, **kwargs): """Shortcut for:: bot.edit_message_reply_markup(chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs) Note: You can only edit messages that the bot sent itself, therefore this method can only be used on the return value of the ``bot.send_*`` family of methods. Returns: :class:`telegram.Message`: On success, instance representing the edited message. """ return self.bot.edit_message_reply_markup( chat_id=self.chat_id, message_id=self.message_id, *args, **kwargs) def delete(self, *args, **kwargs): """Shortcut for:: bot.delete_message(chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs) Returns: :obj:`bool`: On success, ``True`` is returned. """ return self.bot.delete_message( chat_id=self.chat_id, message_id=self.message_id, *args, **kwargs) def parse_entity(self, entity): """Returns the text from a given :class:`telegram.MessageEntity`. Note: This method is present because Telegram calculates the offset and length in UTF-16 codepoint pairs, which some versions of Python don't handle automatically. (That is, you can't just slice ``Message.text`` with the offset and length.) Args: entity (:class:`telegram.MessageEntity`): The entity to extract the text from. It must be an entity that belongs to this message. Returns: :obj:`str`: The text of the given entity """ # Is it a narrow build, if so we don't need to convert if sys.maxunicode == 0xffff: return self.text[entity.offset:entity.offset + entity.length] else: entity_text = self.text.encode('utf-16-le') entity_text = entity_text[entity.offset * 2:(entity.offset + entity.length) * 2] return entity_text.decode('utf-16-le') def parse_caption_entity(self, entity): """Returns the text from a given :class:`telegram.MessageEntity`. Note: This method is present because Telegram calculates the offset and length in UTF-16 codepoint pairs, which some versions of Python don't handle automatically. (That is, you can't just slice ``Message.caption`` with the offset and length.) Args: entity (:class:`telegram.MessageEntity`): The entity to extract the text from. It must be an entity that belongs to this message. Returns: :obj:`str`: The text of the given entity """ # Is it a narrow build, if so we don't need to convert if sys.maxunicode == 0xffff: return self.caption[entity.offset:entity.offset + entity.length] else: entity_text = self.caption.encode('utf-16-le') entity_text = entity_text[entity.offset * 2:(entity.offset + entity.length) * 2] return entity_text.decode('utf-16-le') def parse_entities(self, types=None): """ Returns a :obj:`dict` that maps :class:`telegram.MessageEntity` to :obj:`str`. It contains entities from this message filtered by their :attr:`telegram.MessageEntity.type` attribute as the key, and the text that each entity belongs to as the value of the :obj:`dict`. Note: This method should always be used instead of the :attr:`entities` attribute, since it calculates the correct substring from the message text based on UTF-16 codepoints. See :attr:`parse_entity` for more info. Args: types (List[:obj:`str`], optional): List of :class:`telegram.MessageEntity` types as strings. If the ``type`` attribute of an entity is contained in this list, it will be returned. Defaults to a list of all types. All types can be found as constants in :class:`telegram.MessageEntity`. Returns: Dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to the text that belongs to them, calculated based on UTF-16 codepoints. """ if types is None: types = MessageEntity.ALL_TYPES return { entity: self.parse_entity(entity) for entity in self.entities if entity.type in types } def parse_caption_entities(self, types=None): """ Returns a :obj:`dict` that maps :class:`telegram.MessageEntity` to :obj:`str`. It contains entities from this message's caption filtered by their :attr:`telegram.MessageEntity.type` attribute as the key, and the text that each entity belongs to as the value of the :obj:`dict`. Note: This method should always be used instead of the :attr:`caption_entities` attribute, since it calculates the correct substring from the message text based on UTF-16 codepoints. See :attr:`parse_entity` for more info. Args: types (List[:obj:`str`], optional): List of :class:`telegram.MessageEntity` types as strings. If the ``type`` attribute of an entity is contained in this list, it will be returned. Defaults to a list of all types. All types can be found as constants in :class:`telegram.MessageEntity`. Returns: Dict[:class:`telegram.MessageEntity`, :obj:`str`]: A dictionary of entities mapped to the text that belongs to them, calculated based on UTF-16 codepoints. """ if types is None: types = MessageEntity.ALL_TYPES return { entity: self.parse_caption_entity(entity) for entity in self.caption_entities if entity.type in types } @staticmethod def _parse_html(message_text, entities, urled=False): if message_text is None: return None if not sys.maxunicode == 0xffff: message_text = message_text.encode('utf-16-le') html_text = '' last_offset = 0 for entity, text in sorted(entities.items(), key=(lambda item: item[0].offset)): text = escape(text) if entity.type == MessageEntity.TEXT_LINK: insert = '{}'.format(entity.url, text) elif entity.type == MessageEntity.TEXT_MENTION and entity.user: insert = '{}'.format(entity.user.id, text) elif entity.type == MessageEntity.URL and urled: insert = '{0}'.format(text) elif entity.type == MessageEntity.BOLD: insert = '' + text + '' elif entity.type == MessageEntity.ITALIC: insert = '' + text + '' elif entity.type == MessageEntity.CODE: insert = '' + text + '' elif entity.type == MessageEntity.PRE: insert = '
' + text + '
' else: insert = text if sys.maxunicode == 0xffff: html_text += escape(message_text[last_offset:entity.offset]) + insert else: html_text += escape(message_text[last_offset * 2:entity.offset * 2] .decode('utf-16-le')) + insert last_offset = entity.offset + entity.length if sys.maxunicode == 0xffff: html_text += escape(message_text[last_offset:]) else: html_text += escape(message_text[last_offset * 2:].decode('utf-16-le')) return html_text @property def text_html(self): """Creates an HTML-formatted string from the markup entities found in the message. Use this if you want to retrieve the message text with the entities formatted as HTML in the same way the original message was formatted. Returns: :obj:`str`: Message text with entities formatted as HTML. """ return self._parse_html(self.text, self.parse_entities(), urled=False) @property def text_html_urled(self): """Creates an HTML-formatted string from the markup entities found in the message. Use this if you want to retrieve the message text with the entities formatted as HTML. This also formats :attr:`telegram.MessageEntity.URL` as a hyperlink. Returns: :obj:`str`: Message text with entities formatted as HTML. """ return self._parse_html(self.text, self.parse_entities(), urled=True) @property def caption_html(self): """Creates an HTML-formatted string from the markup entities found in the message's caption. Use this if you want to retrieve the message caption with the caption entities formatted as HTML in the same way the original message was formatted. Returns: :obj:`str`: Message caption with captionentities formatted as HTML. """ return self._parse_html(self.caption, self.parse_caption_entities(), urled=False) @property def caption_html_urled(self): """Creates an HTML-formatted string from the markup entities found in the message's caption. Use this if you want to retrieve the message caption with the caption entities formatted as HTML. This also formats :attr:`telegram.MessageEntity.URL` as a hyperlink. Returns: :obj:`str`: Message caption with caption entities formatted as HTML. """ return self._parse_html(self.caption, self.parse_caption_entities(), urled=True) @staticmethod def _parse_markdown(message_text, entities, urled=False): if message_text is None: return None if not sys.maxunicode == 0xffff: message_text = message_text.encode('utf-16-le') markdown_text = '' last_offset = 0 for entity, text in sorted(entities.items(), key=(lambda item: item[0].offset)): text = escape_markdown(text) if entity.type == MessageEntity.TEXT_LINK: insert = '[{}]({})'.format(text, entity.url) elif entity.type == MessageEntity.TEXT_MENTION and entity.user: insert = '[{}](tg://user?id={})'.format(text, entity.user.id) elif entity.type == MessageEntity.URL and urled: insert = '[{0}]({0})'.format(text) elif entity.type == MessageEntity.BOLD: insert = '*' + text + '*' elif entity.type == MessageEntity.ITALIC: insert = '_' + text + '_' elif entity.type == MessageEntity.CODE: insert = '`' + text + '`' elif entity.type == MessageEntity.PRE: insert = '```' + text + '```' else: insert = text if sys.maxunicode == 0xffff: markdown_text += escape_markdown(message_text[last_offset:entity.offset]) + insert else: markdown_text += escape_markdown(message_text[last_offset * 2:entity.offset * 2] .decode('utf-16-le')) + insert last_offset = entity.offset + entity.length if sys.maxunicode == 0xffff: markdown_text += escape_markdown(message_text[last_offset:]) else: markdown_text += escape_markdown(message_text[last_offset * 2:].decode('utf-16-le')) return markdown_text @property def text_markdown(self): """Creates an Markdown-formatted string from the markup entities found in the message. Use this if you want to retrieve the message text with the entities formatted as Markdown in the same way the original message was formatted. Returns: :obj:`str`: Message text with entities formatted as Markdown. """ return self._parse_markdown(self.text, self.parse_entities(), urled=False) @property def text_markdown_urled(self): """Creates an Markdown-formatted string from the markup entities found in the message. Use this if you want to retrieve the message text with the entities formatted as Markdown. This also formats :attr:`telegram.MessageEntity.URL` as a hyperlink. Returns: :obj:`str`: Message text with entities formatted as Markdown. """ return self._parse_markdown(self.text, self.parse_entities(), urled=True) @property def caption_markdown(self): """Creates an Markdown-formatted string from the markup entities found in the message's caption. Use this if you want to retrieve the message caption with the caption entities formatted as Markdown in the same way the original message was formatted. Returns: :obj:`str`: Message caption with caption entities formatted as Markdown. """ return self._parse_markdown(self.caption, self.parse_caption_entities(), urled=False) @property def caption_markdown_urled(self): """Creates an Markdown-formatted string from the markup entities found in the message's caption. Use this if you want to retrieve the message caption with the caption entities formatted as Markdown. This also formats :attr:`telegram.MessageEntity.URL` as a hyperlink. Returns: :obj:`str`: Message caption with caption entities formatted as Markdown. """ return self._parse_markdown(self.caption, self.parse_caption_entities(), urled=True)