Rename and improve some of the types ParsedTextEntity

Some of the default ones made by Telegram were ugly, especially the
distinct `url` and `text_link`. This commit adds a layer between the
user and the raw types so it's possible to rename them.

Author: Pietro Albini

botogram/objects/messages.py

@@ -43,12 +43,23 @@ class ParsedTextEntity(BaseObject):
     }
     replace_keys = {
         "url": "_url",  # Dynamically implemented
+        "type": "_type",  # Dynamically implemented
 
         # Private attributes, use the ``text`` one
         "offset": "_offset",
         "length": "_length",
     }
 
+    # Bring some sanity to the Bot API
+    replace_types = {
+        "bot_command": "command",
+        "text_link": "link",
+        "url": "link",
+    }
+    replace_types_inverse = {
+        "command": "bot_command",
+        "link": "text_link",
+    }
 
     def __init__(self, data, api=None, message=None):
         super().__init__(data, api)
@@ -75,6 +86,32 @@ def set_message(self, message):
         """Set the message instance related to this object"""
         self._message = message
 
+    @property
+    def type(self):
+        """Get the type of the entity"""
+        # Bring some sanity to the Bot API
+        if self._type in self.replace_types:
+            return self.replace_types[self._type]
+        return self._type
+
+    @type.setter
+    def type(self, value):
+        """Set the type of the entity"""
+        # Special check for link, because two original types points to it
+        if value == "link":
+            # If the URL is not set or it's the same as the text, then it's a
+            # normal URL, else it has a label
+            if self.text == self._url or self._url is None:
+                self._type = "url"
+            else:
+                self._type = "text_link"
+            return
+
+        if value in self.replace_types_inverse:
+            self._type = self.replace_types_inverse[value]
+        else:
+            self._type = value
+
     @property
     @_require_message
     def text(self):
@@ -98,7 +135,7 @@ def url(self):
         if self._url is not None:
             return self._url
 
-        if self.type == "url":
+        if self.type == "link":
             # Standard URLs
             return self.text
         elif self.type == "mention":

docs/api/telegram.rst

@@ -663,9 +663,9 @@ about its business.
 
       * **hashtag**: an hashtag (for example ``#pythonftw``)
 
-      * **bot_command**: a command sent to a bot (for example ``/help``)
+      * **command**: a command sent to a bot (for example ``/help``)
 
-      * **url**: a textual URL (for example ``https://pietroalbini.io``)
+      * **url**: a link (the text can contain its label)
 
       * **email**: an email address (for example ``[email protected]``)
 
@@ -677,8 +677,6 @@ about its business.
 
       * **pre**: a monospace-formatted block
 
-      * **text_link**: a link with a label
-
    .. py:attribute:: text
 
       Return the plaintext content of the entity. In pair with the type you can

tests/test_objects_messages.py

@@ -40,7 +40,7 @@ def test_parsed_text_entity():
         "offset": 12,
         "length": 14,
     })
-    assert entity.type == "url"
+    assert entity.type == "link"
     # Those attributes requires a Message instance
     with pytest.raises(RuntimeError):
         entity.url
@@ -53,6 +53,81 @@ def test_parsed_text_entity():
     assert entity.text == "http://url.com"
 
 
+def test_parsed_text_entity_type():
+    # Basic entity
+    entity = botogram.objects.messages.ParsedTextEntity({
+        "type": "",
+        "offset": 0,
+        "length": 23,
+    })
+
+    #################################
+    #  A type which doesn't mutate  #
+    #################################
+
+    msg = get_dummy_message("#aaaaaaaaaaaaaaaaaaaaaaa")
+    entity.set_message(msg)
+
+    # Getter
+    entity._type = "hashtag"
+    assert entity.type == "hashtag"
+
+    # Setter
+    entity.type = "hashtag"
+    assert entity._type == "hashtag"
+
+    #########################
+    #  A type which mutate  #
+    #########################
+
+    msg = get_dummy_message("/aaaaaaaaaaaaaaaaaaaaaaa")
+    entity.set_message(msg)
+
+    # Getter
+    entity._type = "bot_command"
+    assert entity.type == "command"
+
+    # Setter
+    entity.type = "command"
+    assert entity._type == "bot_command"
+
+    #####################################
+    #  A link (which mutates as "url")  #
+    #####################################
+
+    msg = get_dummy_message("https://www.example.com")
+    entity.set_message(msg)
+
+    # Getter
+    entity._type = "url"
+    assert entity.type == "link"
+
+    # Setter without URL explicitly defined
+    entity.type = "link"
+    assert entity._type == "url"
+
+    # Setter with URL explicitly defined
+    entity._url = "https://www.example.com"
+    entity.type = "link"
+    assert entity._type == "url"
+
+    ###########################################
+    #  A link (which mutates as "text_link")  #
+    ###########################################
+
+    msg = get_dummy_message("This is a labelled link")
+    entity._url = "https://www.example.com"
+    entity.set_message(msg)
+
+    # Getter
+    entity._type = "text_link"
+    assert entity.type == "link"
+
+    # Setter
+    entity.type = "link"
+    assert entity._type == "text_link"
+
+
 def test_parsed_text_entity_url():
     # Basic entity
     entity = botogram.objects.messages.ParsedTextEntity({