2016-04-12 06:12:35 +02:00
|
|
|
#!/usr/bin/env python
|
|
|
|
#
|
|
|
|
# A library that provides a Python interface to the Telegram Bot API
|
2022-01-03 08:15:18 +01:00
|
|
|
# Copyright (C) 2015-2022
|
2016-04-12 06:12:35 +02:00
|
|
|
# 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/].
|
2016-10-17 00:22:40 +02:00
|
|
|
"""This module contains an object that represents a Telegram MessageEntity."""
|
2016-04-16 16:33:58 +02:00
|
|
|
|
2022-05-05 09:27:54 +02:00
|
|
|
from typing import TYPE_CHECKING, Any, ClassVar, List, Optional
|
2020-10-31 16:33:34 +01:00
|
|
|
|
2022-05-05 09:27:54 +02:00
|
|
|
from telegram import constants
|
|
|
|
from telegram._telegramobject import TelegramObject
|
|
|
|
from telegram._user import User
|
2022-04-30 22:18:11 +02:00
|
|
|
from telegram._utils import enum
|
2021-10-10 15:10:21 +02:00
|
|
|
from telegram._utils.types import JSONDict
|
2020-10-06 19:28:40 +02:00
|
|
|
|
|
|
|
if TYPE_CHECKING:
|
|
|
|
from telegram import Bot
|
2016-04-16 16:33:58 +02:00
|
|
|
|
|
|
|
|
|
|
|
class MessageEntity(TelegramObject):
|
|
|
|
"""
|
2017-07-23 22:33:08 +02:00
|
|
|
This object represents one special entity in a text message. For example, hashtags,
|
|
|
|
usernames, URLs, etc.
|
|
|
|
|
2020-07-14 21:33:56 +02:00
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
2021-02-01 17:59:39 +01:00
|
|
|
considered equal, if their :attr:`type`, :attr:`offset` and :attr:`length` are equal.
|
2020-07-14 21:33:56 +02:00
|
|
|
|
2016-04-16 16:33:58 +02:00
|
|
|
Args:
|
2021-10-19 18:28:19 +02:00
|
|
|
type (:obj:`str`): Type of the entity. Can be :attr:`MENTION` (@username),
|
|
|
|
:attr:`HASHTAG`, :attr:`BOT_COMMAND`,
|
|
|
|
:attr:`URL`, :attr:`EMAIL`, :attr:`PHONE_NUMBER`, :attr:`BOLD` (bold text),
|
|
|
|
:attr:`ITALIC` (italic text), :attr:`STRIKETHROUGH`, :attr:`SPOILER` (spoiler message),
|
|
|
|
:attr:`CODE` (monowidth string), :attr:`PRE` (monowidth block), :attr:`TEXT_LINK` (for
|
|
|
|
clickable text URLs), :attr:`TEXT_MENTION` (for users without usernames).
|
2017-07-23 22:33:08 +02:00
|
|
|
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.
|
2020-03-29 09:52:30 +02:00
|
|
|
url (:obj:`str`, optional): For :attr:`TEXT_LINK` only, url that will be opened after
|
Documentation Improvements (#2008)
* Minor doc updates, following official API docs
* Fix spelling in Defaults docstrings
* Clarify Changelog of v12.7 about aware dates
* Fix typo in CHANGES.rst (#2024)
* Fix PicklePersistence.flush() with only bot_data (#2017)
* Update pylint in pre-commit to fix CI (#2018)
* Add Filters.via_bot (#2009)
* feat: via_bot filter
also fixing a small mistake in the empty parameter of the user filter and improve docs slightly
* fix: forgot to set via_bot to None
* fix: redoing subclassing to copy paste solution
* Cosmetic changes
Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de>
* Update CHANGES.rst
Fixed Typo
Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
* Update downloads badge, add info on IRC Channel to Getting Help section
* Remove RegexHandler from ConversationHandlers Docs (#1973)
Replaced RegexHandler with MessageHandler, since the former is deprecated
* Fix Filters.via_bot docstrings
* Add notes on Markdown v1 being legacy mode
* Fixed typo in the Regex doc.. (#2036)
* Typo: Spelling
* Minor cleanup from #2043
* Document CommandHandler ignoring channel posts
* Doc fixes for a few telegram.ext classes
* Doc fixes for most `telegram` classes.
* pep-8
forgot the hard wrap is at 99 chars, not 100!
fixed a few spelling mistakes too.
* Address review and made rendering of booleans consistent
True, False, None are now rendered with ``bool`` wherever they weren't in telegram and telegram.ext classes.
* Few doc fixes for inline* classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram/files classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram.Game
Mostly just added hyperlinks. And fixed message length doc.
As usual, docs were cross-checked with official tg api docs.
* Very minor doc fix for passportfile.py and passportelementerrors.py
Didn't bother changing too much since this seems to be a custom implementation.
* Doc fixes for telegram.payments
As usual, cross-checked with official bot api docs.
* Address review 2
Few tiny other fixes too.
* Changed from ``True/False/None`` to :obj:`True/False/None` project-wide.
Few tiny other doc fixes too.
Co-authored-by: Robert Geislinger <mitachundkrach@gmail.com>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: GauthamramRavichandran <30320759+GauthamramRavichandran@users.noreply.github.com>
Co-authored-by: Mahesh19 <maheshvagicherla99438@gmail.com>
Co-authored-by: hoppingturtles <ilovebhagwan@gmail.com>
2020-08-24 19:35:57 +02:00
|
|
|
user taps on the text.
|
2020-03-29 09:52:30 +02:00
|
|
|
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
|
Documentation Improvements (#2008)
* Minor doc updates, following official API docs
* Fix spelling in Defaults docstrings
* Clarify Changelog of v12.7 about aware dates
* Fix typo in CHANGES.rst (#2024)
* Fix PicklePersistence.flush() with only bot_data (#2017)
* Update pylint in pre-commit to fix CI (#2018)
* Add Filters.via_bot (#2009)
* feat: via_bot filter
also fixing a small mistake in the empty parameter of the user filter and improve docs slightly
* fix: forgot to set via_bot to None
* fix: redoing subclassing to copy paste solution
* Cosmetic changes
Co-authored-by: Hinrich Mahler <hinrich.mahler@freenet.de>
* Update CHANGES.rst
Fixed Typo
Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
* Update downloads badge, add info on IRC Channel to Getting Help section
* Remove RegexHandler from ConversationHandlers Docs (#1973)
Replaced RegexHandler with MessageHandler, since the former is deprecated
* Fix Filters.via_bot docstrings
* Add notes on Markdown v1 being legacy mode
* Fixed typo in the Regex doc.. (#2036)
* Typo: Spelling
* Minor cleanup from #2043
* Document CommandHandler ignoring channel posts
* Doc fixes for a few telegram.ext classes
* Doc fixes for most `telegram` classes.
* pep-8
forgot the hard wrap is at 99 chars, not 100!
fixed a few spelling mistakes too.
* Address review and made rendering of booleans consistent
True, False, None are now rendered with ``bool`` wherever they weren't in telegram and telegram.ext classes.
* Few doc fixes for inline* classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram/files classes
As usual, docs were cross-checked with official tg api docs.
* Doc fixes for telegram.Game
Mostly just added hyperlinks. And fixed message length doc.
As usual, docs were cross-checked with official tg api docs.
* Very minor doc fix for passportfile.py and passportelementerrors.py
Didn't bother changing too much since this seems to be a custom implementation.
* Doc fixes for telegram.payments
As usual, cross-checked with official bot api docs.
* Address review 2
Few tiny other fixes too.
* Changed from ``True/False/None`` to :obj:`True/False/None` project-wide.
Few tiny other doc fixes too.
Co-authored-by: Robert Geislinger <mitachundkrach@gmail.com>
Co-authored-by: Poolitzer <25934244+Poolitzer@users.noreply.github.com>
Co-authored-by: GauthamramRavichandran <30320759+GauthamramRavichandran@users.noreply.github.com>
Co-authored-by: Mahesh19 <maheshvagicherla99438@gmail.com>
Co-authored-by: hoppingturtles <ilovebhagwan@gmail.com>
2020-08-24 19:35:57 +02:00
|
|
|
the entity text.
|
2017-09-01 08:43:08 +02:00
|
|
|
|
2020-12-30 15:59:50 +01:00
|
|
|
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.
|
|
|
|
|
2016-04-16 16:33:58 +02:00
|
|
|
"""
|
|
|
|
|
2021-08-19 22:01:10 +02:00
|
|
|
__slots__ = ("length", "url", "user", "type", "language", "offset")
|
2021-05-29 16:18:16 +02:00
|
|
|
|
2020-10-06 19:28:40 +02:00
|
|
|
def __init__(
|
2020-11-05 18:12:01 +01:00
|
|
|
self,
|
2021-10-08 08:17:00 +02:00
|
|
|
type: str, # pylint: disable=redefined-builtin
|
2020-10-06 19:28:40 +02:00
|
|
|
offset: int,
|
|
|
|
length: int,
|
|
|
|
url: str = None,
|
|
|
|
user: User = None,
|
|
|
|
language: str = None,
|
2020-11-05 18:12:01 +01:00
|
|
|
**_kwargs: Any,
|
2020-10-06 19:28:40 +02:00
|
|
|
):
|
2016-04-16 16:33:58 +02:00
|
|
|
# Required
|
2022-04-30 22:18:11 +02:00
|
|
|
self.type = enum.get_member(constants.MessageEntityType, type, type)
|
2016-04-16 16:33:58 +02:00
|
|
|
self.offset = offset
|
|
|
|
self.length = length
|
|
|
|
# Optionals
|
2016-10-16 16:24:13 +02:00
|
|
|
self.url = url
|
|
|
|
self.user = user
|
2020-03-29 09:52:30 +02:00
|
|
|
self.language = language
|
2016-04-16 16:33:58 +02:00
|
|
|
|
2019-08-23 23:54:04 +02:00
|
|
|
self._id_attrs = (self.type, self.offset, self.length)
|
|
|
|
|
2017-07-23 21:14:38 +02:00
|
|
|
@classmethod
|
2020-10-06 19:28:40 +02:00
|
|
|
def de_json(cls, data: Optional[JSONDict], bot: "Bot") -> Optional["MessageEntity"]:
|
2021-05-27 09:38:17 +02:00
|
|
|
"""See :meth:`telegram.TelegramObject.de_json`."""
|
|
|
|
data = cls._parse_data(data)
|
2017-07-23 21:14:38 +02:00
|
|
|
|
|
|
|
if not data:
|
|
|
|
return None
|
2016-04-16 16:33:58 +02:00
|
|
|
|
2016-09-20 06:36:55 +02:00
|
|
|
data["user"] = User.de_json(data.get("user"), bot)
|
2016-05-24 01:31:36 +02:00
|
|
|
|
2017-07-23 21:14:38 +02:00
|
|
|
return cls(**data)
|
2016-04-17 12:43:09 +02:00
|
|
|
|
2021-10-19 18:28:19 +02:00
|
|
|
MENTION: ClassVar[str] = constants.MessageEntityType.MENTION
|
|
|
|
""":const:`telegram.constants.MessageEntityType.MENTION`"""
|
|
|
|
HASHTAG: ClassVar[str] = constants.MessageEntityType.HASHTAG
|
|
|
|
""":const:`telegram.constants.MessageEntityType.HASHTAG`"""
|
|
|
|
CASHTAG: ClassVar[str] = constants.MessageEntityType.CASHTAG
|
|
|
|
""":const:`telegram.constants.MessageEntityType.CASHTAG`"""
|
|
|
|
PHONE_NUMBER: ClassVar[str] = constants.MessageEntityType.PHONE_NUMBER
|
|
|
|
""":const:`telegram.constants.MessageEntityType.PHONE_NUMBER`"""
|
|
|
|
BOT_COMMAND: ClassVar[str] = constants.MessageEntityType.BOT_COMMAND
|
|
|
|
""":const:`telegram.constants.MessageEntityType.BOT_COMMAND`"""
|
|
|
|
URL: ClassVar[str] = constants.MessageEntityType.URL
|
|
|
|
""":const:`telegram.constants.MessageEntityType.URL`"""
|
|
|
|
EMAIL: ClassVar[str] = constants.MessageEntityType.EMAIL
|
|
|
|
""":const:`telegram.constants.MessageEntityType.EMAIL`"""
|
|
|
|
BOLD: ClassVar[str] = constants.MessageEntityType.BOLD
|
|
|
|
""":const:`telegram.constants.MessageEntityType.BOLD`"""
|
|
|
|
ITALIC: ClassVar[str] = constants.MessageEntityType.ITALIC
|
|
|
|
""":const:`telegram.constants.MessageEntityType.ITALIC`"""
|
|
|
|
CODE: ClassVar[str] = constants.MessageEntityType.CODE
|
|
|
|
""":const:`telegram.constants.MessageEntityType.CODE`"""
|
|
|
|
PRE: ClassVar[str] = constants.MessageEntityType.PRE
|
|
|
|
""":const:`telegram.constants.MessageEntityType.PRE`"""
|
|
|
|
TEXT_LINK: ClassVar[str] = constants.MessageEntityType.TEXT_LINK
|
|
|
|
""":const:`telegram.constants.MessageEntityType.TEXT_LINK`"""
|
|
|
|
TEXT_MENTION: ClassVar[str] = constants.MessageEntityType.TEXT_MENTION
|
|
|
|
""":const:`telegram.constants.MessageEntityType.TEXT_MENTION`"""
|
|
|
|
UNDERLINE: ClassVar[str] = constants.MessageEntityType.UNDERLINE
|
|
|
|
""":const:`telegram.constants.MessageEntityType.UNDERLINE`"""
|
|
|
|
STRIKETHROUGH: ClassVar[str] = constants.MessageEntityType.STRIKETHROUGH
|
|
|
|
""":const:`telegram.constants.MessageEntityType.STRIKETHROUGH`"""
|
|
|
|
SPOILER: ClassVar[str] = constants.MessageEntityType.SPOILER
|
|
|
|
""":const:`telegram.constants.MessageEntityType.SPOILER`
|
2022-01-03 08:13:33 +01:00
|
|
|
|
|
|
|
.. versionadded:: 13.10
|
|
|
|
"""
|
2021-10-19 18:28:19 +02:00
|
|
|
ALL_TYPES: ClassVar[List[str]] = list(constants.MessageEntityType)
|
|
|
|
"""List[:obj:`str`]: A list of all available message entity types."""
|