python/aiogram
1
0
Fork 0
mirror of https://github.com/aiogram/aiogram.git synced 2026-04-08 16:37:47 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

improve doc, codestyle

Browse source
This commit is contained in:
darksidecat 2021-09-01 11:59:21 +03:00
parent 6f1206b751
commit 2fb12fbe54
2 changed files with 9 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

12
aiogram/types/mixins.py
View file

@ -27,19 +27,21 @@ class Downloadable:
At most one of these parameters can be used: :param destination_dir:, :param destination_file:
:param destination: deprecated, use :param destination_dir: or :param destination_file:
:param destination: deprecated, use :param destination_dir: or :param destination_file: instead
:param timeout: Integer
:param chunk_size: Integer
:param seek: Boolean - go to start of file when downloading is finished.
:param make_dirs: Make dirs if not exist
:param destination_dir: directory for saving files
:param destination_file: the path to the file or instance of :class:`io.IOBase`. For e. g. :class:`io.BytesIO`
:param destination_file: path to the file or instance of :class:`io.IOBase`. For e. g. :class:`io.BytesIO`
:return: destination
"""
if destination:
warn_deprecated("destination parameter is deprecated, please use destination_dir.")
if destination_dir and destination_file:
raise ValueError("Use only one of the parameters: destination_dir or destination_file.")
raise ValueError(
"Use only one of the parameters: destination_dir or destination_file."
)
file, destination = await self._prepare_destination(
destination,
@ -59,7 +61,7 @@ class Downloadable:
async def _prepare_destination(self, dest, destination_dir, destination_file, make_dirs):
file = await self.get_file()
if not(any([dest, destination_dir, destination_file])):
if not(any((dest, destination_dir, destination_file))):
destination = file.file_path
elif dest: # backward compatibility
@ -83,7 +85,7 @@ class Downloadable:
else:
raise TypeError("destination_file must be str, pathlib.Path or io.IOBase type")
if make_dirs and os.path.dirname(destination) != '':
if make_dirs and os.path.dirname(destination):
os.makedirs(os.path.dirname(destination), exist_ok=True)
return file, destination

3
tests/types/test_mixins.py
View file

@ -82,7 +82,8 @@ class TestDownloadable:
async def test_download_destination_io_bytes(self, work_directory, downloadable):
file = BytesIO()
await downloadable.download(file)
with pytest.deprecated_call():
await downloadable.download(file)
assert len(file.read()) != 0
async def test_download_raise_value_error(self, work_directory, downloadable):