diff --git a/telegram/message.py b/telegram/message.py
index a48314dc680..2a938541b14 100644
--- a/telegram/message.py
+++ b/telegram/message.py
@@ -27,6 +27,9 @@
from telegram.utils.helpers import escape_html, escape_markdown, to_timestamp, from_timestamp
+_UNDEFINED = object()
+
+
class Message(TelegramObject):
"""
This object represents a message.
@@ -170,6 +173,7 @@ class Message(TelegramObject):
successful_payment (:class:`telegram.SuccessfulPayment`, optional): Message is a service
message about a successful payment, information about the payment.
"""
+ _effective_attachment = _UNDEFINED
def __init__(self,
message_id,
@@ -301,6 +305,39 @@ def de_json(cls, data, bot):
return cls(bot=bot, **data)
+ @property
+ def effective_attachment(self):
+ """
+ :class:`telegram.Audio`
+ or :class:`telegram.Contact`
+ or :class:`telegram.Document`
+ 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
+ ``None`` if no attachment was sent.
+
+ """
+ if self._effective_attachment is not _UNDEFINED:
+ return self._effective_attachment
+
+ for i in (self.audio, self.game, self.document, self.photo, self.sticker,
+ self.video, self.voice, self.video_note, self.contact, self.location,
+ self.venue, self.invoice, self.successful_payment):
+ if i is not None:
+ self._effective_attachment = i
+ break
+ else:
+ self._effective_attachment = None
+
+ return self._effective_attachment
+
def __getitem__(self, item):
if item in self.__dict__.keys():
return self.__dict__[item]
diff --git a/tests/test_message.py b/tests/test_message.py
index 240dc7f8f04..893ad09e191 100644
--- a/tests/test_message.py
+++ b/tests/test_message.py
@@ -205,6 +205,18 @@ def test_equality(self):
self.assertNotEqual(a, e)
self.assertNotEqual(hash(a), hash(e))
+ def test_effective_attachment(self):
+ for i in ('audio', 'game', 'document', 'photo', 'sticker', 'video', 'voice', 'video_note',
+ 'contact', 'location', 'venue', 'invoice', 'invoice', 'successful_payment'):
+ dummy = object()
+ kwargs = {i: dummy}
+ msg = telegram.Message(1, telegram.User(1, ""), None, None, **kwargs)
+ self.assertIs(msg.effective_attachment, dummy,
+ 'invalid {} effective attachment'.format(i))
+
+ msg = telegram.Message(1, telegram.User(1, ""), None, None)
+ self.assertIsNone(msg.effective_attachment)
+
if __name__ == '__main__':
unittest.main()
pFad - Phonifier reborn
Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.
Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.
Alternative Proxies:
Alternative Proxy
pFad Proxy
pFad v3 Proxy
pFad v4 Proxy