Source code for pyrogram.methods.users.set_profile_photo

#  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

from typing import BinaryIO

import pyrogram
from pyrogram import raw


class SetProfilePhoto:
    async def set_profile_photo(
        self: pyrogram.Client,
        *,
        photo: str | BinaryIO | None = None,
        video: str | BinaryIO | None = None,
        is_public: bool | None = None,
    ) -> bool:
        """Set a new profile photo or video (H.264/MPEG-4 AVC video, max 5 seconds).

        The ``photo`` and ``video`` arguments are mutually exclusive.
        Pass either one as named argument (see examples below).

        .. note::

            This method only works for Users.
            Bots profile photos must be set using BotFather.

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

        Parameters:
            photo (``str`` | ``BinaryIO``, *optional*):
                Profile photo to set.
                Pass a file path as string to upload a new photo that exists on your local machine or
                pass a binary file-like object with its attribute ".name" set for in-memory uploads.

            video (``str`` | ``BinaryIO``, *optional*):
                Profile video to set.
                Pass a file path as string to upload a new video that exists on your local machine or
                pass a binary file-like object with its attribute ".name" set for in-memory uploads.

            is_public (``bool``, *optional*):
                Pass True to set the photo shown to the users you hid your real photo from.

        Returns:
            ``bool``: True on success.

        Raises:
            ValueError: If neither *photo* nor *video* is given.

        Example:
            .. code-block:: python

                # Set a new profile photo
                await app.set_profile_photo(photo="new_photo.jpg")

                # Set a new profile video
                await app.set_profile_photo(video="new_video.mp4")
        """

        if photo is None and video is None:
            raise ValueError("Either photo or video must be given")

        return bool(
            await self.invoke(
                raw.functions.photos.UploadProfilePhoto(
                    file=await self.save_file(photo),
                    video=await self.save_file(video),
                    fallback=is_public,
                )
            )
        )


class SetBotProfilePhoto:
    async def set_bot_profile_photo(
        self: pyrogram.Client,
        bot_user_id: int | str,
        *,
        photo: str | BinaryIO | None = None,
        video: str | BinaryIO | None = None,
    ) -> bool:
        """Set or remove the profile photo or video of a bot you own.

        The ``photo`` and ``video`` arguments are mutually exclusive.
        Pass neither to remove the current profile photo.

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

        Parameters:
            bot_user_id (``int`` | ``str``):
                Unique identifier (int) or username (str) of the target bot.

            photo (``str`` | ``BinaryIO``, *optional*):
                Profile photo to set.
                Pass a file path as string to upload a new photo that exists on your local machine or
                pass a binary file-like object with its attribute ".name" set for in-memory uploads.

            video (``str`` | ``BinaryIO``, *optional*):
                Profile video to set.
                Pass a file path as string to upload a new video that exists on your local machine or
                pass a binary file-like object with its attribute ".name" set for in-memory uploads.

        Returns:
            ``bool``: True on success.

        Example:
            .. code-block:: python

                # Set a new bot profile photo
                await app.set_bot_profile_photo("mybot", photo="new_photo.jpg")

                # Set a new bot profile video
                await app.set_bot_profile_photo("mybot", video="new_video.mp4")

                # Remove the bot profile photo
                await app.set_bot_profile_photo("mybot")
        """

        bot = await self.resolve_peer(bot_user_id)

        if photo is None and video is None:
            return bool(
                await self.invoke(
                    raw.functions.photos.UpdateProfilePhoto(
                        id=raw.types.InputPhotoEmpty(),
                        bot=bot,
                    )
                )
            )

        return bool(
            await self.invoke(
                raw.functions.photos.UploadProfilePhoto(
                    bot=bot,
                    file=await self.save_file(photo),
                    video=await self.save_file(video),
                )
            )
        )