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

85 lines
2.8 KiB
Python
Raw Normal View History

2018-07-08 07:22:08 +00:00
# Pyrogram - Telegram MTProto API Client Library for Python
2020-02-01 13:04:33 +00:00
# Copyright (C) 2017-2020 Dan <https://github.com/delivrance>
2018-07-08 07:22:08 +00:00
#
# 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/>.
2018-07-08 08:18:48 +00:00
2018-07-08 07:22:08 +00:00
import os
from typing import Union
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):
2019-03-16 18:23:23 +00:00
def set_chat_photo(
self,
chat_id: Union[int, str],
photo: str
) -> bool:
"""Set a new profile photo for the chat.
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.
photo (``str``):
2019-07-25 09:22:14 +00:00
New chat photo. You can pass a :obj:`Photo` file_id or a file path to upload a new photo from your local
machine.
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
app.set_chat_photo(chat_id, "photo.jpg")
# Set chat photo using an exiting Photo file_id
app.set_chat_photo(chat_id, photo.file_id)
2018-07-15 14:34:32 +00:00
"""
2018-07-08 07:22:08 +00:00
peer = self.resolve_peer(chat_id)
if os.path.exists(photo):
photo = types.InputChatUploadedPhoto(file=self.save_file(photo))
else:
photo = utils.get_input_media_from_file_id(photo)
photo = types.InputChatPhoto(id=photo.id)
2018-07-08 07:22:08 +00:00
if isinstance(peer, types.InputPeerChat):
self.send(
functions.messages.EditChatPhoto(
chat_id=peer.chat_id,
photo=photo
)
)
elif isinstance(peer, types.InputPeerChannel):
self.send(
functions.channels.EditPhoto(
channel=peer,
photo=photo
)
)
else:
raise ValueError("The chat_id \"{}\" belongs to a user".format(chat_id))
return True