Source code for pyrogram.methods.messages.translate_text

#  Pyrogram - Telegram MTProto API Client Library for Python
#  Copyright (C) 2017-present Dan <https://github.com/delivrance>
#
#  This file is part of Pyrogram.
#
#  Pyrogram is free software: you can redistribute it and/or modify
#  it under the terms of the GNU Lesser General Public License as published
#  by the Free Software Foundation, either version 3 of the License, or
#  (at your option) any later version.
#
#  Pyrogram 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 General Public License for more details.
#
#  You should have received a copy of the GNU Lesser General Public License
#  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.


from __future__ import annotations

import pyrogram
from pyrogram import raw


class TranslateText:
    async def translate_text(
        self: pyrogram.Client,
        peer: int | str | None = None,
        id: list[int] | None = None,
        text: str | list[raw.types.TextWithEntities] | None = None,
        to_lang: str | None = None,
        tone: str | None = None,
    ) -> list[raw.types.TextWithEntities]:
        """Translate text or a message to another language.

        .. include:: /_includes/usable-by/users.rst

        Parameters:
            peer (Union[int, str], *optional*): Chat from which to translate an existing message
            id (List[int], *optional*): Message IDs to translate
            text (Union[str, List[raw.types.TextWithEntities]], *optional*): Text to translate (plain string or list of TextWithEntities)
            to_lang (str): Target language code (e.g. "en", "es")
            tone (str, *optional*): AI translation tone preset

        Returns:
            List of :obj:`~pyrogram.raw.types.TextWithEntities`

        Example:
            .. code-block:: python

                await app.translate_text(...)
        """

        if to_lang is None:
            raise ValueError("to_lang is required")

        if isinstance(text, str):
            text = [raw.types.TextWithEntities(text=text, entities=[])]

        r = await self.invoke(
            raw.functions.messages.TranslateText(
                peer=await self.resolve_peer(peer) if peer is not None else None,
                id=id,
                text=text,
                to_lang=to_lang,
                tone=tone,
            )
        )

        return r.result