Add client.set_username() method (pyrogram#208)

bakatrouble · delivrance · commit fda25f65348e · 2019-03-01T18:06:17.000+01:00
* Add client.set_username() method

* Rename set_username() to update_user_username(); allow None as username

* Add client.update_chat_username() method

* Update update_chat_username.py

* Update update_user_username.py

Rename update_user_username to update_username
Add more details in docstrings
Fix style

* Rename update_user_username.py to update_username.py

* Update __init__.py

* Update 400_BAD_REQUEST.tsv
diff --git a/compiler/error/source/400_BAD_REQUEST.tsv b/compiler/error/source/400_BAD_REQUEST.tsv
@@ -88,5 +88,6 @@ MEDIA_INVALID	The media is invalid
 BOT_SCORE_NOT_MODIFIED	The bot score was not modified
 USER_BOT_REQUIRED	The method can be used by bots only
 IMAGE_PROCESS_FAILED	The server failed to process your image
+USERNAME_NOT_MODIFIED	The username was not modified
 CALL_ALREADY_ACCEPTED	The call is already accepted
 CALL_ALREADY_DECLINED	The call is already declined
diff --git a/pyrogram/client/methods/chats/__init__.py b/pyrogram/client/methods/chats/__init__.py
@@ -37,6 +37,7 @@
 from .set_chat_title import SetChatTitle
 from .unban_chat_member import UnbanChatMember
 from .unpin_chat_message import UnpinChatMessage
+from .update_chat_username import UpdateChatUsername
 
 
 class Chats(
@@ -60,6 +61,7 @@ class Chats(
     GetChatMembersCount,
     GetChatPreview,
     IterDialogs,
-    IterChatMembers
+    IterChatMembers,
+    UpdateChatUsername
 ):
     pass
diff --git a/pyrogram/client/methods/chats/update_chat_username.py b/pyrogram/client/methods/chats/update_chat_username.py
@@ -0,0 +1,59 @@
+# Pyrogram - Telegram MTProto API Client Library for Python
+# Copyright (C) 2017-2019 Dan Tès <https://github.com/delivrance>
+#
+# This file is part of Pyrogram.
+#
+# Pyrogram is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Pyrogram is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
+
+from typing import Union
+
+from pyrogram.api import functions, types
+from ...ext import BaseClient
+
+
+class UpdateChatUsername(BaseClient):
+    def update_chat_username(self,
+                             chat_id: Union[int, str],
+                             username: Union[str, None]) -> bool:
+        """Use this method to update a channel or a supergroup username.
+        
+        To update your own username (for users only, not bots) you can use :meth:`update_username`.
+
+        Args:
+            chat_id (``int`` | ``str``)
+                Unique identifier (int) or username (str) of the target chat.
+            username (``str`` | ``None``):
+                Username to set. Pass "" (empty string) or None to remove the username.
+
+        Returns:
+            True on success.
+
+        Raises:
+            :class:`Error <pyrogram.Error>` in case of a Telegram RPC error.
+            ``ValueError`` if a chat_id belongs to a user or chat.
+        """
+
+        peer = self.resolve_peer(chat_id)
+        
+        if isinstance(peer, types.InputPeerChannel):
+            return bool(
+                self.send(
+                    functions.channels.UpdateUsername(
+                        channel=peer,
+                        username=username or ""
+                    )
+                )
+            )
+        else:
+            raise ValueError("The chat_id \"{}\" belongs to a user or chat".format(chat_id))
diff --git a/pyrogram/client/methods/users/__init__.py b/pyrogram/client/methods/users/__init__.py
@@ -21,13 +21,15 @@
 from .get_user_profile_photos import GetUserProfilePhotos
 from .get_users import GetUsers
 from .set_user_profile_photo import SetUserProfilePhoto
+from .update_username import UpdateUsername
 
 
 class Users(
     GetUserProfilePhotos,
     SetUserProfilePhoto,
     DeleteUserProfilePhotos,
     GetUsers,
-    GetMe
+    GetMe,
+    UpdateUsername
 ):
     pass
diff --git a/pyrogram/client/methods/users/update_username.py b/pyrogram/client/methods/users/update_username.py
@@ -0,0 +1,51 @@
+# Pyrogram - Telegram MTProto API Client Library for Python
+# Copyright (C) 2017-2019 Dan Tès <https://github.com/delivrance>
+#
+# This file is part of Pyrogram.
+#
+# Pyrogram is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published
+# by the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# Pyrogram is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
+
+from typing import Union
+
+from pyrogram.api import functions
+from ...ext import BaseClient
+
+
+class UpdateUsername(BaseClient):
+    def update_username(self,
+                        username: Union[str, None]) -> bool:
+        """Use this method to update your own username.
+        
+        This method only works for users, not bots. Bot usernames must be changed via Bot Support or by recreating
+        them from scratch using BotFather. To update a channel or supergroup username you can use
+        :meth:`update_chat_username`.
+
+        Args:
+            username (``str`` | ``None``):
+                Username to set. "" (empty string) or None to remove the username.
+
+        Returns:
+            True on success.
+
+        Raises:
+            :class:`Error <pyrogram.Error>` in case of a Telegram RPC error.
+        """
+
+        return bool(
+            self.send(
+                functions.account.UpdateUsername(
+                    username=username or ""
+                )
+            )
+        )
