Add the "name" computed attribute on Chat and User

This attribute comes really handy when you want to send an user/chat
name in a message, because it contains the best name botogram can get:

* If the chat has a just a title, this attribute contains it
* If the chat has a just a first name, this attribute contains it
* If the chat has both a first and last name, this attribute contains
  the two merged together

Author: Pietro Albini

botogram/objects/__init__.py

@@ -25,6 +25,15 @@ class User(BaseObject, mixins.ChatMixin):
         "username": str,
     }
 
+    @property
+    def name(self):
+        """Get the full name of the user"""
+        result = self.first_name
+        if self.last_name is not None:
+            result += " "+self.last_name
+
+        return result
+
 
 class Chat(BaseObject, mixins.ChatMixin):
     """Telegram API representation of a chat
@@ -43,6 +52,20 @@ class Chat(BaseObject, mixins.ChatMixin):
         "last_name": str,
     }
 
+    @property
+    def name(self):
+        """Get the full name of the chat"""
+        result = None
+
+        if self.title is not None:
+            result = self.title
+        elif self.first_name is not None:
+            result = self.first_name
+            if self.last_name is not None:
+                result += " "+self.last_name
+
+        return result
+
 
 class PhotoSize(BaseObject, mixins.FileMixin):
     """Telegram API representation of a photo size

docs/api/telegram.rst

@@ -59,6 +59,18 @@ about its business.
 
       *This attribute can be None if it's not provided by Telegram.*
 
+   .. py:attribute:: name
+
+      The computed name of the user. If someone has only the first name, this
+      attribute contains it, but if someone also has a last name, this
+      attribute contains the two merged.
+
+      You can't write to this attribute, but it automatically updates when you
+      change :py:attr:`~botogram.User.first_name` or
+      :py:attr:`~botogram.User.last_name`.
+
+      .. versionadded:: 0.2
+
    .. py:method:: send(message, [preview=True, reply_to=None, syntax=None, extra=None])
 
       Send the textual *message* to the user. You may optionally stop clients
@@ -228,6 +240,20 @@ about its business.
 
       *This attribute can be None if it's not provided by Telegram.*
 
+   .. py:attribute:: name
+
+      The computed name of the chat. If this chat has a title this attribute
+      contains it. If someone has only the first name, this attribute contains
+      it, but if someone also has a last name, this attribute contains the two
+      merged.
+
+      You can't write to this attribute, but it automatically updates when you
+      change :py:attr:`~botogram.Chat.title`,
+      :py:attr:`~botogram.Chat.first_name` or
+      :py:attr:`~botogram.Chat.last_name`.
+
+      .. versionadded:: 0.2
+
    .. py:method:: send(message, [preview=True, reply_to=None, syntax=None, extra=None])
 
       Send the textual *message* to the chat. You may optionally stop clients

docs/changelog.rst

@@ -16,6 +16,10 @@ botogram 0.2
 
 *Alpha release, not yet released*
 
+* Added the :py:attr:`~botogram.User.name` computed attribute on the
+  :py:class:`~botogram.User` objects
+* Added the :py:attr:`~botogram.Chat.name` computed attribute on the
+  :py:class:`~botogram.Chat` objects
 * Renamed ``Bot.init_shared_memory`` to ``Bot.prepare_memory``
 * Renamed ``Component.add_shared_memory_initializer`` to
   ``Component.add_memory_preparer``

tests/test_objects.py

@@ -47,3 +47,32 @@ def test_photo_object():
     # And the items inside a list must be PhotoSize
     with pytest.raises(ValueError):
         botogram.objects.Photo([{"This": "isn't", "a": "PhotoSize"}])
+
+
+def test_user_name():
+    # Create a dummy User object
+    user = botogram.objects.User({"id": 123, "first_name": "John"})
+
+    # With only the first name
+    assert user.name == "John"
+
+    # Also with a last name
+    user.last_name = "Doe"
+    assert user.name == "John Doe"
+
+
+def test_chat_name():
+    # Create a dummy Chat object
+    chat = botogram.objects.Chat({"id": 123, "type": "",
+                                  "title": "Test", "first_name": "John"})
+
+    # With a title
+    assert chat.name == "Test"
+
+    # Without a title
+    chat.title = None
+    assert chat.name == "John"
+
+    # Without a title and with a last name
+    chat.last_name = "Doe"
+    assert chat.name == "John Doe"