MTPyroger/pyrogram/methods/users/set_profile_photo.py
2021-01-01 22:58:48 +01:00

74 lines
2.6 KiB
Python

# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2021 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 typing import Union, BinaryIO
from pyrogram import raw
from pyrogram.scaffold import Scaffold
class SetProfilePhoto(Scaffold):
async def set_profile_photo(
self,
*,
photo: Union[str, BinaryIO] = None,
video: Union[str, BinaryIO] = 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.
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.
Returns:
``bool``: True on success.
Example:
.. code-block:: python
# Set a new profile photo
app.set_profile_photo(photo="new_photo.jpg")
# Set a new profile video
app.set_profile_photo(video="new_video.mp4")
"""
return bool(
await self.send(
raw.functions.photos.UploadProfilePhoto(
file=await self.save_file(photo),
video=await self.save_file(video)
)
)
)