- file updates

- some method fix

Author: p1p1daster

pybotx/bot/bot.py

@@ -1450,6 +1450,7 @@ async def search_user_by_email_post(
     ) -> UserFromSearch:
         """Search user by email for search.
 
+        Wraps the single email into a list payload and returns the first result.
         For multiple emails use `search_user_by_emails`.
 
         :param bot_id: Bot which should perform the request.
@@ -2171,13 +2172,15 @@ async def download_file(
         chat_id: UUID,
         file_id: UUID,
         async_buffer: AsyncBufferWritable,
+        is_preview: bool = False,
     ) -> None:
         """Download file form file service.
 
         :param bot_id: Bot which should perform the request.
         :param chat_id: Target chat id.
         :param file_id: Async file id.
         :param async_buffer: Buffer to write downloaded file.
+        :param is_preview: If true and file has preview, return it instead of original.
         """
 
         method = DownloadFileMethod(
@@ -2188,6 +2191,7 @@ async def download_file(
         payload = BotXAPIDownloadFileRequestPayload.from_domain(
             chat_id=chat_id,
             file_id=file_id,
+            is_preview=is_preview,
         )
 
         await method.execute(payload, async_buffer)

pybotx/client/files_api/download_file.py

@@ -22,11 +22,12 @@ def from_domain(
         cls,
         chat_id: UUID,
         file_id: UUID,
+        is_preview: bool = False,
     ) -> "BotXAPIDownloadFileRequestPayload":
         return cls(
             group_chat_id=chat_id,
             file_id=file_id,
-            is_preview=False,
+            is_preview=is_preview,
         )
 
 

pybotx/client/users_api/search_user_by_email.py

@@ -2,8 +2,13 @@
 
 from pybotx.client.authorized_botx_method import AuthorizedBotXMethod
 from pybotx.client.botx_method import response_exception_thrower
+from pybotx.client.exceptions.http import InvalidBotXResponsePayloadError
 from pybotx.client.exceptions.users import UserNotFoundError
-from pybotx.client.users_api.user_from_search import BotXAPISearchUserResponsePayload
+from pybotx.client.users_api.user_from_search import (
+    BotXAPISearchUserByEmailsResponsePayload,
+    BotXAPISearchUserResponsePayload,
+)
+from pybotx.logger import logger
 from pybotx.models.api_base import UnverifiedPayloadBaseModel
 
 
@@ -61,13 +66,32 @@ async def execute(
     ) -> BotXAPISearchUserResponsePayload:
         path = "/api/v3/botx/users/by_email"
 
+        email = payload.email
+        request_json = {"emails": [email]}
+
         response = await self._botx_method_call(
             "POST",
             self._build_url(path),
-            json=payload.jsonable_dict(),
+            json=request_json,
         )
 
-        return self._verify_and_extract_api_model(
-            BotXAPISearchUserResponsePayload,
-            response,
+        try:
+            list_payload = self._verify_and_extract_api_model(
+                BotXAPISearchUserByEmailsResponsePayload,
+                response,
+            )
+        except InvalidBotXResponsePayloadError as exc:
+            raise exc
+
+        if not list_payload.result:
+            raise UserNotFoundError("User not found")
+
+        if len(list_payload.result) > 1:
+            logger.warning(
+                "Search by email returned multiple users; taking the first result"
+            )
+
+        return BotXAPISearchUserResponsePayload(
+            status="ok",
+            result=list_payload.result[0],
         )

pybotx/models/async_files.py

@@ -1,12 +1,13 @@
 from contextlib import asynccontextmanager
 from dataclasses import dataclass
-from typing import AsyncGenerator, Literal, Union, cast
+from typing import AsyncGenerator, Literal, Optional, Union, cast
 from uuid import UUID
 
 from aiofiles.tempfile import SpooledTemporaryFile
 
 from pybotx.bot.contextvars import bot_id_var, bot_var, chat_id_var
 from pybotx.constants import CHUNK_SIZE
+from pybotx.missing import MissingOptional, Undefined
 from pybotx.models.api_base import VerifiedPayloadBaseModel
 from pydantic import ConfigDict
 from pybotx.models.enums import (
@@ -29,9 +30,27 @@ class AsyncFileBase:
     _file_url: str
     _file_mimetype: str
     _file_hash: str
+    file_preview: Optional[str] = None
+    file_preview_height: Optional[int] = None
+    file_preview_width: Optional[int] = None
+    file_encryption_algo: Optional[str] = None
+    chunk_size: Optional[int] = None
+    caption: Optional[str] = None
+
+    @property
+    def file_url(self) -> str:
+        return self._file_url
+
+    @property
+    def file_mimetype(self) -> str:
+        return self._file_mimetype
+
+    @property
+    def file_hash(self) -> str:
+        return self._file_hash
 
     @asynccontextmanager
-    async def open(self) -> AsyncGenerator[SpooledTemporaryFile, None]:
+    async def open(self, *, is_preview: bool = False) -> AsyncGenerator[SpooledTemporaryFile, None]:
         bot = bot_var.get()
 
         async with SpooledTemporaryFile(max_size=CHUNK_SIZE) as tmp_file:
@@ -40,6 +59,7 @@ async def open(self) -> AsyncGenerator[SpooledTemporaryFile, None]:
                 chat_id=chat_id_var.get(),
                 file_id=self._file_id,
                 async_buffer=tmp_file,
+                is_preview=is_preview,
             )
 
             yield tmp_file
@@ -53,7 +73,7 @@ class Image(AsyncFileBase):
 @dataclass
 class Video(AsyncFileBase):
     type: Literal[AttachmentTypes.VIDEO]
-    duration: int
+    duration: int = 0
 
 
 @dataclass
@@ -64,7 +84,7 @@ class Document(AsyncFileBase):
 @dataclass
 class Voice(AsyncFileBase):
     type: Literal[AttachmentTypes.VOICE]
-    duration: int
+    duration: int = 0
 
 
 class APIAsyncFileBase(VerifiedPayloadBaseModel):
@@ -75,8 +95,14 @@ class APIAsyncFileBase(VerifiedPayloadBaseModel):
     file_name: str
     file_size: int
     file_hash: str
+    file_preview: MissingOptional[str] = Undefined
+    file_preview_height: MissingOptional[int] = Undefined
+    file_preview_width: MissingOptional[int] = Undefined
+    file_encryption_algo: MissingOptional[str] = Undefined
+    chunk_size: MissingOptional[int] = Undefined
+    caption: MissingOptional[str] = Undefined
 
-    model_config = ConfigDict(extra="allow")
+    model_config = ConfigDict(extra="allow", arbitrary_types_allowed=True)
 
 
 class ApiAsyncFileImage(APIAsyncFileBase):
@@ -107,6 +133,14 @@ class ApiAsyncFileVoice(APIAsyncFileBase):
 File = Union[Image, Video, Document, Voice]
 
 
+def _to_optional(value: MissingOptional[Union[str, int]]) -> Optional[Union[str, int]]:
+    return None if value is Undefined else value
+
+
+def _to_missing(value: Optional[Union[str, int]]) -> MissingOptional[Union[str, int]]:
+    return Undefined if value is None else value
+
+
 def convert_async_file_from_domain(file: File) -> APIAsyncFile:
     attachment_type = convert_attachment_type_from_domain(file.type)
 
@@ -121,6 +155,12 @@ def convert_async_file_from_domain(file: File) -> APIAsyncFile:
             file=file._file_url,
             file_mime_type=file._file_mimetype,
             file_hash=file._file_hash,
+            file_preview=_to_missing(file.file_preview),
+            file_preview_height=_to_missing(file.file_preview_height),
+            file_preview_width=_to_missing(file.file_preview_width),
+            file_encryption_algo=_to_missing(file.file_encryption_algo),
+            chunk_size=_to_missing(file.chunk_size),
+            caption=_to_missing(file.caption),
         )
 
     if attachment_type == APIAttachmentTypes.VIDEO:
@@ -135,6 +175,12 @@ def convert_async_file_from_domain(file: File) -> APIAsyncFile:
             file=file._file_url,
             file_mime_type=file._file_mimetype,
             file_hash=file._file_hash,
+            file_preview=_to_missing(file.file_preview),
+            file_preview_height=_to_missing(file.file_preview_height),
+            file_preview_width=_to_missing(file.file_preview_width),
+            file_encryption_algo=_to_missing(file.file_encryption_algo),
+            chunk_size=_to_missing(file.chunk_size),
+            caption=_to_missing(file.caption),
         )
 
     if attachment_type == APIAttachmentTypes.DOCUMENT:
@@ -148,6 +194,12 @@ def convert_async_file_from_domain(file: File) -> APIAsyncFile:
             file=file._file_url,
             file_mime_type=file._file_mimetype,
             file_hash=file._file_hash,
+            file_preview=_to_missing(file.file_preview),
+            file_preview_height=_to_missing(file.file_preview_height),
+            file_preview_width=_to_missing(file.file_preview_width),
+            file_encryption_algo=_to_missing(file.file_encryption_algo),
+            chunk_size=_to_missing(file.chunk_size),
+            caption=_to_missing(file.caption),
         )
 
     if attachment_type == APIAttachmentTypes.VOICE:
@@ -162,6 +214,12 @@ def convert_async_file_from_domain(file: File) -> APIAsyncFile:
             file=file._file_url,
             file_mime_type=file._file_mimetype,
             file_hash=file._file_hash,
+            file_preview=_to_missing(file.file_preview),
+            file_preview_height=_to_missing(file.file_preview_height),
+            file_preview_width=_to_missing(file.file_preview_width),
+            file_encryption_algo=_to_missing(file.file_encryption_algo),
+            chunk_size=_to_missing(file.chunk_size),
+            caption=_to_missing(file.caption),
         )
 
     raise NotImplementedError(f"Unsupported attachment type: {attachment_type}")
@@ -182,6 +240,21 @@ def convert_async_file_to_domain(async_file: APIAsyncFile) -> File:
             _file_mimetype=async_file.file_mime_type,
             _file_url=async_file.file,
             _file_hash=async_file.file_hash,
+            file_preview=cast(Optional[str], _to_optional(async_file.file_preview)),
+            file_preview_height=cast(
+                Optional[int],
+                _to_optional(async_file.file_preview_height),
+            ),
+            file_preview_width=cast(
+                Optional[int],
+                _to_optional(async_file.file_preview_width),
+            ),
+            file_encryption_algo=cast(
+                Optional[str],
+                _to_optional(async_file.file_encryption_algo),
+            ),
+            chunk_size=cast(Optional[int], _to_optional(async_file.chunk_size)),
+            caption=cast(Optional[str], _to_optional(async_file.caption)),
         )
 
     if attachment_type == AttachmentTypes.VIDEO:
@@ -197,6 +270,21 @@ def convert_async_file_to_domain(async_file: APIAsyncFile) -> File:
             _file_mimetype=async_file.file_mime_type,
             _file_url=async_file.file,
             _file_hash=async_file.file_hash,
+            file_preview=cast(Optional[str], _to_optional(async_file.file_preview)),
+            file_preview_height=cast(
+                Optional[int],
+                _to_optional(async_file.file_preview_height),
+            ),
+            file_preview_width=cast(
+                Optional[int],
+                _to_optional(async_file.file_preview_width),
+            ),
+            file_encryption_algo=cast(
+                Optional[str],
+                _to_optional(async_file.file_encryption_algo),
+            ),
+            chunk_size=cast(Optional[int], _to_optional(async_file.chunk_size)),
+            caption=cast(Optional[str], _to_optional(async_file.caption)),
         )
 
     if attachment_type == AttachmentTypes.DOCUMENT:
@@ -211,6 +299,21 @@ def convert_async_file_to_domain(async_file: APIAsyncFile) -> File:
             _file_mimetype=async_file.file_mime_type,
             _file_url=async_file.file,
             _file_hash=async_file.file_hash,
+            file_preview=cast(Optional[str], _to_optional(async_file.file_preview)),
+            file_preview_height=cast(
+                Optional[int],
+                _to_optional(async_file.file_preview_height),
+            ),
+            file_preview_width=cast(
+                Optional[int],
+                _to_optional(async_file.file_preview_width),
+            ),
+            file_encryption_algo=cast(
+                Optional[str],
+                _to_optional(async_file.file_encryption_algo),
+            ),
+            chunk_size=cast(Optional[int], _to_optional(async_file.chunk_size)),
+            caption=cast(Optional[str], _to_optional(async_file.caption)),
         )
 
     if attachment_type == AttachmentTypes.VOICE:
@@ -226,6 +329,21 @@ def convert_async_file_to_domain(async_file: APIAsyncFile) -> File:
             _file_mimetype=async_file.file_mime_type,
             _file_url=async_file.file,
             _file_hash=async_file.file_hash,
+            file_preview=cast(Optional[str], _to_optional(async_file.file_preview)),
+            file_preview_height=cast(
+                Optional[int],
+                _to_optional(async_file.file_preview_height),
+            ),
+            file_preview_width=cast(
+                Optional[int],
+                _to_optional(async_file.file_preview_width),
+            ),
+            file_encryption_algo=cast(
+                Optional[str],
+                _to_optional(async_file.file_encryption_algo),
+            ),
+            chunk_size=cast(Optional[int], _to_optional(async_file.chunk_size)),
+            caption=cast(Optional[str], _to_optional(async_file.caption)),
         )
 
     raise NotImplementedError(f"Unsupported attachment type: {attachment_type}")

tests/client/files_api/test_download_file.py

@@ -37,6 +37,7 @@ async def test__download_file__unexpected_not_found_error_raised(
         params={
             "group_chat_id": "054af49e-5e18-4dca-ad73-4f96b6de63fa",
             "file_id": "c3b9def2-b2c8-4732-b61f-99b9b110fa80",
+            "is_preview": False,
         },
         headers={"Authorization": "Bearer token"},
     ).mock(
@@ -84,6 +85,7 @@ async def test__download_file__file_metadata_not_found_error_raised(
         params={
             "group_chat_id": "054af49e-5e18-4dca-ad73-4f96b6de63fa",
             "file_id": "c3b9def2-b2c8-4732-b61f-99b9b110fa80",
+            "is_preview": False,
         },
         headers={"Authorization": "Bearer token"},
     ).mock(
@@ -132,6 +134,7 @@ async def test__download_file__file_deleted_error_raised(
         params={
             "group_chat_id": "054af49e-5e18-4dca-ad73-4f96b6de63fa",
             "file_id": "c3b9def2-b2c8-4732-b61f-99b9b110fa80",
+            "is_preview": False,
         },
         headers={"Authorization": "Bearer token"},
     ).mock(
@@ -179,6 +182,7 @@ async def test__download_file__chat_not_found_error_raised(
         params={
             "group_chat_id": "054af49e-5e18-4dca-ad73-4f96b6de63fa",
             "file_id": "c3b9def2-b2c8-4732-b61f-99b9b110fa80",
+            "is_preview": False,
         },
         headers={"Authorization": "Bearer token"},
     ).mock(
@@ -226,6 +230,7 @@ async def test__download_file__succeed(
         params={
             "group_chat_id": "054af49e-5e18-4dca-ad73-4f96b6de63fa",
             "file_id": "c3b9def2-b2c8-4732-b61f-99b9b110fa80",
+            "is_preview": False,
         },
         headers={"Authorization": "Bearer token"},
     ).mock(

tests/client/files_api/test_upload_file.py

@@ -114,12 +114,18 @@ async def test__download_file__succeed(
 
     # - Act -
     async with lifespan_wrapper(built_bot) as bot:
-        await bot.upload_file(
+        uploaded_file = await bot.upload_file(
             bot_id=bot_id,
             chat_id=UUID("054af49e-5e18-4dca-ad73-4f96b6de63fa"),
             async_buffer=async_buffer,
             filename="test.txt",
         )
 
     # - Assert -
+    assert uploaded_file.file_preview == "https://link.to/preview"
+    assert uploaded_file.file_preview_height == 300
+    assert uploaded_file.file_preview_width == 300
+    assert uploaded_file.file_encryption_algo == "stream"
+    assert uploaded_file.chunk_size == 2097152
+    assert uploaded_file.caption == "текст"
     assert endpoint.called