YiISrSSKrSSKrSSKJr SSKJrJrJrJ r SSK J r SSK J r SSKJr SSKJr SS KJr SS KJr \(aSS K Jr \S r"S S \ 5rg)zHThis module contains an object that represents a Telegram MessageEntity.N)Sequence) TYPE_CHECKINGFinalOptionalUnion) constants)TelegramObject)User)enum) TextEncoding)JSONDict)Bot MessageEntityc*^\rSrSr%SrSrS0SS.S\S\S\S \\S \\ S \\S \\S \\ 4U4Sjjjjr \ S1S\\ S\SS\S4U4Sjjj5r \S\S\S\4Sj5r\S\\\4S\S\4Sj5r\ S\\\\4\\\\44S\\\44Sj5r\"\R05r\\\\S'\R0R8r\\\S'\R0R:r\\\S'\R0R<r\\\S'\R0R>r\\\S'\R0R@r \\\S '\R0RBr!\\\S!'\R0RDr"\\\S"'\R0RFr#\\\S#'\R0RHr$\\\S$'\R0RJr%\\\S%'\R0RLr&\\\S&'\R0RNr'\\\S''\R0RPr(\\\S('\R0RRr)\\\S)'\R0RTr*\\\S*'\R0RVr+\\\S+'\R0RXr,\\\S,'\R0RZr-\\\S-'\R0R\r.\\\S.'S/r/U=r0$)2r'a This object represents one special entity in a text message. For example, hashtags, usernames, URLs, etc. Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their :attr:`type`, :attr:`offset` and :attr:`length` are equal. Args: type (:obj:`str`): Type of the entity. Can be :attr:`MENTION` (``@username``), :attr:`HASHTAG` (``#hashtag`` or ``#hashtag@chatusername``), :attr:`CASHTAG` (``$USD`` or ``USD@chatusername``), :attr:`BOT_COMMAND` (``/start@jobs_bot``), :attr:`URL` (``https://telegram.org``), :attr:`EMAIL` (``do-not-reply@telegram.org``), :attr:`PHONE_NUMBER` (``+1-212-555-0123``), :attr:`BOLD` (**bold text**), :attr:`ITALIC` (*italic text*), :attr:`UNDERLINE` (underlined text), :attr:`STRIKETHROUGH`, :attr:`SPOILER` (spoiler message), :attr:`BLOCKQUOTE` (block quotation), :attr:`CODE` (monowidth string), :attr:`PRE` (monowidth block), :attr:`TEXT_LINK` (for clickable text URLs), :attr:`TEXT_MENTION` (for users without usernames), :attr:`CUSTOM_EMOJI` (for inline custom emoji stickers). .. versionadded:: 20.0 Added inline custom emoji .. versionadded:: 20.8 Added block quotation offset (:obj:`int`): Offset in UTF-16 code units to the start of the entity. length (:obj:`int`): Length of the entity in UTF-16 code units. url (:obj:`str`, optional): For :attr:`TEXT_LINK` only, url that will be opened after user taps on the text. user (:class:`telegram.User`, optional): For :attr:`TEXT_MENTION` only, the mentioned user. language (:obj:`str`, optional): For :attr:`PRE` only, the programming language of the entity text. custom_emoji_id (:obj:`str`, optional): For :attr:`CUSTOM_EMOJI` only, unique identifier of the custom emoji. Use :meth:`telegram.Bot.get_custom_emoji_stickers` to get full information about the sticker. .. versionadded:: 20.0 Attributes: type (:obj:`str`): Type of the entity. Can be :attr:`MENTION` (``@username``), :attr:`HASHTAG` (``#hashtag`` or ``#hashtag@chatusername``), :attr:`CASHTAG` (``$USD`` or ``USD@chatusername``), :attr:`BOT_COMMAND` (``/start@jobs_bot``), :attr:`URL` (``https://telegram.org``), :attr:`EMAIL` (``do-not-reply@telegram.org``), :attr:`PHONE_NUMBER` (``+1-212-555-0123``), :attr:`BOLD` (**bold text**), :attr:`ITALIC` (*italic text*), :attr:`UNDERLINE` (underlined text), :attr:`STRIKETHROUGH`, :attr:`SPOILER` (spoiler message), :attr:`BLOCKQUOTE` (block quotation), :attr:`CODE` (monowidth string), :attr:`PRE` (monowidth block), :attr:`TEXT_LINK` (for clickable text URLs), :attr:`TEXT_MENTION` (for users without usernames), :attr:`CUSTOM_EMOJI` (for inline custom emoji stickers). .. versionadded:: 20.0 Added inline custom emoji .. versionadded:: 20.8 Added block quotation offset (:obj:`int`): Offset in UTF-16 code units to the start of the entity. length (:obj:`int`): Length of the entity in UTF-16 code units. url (:obj:`str`): Optional. For :attr:`TEXT_LINK` only, url that will be opened after user taps on the text. user (:class:`telegram.User`): Optional. For :attr:`TEXT_MENTION` only, the mentioned user. language (:obj:`str`): Optional. For :attr:`PRE` only, the programming language of the entity text. custom_emoji_id (:obj:`str`): Optional. For :attr:`CUSTOM_EMOJI` only, unique identifier of the custom emoji. Use :meth:`telegram.Bot.get_custom_emoji_stickers` to get full information about the sticker. .. versionadded:: 20.0 )custom_emoji_idlanguagelengthoffsettypeurluserN api_kwargsrrrrrrrrc,>[T U]US9 [R"[R X5UlX lX0lX@l XPl X`l Xpl UR URUR4Ul UR5 g)Nr)super__init__r get_memberrMessageEntityTyperrrrrrr _id_attrs_freeze) selfrrrrrrrr __class__s B/app/.venv/lib/python3.13/site-packages/telegram/_messageentity.pyrMessageEntity.__init__pso J/)D)DdQ ! ! "%$( '/ .=))T[[$++> databotrreturnc>URU5nU(dg[R"URS5U5US'[TU] XS9$)z,See :meth:`telegram.TelegramObject.de_json`.Nr)r'r() _parse_datar de_jsongetr)clsr'r(r#s r$r,MessageEntity.de_jsonsG t$||DHHV$4c:V wD22r&textentitiesc.[[R"SU565nSn0n[U5HJupVUS:aX%S- OSnXUnU[ UR [ R55S-- nX4U'ML /n UH{n XJRn XJRU R-U - n [R"U 5n U R5 XlXl SSS5 U RU 5 M} U $!,(df  N%=f)uUtility functionality for converting the offset and length of entities from Unicode (:obj:`str`) to UTF-16 (``utf-16-le`` encoded :obj:`bytes`). Tip: Only the offsets and lengths calulated in UTF-16 is acceptable by the Telegram Bot API. If they are calculated using the Unicode string (:obj:`str` object), errors may occur when the text contains characters that are not in the Basic Multilingual Plane (BMP). For more information, see `Unicode `_ and `Plane (Unicode) `_. .. versionadded:: 21.4 Examples: Below is a snippet of code that demonstrates how to use this function to convert entities from Unicode to UTF-16 space. The ``unicode_entities`` are calculated in Unicode and the `utf_16_entities` are calculated in UTF-16. .. code-block:: python text = "𠌕 bold 𝄢 italic underlined: 𝛙𝌢𑁍" unicode_entities = [ MessageEntity(offset=2, length=4, type=MessageEntity.BOLD), MessageEntity(offset=9, length=6, type=MessageEntity.ITALIC), MessageEntity(offset=28, length=3, type=MessageEntity.UNDERLINE), ] utf_16_entities = MessageEntity.adjust_message_entities_to_utf_16( text, unicode_entities ) await bot.send_message( chat_id=123, text=text, entities=utf_16_entities, ) # utf_16_entities[0]: offset=3, length=4 # utf_16_entities[1]: offset=11, length=6 # utf_16_entities[2]: offset=30, length=6 Args: text (:obj:`str`): The text that the entities belong to entities (Sequence[:class:`telegram.MessageEntity`]): Sequence of entities with offset and length calculated in Unicode Returns: Sequence[:class:`telegram.MessageEntity`]: Sequence of entities with offset and length calculated in UTF-16 encoding c3j# UH)oRURUR-4v M+ g7fN)rr).0xs r$ BMessageEntity.adjust_message_entities_to_utf_16..s',_V^QRhh1888K-LV^s13rN) sorted itertoolschain enumeratelenencoder UTF_16_LErrcopy _unfrozenappend)r0r1 positionsaccumulated_lengthposition_translationiposition last_position text_sliceoutentitytranslated_positionstranslated_length new_entitys r$!adjust_message_entities_to_utf_16/MessageEntity.adjust_message_entities_to_utf_16sb9??,_V^,_`a 02$Y/KA01AI!e,1MH5J #j&7&7 8N8N&O"PTU"U U -? * 0 F#7 #F $]]V]]%BCFZZ 6*J%%'$8!$5!( JJz " ('s  D D bycP[U[5(aUO[URS55S-n/nUHXn[R"U5nUR 5 U=R U- slSSS5 URU5 MZ U$!,(df  N%=f)u^Utility functionality for shifting the offset of entities by a given amount. Examples: Shifting by an integer amount: .. code-block:: python text = "Hello, world!" entities = [ MessageEntity(offset=0, length=5, type=MessageEntity.BOLD), MessageEntity(offset=7, length=5, type=MessageEntity.ITALIC), ] shifted_entities = MessageEntity.shift_entities(1, entities) await bot.send_message( chat_id=123, text="!" + text, entities=shifted_entities, ) Shifting using a string: .. code-block:: python text = "Hello, world!" prefix = "𝄢" entities = [ MessageEntity(offset=0, length=5, type=MessageEntity.BOLD), MessageEntity(offset=7, length=5, type=MessageEntity.ITALIC), ] shifted_entities = MessageEntity.shift_entities(prefix, entities) await bot.send_message( chat_id=123, text=prefix + text, entities=shifted_entities, ) Tip: The :paramref:`entities` are *not* modified in place. The function returns a sequence of new objects. .. versionadded:: 21.5 Args: by (:obj:`str` | :obj:`int`): Either the amount to shift the offset by or a string whose length will be used as the amount to shift the offset by. In this case, UTF-16 encoding will be used to calculate the length. entities (Sequence[:class:`telegram.MessageEntity`]): Sequence of entities Returns: Sequence[:class:`telegram.MessageEntity`]: Sequence of entities with the offset shifted z utf-16-ler:N) isinstanceintr?r@rBrCrrD)rSr1effective_shiftrLrMrPs r$shift_entitiesMessageEntity.shift_entitiessj!+2s 3 3"RYY{=S9TXY9YF6*J%%'!!_4!( JJz "   ('s "B B% argscSn/nUHXnUSUSpe[U5S:aUSSLaURXV5nURURX&55 X%- nMZ X#4$)u Utility functionality for concatenating two text along with their formatting entities. Tip: This function is useful for prefixing an already formatted text with a new text and its formatting entities. In particular, it automatically correctly handles UTF-16 encoding. Examples: This example shows a callback function that can be used to add a prefix and suffix to the message in a :class:`~telegram.ext.CallbackQueryHandler`: .. code-block:: python async def prefix_message(update: Update, context: ContextTypes.DEFAULT_TYPE): prefix = "𠌕 bold 𝄢 italic underlined: 𝛙𝌢𑁍 | " prefix_entities = [ MessageEntity(offset=2, length=4, type=MessageEntity.BOLD), MessageEntity(offset=9, length=6, type=MessageEntity.ITALIC), MessageEntity(offset=28, length=3, type=MessageEntity.UNDERLINE), ] suffix = " | 𠌕 bold 𝄢 italic underlined: 𝛙𝌢𑁍" suffix_entities = [ MessageEntity(offset=5, length=4, type=MessageEntity.BOLD), MessageEntity(offset=12, length=6, type=MessageEntity.ITALIC), MessageEntity(offset=31, length=3, type=MessageEntity.UNDERLINE), ] message = update.effective_message first = (prefix, prefix_entities, True) second = (message.text, message.entities) third = (suffix, suffix_entities, True) new_text, new_entities = MessageEntity.concatenate(first, second, third) await update.callback_query.edit_message_text( text=new_text, entities=new_entities, ) Hint: The entities are *not* modified in place. The function returns a new sequence of objects. .. versionadded:: 21.5 Args: *args (tuple[:obj:`str`, Sequence[:class:`telegram.MessageEntity`]] | tuple[:obj:`str`, Sequence[:class:`telegram.MessageEntity`], :obj:`bool`]): Arbitrary number of tuples containing the text and its entities to concatenate. If the last element of the tuple is a :obj:`bool`, it is used to determine whether to adjust the entities to UTF-16 via :meth:`adjust_message_entities_to_utf_16`. UTF-16 adjustment is disabled by default. Returns: tuple[:obj:`str`, Sequence[:class:`telegram.MessageEntity`]]: The concatenated text and its entities rr9r:T)r?rQextendrX)r.rZ output_textoutput_entitiesargr0r1s r$ concatenateMessageEntity.concatenate!syz /1C VSV(3x!|A$@@P  " "3#5#5k#L M  K++r& ALL_TYPES BLOCKQUOTEBOLD BOT_COMMANDCASHTAGCODE CUSTOM_EMOJIEMAILEXPANDABLE_BLOCKQUOTEHASHTAGITALICMENTION PHONE_NUMBERPRESPOILER STRIKETHROUGH TEXT_LINK TEXT_MENTION UNDERLINEURL)r rrrrrrr)NNNNr4)1__name__ __module__ __qualname____firstlineno____doc__ __slots__strrVrr r r classmethodr, staticmethod_SEMrQrrXtupleboolralistrrrcr__annotations__rdrerfrgrhrirjrkrlrmrnrorprqrrrsrtrurv__static_attributes__ __classcell__)r#s@r$rr'sDL[I"#"&)-*.  c]  tn 3-"#X&6>B 3H% 3,4UO 3 / " 3 3FFtFFFP<5c?<d<t<<|G,U39%uS$_'==>G, sDy G,G,R#'y'B'B"CIuT#YCI&88CCJc C!2277D%*7<'99EEKsEC#55==GU3Z=? 2277D%*7<(::GGL%*G"3399E5:9=(1(C(C(Y(Y5:Y$55==GU3Z=?"44;;FE#J;>#55==GU3Z=?(::GGL%*GD1155Cs5;#55==GU3Z=!* ; ; I IM5:IE%77AAIuSzAA(::GGL%*GD%77AAIuSzAA1155Cs5;r&)r{rBr<collections.abcrtypingrrrrtelegramrtelegram._telegramobjectr telegram._userr telegram._utilsr telegram._utils.stringsr telegram._utils.typesr rrrr&r$rsJ&O $883 0* w