feat: 新增检测用户名是否可用

aicoder0 · aicoder0 · commit 5bdfe17d0ac0 · 2024-12-27T04:59:17.000+08:00
diff --git a/pyrogram/methods/users/__init__.py b/pyrogram/methods/users/__init__.py
@@ -29,6 +29,7 @@
 from .set_username import SetUsername
 from .unblock_user import UnblockUser
 from .update_profile import UpdateProfile
+from .check_username import CheckUsername
 
 
 class Users(
@@ -44,6 +45,7 @@ class Users(
     UnblockUser,
     UpdateProfile,
     GetDefaultEmojiStatuses,
-    SetEmojiStatus
+    SetEmojiStatus,
+    CheckUsername
 ):
     pass
diff --git a/pyrogram/methods/users/check_username.py b/pyrogram/methods/users/check_username.py
@@ -0,0 +1,57 @@
+#  Pyrogram - Telegram MTProto API Client Library for Python
+#  Copyright (C) 2017-present Dan <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 Optional
+
+import pyrogram
+from pyrogram import raw
+
+
+class CheckUsername:
+    async def check_username(
+        self: "pyrogram.Client",
+        username: Optional[str]
+    ) -> bool:
+        """check 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 set a channel or supergroup username you can use
+        :meth:`~pyrogram.Client.check_username`.
+
+        .. include:: /_includes/usable-by/users.rst
+
+        Parameters:
+            username (``str`` | ``None``):
+                Username to set. "" (empty string) or None to remove it.
+
+        Returns:
+            ``bool``: True on success.
+
+        Example:
+            .. code-block:: python
+
+                await app.check_username("username")
+        """
+
+        return bool(
+            await self.invoke(
+                raw.functions.account.CheckUsername(
+                    username=username or ""
+                )
+            )
+        )
