mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2025-03-29 01:37:28 +01:00
a0720b9ac6
* 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>
335 lines
15 KiB
Python
335 lines
15 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2020
|
|
# 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/].
|
|
"""Base class for Telegram InputMedia Objects."""
|
|
|
|
from telegram import TelegramObject, InputFile, PhotoSize, Animation, Video, Audio, Document
|
|
from telegram.utils.helpers import DEFAULT_NONE
|
|
|
|
|
|
class InputMedia(TelegramObject):
|
|
"""Base class for Telegram InputMedia Objects.
|
|
|
|
See :class:`telegram.InputMediaAnimation`, :class:`telegram.InputMediaAudio`,
|
|
:class:`telegram.InputMediaDocument`, :class:`telegram.InputMediaPhoto` and
|
|
:class:`telegram.InputMediaVideo` for detailed use.
|
|
|
|
"""
|
|
pass
|
|
|
|
|
|
class InputMediaAnimation(InputMedia):
|
|
"""Represents an animation file (GIF or H.264/MPEG-4 AVC video without sound) to be sent.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): ``animation``.
|
|
media (:obj:`str` | :class:`telegram.InputFile`): Animation to send.
|
|
caption (:obj:`str`): Optional. Caption of the document to be sent.
|
|
parse_mode (:obj:`str`): Optional. The parse mode to use for text formatting.
|
|
thumb (:class:`telegram.InputFile`): Optional. Thumbnail of the file to send.
|
|
width (:obj:`int`): Optional. Animation width.
|
|
height (:obj:`int`): Optional. Animation height.
|
|
duration (:obj:`int`): Optional. Animation duration.
|
|
|
|
|
|
Args:
|
|
media (:obj:`str` | `filelike object` | :class:`telegram.Animation`): File to send. Pass a
|
|
file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP
|
|
URL for Telegram to get a file from the Internet. Lastly you can pass an existing
|
|
:class:`telegram.Animation` object to send.
|
|
thumb (`filelike object`, optional): Thumbnail of the file sent; can be ignored if
|
|
thumbnail generation for the file is supported server-side. The thumbnail should be
|
|
in JPEG format and less than 200 kB in size. A thumbnail's width and height should
|
|
not exceed 320. Ignored if the file is not uploaded using multipart/form-data.
|
|
Thumbnails can't be reused and can be only uploaded as a new file.
|
|
caption (:obj:`str`, optional): Caption of the animation to be sent, 0-1024 characters
|
|
after entities parsing.
|
|
parse_mode (:obj:`str`, optional): Send Markdown or HTML, if you want Telegram apps to show
|
|
bold, italic, fixed-width text or inline URLs in the media caption. See the constants
|
|
in :class:`telegram.ParseMode` for the available modes.
|
|
width (:obj:`int`, optional): Animation width.
|
|
height (:obj:`int`, optional): Animation height.
|
|
duration (:obj:`int`, optional): Animation duration.
|
|
|
|
Note:
|
|
When using a :class:`telegram.Animation` for the :attr:`media` attribute. It will take the
|
|
width, height and duration from that video, unless otherwise specified with the optional
|
|
arguments.
|
|
"""
|
|
|
|
def __init__(self,
|
|
media,
|
|
thumb=None,
|
|
caption=None,
|
|
parse_mode=DEFAULT_NONE,
|
|
width=None,
|
|
height=None,
|
|
duration=None):
|
|
self.type = 'animation'
|
|
|
|
if isinstance(media, Animation):
|
|
self.media = media.file_id
|
|
self.width = media.width
|
|
self.height = media.height
|
|
self.duration = media.duration
|
|
elif InputFile.is_file(media):
|
|
self.media = InputFile(media, attach=True)
|
|
else:
|
|
self.media = media
|
|
|
|
if thumb:
|
|
self.thumb = thumb
|
|
if InputFile.is_file(self.thumb):
|
|
self.thumb = InputFile(self.thumb, attach=True)
|
|
|
|
if caption:
|
|
self.caption = caption
|
|
self.parse_mode = parse_mode
|
|
if width:
|
|
self.width = width
|
|
if height:
|
|
self.height = height
|
|
if duration:
|
|
self.duration = duration
|
|
|
|
|
|
class InputMediaPhoto(InputMedia):
|
|
"""Represents a photo to be sent.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): ``photo``.
|
|
media (:obj:`str` | :class:`telegram.InputFile`): Photo to send.
|
|
caption (:obj:`str`): Optional. Caption of the document to be sent.
|
|
parse_mode (:obj:`str`): Optional. The parse mode to use for text formatting.
|
|
|
|
Args:
|
|
media (:obj:`str` | `filelike object` | :class:`telegram.PhotoSize`): File to send. Pass a
|
|
file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP
|
|
URL for Telegram to get a file from the Internet. Lastly you can pass an existing
|
|
:class:`telegram.PhotoSize` object to send.
|
|
caption (:obj:`str`, optional ): Caption of the photo to be sent, 0-1024 characters after
|
|
entities parsing.
|
|
parse_mode (:obj:`str`, optional): Send Markdown or HTML, if you want Telegram apps to show
|
|
bold, italic, fixed-width text or inline URLs in the media caption. See the constants
|
|
in :class:`telegram.ParseMode` for the available modes.
|
|
"""
|
|
|
|
def __init__(self, media, caption=None, parse_mode=DEFAULT_NONE):
|
|
self.type = 'photo'
|
|
|
|
if isinstance(media, PhotoSize):
|
|
self.media = media.file_id
|
|
elif InputFile.is_file(media):
|
|
self.media = InputFile(media, attach=True)
|
|
else:
|
|
self.media = media
|
|
|
|
if caption:
|
|
self.caption = caption
|
|
self.parse_mode = parse_mode
|
|
|
|
|
|
class InputMediaVideo(InputMedia):
|
|
"""Represents a video to be sent.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): ``video``.
|
|
media (:obj:`str` | :class:`telegram.InputFile`): Video file to send.
|
|
caption (:obj:`str`): Optional. Caption of the document to be sent.
|
|
parse_mode (:obj:`str`): Optional. The parse mode to use for text formatting.
|
|
width (:obj:`int`): Optional. Video width.
|
|
height (:obj:`int`): Optional. Video height.
|
|
duration (:obj:`int`): Optional. Video duration.
|
|
supports_streaming (:obj:`bool`): Optional. Pass :obj:`True`, if the uploaded video is
|
|
suitable for streaming.
|
|
thumb (:class:`telegram.InputFile`): Optional. Thumbnail of the file to send.
|
|
|
|
Args:
|
|
media (:obj:`str` | `filelike object` | :class:`telegram.Video`): File to send. Pass a
|
|
file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP
|
|
URL for Telegram to get a file from the Internet. Lastly you can pass an existing
|
|
:class:`telegram.Video` object to send.
|
|
caption (:obj:`str`, optional): Caption of the video to be sent, 0-1024 characters after
|
|
entities parsing.
|
|
parse_mode (:obj:`str`, optional): Send Markdown or HTML, if you want Telegram apps to show
|
|
bold, italic, fixed-width text or inline URLs in the media caption. See the constants
|
|
in :class:`telegram.ParseMode` for the available modes.
|
|
width (:obj:`int`, optional): Video width.
|
|
height (:obj:`int`, optional): Video height.
|
|
duration (:obj:`int`, optional): Video duration.
|
|
supports_streaming (:obj:`bool`, optional): Pass :obj:`True`, if the uploaded video is
|
|
suitable for streaming.
|
|
thumb (`filelike object`, optional): Thumbnail of the file sent; can be ignored if
|
|
thumbnail generation for the file is supported server-side. The thumbnail should be
|
|
in JPEG format and less than 200 kB in size. A thumbnail's width and height should
|
|
not exceed 320. Ignored if the file is not uploaded using multipart/form-data.
|
|
Thumbnails can't be reused and can be only uploaded as a new file.
|
|
|
|
Note:
|
|
When using a :class:`telegram.Video` for the :attr:`media` attribute. It will take the
|
|
width, height and duration from that video, unless otherwise specified with the optional
|
|
arguments.
|
|
"""
|
|
|
|
def __init__(self, media, caption=None, width=None, height=None, duration=None,
|
|
supports_streaming=None, parse_mode=DEFAULT_NONE, thumb=None):
|
|
self.type = 'video'
|
|
|
|
if isinstance(media, Video):
|
|
self.media = media.file_id
|
|
self.width = media.width
|
|
self.height = media.height
|
|
self.duration = media.duration
|
|
elif InputFile.is_file(media):
|
|
self.media = InputFile(media, attach=True)
|
|
else:
|
|
self.media = media
|
|
|
|
if thumb:
|
|
self.thumb = thumb
|
|
if InputFile.is_file(self.thumb):
|
|
self.thumb = InputFile(self.thumb, attach=True)
|
|
|
|
if caption:
|
|
self.caption = caption
|
|
self.parse_mode = parse_mode
|
|
if width:
|
|
self.width = width
|
|
if height:
|
|
self.height = height
|
|
if duration:
|
|
self.duration = duration
|
|
if supports_streaming:
|
|
self.supports_streaming = supports_streaming
|
|
|
|
|
|
class InputMediaAudio(InputMedia):
|
|
"""Represents an audio file to be treated as music to be sent.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): ``audio``.
|
|
media (:obj:`str` | :class:`telegram.InputFile`): Audio file to send.
|
|
caption (:obj:`str`): Optional. Caption of the document to be sent.
|
|
parse_mode (:obj:`str`): Optional. The parse mode to use for text formatting.
|
|
duration (:obj:`int`): Duration of the audio in seconds.
|
|
performer (:obj:`str`): Optional. Performer of the audio as defined by sender or by audio
|
|
tags.
|
|
title (:obj:`str`): Optional. Title of the audio as defined by sender or by audio tags.
|
|
thumb (:class:`telegram.InputFile`): Optional. Thumbnail of the file to send.
|
|
|
|
Args:
|
|
media (:obj:`str` | `filelike object` | :class:`telegram.Audio`): File to send. Pass a
|
|
file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP
|
|
URL for Telegram to get a file from the Internet. Lastly you can pass an existing
|
|
:class:`telegram.Audio` object to send.
|
|
caption (:obj:`str`, optional): Caption of the audio to be sent, 0-1024 characters after
|
|
entities parsing.
|
|
parse_mode (:obj:`str`, optional): Send Markdown or HTML, if you want Telegram apps to show
|
|
bold, italic, fixed-width text or inline URLs in the media caption. See the constants
|
|
in :class:`telegram.ParseMode` for the available modes.
|
|
duration (:obj:`int`): Duration of the audio in seconds as defined by sender.
|
|
performer (:obj:`str`, optional): Performer of the audio as defined by sender or by audio
|
|
tags.
|
|
title (:obj:`str`, optional): Title of the audio as defined by sender or by audio tags.
|
|
thumb (`filelike object`, optional): Thumbnail of the file sent; can be ignored if
|
|
thumbnail generation for the file is supported server-side. The thumbnail should be
|
|
in JPEG format and less than 200 kB in size. A thumbnail's width and height should
|
|
not exceed 320. Ignored if the file is not uploaded using multipart/form-data.
|
|
Thumbnails can't be reused and can be only uploaded as a new file.
|
|
|
|
Note:
|
|
When using a :class:`telegram.Audio` for the :attr:`media` attribute. It will take the
|
|
duration, performer and title from that video, unless otherwise specified with the
|
|
optional arguments.
|
|
"""
|
|
|
|
def __init__(self, media, thumb=None, caption=None, parse_mode=DEFAULT_NONE,
|
|
duration=None, performer=None, title=None):
|
|
self.type = 'audio'
|
|
|
|
if isinstance(media, Audio):
|
|
self.media = media.file_id
|
|
self.duration = media.duration
|
|
self.performer = media.performer
|
|
self.title = media.title
|
|
elif InputFile.is_file(media):
|
|
self.media = InputFile(media, attach=True)
|
|
else:
|
|
self.media = media
|
|
|
|
if thumb:
|
|
self.thumb = thumb
|
|
if InputFile.is_file(self.thumb):
|
|
self.thumb = InputFile(self.thumb, attach=True)
|
|
|
|
if caption:
|
|
self.caption = caption
|
|
self.parse_mode = parse_mode
|
|
if duration:
|
|
self.duration = duration
|
|
if performer:
|
|
self.performer = performer
|
|
if title:
|
|
self.title = title
|
|
|
|
|
|
class InputMediaDocument(InputMedia):
|
|
"""Represents a general file to be sent.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): ``document``.
|
|
media (:obj:`str` | :class:`telegram.InputFile`): File to send.
|
|
caption (:obj:`str`): Optional. Caption of the document to be sent.
|
|
parse_mode (:obj:`str`): Optional. The parse mode to use for text formatting.
|
|
thumb (:class:`telegram.InputFile`): Optional. Thumbnail of the file to send.
|
|
|
|
Args:
|
|
media (:obj:`str` | `filelike object` | :class:`telegram.Document`): File to send. Pass a
|
|
file_id to send a file that exists on the Telegram servers (recommended), pass an HTTP
|
|
URL for Telegram to get a file from the Internet. Lastly you can pass an existing
|
|
:class:`telegram.Document` object to send.
|
|
caption (:obj:`str`, optional): Caption of the document to be sent, 0-1024 characters after
|
|
entities parsing.
|
|
parse_mode (:obj:`str`, optional): Send Markdown or HTML, if you want Telegram apps to show
|
|
bold, italic, fixed-width text or inline URLs in the media caption. See the constants
|
|
in :class:`telegram.ParseMode` for the available modes.
|
|
thumb (`filelike object`, optional): Thumbnail of the file sent; can be ignored if
|
|
thumbnail generation for the file is supported server-side. The thumbnail should be
|
|
in JPEG format and less than 200 kB in size. A thumbnail's width and height should
|
|
not exceed 320. Ignored if the file is not uploaded using multipart/form-data.
|
|
Thumbnails can't be reused and can be only uploaded as a new file.
|
|
"""
|
|
|
|
def __init__(self, media, thumb=None, caption=None, parse_mode=DEFAULT_NONE):
|
|
self.type = 'document'
|
|
|
|
if isinstance(media, Document):
|
|
self.media = media.file_id
|
|
elif InputFile.is_file(media):
|
|
self.media = InputFile(media, attach=True)
|
|
else:
|
|
self.media = media
|
|
|
|
if thumb:
|
|
self.thumb = thumb
|
|
if InputFile.is_file(self.thumb):
|
|
self.thumb = InputFile(self.thumb, attach=True)
|
|
|
|
if caption:
|
|
self.caption = caption
|
|
self.parse_mode = parse_mode
|