Added support for getting, setting and removing the chat photo

Author: Francesco Zimbolo

botogram/objects/chats.py

@@ -23,7 +23,7 @@
 from . import mixins
 from datetime import datetime as dt
 from time import mktime
-from .media import Photo
+from .media import Photo, ChatPhoto
 
 
 class User(BaseObject, mixins.ChatMixin):
@@ -114,10 +114,12 @@ class Chat(BaseObject, mixins.ChatMixin):
         # This is added at the bottom of messages.py due to circular imports
         # "pinned_message" = Message
         "sticker_set_name": str,
-        "can_set_sticker_set": bool
+        "can_set_sticker_set": bool,
+        "photo": ChatPhoto
     }
     replace_keys = {
         "invite_link": "_invite_link",
+        "photo": "_photo"
     }
     _check_equality_ = "id"
 
@@ -358,6 +360,30 @@ def pin_message(self, message, notify=True):
             "disable_notification": not notify
         }, expect=bool)
 
+    @property
+    @mixins._require_api
+    def photo(self):
+        """Get the current chat photo small and big ids"""
+        if self.type not in ("supergroup", "channel"):
+            raise RuntimeError(
+                "You can only get the photo in a supergroup or a channel")
+
+        if hasattr(self, "_cache_photo"):
+            return self._cache_photo
+
+        if self._photo is not None:
+            self._cache_photo = self._photo
+            return self._cache_photo
+
+        chat = self._api.call("getChat", {
+            "chat_id": self.id
+        }, expect=Chat)
+        if not chat._photo:
+            raise RuntimeError("This chat doesn't have a photo")
+
+        self._cache_photo = chat._photo
+        return self._cache_photo
+
     def unpin_message(self):
         return self._api.call("unpinChatMessage", {
             "chat_id": self.id,

botogram/objects/media.py

@@ -39,6 +39,23 @@ class PhotoSize(BaseObject, mixins.FileMixin):
     _check_equality_ = "file_id"
 
 
+class ChatPhoto(BaseObject, mixins.FileMixin):
+    """Telegram API representation of a chat photo
+
+    https://core.telegram.org/bots/api#chatphoto
+    """
+
+    required = {
+        "small_file_id": str,
+        "big_file_id": str,
+    }
+    replace_keys = {
+        "small_file_id": "small",
+        "big_file_id": "big"
+    }
+    _check_equality_ = "small_file_id"
+
+
 class Photo(mixins.FileMixin):
     """Custom representation of a photo
 

botogram/objects/mixins.py

@@ -361,6 +361,21 @@ def delete_message(self, message):
             "message_id": message,
         })
 
+    @_require_api
+    def set_photo(self, path):
+        args = {"chat_id": self.id}
+        if path is not None:
+            files = {"photo": open(path, "rb")}
+        else:
+            raise TypeError("path of the new photo is missing")
+
+        self._api.call("setChatPhoto", args, files)
+
+    @_require_api
+    def remove_photo(self):
+        args = {"chat_id": self.id}
+        self._api.call("deleteChatPhoto", args)
+
     @_require_api
     def send_album(self, album=None, reply_to=None, notify=True):
         """Send a Album"""
@@ -566,9 +581,16 @@ class FileMixin:
     """Add some methods for files"""
 
     @_require_api
-    def save(self, path):
+    def save(self, path, big=True):
         """Save the file to a particular path"""
-        response = self._api.call("getFile", {"file_id": self.file_id})
+        if not hasattr("self", "file_id"):
+            if big:
+                _file_id = self.big
+            else:
+                _file_id = self.small
+        else:
+            _file_id = self.file_id
+        response = self._api.call("getFile", {"file_id": _file_id})
 
         # Save the file to the wanted path
         downloaded = self._api.file_content(response["result"]["file_path"])

docs/api/telegram.rst

@@ -21,6 +21,7 @@ about its business.
 * :py:class:`~botogram.Message`
 * :py:class:`~botogram.Photo`
 * :py:class:`~botogram.PhotoSize`
+* :py:class:`~botogram.ChatPhoto`
 * :py:class:`~botogram.Audio`
 * :py:class:`~botogram.Document`
 * :py:class:`~botogram.Sticker`
@@ -772,6 +773,12 @@ about its business.
 
       .. versionadded:: 0.3
 
+   .. py:attribute:: photo
+
+      The current chat photo, represented by a :py:class:`~botogram.ChatPhoto` object.
+
+   .. versionadded:: 0.7
+
    .. py:method:: status_of(user)
 
       Return the status of the provided user (either an instance of
@@ -1445,6 +1452,20 @@ about its business.
 
       .. versionadded:: 0.6
 
+   .. py:method:: set_photo(path)
+
+      Set a new chat photo, by providing its path.
+
+      :param str path: The path to the new photo
+
+      .. versionadded:: 0.7
+
+   .. py:method:: remove_photo()
+
+      Remove the current chat photo.
+
+      .. versionadded:: 0.7
+
 .. py:class:: botogram.ParsedText
 
    This class contains the parsed representation of the text of a received
@@ -2419,6 +2440,32 @@ about its business.
 
       :param str path: The file name path locating where the image should be saved.
 
+.. py:class:: botogram.ChatPhoto
+
+   This class represents a Telegram API chat photo.
+
+   It consists of two file IDs, each one representing a different size of the current chat photo.
+
+   The photos can be saved using the method :py:meth:`~ChatPhoto.save`
+
+   .. py:attribute:: big
+
+      The string ID of the 640x640 version of the chat photo
+
+   .. py:attribute:: small
+
+      The string ID of the 160x160 version of the chat photo
+
+   .. py:method:: save(path [, big=True])
+
+      Save the image represented to a file located by *path*. Be aware that
+      Telegram does not provide the name of the original file sent by its
+      sender. This should be generated as part of the path.
+
+      :param str path: The file name path locating where the image should be saved.
+      :param bool big: Whether it should save the big or the small version of the chat photo
+
+   .. versionadded:: 0.7
 
 .. py:class:: botogram.Audio
 

docs/changelog/0.7.rst

@@ -32,6 +32,12 @@ New features
   * New method :py:meth:`~Message.edit_live_location`
   * New method :py:meth:`~Message.stop_live_location`
 
+* Added support for editing, getting and removing the chat photo
+
+  * New method :py:meth:`~Chat.set_photo`
+  * New method :py:meth:`~Chat.remove_photo`
+  * New attribute :py:attr:`~Chat.photo`
+  * New class :py:class:`~botogram.ChatPhoto`
 
 Bug fixes
 ---------