U 2tc@sVdZddlZddlZddlmZddlmZmZmZm Z m Z m Z m Z m Z ddlmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZmZm Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0m1Z1ddl2m3Z3m4Z4m5Z5m6Z6m7Z7ddl8m9Z9m:Z:m;Z;mZ>m?Z?m@Z@mAZAmBZBmCZCmDZDmEZEGd d d e ZFdS) zBThis module contains an object that represents a Telegram Message.N)escape) TYPE_CHECKINGAnyDictListOptionalUnionClassVarTuple)# AnimationAudioChatContactDiceDocumentGameInlineKeyboardMarkupInvoiceLocation MessageEntity ParseMode PassportData PhotoSizePollStickerSuccessfulPaymentTelegramObjectUserVenueVideo VideoNoteVoiceVoiceChatStartedVoiceChatEndedVoiceChatParticipantsInvitedProximityAlertTriggered ReplyMarkupMessageAutoDeleteTimerChangedVoiceChatScheduledVideoChatStartedVideoChatEndedVideoChatParticipantsInvited WebAppDataVideoChatScheduled)escape_markdownfrom_timestamp to_timestamp DEFAULT_NONE DEFAULT_20)JSONDict FileInputODVInputDVInput) Bot GameHighScore InputMedia MessageIdInputMediaAudioInputMediaDocumentInputMediaPhotoInputMediaVideo LabeledPricecCseZdZUdZdZddddddd d d d d dddgZeeee d<ddddddddddddddd d!d"d#d$d%d&geZ eeee d'<de e j e eee e e j de j eed*ed*eeeeeeeeeeeeeeeeeeeeeeee e deeeeeeeeeee d+e!ee"e e#e$e%e&e'eee(e)e*e+e,e-d,Ad-d.Z.e/e d/d0d1Z0e/e1ed/d2d3Z2e3e1e4d+e1dd4d5d6Z5e/e6eeeeeeeeeeeeeed(fd/d7d8Z7ee-d9fd:d; Z8e4d/fdd?d@Z:e;e;e;d(d(e;d(e;d(d(d(f eeeeeee=e?ee=e?ee=e?ee=e?e4ee=e?e4ee=e?e e ee=e?eGe4ee=e?eeeeeeeedk r@|6|>kr@td|7dk r`|?dk r`|7|?kr`tdt||_||_|4|_||_||_||_||_||_ |:|_ | |_ | |_ |;|_ | |_| pg|_| pg|_||_||_||_|pg|_||_||_||_||_||_||_||_||_|pg|_||_||_|p2g|_ t!||_"t!||_#t!| |_$|"|_%|#|_&t!|!|_'|8|_(|$|_)||_*|%|_+|&|_,|*|_-|'|_.|.|_/|(|_0|)|_1|+|_2|,|_3|-|_4|1|_5|2|_6|3|_7|/|_8|dk r|>n|6}D|D|_=|D|_>|?dk r8|?n|7}E|E|_?|E|_@|@|_A|0|_BtC|_D|j|jf|_EdS)NzKOnly supply one of `video_chat_scheduled`/`voice_chat_scheduled`, not both.zCOnly supply one of `video_chat_ended`/`voice_chat_ended`, not both.zaOnly supply one of `video_chat_participants_invited`/`voice_chat_participants_invited`, not both.)F ValueErrorintrcrerhrmrFrYrarMrr^r]rrIrSrkrBrHrKrqrZrQrlrtrPrCr[r\rUrprLrbboolrdrNrnrDrXrrrvr`rjrsrGrVrErJrfrOrWr_rorirTrgrArzr~ryr}rwr{rxr|rrRr1rur)FselfrcrmrFrerYrarjrMr^r]rIrSrkrBrKrHrqrZrQrlrtrUrPrCr[r\rprLrbrdrNrnrrrDrXr`rsrGrErfrOrVrWr_rorJrArRrirTrgrhryrwrxrvrzrrr~r}r{r|rrZtemp0Ztemp1Ztemp2Ztemp3r4/tmp/pip-unpacked-wheel-2u9rcp5s/telegram/message.py__init__ sE          zMessage.__init__)returncCs|jjS)zC:obj:`int`: Shortcut for :attr:`telegram.Chat.id` for :attr:`chat`.)rFidrrrrchat_idszMessage.chat_idcCsV|jjtjtjfkrR|jjr&|jj}ndt|jjdd}d|d|jSdS)z:obj:`str`: Convenience property. If the chat of the message is not a private chat or normal group, returns a t.me link of the message. zc/Nz https://t.me//) rFtyper PRIVATEZGROUPusernamestrrrc)rZto_linkrrrlinks  z Message.link)datarRrcCs||}|sdSt|d||d<t|d||d<t|d|d<t|d||d<t|d||d<t|d||d<t|d ||d <t|d ||d <t|d |d <t|d ||d <t|d |d <t |d||d<t |d||d<t |d||d<t |d||d<t |d||d<t|d||d<t|d||d<t|d||d<t|d||d<t|d||d<t|d||d<t|d||d<t|d||d<t|d||d<t |d||d<t|d||d<t|d||d<t|d||d<t|d ||d <t|d!||d!<t|d"||d"<t|d#||d#<t|d$||d$<t|d%||d%<t|d&||d&<t|d'||d'<t|d(||d(<t|d)||d)<t |d*||d*<t|d+||d+<t|d,||d,<t|d-||d-<t |d.||d.<t!|d/||d/<|fd0|i|S)1z,See :meth:`telegram.TelegramObject.de_json`.NfromrerhrmrFrSrkrYrarMr^r]rBrKrWrHrqrZrQrlrtrCr[r\rUrprbrvr`rsrGr_rorirTrgrArzryrwrxr~r}r{r|rrR)"Z _parse_datarde_jsongetr r/rZde_listr@r rr rrrrr!r rrrr'rrrrrr%rr-r)r*r+r,)clsrrRrrrrs zMessage.de_jsoncCsD|jtk r|jStjD] }t||drt|||_q>qd|_|jS)a :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 :obj:`None` if no attachment was sent. N)rur1r@rgetattr)rirrreffective_attachments%    zMessage.effective_attachment)itemrcs|dkr|jjSt|S)Nr)rFrsuper __getitem__)rr __class__rrrDszMessage.__getitem__cst}t|j|d<|jr,t|j|d<|jr@t|j|d<|jrZdd|jD|d<|jrtdd|jD|d<|jrd d|jD|d <|j rd d|j D|d <|j rd d|j D|d<|S)z,See :meth:`telegram.TelegramObject.to_dict`.rmrMr]cSsg|] }|qSrto_dict.0prrr Ssz#Message.to_dict..rqcSsg|] }|qSrrrerrrrUsrScSsg|] }|qSrrrrrrrWsrkcSsg|] }|qSrrrrrrrYsrbcSsg|] }|qSrr)rurrrr[srU) rrr0rmrMr]rqrSrkrbrU)rrrrrrGs" zMessage.to_dict)quotereply_to_message_idrcCs\|dk r |S|dk r |rX|jSn8|jjr4|jjj}nd}|dkrN|jjtjksR|rX|jSdS)z3Modify kwargs for replying with or without quoting.N)rcrRdefaultsrrFrr r)rrrZ default_quoterrr_quote_s zMessage._quote)r.) rI parse_modedisable_web_page_previewdisable_notificationrrAtimeout api_kwargsallow_sending_without_replyrSrprotect_contentrc Cs2|| |}|jj|j||||||||| | | d S)aShortcut for:: bot.send_message(update.effective_message.chat_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_message`. Args: quote (:obj:`bool`, optional): If set to :obj:`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: :obj:`True` in group chats and :obj:`False` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. rrIrrrrrArrrrSr)rrR send_messager) rrIrrrrrArrrrSrrrrr reply_textrs zMessage.reply_text) rIrrrrArrrrSrrrc Cs4|| |}|jj|j|tj|||||||| | d S)aShortcut for:: bot.send_message( update.effective_message.chat_id, parse_mode=ParseMode.MARKDOWN, *args, **kwargs, ) Sends a message with Markdown version 1 formatting. For the documentation of the arguments, please see :meth:`telegram.Bot.send_message`. Note: :attr:`telegram.ParseMode.MARKDOWN` is a legacy mode, retained by Telegram for backward compatibility. You should use :meth:`reply_markdown_v2` instead. Args: quote (:obj:`bool`, optional): If set to :obj:`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: :obj:`True` in group chats and :obj:`False` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. r)rrRrrrZMARKDOWN rrIrrrrArrrrSrrrrrreply_markdowns( zMessage.reply_markdownc Cs4|| |}|jj|j|tj|||||||| | d S)a8Shortcut for:: bot.send_message( update.effective_message.chat_id, parse_mode=ParseMode.MARKDOWN_V2, *args, **kwargs, ) Sends a message with markdown version 2 formatting. For the documentation of the arguments, please see :meth:`telegram.Bot.send_message`. Args: quote (:obj:`bool`, optional): If set to :obj:`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: :obj:`True` in group chats and :obj:`False` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. r)rrRrrrZ MARKDOWN_V2rrrrreply_markdown_v2s$ zMessage.reply_markdown_v2c Cs4|| |}|jj|j|tj|||||||| | d S)a#Shortcut for:: bot.send_message( update.effective_message.chat_id, parse_mode=ParseMode.HTML, *args, **kwargs, ) Sends a message with HTML formatting. For the documentation of the arguments, please see :meth:`telegram.Bot.send_message`. Args: quote (:obj:`bool`, optional): If set to :obj:`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: :obj:`True` in group chats and :obj:`False` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. r)rrRrrrZHTMLrrrr reply_html s$ zMessage.reply_html)r;r<r=r>) mediarrrrrrrrc Cs*|||}|jj|j|||||||dS)aShortcut for:: bot.send_media_group(update.effective_message.chat_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_media_group`. Args: quote (:obj:`bool`, optional): If set to :obj:`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: :obj:`True` in group chats and :obj:`False` in private chats. Returns: List[:class:`telegram.Message`]: An array of the sent Messages. Raises: :class:`telegram.error.TelegramError` )rrrrrrrr)rrRZsend_media_groupr) rrrrrrrrrrrrreply_media_groupAs zMessage.reply_media_groupr)rqrPrrrArrrrrkfilenamerrrcCs4|| |}|jj|j||||||||| | | | d S)aShortcut for:: bot.send_photo(update.effective_message.chat_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_photo`. Args: quote (:obj:`bool`, optional): If set to :obj:`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: :obj:`True` in group chats and :obj:`False` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. ) rrqrPrrrArrrrrkrr)rrRZ send_photor)rrqrPrrrArrrrrkrrrrrr reply_photols zMessage.reply_photor )rBduration performertitlerPrrrArrthumbrrrkrrrrcCs<|||}|jj|j||||||||| | | | | |||dS)aShortcut for:: bot.send_audio(update.effective_message.chat_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_audio`. Args: quote (:obj:`bool`, optional): If set to :obj:`True`, the audio is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. )rrBrrrrPrrrArrrrrrkrr)rrRZ send_audior)rrBrrrrPrrrArrrrrrkrrrrrr reply_audios($ zMessage.reply_audior)rKrrPrrrArrrrdisable_content_type_detectionrrkrrrcCs8|||}|jj|j||||||||| | | | | |dS)aShortcut for:: bot.send_document(update.effective_message.chat_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_document`. Args: quote (:obj:`bool`, optional): If set to :obj:`True`, the document is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. )rrKrrPrrrArrrrrrrkr)rrRZ send_documentr)rrKrrPrrrArrrrrrrkrrrrrreply_documents$" zMessage.reply_documentr )rWrwidthheightrrPrrrrArrrrkrrrrcCs<||| } |jj|j||||||||| | | | | |||dS)aShortcut for:: bot.send_animation(update.effective_message.chat_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_animation`. Args: quote (:obj:`bool`, optional): If set to :obj:`True`, the animation is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. )rrWrrrrrPrrrrArrrrkrr)rrRZsend_animationr)rrWrrrrrPrrrrArrrrkrrrrrrreply_animation s($ zMessage.reply_animationr) rZrrrArrrrrrc Cs,|||}|jj|j|||||||| d S)aShortcut for:: bot.send_sticker(update.effective_message.chat_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_sticker`. Args: quote (:obj:`bool`, optional): If set to :obj:`True`, the sticker is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. ) rrZrrrArrrr)rrRZ send_stickerr) rrZrrrArrrrrrrr reply_stickerDs zMessage.reply_stickerr)rQrrPrrrArrrrsupports_streamingrrrrkrrrrcCs>|||}|jj|j||||||||| | | | | ||||dS)aShortcut for:: bot.send_video(update.effective_message.chat_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_video`. Args: quote (:obj:`bool`, optional): If set to :obj:`True`, the video is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. )rrQrrPrrrArrrrrrrrrkrr)rrRZ send_videor)rrQrrPrrrArrrrrrrrrkrrrrrr reply_videoms*% zMessage.reply_videor )rtrlengthrrrArrrrrrrrcCs4|| |}|jj|j||||||||| | | | d S)aShortcut for:: bot.send_video_note(update.effective_message.chat_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_video_note`. Args: quote (:obj:`bool`, optional): If set to :obj:`True`, the video note is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. ) rrtrrrrrArrrrrr)rrRZsend_video_noter)rrtrrrrrArrrrrrrrrrreply_video_notes zMessage.reply_video_noter!)rlrrPrrrArrrrrkrrrrcCs6|| |}|jj|j||||||||| | | | |dS)aShortcut for:: bot.send_voice(update.effective_message.chat_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_voice`. Args: quote (:obj:`bool`, optional): If set to :obj:`True`, the voice note is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. )rrlrrPrrrArrrrrkrr)rrRZ send_voicer)rrlrrPrrrArrrrrkrrrrrr reply_voices"! zMessage.reply_voice)latitude longituderrrArr[ live_periodrhorizontal_accuracyheadingproximity_alert_radiusrrrrcCs8|||}|jj|j||||||||| | | | | |dS)aShortcut for:: bot.send_location(update.effective_message.chat_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_location`. Args: quote (:obj:`bool`, optional): If set to :obj:`True`, the location is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. )rrrrrrArr[rrrrrrr)rrRZ send_locationr)rrrrrrArr[rrrrrrrrrrrreply_location s$" zMessage.reply_location)rrraddress foursquare_idrrrArr\foursquare_typergoogle_place_idgoogle_place_typerrrrcCs<|||}|jj|j||||||||| | | | | |||dS)aShortcut for:: bot.send_venue(update.effective_message.chat_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_venue`. Args: quote (:obj:`bool`, optional): If set to :obj:`True`, the venue is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. )rrrrrrrrrArr\rrrrrr)rrRZ send_venuer)rrrrrrrrrArr\rrrrrrrrrr reply_venueAs($ zMessage.reply_venue) phone_number first_name last_namerrrArrCvcardrrrrrcCs4|| |}|jj|j||||||||| | | | d S)aShortcut for:: bot.send_contact(update.effective_message.chat_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_contact`. Args: quote (:obj:`bool`, optional): If set to :obj:`True`, the contact is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. ) rrrrrrrArrCrrrr)rrRZ send_contactr)rrrrrrrArrCrrrrrrrr reply_contactzs zMessage.reply_contactT)questionoptions is_anonymousrallows_multiple_answerscorrect_option_id is_closedrrrAr explanationexplanation_parse_mode open_period close_daterrexplanation_entitiesrrrcCsB||| } |jj|j||||||||| | | | | ||||||dS)aShortcut for:: bot.send_poll(update.effective_message.chat_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_poll`. Args: quote (:obj:`bool`, optional): If set to :obj:`True`, the poll is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. )rrrrrrrrrrrArrrrrrrrr)rrRZ send_pollr)rrrrrrrrrrrArrrrrrrrrrrrr reply_polls.' zMessage.reply_poll) rrrAremojirrrrrc Cs,|||}|jj|j|||||||| d S)aShortcut for:: bot.send_dice(update.effective_message.chat_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_dice`. Args: quote (:obj:`bool`, optional): If set to :obj:`True`, the dice is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. ) rrrrArrrrr)rrRZ send_dicer) rrrrArrrrrrrrr reply_dices zMessage.reply_dice)actionrrrcCs|jj|j|||dS)a@Shortcut for:: bot.send_chat_action(update.effective_message.chat_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_chat_action`. .. versionadded:: 13.2 Returns: :obj:`bool`: On success, :obj:`True` is returned. )rrrr)rRZsend_chat_actionr)rrrrrrrreply_chat_actions zMessage.reply_chat_actionr) game_short_namerrrArrrrrrc Cs,|||}|jj|j|||||||| d S)aShortcut for:: bot.send_game(update.effective_message.chat_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_game`. Args: quote (:obj:`bool`, optional): If set to :obj:`True`, the game is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats. .. versionadded:: 13.2 Returns: :class:`telegram.Message`: On success, instance representing the message posted. ) rrrrrArrrr)rrRZ send_gamer) rrrrrArrrrrrrr reply_game,s zMessage.reply_gamer?)r descriptionpayloadprovider_tokencurrencypricesstart_parameter photo_url photo_size photo_width photo_height need_nameneed_phone_number need_emailneed_shipping_address is_flexiblerrrA provider_datasend_phone_number_to_providersend_email_to_providerrrrrmax_tip_amountsuggested_tip_amountsrrcCsT|||}|jj|j||||||||| | | | | |||||||||||||||dS)aShortcut for:: bot.send_invoice(update.effective_message.chat_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_invoice`. Warning: As of API 5.2 :attr:`start_parameter` is an optional argument and therefore the order of the arguments had to be changed. Use keyword arguments to make sure that the arguments are passed correctly. .. versionadded:: 13.2 .. versionchanged:: 13.5 As of Bot API 5.2, the parameter :attr:`start_parameter` is optional. Args: quote (:obj:`bool`, optional): If set to :obj:`True`, the invoice is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats. Returns: :class:`telegram.Message`: On success, instance representing the message posted. )rrrrrrrrrrrrrrrrrrrrArrr rrrr r r)rrRZ send_invoicer)rrrrrrrrrrrrrrrrrrrrArrr rrrrr r rrrr reply_invoiceWs@: zMessage.reply_invoice)rrrrrrc Cs|jj||j|j||||dS)aShortcut for:: bot.forward_message(chat_id=chat_id, from_chat_id=update.effective_message.chat_id, message_id=update.effective_message.message_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.forward_message`. Note: Since the release of Bot API 5.5 it can be impossible to forward messages from some chats. Use the attributes :attr:`telegram.Message.has_protected_content` and :attr:`telegram.Chat.has_protected_content` to check this. As a workaround, it is still possible to use :meth:`copy`. However, this behaviour is undocumented and might be changed by Telegram. Returns: :class:`telegram.Message`: On success, instance representing the message forwarded. )r from_chat_idrcrrrr)rRZforward_messagerrc)rrrrrrrrrforwardszMessage.forwardr:) rrPrrkrrrrArrrrc Cs*|jj||j|j|||||||| | | d S)aShortcut for:: bot.copy_message(chat_id=chat_id, from_chat_id=update.effective_message.chat_id, message_id=update.effective_message.message_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.copy_message`. Returns: :class:`telegram.MessageId`: On success, returns the MessageId of the sent message. rr rcrPrrkrrrrArrr)rR copy_messagerrc) rrrPrrkrrrrArrrrrrcopysz Message.copy)r rcrPrrkrrrrArrrrrcCs4|| |}|jj|j||||||||| | | | d S)aPShortcut for:: bot.copy_message(chat_id=message.chat.id, from_chat_id=from_chat_id, message_id=message_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.copy_message`. Args: quote (:obj:`bool`, optional): If set to :obj:`True`, the copy is sent as an actual reply to this message. If ``reply_to_message_id`` is passed in ``kwargs``, this parameter will be ignored. Default: :obj:`True` in group chats and :obj:`False` in private chats. .. versionadded:: 13.1 Returns: :class:`telegram.MessageId`: On success, returns the MessageId of the sent message. r)rrRrr)rr rcrPrrkrrrrArrrrrrr reply_copys & zMessage.reply_copy)rIrrrArrrSrc Cs$|jj|j|j|||||||dd S)aShortcut for:: bot.edit_message_text(chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.edit_message_text`. Note: You can only edit messages that the bot sent itself (i.e. of the ``bot.send_*`` family of methods) or channel posts, if the bot is an admin in that channel. However, this behaviour is undocumented and might be changed by Telegram. Returns: :class:`telegram.Message`: On success, if edited message is sent by the bot, the edited Message is returned, otherwise ``True`` is returned. N) rrcrIrrrArrrSinline_message_id)rRZedit_message_textrrc)rrIrrrArrrSrrr edit_text=szMessage.edit_text)rPrArrrrkrc Cs"|jj|j|j||||||dd S)a6Shortcut for:: bot.edit_message_caption(chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.edit_message_caption`. Note: You can only edit messages that the bot sent itself (i.e. of the ``bot.send_*`` family of methods) or channel posts, if the bot is an admin in that channel. However, this behaviour is undocumented and might be changed by Telegram. Returns: :class:`telegram.Message`: On success, if edited message is sent by the bot, the edited Message is returned, otherwise ``True`` is returned. N) rrcrPrArrrrkr)rRZedit_message_captionrrc)rrPrArrrrkrrr edit_captiongszMessage.edit_captionr9)rrArrrc Cs|jj|j|j||||ddS)a+Shortcut for:: bot.edit_message_media(chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.edit_message_media`. Note: You can only edit messages that the bot sent itself(i.e. of the ``bot.send_*`` family of methods) or channel posts, if the bot is an admin in that channel. However, this behaviour is undocumented and might be changed by Telegram. Returns: :class:`telegram.Message`: On success, if edited message is sent by the bot, the edited Message is returned, otherwise ``True`` is returned. N)rrcrrArrr)rRZedit_message_mediarrc)rrrArrrrr edit_mediaszMessage.edit_media)rArrrcCs|jj|j|j|||ddS)aNShortcut for:: bot.edit_message_reply_markup(chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.edit_message_reply_markup`. Note: You can only edit messages that the bot sent itself (i.e. of the ``bot.send_*`` family of methods) or channel posts, if the bot is an admin in that channel. However, this behaviour is undocumented and might be changed by Telegram. Returns: :class:`telegram.Message`: On success, if edited message is sent by the bot, the edited Message is returned, otherwise ``True`` is returned. NrrcrArrr)rRZedit_message_reply_markuprrcrrArrrrredit_reply_markupszMessage.edit_reply_markup) rrr[rArrrrrrc Cs(|jj|j|j||||||||| dd S)aVShortcut for:: bot.edit_message_live_location(chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.edit_message_live_location`. Note: You can only edit messages that the bot sent itself (i.e. of the ``bot.send_*`` family of methods) or channel posts, if the bot is an admin in that channel. However, this behaviour is undocumented and might be changed by Telegram. Returns: :class:`telegram.Message`: On success, if edited message is sent by the bot, the edited Message is returned, otherwise :obj:`True` is returned. N) rrcrrr[rArrrrrr)rRZedit_message_live_locationrrc) rrrr[rArrrrrrrredit_live_locationszMessage.edit_live_locationcCs|jj|j|j|||ddS)aVShortcut for:: bot.stop_message_live_location(chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.stop_message_live_location`. Note: You can only edit messages that the bot sent itself (i.e. of the ``bot.send_*`` family of methods) or channel posts, if the bot is an admin in that channel. However, this behaviour is undocumented and might be changed by Telegram. Returns: :class:`telegram.Message`: On success, if edited message is sent by the bot, the edited Message is returned, otherwise :obj:`True` is returned. Nr)rRZstop_message_live_locationrrcrrrrstop_live_location szMessage.stop_live_location)user_idscoreforcedisable_edit_messagerrrc Cs"|jj|j|j||||||dd S)aShortcut for:: bot.set_game_score(chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.set_game_score`. Note: You can only edit messages that the bot sent itself (i.e. of the ``bot.send_*`` family of methods) or channel posts, if the bot is an admin in that channel. However, this behaviour is undocumented and might be changed by Telegram. Returns: :class:`telegram.Message`: On success, if edited message is sent by the bot, the edited Message is returned, otherwise :obj:`True` is returned. N) rrcrrrrrrr)rRset_game_scorerrc)rrrrrrrrrrr ' szMessage.set_game_scorer8)rrrrcCs|jj|j|j|||ddS)aShortcut for:: bot.get_game_high_scores(chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.get_game_high_scores`. Note: You can only edit messages that the bot sent itself (i.e. of the ``bot.send_*`` family of methods) or channel posts, if the bot is an admin in that channel. However, this behaviour is undocumented and might be changed by Telegram. Returns: List[:class:`telegram.GameHighScore`] N)rrcrrrr)rRget_game_high_scoresrrc)rrrrrrrr!N szMessage.get_game_high_scores)rrrcCs|jj|j|j||dS)aShortcut for:: bot.delete_message(chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.delete_message`. Returns: :obj:`bool`: On success, :obj:`True` is returned. rrcrr)rRZdelete_messagerrcrrrrrrdeleteo s zMessage.deletecCs|jj|j|j|||dS)aShortcut for:: bot.stop_poll(chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.stop_poll`. Returns: :class:`telegram.Poll`: On success, the stopped Poll with the final results is returned. )rrcrArr)rR stop_pollrrcrrrrr% szMessage.stop_poll)rrrrcCs|jj|j|j|||dS)aShortcut for:: bot.pin_chat_message(chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.pin_chat_message`. Returns: :obj:`bool`: On success, :obj:`True` is returned. )rrcrrr)rRZpin_chat_messagerrc)rrrrrrrpin sz Message.pincCs|jj|j|j||dS)aShortcut for:: bot.unpin_chat_message(chat_id=message.chat_id, message_id=message.message_id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.unpin_chat_message`. Returns: :obj:`bool`: On success, :obj:`True` is returned. r")rRZunpin_chat_messagerrcr#rrrunpin s z Message.unpin)entityrcCsd|jstdtjdkr0|j|j|j|jS|jd}||jd|j|jd}|dS)aReturns 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. Raises: RuntimeError: If the message has no text. zThis Message has no 'text'. utf-16-le)rI RuntimeErrorsys maxunicodeoffsetrencodedecoderr(Z entity_textrrr parse_entity s  zMessage.parse_entitycCsd|jstdtjdkr0|j|j|j|jS|jd}||jd|j|jd}|dS)aReturns 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. Raises: RuntimeError: If the message has no caption. zThis Message has no 'caption'.r)r*r+)rPr,r-r.r/rr0r1r2rrrparse_caption_entity s  zMessage.parse_caption_entity)typesrcs(dkrtjfddjp"gDS)ai 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. Ncs"i|]}|jkr||qSr)rr3rr(rr5rr . s z*Message.parse_entities..)r ALL_TYPESrSr7rr7rparse_entities s  zMessage.parse_entitiescs(dkrtjfddjp"gDS)a{ 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. Ncs"i|]}|jkr||qSr)rr4r6r7rrr8N s z2Message.parse_caption_entities..)rr9rkr7rr7rparse_caption_entities4 s  zMessage.parse_caption_entitiesr) message_textrSurledr/rc sJ|dkr dStjdkr |d}d}d}t|ddd}g}|D]z\}|krDfdd |D} |t| |} t|}| rt j | | |j d }j t jkrd jd |d } n:j t jkrjrdjjd |d } nj t jkr|rd |d |d } nj t jkr2d|d} nʈj t jkrNd|d} nj t jkrjd|d} nj t jkrjrdjd |d} n d|d} nXj t jkrd|d} n<j t jkrd|d} n j t jkrd|d} n|} |dkr`tjdkr2|t||j || 7}n,|t||dj |dd| 7}nPtjdkr|||j || 7}n(|||dj |dd| 7}j |j}qD|dkrtjdkr|t||d7}n|t||ddd7}n8tjdkr,|||d7}n|||ddd7}|S) Nr)r*rcSs |djSNrr/rrrrd z%Message._parse_html..keycsBi|]:\}}|jjkr|j|jjjkr|kr||qSrr/rrrtr(rrr8i s  z'Message._parse_html..)r=r/z zzz
z
zzzzzzr+)r-r.r0sorteditemsextendlistkeysrr@ _parse_htmlr/rr TEXT_LINKurl TEXT_MENTIONuserrURLBOLDITALICCODEPRElanguage UNDERLINE STRIKETHROUGHSPOILERr1r) r<rSr=r/Z html_text last_offsetsorted_entitiesparsed_entitiesrInested_entities orig_textinsertrrIrrOT s            zMessage._parse_htmlcCs|j|j|ddS)aCreates 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. Note: |custom_emoji_formatting_note| .. versionchanged:: 13.10 Spoiler entities are now formatted as HTML. Returns: :obj:`str`: Message text with entities formatted as HTML. Fr=rOrIr:rrrr text_html szMessage.text_htmlcCs|j|j|ddS)aCreates 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. Note: |custom_emoji_formatting_note| .. versionchanged:: 13.10 Spoiler entities are now formatted as HTML. Returns: :obj:`str`: Message text with entities formatted as HTML. Trcrdrrrrtext_html_urled szMessage.text_html_urledcCs|j|j|ddS)aCreates 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. Note: |custom_emoji_formatting_note| .. versionchanged:: 13.10 Spoiler entities are now formatted as HTML. Returns: :obj:`str`: Message caption with caption entities formatted as HTML. FrcrOrPr;rrrr caption_html szMessage.caption_htmlcCs|j|j|ddS)aCreates 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. Note: |custom_emoji_formatting_note| .. versionchanged:: 13.10 Spoiler entities are now formatted as HTML. Returns: :obj:`str`: Message caption with caption entities formatted as HTML. Trcrgrrrrcaption_html_urled szMessage.caption_html_urled)r<rSr=versionr/rcst|}|dkrdStjdkr(|d}d}d}t|ddd}g}|D]:\} |krLfdd |D} |t| | } t | |d } | r|d krt d t j | | |j |d } jtjkr|dkrڈj} nt j|tjd} d| d| d} njtjkr2jr2d| djjd} njtjkrp|rp|dkrV| }n| }d|d| d} nLjtjkrd| d} n.jtjkrd| d} njtjkrdt | |tjdd} njtjkr.t | |tjd}jr djd}n|drd}nd}||d} njtjkr\|dkrNt dd| d} n`jtjkr|dkr|t dd| d} n2jtjkr|dkrt dd | d } n| } |dkr(tjdkr|t ||j ||d | 7}n0|t ||d j |d d|d | 7}nPtjdkrP|||j || 7}n(|||d j |d d| 7}j |j }qL|dkrtjdkr|t ||d|d 7}n"|t ||d dd|d 7}n8tjdkr|||d7}n|||d dd7}|S)!Nr)r*r>rcSs |djSr?r@rArrrrB rCz)Message._parse_markdown..rDcsBi|]:\}}|jjkr|j|jjjkr|kr||qSrrFrGrIrrr8" s  z+Message._parse_markdown..)rkr+z8Nested entities are not supported for Markdown version 1)r=r/rkrj)rkZ entity_type[z]()z](tg://user?id=*_`z``` \z``` z;Underline entities are not supported for Markdown version 1__z?Strikethrough entities are not supported for Markdown version 1~z9Spoiler entities are not supported for Markdown version 1z||)!rr-r.r0rJrKrLrMrNr.rr@_parse_markdownr/rrrPrQrRrSrrTrUrVrWrXrY startswithrZr[r\r1r)r<rSr=rkr/Z markdown_textr]r^r_rIr`rarQrbrcodeprefixrrIrru s                  zMessage._parse_markdowncCs|j|j|ddS)a Creates an Markdown-formatted string from the markup entities found in the message using :class:`telegram.ParseMode.MARKDOWN`. 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. Note: * :attr:`telegram.ParseMode.MARKDOWN` is a legacy mode, retained by Telegram for backward compatibility. You should use :meth:`text_markdown_v2` instead. * |custom_emoji_formatting_note| Returns: :obj:`str`: Message text with entities formatted as Markdown. Raises: :exc:`ValueError`: If the message contains underline, strikethrough, spoiler or nested entities. FrcrurIr:rrrr text_markdown szMessage.text_markdowncCs|j|j|dddS)a(Creates an Markdown-formatted string from the markup entities found in the message using :class:`telegram.ParseMode.MARKDOWN_V2`. 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. Note: |custom_emoji_formatting_note| .. versionchanged:: 13.10 Spoiler entities are now formatted as Markdown V2. Returns: :obj:`str`: Message text with entities formatted as Markdown. Fr+r=rkryrrrrtext_markdown_v2 szMessage.text_markdown_v2cCs|j|j|ddS)a$Creates an Markdown-formatted string from the markup entities found in the message using :class:`telegram.ParseMode.MARKDOWN`. 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. Note: * :attr:`telegram.ParseMode.MARKDOWN` is a legacy mode, retained by Telegram for backward compatibility. You should use :meth:`text_markdown_v2_urled` instead. * |custom_emoji_formatting_note| Returns: :obj:`str`: Message text with entities formatted as Markdown. Raises: :exc:`ValueError`: If the message contains underline, strikethrough, spoiler or nested entities. Trcryrrrrtext_markdown_urled szMessage.text_markdown_urledcCs|j|j|dddS)a:Creates an Markdown-formatted string from the markup entities found in the message using :class:`telegram.ParseMode.MARKDOWN_V2`. 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. Note: |custom_emoji_formatting_note| .. versionchanged:: 13.10 Spoiler entities are now formatted as Markdown V2. Returns: :obj:`str`: Message text with entities formatted as Markdown. Tr+r{ryrrrrtext_markdown_v2_urled szMessage.text_markdown_v2_urledcCs|j|j|ddS)a/Creates an Markdown-formatted string from the markup entities found in the message's caption using :class:`telegram.ParseMode.MARKDOWN`. 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. Note: * :attr:`telegram.ParseMode.MARKDOWN` is a legacy mode, retained by Telegram for backward compatibility. You should use :meth:`caption_markdown_v2` instead. * |custom_emoji_formatting_note| Returns: :obj:`str`: Message caption with caption entities formatted as Markdown. Raises: :exc:`ValueError`: If the message contains underline, strikethrough, spoiler or nested entities. FrcrurPr;rrrrcaption_markdown szMessage.caption_markdowncCs|j|j|dddS)aHCreates an Markdown-formatted string from the markup entities found in the message's caption using :class:`telegram.ParseMode.MARKDOWN_V2`. 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. Note: |custom_emoji_formatting_note| .. versionchanged:: 13.10 Spoiler entities are now formatted as Markdown V2. Returns: :obj:`str`: Message caption with caption entities formatted as Markdown. Fr+r{rrrrrcaption_markdown_v2 s zMessage.caption_markdown_v2cCs|j|j|ddS)aGCreates an Markdown-formatted string from the markup entities found in the message's caption using :class:`telegram.ParseMode.MARKDOWN`. 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. Note: * :attr:`telegram.ParseMode.MARKDOWN` is a legacy mode, retained by Telegram for backward compatibility. You should use :meth:`caption_markdown_v2_urled` instead. * |custom_emoji_formatting_note| Returns: :obj:`str`: Message caption with caption entities formatted as Markdown. Raises: :exc:`ValueError`: If the message contains underline, strikethrough, spoiler or nested entities. Trcrrrrrcaption_markdown_urled2 szMessage.caption_markdown_urledcCs|j|j|dddS)aZCreates an Markdown-formatted string from the markup entities found in the message's caption using :class:`telegram.ParseMode.MARKDOWN_V2`. 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. Note: |custom_emoji_formatting_note| .. versionchanged:: 13.10 Spoiler entities are now formatted as Markdown V2. Returns: :obj:`str`: Message caption with caption entities formatted as Markdown. Tr+r{rrrrrcaption_markdown_v2_urledJ s z!Message.caption_markdown_v2_urled)=NNNNNNNNNNNNNNNNNNNNNNNNNNFFFFNNNNNNNNNNNNNNNNNNNNNNNNNNNNNNN)N)N)Fr)Frjr)__name__ __module__ __qualname____doc__ __slots__rr rr__annotations__rrdatetimer rr rrrrrr!r rrrrrrr rrrrr%r"r#r$r'r(r-r)r*r+r,rrpropertyrrr classmethodr3rrrrrrr1r5r6r&floatr rrrrr2rr4rrrrrrrrrrrZREGULARrrrrobjectr rrrrrrrrrr r!r$r%r&r'rr3r4rr:r; staticmethodrOrerfrhrirurzr|r}r~rrrr __classcell__rrrrr@VsD IF 1 C0 2 ; 7 9 .  4  <  8  <  ,  >  4  5 7 ; 5  A ,  3  ^  +  0  : , + ' $ 0 &  *  #       i %r@)Grrr-htmlrtypingrrrrrrr r Ztelegramr r r rrrrrrrrrrrrrrrrrrr r!r"r#r$r%r&r'r(r)r*r+r,r-Ztelegram.utils.helpersr.r/r0r1r2Ztelegram.utils.typesr3r4r5r6r7r8r9r:r;r<r=r>r?r@rrrrs (%,