Merge pull request #49 from thesharp/master

Author: Pietro Albini

botogram/objects/__init__.py

@@ -8,6 +8,7 @@
 
 from .base import BaseObject, multiple, _itself
 from . import mixins
+from .. import utils
 
 
 class User(BaseObject, mixins.ChatMixin):
@@ -303,6 +304,12 @@ class Message(BaseObject, mixins.MessageMixin):
     https://core.telegram.org/bots/api#message
     """
 
+    @property
+    @utils.deprecated("Message.from_", "1.0",
+                      "Rename property to Message.sender")
+    def from_(self):
+        return self.sender
+
     required = {
         "message_id": int,
         "from": User,
@@ -335,7 +342,7 @@ class Message(BaseObject, mixins.MessageMixin):
         "migrate_from_chat_id": int,
     }
     replace_keys = {
-        "from": "from_",
+        "from": "sender",
     }
 
 

docs/api/telegram.rst

@@ -508,13 +508,26 @@ about its business.
 
       The integer ID of the message.
 
+   .. py:attribute:: sender
+
+      The sending :py:class:`~botogram.User` of the message. Note the trailing
+      underscore, needed due to 'from' being a python keyword.
+
+      *This attribute can be None if it's not provided by Telegram.*
+
+      .. versionchanged:: 0.2
+
+      Before it was called ``from_``.
+
    .. py:attribute:: from_
 
       The sending :py:class:`~botogram.User` of the message. Note the trailing
       underscore, needed due to 'from' being a python keyword.
 
       *This attribute can be None if it's not provided by Telegram.*
 
+      .. deprecated:: 0.2 It will be removed in botogram 1.0
+
    .. py:attribute:: date
 
       The integer date of when the message was sent, in Unix time.

docs/channels.rst

@@ -77,8 +77,8 @@ cites botogram in a chat, you can do this:
    @bot.message_contains("botogram")
    def we_are_famous(bot, chat, message):
        user = "Someone"
-       if message.from_.username is not None:
-           user = message.from_.username
+       if message.sender.username is not None:
+           user = message.sender.username
 
        bot.send("@my_channel", "%s mentioned botogram!" % user)
 

docs/custom-components.rst

@@ -95,7 +95,7 @@ the :py:meth:`botogram.Component.add_before_processing_hook` method:
            self.add_before_processing_hook(self.filter)
 
        def filter(self, chat, message):
-           if message.from_.id not in self.allowed:
+           if message.sender.id not in self.allowed:
                return True  # Stop processing the update
 
 And the component is complete! The filter simply checks if the message
@@ -117,7 +117,7 @@ source code of the component is the following:
            self.add_before_processing_hook(self.filter)
 
        def filter(self, chat, message):
-           if message.from_.id not in self.allowed:
+           if message.sender.id not in self.allowed:
                return True  # Stop processing the update
 
 .. _custom-components-use: