Merge pull request #106 from matteb99/release/0.5

add multiple fuction

Author: emilyalbini

botogram/frozenbot.py

@@ -161,7 +161,7 @@ def _edit_create_fake_message_object(self, chat, message):
         """Helper method for edit_message and edit_caption"""
         # Also accept objects
         if hasattr(message, "message_id"):
-            message = message.message_id
+            message = message.id
         if hasattr(chat, "id"):
             chat = chat.id
 
@@ -179,15 +179,15 @@ def _edit_create_fake_message_object(self, chat, message):
         }, self.api)
 
     def edit_message(self, chat, message, text, syntax=None, preview=True,
-                     extra=None):
+                     extra=None, attach=None):
         """Edit a message already sent to the user"""
         msg = self._edit_create_fake_message_object(chat, message)
-        msg.edit(text, syntax, preview, extra)
+        msg.edit(text, syntax, preview, extra, attach)
 
-    def edit_caption(self, chat, message, caption, extra=None):
+    def edit_caption(self, chat, message, caption, extra=None, attach=None):
         """Edit the caption of a media already sent to the user"""
         msg = self._edit_create_fake_message_object(chat, message)
-        msg.edit_caption(caption, extra)
+        msg.edit_caption(caption, extra, attach)
 
     # Let's process the messages
 

botogram/objects/__init__.py

@@ -20,7 +20,7 @@
 
 # flake8: noqa
 
-from .chats     import User, Chat, UserProfilePhotos
+from .chats     import User, Chat, UserProfilePhotos, Permissions
 from .media     import PhotoSize, Photo, Audio, Voice, Document, Sticker, \
                        Video, Contact, Location, Venue
 from .messages  import Message

botogram/objects/chats.py

@@ -21,6 +21,9 @@
 from .. import api
 from .base import BaseObject, multiple
 from . import mixins
+from datetime import datetime as dt
+from time import mktime
+
 
 from .media import Photo
 
@@ -38,6 +41,7 @@ class User(BaseObject, mixins.ChatMixin):
     optional = {
         "last_name": str,
         "username": str,
+        "is_bot": bool
     }
     _check_equality_ = "id"
 
@@ -102,6 +106,13 @@ class Chat(BaseObject, mixins.ChatMixin):
         "username": str,
         "first_name": str,
         "last_name": str,
+        "all_members_are_administrators": bool,
+        "description": str,
+        "invite_link": str,
+        # 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
     }
     _check_equality_ = "id"
 
@@ -260,6 +271,115 @@ def unban(self, user):
             "user_id": user,
         })
 
