MTPyroger/pyrogram/client/methods/chats/set_chat_photo.py

117 lines
4.4 KiB
Python
Raw Normal View History

2020-03-21 14:43:32 +00:00
# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2020 Dan <https://github.com/delivrance>
2018-07-08 07:22:08 +00:00
#
2020-03-21 14:43:32 +00:00
# This file is part of Pyrogram.
2018-07-08 07:22:08 +00:00
#
2020-03-21 14:43:32 +00:00
# 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.
2018-07-08 07:22:08 +00:00
#
2020-03-21 14:43:32 +00:00
# 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.
2018-07-08 07:22:08 +00:00
#
2020-03-21 14:43:32 +00:00
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
2018-07-08 08:18:48 +00:00
2018-07-08 07:22:08 +00:00
import os
from typing import Union, BinaryIO
2018-07-08 07:22:08 +00:00
from pyrogram.api import functions, types
2019-07-25 09:22:14 +00:00
from ...ext import BaseClient, utils
2018-07-08 07:22:08 +00:00
class SetChatPhoto(BaseClient):
async def set_chat_photo(
2019-03-16 18:23:23 +00:00
self,
chat_id: Union[int, str],
2020-07-27 13:03:23 +00:00
*,
photo: Union[str, BinaryIO] = None,
video: Union[str, BinaryIO] = None,
file_ref: str = None
2019-03-16 18:23:23 +00:00
) -> bool:
2020-07-27 13:03:23 +00:00
"""Set a new chat 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).
2018-07-15 14:34:32 +00:00
2019-07-25 09:22:14 +00:00
You must be an administrator in the chat for this to work and must have the appropriate admin rights.
2018-07-15 14:34:32 +00:00
Parameters:
2018-07-15 14:34:32 +00:00
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
2020-07-27 13:03:23 +00:00
photo (``str`` | ``BinaryIO``, *optional*):
New chat photo. You can pass a :obj:`Photo` file_id (in pair with a valid file_ref), a file path to
upload a new photo from your local machine or a binary file-like object with its attribute ".name"
set for in-memory uploads.
2020-07-27 13:03:23 +00:00
video (``str`` | ``BinaryIO``, *optional*):
New chat video. You can pass a :obj:`Video` file_id (in pair with a valid file_ref), a file path to
upload a new video from your local machine or a binary file-like object with its attribute ".name"
set for in-memory uploads.
file_ref (``str``, *optional*):
A valid file reference obtained by a recently fetched media message.
To be used in combination with a file_id in case a file reference is needed.
2018-07-15 14:34:32 +00:00
Returns:
``bool``: True on success.
2018-07-15 14:34:32 +00:00
Raises:
2019-05-28 14:41:55 +00:00
ValueError: if a chat_id belongs to user.
2019-07-25 09:22:14 +00:00
Example:
.. code-block:: python
# Set chat photo using a local file
2020-07-27 13:03:23 +00:00
app.set_chat_photo(chat_id, photo="photo.jpg")
2019-07-25 09:22:14 +00:00
# Set chat photo using an exiting Photo file_id
2020-07-27 13:03:23 +00:00
app.set_chat_photo(chat_id, photo=photo.file_id, file_ref=photo.file_ref)
# Set chat video using a local file
app.set_chat_photo(chat_id, video="video.mp4")
# Set chat photo using an exiting Video file_id
app.set_chat_photo(chat_id, video=video.file_id, file_ref=video.file_ref)
2018-07-15 14:34:32 +00:00
"""
peer = await self.resolve_peer(chat_id)
2018-07-08 07:22:08 +00:00
if isinstance(photo, str):
if os.path.isfile(photo):
2020-07-27 13:03:23 +00:00
photo = types.InputChatUploadedPhoto(
file=await self.save_file(photo),
video=await self.save_file(video)
2020-07-27 13:03:23 +00:00
)
else:
photo = utils.get_input_media_from_file_id(photo, file_ref, 2)
photo = types.InputChatPhoto(id=photo.id)
2018-07-08 07:22:08 +00:00
else:
2020-07-27 13:03:23 +00:00
photo = types.InputChatUploadedPhoto(
file=await self.save_file(photo),
video=await self.save_file(video)
2020-07-27 13:03:23 +00:00
)
2018-07-08 07:22:08 +00:00
if isinstance(peer, types.InputPeerChat):
await self.send(
2018-07-08 07:22:08 +00:00
functions.messages.EditChatPhoto(
chat_id=peer.chat_id,
photo=photo
)
)
elif isinstance(peer, types.InputPeerChannel):
await self.send(
2018-07-08 07:22:08 +00:00
functions.channels.EditPhoto(
channel=peer,
photo=photo
)
)
else:
raise ValueError("The chat_id \"{}\" belongs to a user".format(chat_id))
return True