-
Notifications
You must be signed in to change notification settings - Fork 6.1k
Expand file tree
/
Copy pathmessageentity.py
More file actions
162 lines (140 loc) · 6.62 KB
/
Copy pathmessageentity.py
File metadata and controls
162 lines (140 loc) · 6.62 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
#!/usr/bin/env python
#
# A library that provides a Python interface to the Telegram Bot API
# Copyright (C) 2015-2022
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
#
# 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 MessageEntity."""
from typing import TYPE_CHECKING, Any, List, Optional, ClassVar
from telegram import TelegramObject, User, constants
from telegram.utils.types import JSONDict
if TYPE_CHECKING:
from telegram import Bot
class MessageEntity(TelegramObject):
"""
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. Currently, can be mention (@username), hashtag,
bot_command, url, email, phone_number, bold (bold text), italic (italic text),
strikethrough, spoiler (spoiler message), code (monowidth string), pre
(monowidth block), text_link (for clickable text URLs), text_mention
(for users without usernames), custom_emoji (for inline custom emoji stickers).
.. versionadded:: 13.14
added inline custom emoji
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:: 13.14
Attributes:
type (:obj:`str`): Type of the entity.
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. Url that will be opened after user taps on the text.
user (:class:`telegram.User`): Optional. The mentioned user.
language (:obj:`str`): Optional. Programming language of the entity text.
custom_emoji_id (:obj:`str`): Optional. Unique identifier of the custom emoji.
.. versionadded:: 13.14
"""
__slots__ = (
'length',
'url',
'user',
'type',
'language',
'offset',
'custom_emoji_id',
'_id_attrs',
)
def __init__(
self,
type: str, # pylint: disable=W0622
offset: int,
length: int,
url: str = None,
user: User = None,
language: str = None,
custom_emoji_id: str = None,
**_kwargs: Any,
):
# Required
self.type = type
self.offset = offset
self.length = length
# Optionals
self.url = url
self.user = user
self.language = language
self.custom_emoji_id = custom_emoji_id
self._id_attrs = (self.type, self.offset, self.length)
@classmethod
def de_json(cls, data: Optional[JSONDict], bot: 'Bot') -> Optional['MessageEntity']:
"""See :meth:`telegram.TelegramObject.de_json`."""
data = cls._parse_data(data)
if not data:
return None
data['user'] = User.de_json(data.get('user'), bot)
return cls(**data)
MENTION: ClassVar[str] = constants.MESSAGEENTITY_MENTION
""":const:`telegram.constants.MESSAGEENTITY_MENTION`"""
HASHTAG: ClassVar[str] = constants.MESSAGEENTITY_HASHTAG
""":const:`telegram.constants.MESSAGEENTITY_HASHTAG`"""
CASHTAG: ClassVar[str] = constants.MESSAGEENTITY_CASHTAG
""":const:`telegram.constants.MESSAGEENTITY_CASHTAG`"""
PHONE_NUMBER: ClassVar[str] = constants.MESSAGEENTITY_PHONE_NUMBER
""":const:`telegram.constants.MESSAGEENTITY_PHONE_NUMBER`"""
BOT_COMMAND: ClassVar[str] = constants.MESSAGEENTITY_BOT_COMMAND
""":const:`telegram.constants.MESSAGEENTITY_BOT_COMMAND`"""
URL: ClassVar[str] = constants.MESSAGEENTITY_URL
""":const:`telegram.constants.MESSAGEENTITY_URL`"""
EMAIL: ClassVar[str] = constants.MESSAGEENTITY_EMAIL
""":const:`telegram.constants.MESSAGEENTITY_EMAIL`"""
BOLD: ClassVar[str] = constants.MESSAGEENTITY_BOLD
""":const:`telegram.constants.MESSAGEENTITY_BOLD`"""
ITALIC: ClassVar[str] = constants.MESSAGEENTITY_ITALIC
""":const:`telegram.constants.MESSAGEENTITY_ITALIC`"""
CODE: ClassVar[str] = constants.MESSAGEENTITY_CODE
""":const:`telegram.constants.MESSAGEENTITY_CODE`"""
PRE: ClassVar[str] = constants.MESSAGEENTITY_PRE
""":const:`telegram.constants.MESSAGEENTITY_PRE`"""
TEXT_LINK: ClassVar[str] = constants.MESSAGEENTITY_TEXT_LINK
""":const:`telegram.constants.MESSAGEENTITY_TEXT_LINK`"""
TEXT_MENTION: ClassVar[str] = constants.MESSAGEENTITY_TEXT_MENTION
""":const:`telegram.constants.MESSAGEENTITY_TEXT_MENTION`"""
UNDERLINE: ClassVar[str] = constants.MESSAGEENTITY_UNDERLINE
""":const:`telegram.constants.MESSAGEENTITY_UNDERLINE`"""
STRIKETHROUGH: ClassVar[str] = constants.MESSAGEENTITY_STRIKETHROUGH
""":const:`telegram.constants.MESSAGEENTITY_STRIKETHROUGH`"""
SPOILER: ClassVar[str] = constants.MESSAGEENTITY_SPOILER
""":const:`telegram.constants.MESSAGEENTITY_SPOILER`
.. versionadded:: 13.10
"""
CUSTOM_EMOJI: ClassVar[str] = constants.MESSAGEENTITY_CUSTOM_EMOJI
""":const:`telegram.constants.MESSAGEENTITY_CUSTOM_EMOJI`
.. versionadded:: 13.14
"""
ALL_TYPES: ClassVar[List[str]] = constants.MESSAGEENTITY_ALL_TYPES
""":const:`telegram.constants.MESSAGEENTITY_ALL_TYPES`\n
List of all the types"""