mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-11-23 07:38:58 +01:00
f6332d45a8
- File.download_as_bytearray - new method to get a d/led file as bytearray This is much more convenient and straight forward than using a file object. - File.download(): Now returns a meaningful return value - File.download*(): New and/or better unitests
146 lines
4.7 KiB
Python
146 lines
4.7 KiB
Python
#!/usr/bin/env python
|
|
# -*- coding: utf-8 -*-
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2018
|
|
# 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/].
|
|
import os
|
|
from tempfile import TemporaryFile, mkstemp
|
|
|
|
import pytest
|
|
from flaky import flaky
|
|
|
|
from telegram import File, TelegramError, Voice
|
|
|
|
|
|
@pytest.fixture(scope='class')
|
|
def file(bot):
|
|
return File(TestFile.file_id,
|
|
file_path=TestFile.file_path,
|
|
file_size=TestFile.file_size,
|
|
bot=bot)
|
|
|
|
|
|
class TestFile(object):
|
|
file_id = 'NOTVALIDDOESNOTMATTER'
|
|
file_path = (
|
|
u'https://api.org/file/bot133505823:AAHZFMHno3mzVLErU5b5jJvaeG--qUyLyG0/document/file_3')
|
|
file_size = 28232
|
|
file_content = u'Saint-Saëns'.encode('utf-8') # Intentionally contains unicode chars.
|
|
|
|
def test_de_json(self, bot):
|
|
json_dict = {
|
|
'file_id': self.file_id,
|
|
'file_path': self.file_path,
|
|
'file_size': self.file_size
|
|
}
|
|
new_file = File.de_json(json_dict, bot)
|
|
|
|
assert new_file.file_id == self.file_id
|
|
assert new_file.file_path == self.file_path
|
|
assert new_file.file_size == self.file_size
|
|
|
|
def test_to_dict(self, file):
|
|
file_dict = file.to_dict()
|
|
|
|
assert isinstance(file_dict, dict)
|
|
assert file_dict['file_id'] == file.file_id
|
|
assert file_dict['file_path'] == file.file_path
|
|
assert file_dict['file_size'] == file.file_size
|
|
|
|
@flaky(3, 1)
|
|
@pytest.mark.timeout(10)
|
|
def test_error_get_empty_file_id(self, bot):
|
|
with pytest.raises(TelegramError):
|
|
bot.get_file(file_id='')
|
|
|
|
def test_download(self, monkeypatch, file):
|
|
def test(*args, **kwargs):
|
|
return self.file_content
|
|
|
|
monkeypatch.setattr('telegram.utils.request.Request.retrieve', test)
|
|
out_file = file.download()
|
|
|
|
try:
|
|
with open(out_file, 'rb') as fobj:
|
|
assert fobj.read() == self.file_content
|
|
finally:
|
|
os.unlink(out_file)
|
|
|
|
def test_download_custom_path(self, monkeypatch, file):
|
|
def test(*args, **kwargs):
|
|
return self.file_content
|
|
|
|
monkeypatch.setattr('telegram.utils.request.Request.retrieve', test)
|
|
file_handle, custom_path = mkstemp()
|
|
try:
|
|
out_file = file.download(custom_path)
|
|
assert out_file == custom_path
|
|
|
|
with open(out_file, 'rb') as fobj:
|
|
assert fobj.read() == self.file_content
|
|
finally:
|
|
os.close(file_handle)
|
|
os.unlink(custom_path)
|
|
|
|
def test_download_file_obj(self, monkeypatch, file):
|
|
def test(*args, **kwargs):
|
|
return self.file_content
|
|
|
|
monkeypatch.setattr('telegram.utils.request.Request.retrieve', test)
|
|
with TemporaryFile() as custom_fobj:
|
|
out_fobj = file.download(out=custom_fobj)
|
|
assert out_fobj is custom_fobj
|
|
|
|
out_fobj.seek(0)
|
|
assert out_fobj.read() == self.file_content
|
|
|
|
def test_download_bytearray(self, monkeypatch, file):
|
|
def test(*args, **kwargs):
|
|
return self.file_content
|
|
|
|
monkeypatch.setattr('telegram.utils.request.Request.retrieve', test)
|
|
|
|
# Check that a download to a newly allocated bytearray works.
|
|
buf = file.download_as_bytearray()
|
|
assert buf == bytearray(self.file_content)
|
|
|
|
# Check that a download to a given bytearray works (extends the bytearray).
|
|
buf2 = buf[:]
|
|
buf3 = file.download_as_bytearray(buf=buf2)
|
|
assert buf3 is buf2
|
|
assert buf2[len(buf):] == buf
|
|
assert buf2[:len(buf)] == buf
|
|
|
|
def test_equality(self, bot):
|
|
a = File(self.file_id, bot)
|
|
b = File(self.file_id, bot)
|
|
c = File(self.file_id, None)
|
|
d = File('', bot)
|
|
e = Voice(self.file_id, 0)
|
|
|
|
assert a == b
|
|
assert hash(a) == hash(b)
|
|
assert a is not b
|
|
|
|
assert a == c
|
|
assert hash(a) == hash(c)
|
|
|
|
assert a != d
|
|
assert hash(a) != hash(d)
|
|
|
|
assert a != e
|
|
assert hash(a) != hash(e)
|