U 2tc@sdZddlmZddlmZmZmZmZmZmZddl m Z m Z m Z ddl mZddlmZmZmZddlmZddlmZmZmZmZerdd l mZmZmZmZmZm 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/m0Z0m1Z1Gd d d e Z2d S) z?This module contains an object that represents a Telegram User.)datetime) TYPE_CHECKINGAnyListOptionalUnionTuple)TelegramObject constants MenuButton)InlineKeyboardButton) mention_html DEFAULT_NONE DEFAULT_20)mention_markdown)JSONDict FileInputODVInputDVInput)BotMessageUserProfilePhotos MessageIdInputMediaAudioInputMediaDocumentInputMediaPhotoInputMediaVideo MessageEntity ReplyMarkup PhotoSizeAudioContactDocumentInlineKeyboardMarkup LabeledPriceLocation AnimationStickerVideoVenue VideoNoteVoicec@s eZdZdZdZdeeeeeeeeedeeed ddZ e edd d Z e edd d Z e e edd dZddedfeeeeee ddddZdeedddZdeedddZdeedddZdeedddZeedfeeeeeeedddZeddfeeeeed d!d"Zedfeeeed#d$d%Zeeeddededdf eeeeeeeed&eeeeeeed'ed(fed)d* d+d,Z dedde!ededddf ee"d-feeeed&eeeeeeeeed'ed(feed)d. d/d0Z#ede!dedfeed1eeeeeeeeeed)d2d3d4Z$ddddedde!eddedddfee"d5feeeeeeed&eeeee"eeeeed'ed(feed)d6d7d8Z%edfeeeeed9d:d;Z&e&Z'dddeddedddedf eeeeeed&eedd?Z(eddeddedfeeed&eeeeeeed)d@ dAdBZ)ddedde!edddeddf ee"dCfeeeeed&eeeee"eeeeeed'ed(fed)dDdEdFZ*eddededfeeeedGeeeeeed)dH dIdJZ+ddddddddddedddddededddfeeeeeedKeeeeeeeeeeeeedGeee,feeeeeeeeeeed)dLdMdNZ-ddeddeddddddedfeeeeed&eedOeeeeeeeed)dPdQdRZ.dddddeedde!dedddfee"dSfeeee"eeeeeed&eeeeeeed'ed(feed)dTdUdVZ/edde!dedfee"dWfeeed&eeeeeed)dX dYdZZ0ddedde!ddedddedddfee"d[feeeeed&eeeeeeee"eeeeed'ed(feed)d\d]d^Z1dddddeddedddddedfeeeeeeeed&eed_eeeeeeed)d`dadbZ2ddedde!ddeddf ee"dcfeeeeed&eee"eeeeed)dd dedfZ3ddedde!ededddf ee"dgfeeeeed&eeeeeeeeed'ed(feed)dhdidjZ4dke5j6dlddeddededddeddfeeeeeeeeeeed&eeeeeeeee7feeeeed'ed(fed)dmdndoZ8dededededdf eeefeeeeeed(ed'feeeeed&eeeedpdq drdsZ9dededededdf eeefeeeeeed(ed'feeeeed&eeeedpdt dudvZ:edfeeefeeeedwdxdyZ;edfeeefeeeedwdzd{Zedfeeee=d#ddZ?dS)UseraC This object represents a Telegram user or bot. Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`id` is equal. Args: id (:obj:`int`): Unique identifier for this user or bot. is_bot (:obj:`bool`): :obj:`True`, if this user is a bot. first_name (:obj:`str`): User's or bots first name. last_name (:obj:`str`, optional): User's or bots last name. username (:obj:`str`, optional): User's or bots username. language_code (:obj:`str`, optional): IETF language tag of the user's language. can_join_groups (:obj:`str`, optional): :obj:`True`, if the bot can be invited to groups. Returned only in :attr:`telegram.Bot.get_me` requests. can_read_all_group_messages (:obj:`str`, optional): :obj:`True`, if privacy mode is disabled for the bot. Returned only in :attr:`telegram.Bot.get_me` requests. supports_inline_queries (:obj:`str`, optional): :obj:`True`, if the bot supports inline queries. Returned only in :attr:`telegram.Bot.get_me` requests. bot (:class:`telegram.Bot`, optional): The Bot to use for instance methods. is_premium (:obj:`bool`, optional): :obj:`True`, if this user is a Telegram Premium user. .. versionadded:: 13.13 added_to_attachment_menu (:obj:`bool`, optional): :obj:`True`, if this user added the bot to the attachment menu. .. versionadded:: 13.13 Attributes: id (:obj:`int`): Unique identifier for this user or bot. is_bot (:obj:`bool`): :obj:`True`, if this user is a bot. first_name (:obj:`str`): User's or bot's first name. last_name (:obj:`str`): Optional. User's or bot's last name. username (:obj:`str`): Optional. User's or bot's username. language_code (:obj:`str`): Optional. IETF language tag of the user's language. can_join_groups (:obj:`str`): Optional. :obj:`True`, if the bot can be invited to groups. Returned only in :attr:`telegram.Bot.get_me` requests. can_read_all_group_messages (:obj:`str`): Optional. :obj:`True`, if privacy mode is disabled for the bot. Returned only in :attr:`telegram.Bot.get_me` requests. supports_inline_queries (:obj:`str`): Optional. :obj:`True`, if the bot supports inline queries. Returned only in :attr:`telegram.Bot.get_me` requests. bot (:class:`telegram.Bot`): Optional. The Bot to use for instance methods. is_premium (:obj:`bool`): Optional. :obj:`True`, if this user is a Telegram Premium user. .. versionadded:: 13.13 added_to_attachment_menu (:obj:`bool`): Optional. :obj:`True`, if this user added the bot to the attachment menu. .. versionadded:: 13.13 ) is_botcan_read_all_group_messagesusername first_name last_namecan_join_groupssupports_inline_queriesidbot language_code is_premiumadded_to_attachment_menu _id_attrsNr) r4r0r-r1r/r6r2r.r3r5r7r8_kwargsc KsZt||_||_||_||_||_||_||_||_| |_ | |_ | |_ | |_ |jf|_ dS)N)intr4r0r-r1r/r6r2r.r3r7r8r5r9)selfr4r0r-r1r/r6r2r.r3r5r7r8r:r=1/tmp/pip-unpacked-wheel-2u9rcp5s/telegram/user.py__init__s z User.__init__)returncCs|jrd|jS|jS)z:obj:`str`: Convenience property. If available, returns the user's :attr:`username` prefixed with "@". If :attr:`username` is not available, returns :attr:`full_name`. @)r/ full_namer<r=r=r>names z User.namecCs|jr|jd|jS|jS)z:obj:`str`: Convenience property. The user's :attr:`first_name`, followed by (if available) :attr:`last_name`.  )r1r0rCr=r=r>rBszUser.full_namecCs|jrd|jSdS)zu:obj:`str`: Convenience property. If :attr:`username` is available, returns a t.me link of the user. z https://t.me/N)r/rCr=r=r>links z User.linkdr)offsetlimittimeout api_kwargsr@cCs|jj|j||||dS)z Shortcut for:: bot.get_user_profile_photos(update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.get_user_profile_photos`. )user_idrHrIrJrK)r5Zget_user_profile_photosr4)r<rHrIrJrKr=r=r>get_profile_photosszUser.get_profile_photos)rDr@cCs|rt|j|St|j|jS)a Note: :attr:`telegram.ParseMode.MARKDOWN` is a legacy mode, retained by Telegram for backward compatibility. You should use :meth:`mention_markdown_v2` instead. Args: name (:obj:`str`): The name used as a link for the user. Defaults to :attr:`full_name`. Returns: :obj:`str`: The inline mention for the user as markdown (version 1). util_mention_markdownr4rBr<rDr=r=r>rs  zUser.mention_markdowncCs&|rt|j|ddSt|j|jddS)z Args: name (:obj:`str`): The name used as a link for the user. Defaults to :attr:`full_name`. Returns: :obj:`str`: The inline mention for the user as markdown (version 2). )versionrNrPr=r=r>mention_markdown_v2s zUser.mention_markdown_v2cCs|rt|j|St|j|jS)z Args: name (:obj:`str`): The name used as a link for the user. Defaults to :attr:`full_name`. Returns: :obj:`str`: The inline mention for the user as HTML. )util_mention_htmlr4rBrPr=r=r>r s  zUser.mention_htmlcCst|p |jd|jdS)a Shortcut for:: InlineKeyboardButton(text=name, url=f"tg://user?id={update.effective_user.id}") .. versionadded:: 13.9 Args: name (:obj:`str`): The name used as a link for the user. Defaults to :attr:`full_name`. Returns: :class:`telegram.InlineKeyboardButton`: InlineButton with url set to the user mention z tg://user?id=)texturl)r rBr4rPr=r=r>mention_buttonszUser.mention_button) message_iddisable_notificationrJrKr@cCs|jj|j||||dS)aeShortcut for:: bot.pin_chat_message(chat_id=update.effective_user.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. )chat_idrXrYrJrK)r5Zpin_chat_messager4)r<rXrYrJrKr=r=r> pin_messageszUser.pin_message)rJrKrXr@cCs|jj|j|||dS)amShortcut for:: bot.unpin_chat_message(chat_id=update.effective_user.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. )rZrJrKrX)r5Zunpin_chat_messager4)r<rJrKrXr=r=r> unpin_message-s zUser.unpin_message)rJrKr@cCs|jj|j||dS)aShortcut for:: bot.unpin_all_chat_messages(chat_id=update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.unpin_all_chat_messages`. Returns: :obj:`bool`: On success, :obj:`True` is returned. rZrJrK)r5Zunpin_all_chat_messagesr4r<rJrKr=r=r>unpin_all_messagesFs zUser.unpin_all_messagesrr)r.r) rU parse_modedisable_web_page_previewrYreply_to_message_id reply_markuprJrKallow_sending_without_replyentitiesprotect_contentr@c Cs&|jj|j||||||||| | | d S)a/Shortcut for:: bot.send_message(update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_message`. Returns: :class:`telegram.Message`: On success, instance representing the message posted. ) rZrUr`rarYrbrcrJrKrdrerf)r5 send_messager4) r<rUr`rarYrbrcrJrKrdrerfr=r=r>rg^szUser.send_messager) photocaptionrYrbrcrJr`rKrdcaption_entitiesfilenamerfr@c Cs(|jj|j||||||||| | | | d S)a+Shortcut for:: bot.send_photo(update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_photo`. Returns: :class:`telegram.Message`: On success, instance representing the message posted. ) rZrhrirYrbrcrJr`rKrdrjrkrf)r5 send_photor4) r<rhrirYrbrcrJr`rKrdrjrkrfr=r=r>rlszUser.send_photo)rrrr)mediarYrbrJrKrdrfr@c Cs|jj|j|||||||dS)a=Shortcut for:: bot.send_media_group(update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_media_group`. Returns: List[:class:`telegram.Message`:] On success, instance representing the message posted. )rZrmrYrbrJrKrdrf)r5send_media_groupr4)r<rmrYrbrJrKrdrfr=r=r>rnszUser.send_media_groupr )audioduration performertitlerirYrbrcrJr`thumbrKrdrjrkrfr@cCs0|jj|j||||||||| | | | | |||dS)a+Shortcut for:: bot.send_audio(update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_audio`. Returns: :class:`telegram.Message`: On success, instance representing the message posted. )rZrorprqrrrirYrbrcrJr`rsrKrdrjrkrf)r5 send_audior4)r<rorprqrrrirYrbrcrJr`rsrKrdrjrkrfr=r=r>rts&zUser.send_audio)actionrJrKr@cCs|jj|j|||dS)zShortcut for:: bot.send_chat_action(update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_chat_action`. Returns: :obj:`True`: On success. )rZrurJrK)r5send_chat_actionr4)r<rurJrKr=r=r>rvs zUser.send_chat_actionr!) phone_numberr0r1rYrbrcrJcontactvcardrKrdrfr@c Cs(|jj|j||||||||| | | | d S)a/Shortcut for:: bot.send_contact(update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_contact`. Returns: :class:`telegram.Message`: On success, instance representing the message posted. ) rZrwr0r1rYrbrcrJrxryrKrdrf)r5 send_contactr4) r<rwr0r1rYrbrcrJrxryrKrdrfr=r=r>rzszUser.send_contact) rYrbrcrJemojirKrdrfr@c Cs |jj|j||||||||d S)a)Shortcut for:: bot.send_dice(update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_dice`. Returns: :class:`telegram.Message`: On success, instance representing the message posted. ) rZrYrbrcrJr{rKrdrf)r5 send_dicer4) r<rYrbrcrJr{rKrdrfr=r=r>r|CszUser.send_dicer")documentrkrirYrbrcrJr`rsrKdisable_content_type_detectionrdrjrfr@cCs,|jj|j||||||||| | | | | |dS)a1Shortcut for:: bot.send_document(update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_document`. Returns: :class:`telegram.Message`: On success, instance representing the message posted. )rZr}rkrirYrbrcrJr`rsrKr~rdrjrf)r5 send_documentr4)r<r}rkrirYrbrcrJr`rsrKr~rdrjrfr=r=r>rds"zUser.send_documentr#) game_short_namerYrbrcrJrKrdrfr@c Cs |jj|j||||||||d S)a)Shortcut for:: bot.send_game(update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_game`. Returns: :class:`telegram.Message`: On success, instance representing the message posted. ) rZrrYrbrcrJrKrdrf)r5 send_gamer4) r<rrYrbrcrJrKrdrfr=r=r>rszUser.send_gamer$)rr descriptionpayloadprovider_tokencurrencypricesstart_parameter photo_url photo_size photo_width photo_height need_nameneed_phone_number need_emailneed_shipping_address is_flexiblerYrbrc provider_datasend_phone_number_to_providersend_email_to_providerrJrKrdmax_tip_amountsuggested_tip_amountsrfr@cCsH|jj|j||||||||| | | | | |||||||||||||||dS)aShortcut for:: bot.send_invoice(update.effective_user.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. .. versionchanged:: 13.5 As of Bot API 5.2, the parameter :attr:`start_parameter` is optional. Returns: :class:`telegram.Message`: On success, instance representing the message posted. )rZrrrrrrrrrrrrrrrrrrYrbrcrrrrJrKrdrrrf)r5 send_invoicer4)r<rrrrrrrrrrrrrrrrrrYrbrcrrrrJrKrdrrrfr=r=r>rs>1zUser.send_invoicer%)latitude longituderYrbrcrJlocation live_periodrKhorizontal_accuracyheadingproximity_alert_radiusrdrfr@cCs,|jj|j||||||||| | | | | |dS)a1Shortcut for:: bot.send_location(update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_location`. Returns: :class:`telegram.Message`: On success, instance representing the message posted. )rZrrrYrbrcrJrrrKrrrrdrf)r5 send_locationr4)r<rrrYrbrcrJrrrKrrrrdrfr=r=r>rs"zUser.send_locationr&) animationrpwidthheightrsrir`rYrbrcrJrKrdrjrkrfr@cCs0|jj|j||||||||| | | | | |||dS)a3Shortcut for:: bot.send_animation(update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_animation`. Returns: :class:`telegram.Message`: On success, instance representing the message posted. )rZrrprrrsrir`rYrbrcrJrKrdrjrkrf)r5send_animationr4)r<rrprrrsrir`rYrbrcrJrKrdrjrkrfr=r=r>r0s&zUser.send_animationr') stickerrYrbrcrJrKrdrfr@c Cs |jj|j||||||||d S)a/Shortcut for:: bot.send_sticker(update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_sticker`. Returns: :class:`telegram.Message`: On success, instance representing the message posted. ) rZrrYrbrcrJrKrdrf)r5 send_stickerr4) r<rrYrbrcrJrKrdrfr=r=r>raszUser.send_stickerr()videorprirYrbrcrJrrr`supports_streamingrsrKrdrjrkrfr@cCs2|jj|j||||||||| | | | | ||||dS)a+Shortcut for:: bot.send_video(update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_video`. Returns: :class:`telegram.Message`: On success, instance representing the message posted. )rZrrprirYrbrcrJrrr`rrsrKrdrjrkrf)r5 send_videor4)r<rrprirYrbrcrJrrr`rrsrKrdrjrkrfr=r=r>rs(zUser.send_videor))rrrraddress foursquare_idrYrbrcrJvenuefoursquare_typerKgoogle_place_idgoogle_place_typerdrfr@cCs0|jj|j||||||||| | | | | |||dS)a+Shortcut for:: bot.send_venue(update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_venue`. Returns: :class:`telegram.Message`: On success, instance representing the message posted. )rZrrrrrrrYrbrcrJrrrKrrrdrf)r5 send_venuer4)r<rrrrrrrYrbrcrJrrrKrrrdrfr=r=r>rs&zUser.send_venuer*) video_noterplengthrYrbrcrJrsrKrdrkrfr@c Cs(|jj|j||||||||| | | | d S)a5Shortcut for:: bot.send_video_note(update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_video_note`. Returns: :class:`telegram.Message`: On success, instance representing the message posted. ) rZrrprrYrbrcrJrsrKrdrkrf)r5send_video_noter4) r<rrprrYrbrcrJrsrKrdrkrfr=r=r>rszUser.send_video_noter+)voicerprirYrbrcrJr`rKrdrjrkrfr@cCs*|jj|j||||||||| | | | | dS)a+Shortcut for:: bot.send_voice(update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_voice`. Returns: :class:`telegram.Message`: On success, instance representing the message posted. )rZrrprirYrbrcrJr`rKrdrjrkrf)r5 send_voicer4)r<rrprirYrbrcrJr`rKrdrjrkrfr=r=r>rs zUser.send_voiceTF)questionoptions is_anonymoustypeallows_multiple_answerscorrect_option_id is_closedrYrbrcrJ explanationexplanation_parse_mode open_period close_daterKrdexplanation_entitiesrfr@cCs6|jj|j||||||||| | | | | ||||||dS)a)Shortcut for:: bot.send_poll(update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.send_poll`. Returns: :class:`telegram.Message`: On success, instance representing the message posted. )rZrrrrrrrrYrbrcrJrrrrrKrdrrf)r5 send_pollr4)r<rrrrrrrrYrbrcrJrrrrrKrdrrfr=r=r>r:s,!zUser.send_pollr) from_chat_idrXrir`rjrYrbrdrcrJrKrfr@c Cs(|jj|j||||||||| | | | d S)a7Shortcut for:: bot.copy_message(chat_id=update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.copy_message`. Returns: :class:`telegram.Message`: On success, instance representing the message posted. ) rZrrXrir`rjrYrbrdrcrJrKrfr5 copy_messager4) r<rrXrir`rjrYrbrdrcrJrKrfr=r=r> send_copyrszUser.send_copy) rZrXrir`rjrYrbrdrcrJrKrfr@c Cs(|jj|j||||||||| | | | d S)a<Shortcut for:: bot.copy_message(from_chat_id=update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.copy_message`. Returns: :class:`telegram.Message`: On success, instance representing the message posted. ) rrZrXrir`rjrYrbrdrcrJrKrfr) r<rZrXrir`rjrYrbrdrcrJrKrfr=r=r>rszUser.copy_message)rZrJrKr@cCs|jj|j|||dS)aZShortcut for:: bot.approve_chat_join_request(user_id=update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.approve_chat_join_request`. .. versionadded:: 13.8 Returns: :obj:`bool`: On success, :obj:`True` is returned. rLrZrJrK)r5Zapprove_chat_join_requestr4r<rZrJrKr=r=r>approve_join_requests zUser.approve_join_requestcCs|jj|j|||dS)aZShortcut for:: bot.decline_chat_join_request(user_id=update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.decline_chat_join_request`. .. versionadded:: 13.8 Returns: :obj:`bool`: On success, :obj:`True` is returned. r)r5Zdecline_chat_join_requestr4rr=r=r>decline_join_requests zUser.decline_join_request) menu_buttonrJrKr@cCs|jj|j|||dS)a~Shortcut for:: bot.set_chat_menu_button(chat_id=update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.set_chat_menu_button`. ..seealso:: :meth:`get_menu_button` .. versionadded:: 13.12 Returns: :obj:`bool`: On success, :obj:`True` is returned. )rZrrJrK)r5Zset_chat_menu_buttonr4)r<rrJrKr=r=r>set_menu_buttons zUser.set_menu_buttoncCs|jj|j||dS)aShortcut for:: bot.get_chat_menu_button(chat_id=update.effective_user.id, *args, **kwargs) For the documentation of the arguments, please see :meth:`telegram.Bot.get_chat_menu_button`. ..seealso:: :meth:`set_menu_button` .. versionadded:: 13.12 Returns: :class:`telegram.MenuButton`: On success, the current menu button is returned. r])r5Zget_chat_menu_buttonr4r^r=r=r>get_menu_button s zUser.get_menu_button) NNNNNNNNN)N)N)N)N)@__name__ __module__ __qualname____doc__ __slots__r;strboolrr?propertyrDrBrrFrrfloatrrMrrSr r rWr[r\r_rrrrrgrrrlrnrtrvZ send_actionrzr|rrobjectrrrrrrrrr Z POLL_REGULARrrrrrrr rrr=r=r=r>r,>s(4 !        *  . $  4  + $  0 )  S 0  4  $  5 4  ,  /  <  -  ,     r,N)3rrtypingrrrrrrZtelegramr r r Z$telegram.inline.inlinekeyboardbuttonr Ztelegram.utils.helpersr rTrrrrOZtelegram.utils.typesrrrrrrrrrrrrrrrr r!r"r#r$r%r&r'r(r)r*r+r,r=r=r=r>s    d