feat: add name param to download_file method (#167)

botx/bots/mixins/requests/files.py

@@ -50,12 +50,13 @@ async def upload_file(  # noqa: WPS211
             credentials=credentials,
         )
 
-    async def download_file(
+    async def download_file(  # noqa: WPS211
         self: BotXMethodCallProtocol,
         credentials: SendingCredentials,
         file_id: UUID,
         group_chat_id: UUID,
         *,
+        file_name: Optional[str] = None,
         is_preview: bool = False,
     ) -> File:
         """Download file from the chat.
@@ -64,16 +65,23 @@ async def download_file(
             credentials: credentials for making request.
             file_id: ID of the file.
             group_chat_id: ID of the chat that accepts the file.
+            file_name: file name to be assigned instead of default name.
             is_preview: get preview or file.
 
         Returns:
             Downloaded file.
         """
-        return await self.call_method(
+        file = await self.call_method(
             DownloadFile(
                 file_id=file_id,
                 group_chat_id=group_chat_id,
                 is_preview=is_preview,
             ),
             credentials=credentials,
         )
+
+        if file_name:
+            ext = file.file_name.split(".", maxsplit=1)[1]
+            file.file_name = "{name}.{ext}".format(name=file_name, ext=ext)
+
+        return file

docs/changelog.md

@@ -1,3 +1,10 @@
+## 0.23.2 (Sep 09, 2021)
+
+### Added
+
+* Add `file_name` param to `download_file` method to provide ability to change the returned file name.
+
+
 ## 0.23.1 (Aug 30, 2021)
 
 ### Fixed

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "botx"
-version = "0.23.1"
+version = "0.23.2"
 description = "A little python framework for building bots for eXpress"
 license = "MIT"
 authors = [

tests/test_bots/test_mixins/test_requests/test_files.py

@@ -25,3 +25,14 @@ async def test_download_file(client, message):
     )
 
     assert isinstance(client.requests[0], DownloadFile)
+
+
+async def test_custom_filename(client, message):
+    file = await client.bot.download_file(
+        message.credentials,
+        file_id=uuid4(),
+        group_chat_id=uuid4(),
+        file_name="myname",
+    )
+
+    assert file.file_name == "myname.txt"