mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2025-01-01 08:56:27 +01:00
2a4a0d0ccd
* Change default handling, update signatures, get existing tests to pass. * Try running tests on ubuntu 18.04 * Roll back * Rework check_shortcut_call tests * Further improve check_shortcut_call tests * Start on defaults-checks for shortcuts, get it working for test_message * Add check_shortcut_defaults to all other shortcut tests * Some fine tuning * Add defaults checking for bot methods * Missing tests for TestCallbackQuery * Test edit_message_media with defaults & some comments * Fix cryptography requirement * drop debug prints * Remove debug prints * Another try * Try to fix coverage & logs * Rearrange test order * increase coverage * Try to fix coverage reports * address review * Adapt tests like in #2386 * fix CI * fix CI
96 lines
3.6 KiB
Python
96 lines
3.6 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2021
|
|
# 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 Voice."""
|
|
|
|
from typing import TYPE_CHECKING, Any
|
|
|
|
from telegram import TelegramObject
|
|
from telegram.utils.helpers import DEFAULT_NONE
|
|
from telegram.utils.types import JSONDict, ODVInput
|
|
|
|
if TYPE_CHECKING:
|
|
from telegram import Bot, File
|
|
|
|
|
|
class Voice(TelegramObject):
|
|
"""This object represents a voice note.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`file_unique_id` is equal.
|
|
|
|
Args:
|
|
file_id (:obj:`str`): Identifier for this file, which can be used to download
|
|
or reuse the file.
|
|
file_unique_id (:obj:`str`): Unique identifier for this file, which
|
|
is supposed to be the same over time and for different bots.
|
|
Can't be used to download or reuse the file.
|
|
duration (:obj:`int`, optional): Duration of the audio in seconds as defined by sender.
|
|
mime_type (:obj:`str`, optional): MIME type of the file as defined by sender.
|
|
file_size (:obj:`int`, optional): File size.
|
|
bot (:class:`telegram.Bot`, optional): The Bot to use for instance methods.
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
|
|
|
Attributes:
|
|
file_id (:obj:`str`): Identifier for this file.
|
|
file_unique_id (:obj:`str`): Unique identifier for this file, which
|
|
is supposed to be the same over time and for different bots.
|
|
Can't be used to download or reuse the file.
|
|
duration (:obj:`int`): Duration of the audio in seconds as defined by sender.
|
|
mime_type (:obj:`str`): Optional. MIME type of the file as defined by sender.
|
|
file_size (:obj:`int`): Optional. File size.
|
|
bot (:class:`telegram.Bot`): Optional. The Bot to use for instance methods.
|
|
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
file_id: str,
|
|
file_unique_id: str,
|
|
duration: int,
|
|
mime_type: str = None,
|
|
file_size: int = None,
|
|
bot: 'Bot' = None,
|
|
**_kwargs: Any,
|
|
):
|
|
# Required
|
|
self.file_id = str(file_id)
|
|
self.file_unique_id = str(file_unique_id)
|
|
self.duration = int(duration)
|
|
# Optionals
|
|
self.mime_type = mime_type
|
|
self.file_size = file_size
|
|
self.bot = bot
|
|
|
|
self._id_attrs = (self.file_unique_id,)
|
|
|
|
def get_file(
|
|
self, timeout: ODVInput[float] = DEFAULT_NONE, api_kwargs: JSONDict = None
|
|
) -> 'File':
|
|
"""Convenience wrapper over :attr:`telegram.Bot.get_file`
|
|
|
|
For the documentation of the arguments, please see :meth:`telegram.Bot.get_file`.
|
|
|
|
Returns:
|
|
:class:`telegram.File`
|
|
|
|
Raises:
|
|
:class:`telegram.error.TelegramError`
|
|
|
|
"""
|
|
return self.bot.get_file(file_id=self.file_id, timeout=timeout, api_kwargs=api_kwargs)
|