+    def kick(self, user, time=None):
+        if self.type == "private":
+            raise RuntimeError("This chat is a private!")
+        if isinstance(user, User):
+            user = user.id
+
+        if time is None:
+            self._api.call("unbanChatMember", {
+                "chat_id": self.id,
+                "user_id": user
+            })
+        else:
+            if isinstance(time, dt):
+                time = mktime(time.timetuple())
+            self._api.call("kickChatMember", {
+                "chat_id": self.id,
+                "user_id": user,
+                "until_date": time
+            })
+
+    def permissions(self, user):
+        return Permissions(user, self)
+
+
+class Permissions:
+    def __init__(self, user, chat):
+        if chat.type not in ("group", "supergroup"):
+            raise RuntimeError("This chat is not a group or a supergroup!")
+        # Accept also an instance of `User`
+        self._chatid = chat.id
+        self._api = chat._api
+        if isinstance(user, User):
+            self._user = user.id
+        else:
+            self._user = user
+        infouser = self._api.call("getChatMember", {
+            "chat_id": self._chatid,
+            "user_id": self._user},
+                                  expect=ChatMember)
+
+        try:
+            self._until_date = infouser.until_date
+        except AttributeError:
+            self._until_date = 0
+        self.until_date = self._until_date
+
+        try:
+            self._send_messages = infouser.can_send_messages
+        except AttributeError:
+            self._send_messages = True
+        self.send_messages = self._send_messages
+
+        try:
+            self._send_media_messages = infouser.can_media_messages
+        except AttributeError:
+            self._send_media_messages = True
+        self.send_media_messages = self._send_media_messages
+
+        try:
+            self._send_other_messages = infouser.can_send_other_messages
+        except AttributeError:
+            self._send_other_messages = True
+        self.send_other_messages = self._send_other_messages
+
+        try:
+            self._add_web_page_previews = infouser.can_add_web_page_previews
+        except AttributeError:
+            self._add_web_page_previews = True
+        self.add_web_page_previews = self._add_web_page_previews
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        if exc_type is None:
+            self.save()
+
+    def save(self):
+        arguments = {
+            "chat_id": self.chatid,
+            "user_id": self.user
+        }
+        modify = False
+
+        if isinstance(self.until_date, dt):
+            self.until_date = mktime(self.until_date.timetuple())
+            modify = True
+        if self._until_date != self.until_date:
+            arguments.update({"until_date": self.until_date})
+            modify = True
+        if self._send_messages != self.send_messages:
+            arguments.update({"can_send_messages": self.send_messages})
+            modify = True
+        if self._send_media_messages != self.send_media_messages:
+            arguments.update({"can_send_media_messages":
+                             self.send_media_messages})
+            modify = True
+        if self._send_other_messages != self.send_other_messages:
+            arguments.update({"can_send_other_messages":
+                             self.send_other_messages})
+            modify = True
+        if self._add_web_page_previews != self.add_web_page_previews:
+            arguments.update({"can_add_web_page_previews":
+                             self.add_web_page_previews})
+            modify = True
+
+        if modify:
+            self._api.call("restrictChatMember", arguments)
+
 
 class ChatMember(BaseObject):
     """Telegram API representation of a chat member
@@ -271,6 +391,22 @@ class ChatMember(BaseObject):
         "user": User,
         "status": str,
     }
+    optional = {
+        "until_date": int,
+        "can_be_edited": bool,
+        "can_change_info": bool,
+        "can_post_messages": bool,
+        "can_edit_messages": bool,
+        "can_delete_messages": bool,
+        "can_invite_users": bool,
+        "can_restrict_members": bool,
+        "can_pin_messages": bool,
+        "can_promote_members": bool,
+        "can_send_messages": bool,
+        "can_send_media_messages": bool,
+        "can_send_other_messages": bool,
+        "can_add_web_page_previews": bool
+    }
     _check_equality_ = "user"
 
 
@@ -284,3 +420,9 @@ class UserProfilePhotos(BaseObject):
         "total_count": int,
         "photos": multiple(Photo),
     }
+
+
+# add this code on the button to avoid import loop
+# flake8: noqa
+from .messages import Message
+Chat.optional["pinned_message"] = Message

botogram/objects/messages.py

@@ -23,7 +23,6 @@
 from .base import BaseObject, _itself
 from . import mixins
 from .. import utils
-
 from .chats import User, Chat
 from .media import Audio, Voice, Document, Photo, Sticker, Video, Contact, \
     Location, Venue
@@ -93,7 +92,7 @@ def __eq__(self, other):
         if self._message is None or other._message is None:
             return id(self) == id(other)
 
-        return self._message.message_id == other._message.message_id and \
+        return self._message.id == other._message.id and \
             self._offset == other._offset and self._length == other._length
 
     def __str__(self):
@@ -364,6 +363,7 @@ def from_(self):
     replace_keys = {
         "from": "sender",
         "entities": "parsed_text",
+        "message_id": "id",
 
         # Those are provided dynamically by self.forward_from
         "forward_from": "_forward_from",
@@ -413,6 +413,12 @@ def new_chat_participant(self):
 
     @property
     @utils.deprecated("Message.left_chat_participant", "1.0",
-                      "Rename property ot Message.left_chat_member")
+                      "Rename property to Message.left_chat_member")
     def left_chat_participant(self):
         return self.left_chat_member
+
+    @property
+    @utils.deprecated("Message.message_id", "0.5",
+                      "Rename property to Message.id")
+    def message_id(self):
+        return self.id

botogram/objects/mixins.py

@@ -56,7 +56,7 @@ def _get_call_args(self, reply_to, extra, attach, notify):
         """Get default API call arguments"""
         # Convert instance of Message to ids in reply_to
         if hasattr(reply_to, "message_id"):
-            reply_to = reply_to.message_id
+            reply_to = reply_to.id
 
         args = {"chat_id": self.id}
         if reply_to is not None:
@@ -351,7 +351,7 @@ def forward_to(self, to, notify=True):
     @_require_api
     def edit(self, text, syntax=None, preview=True, extra=None, attach=None):
         """Edit this message"""
-        args = {"message_id": self.message_id, "chat_id": self.chat.id}
+        args = {"message_id": self.id, "chat_id": self.chat.id}
         args["text"] = text
 
         syntax = syntaxes.guess_syntax(text, syntax)
@@ -463,7 +463,7 @@ def delete(self):
         """Delete the message"""
         return self._api.call("deleteMessage", {
             "chat_id": self.chat.id,
-            "message_id": self.message_id,
+            "message_id": self.id,
         })
 
 

docs/_themes/botogram/static/fonts/bitter.ttf

@@ -438,7 +438,7 @@ components.
 
       :return: A frozen instance of the current bot.
 
-   .. py:method:: edit_message(chat, message, text, [syntax=None, preview=True, extra=None])
+   .. py:method:: edit_message(chat, message, text, [syntax=None, preview=True, attach=None, extra=None])
 
       With this method you can edit the text of a message the user already
       received. This allows you to do a lot of interesting things, like
@@ -456,11 +456,15 @@ components.
       :param str text: The new text of the message
       :param bool preview: Whether to show link previews.
       :param str syntax: The name of the syntax used for the message.
+      :param object attach: An extra thing to attach to the message.
       :param object extra: An extra reply interface object to attach.
 
       .. versionadded:: 0.3
+      .. versionchanged:: 0.6
 
-   .. py:method:: edit_caption(caption, [extra=None])
+         Added support for attach
+
+   .. py:method:: edit_caption(caption, [attach=None, extra=None])
 
       With this method you can edit the caption of the media attached to a
       message the user already received. This allows you to do a lot of
@@ -470,10 +474,15 @@ components.
       Please remember you can only edit messages your bot sent to the user.
 
       :param str caption: The new caption of the media file.
+      :param object attach: An extra thing to attach to the message.
       :param object extra: An extra reply interface object to attach.
 
       .. versionadded:: 0.3
 
+      .. versionchanged:: 0.6
+
+         Added support for attach
+
    .. py:method:: chat(id)
 
       Get the :py:class:`~botogram.Chat` object of the chat with the ID you