feat: add guild_count property (#1743)

* feat: add guild_count property

* docs: remove incorrect comment

Signed-off-by: Astrea <[email protected]>

---------

Signed-off-by: Astrea <[email protected]>

Author: AstreaTSS

interactions/client/client.py

@@ -534,6 +534,16 @@ def guilds(self) -> List["Guild"]:
         """Returns a list of all guilds the bot is in."""
         return self.user.guilds
 
+    @property
+    def guild_count(self) -> int:
+        """
+        Returns the number of guilds the bot is in.
+
+        This function is faster than using `len(client.guilds)` as it does not require using the cache.
+        As such, this is preferred when you only need the count of guilds.
+        """
+        return self.user.guild_count
+
     @property
     def status(self) -> Status:
         """

interactions/ext/debug_extension/__init__.py

@@ -76,7 +76,7 @@ async def debug_info(self, ctx: InteractionContext) -> None:
 
         e.add_field("Loaded Exts", ", ".join(self.bot.ext))
 
-        e.add_field("Guilds", str(len(self.bot.guilds)))
+        e.add_field("Guilds", str(self.bot.guild_count))
 
         await ctx.send(embeds=[e])
 

interactions/models/discord/user.py

@@ -239,6 +239,16 @@ def guilds(self) -> List["Guild"]:
         """The guilds the user is in."""
         return list(filter(None, (self._client.cache.get_guild(guild_id) for guild_id in self._guild_ids)))
 
+    @property
+    def guild_count(self) -> int:
+        """
+        Returns the number of guilds the bot is in.
+
+        This function is faster than using `len(client_user.guilds)` as it does not require using the cache.
+        As such, this is preferred when you only need the count of guilds.
+        """
+        return len(self._guild_ids or ())
+
     async def edit(
         self,
         *,

interactions/models/discord/user.pyi

@@ -95,6 +95,8 @@ class ClientUser(User):
     def _add_guilds(self, guild_ids: Set["Snowflake_Type"]) -> None: ...
     @property
     def guilds(self) -> List["Guild"]: ...
+    @property
+    def guild_count(self) -> int: ...
     async def edit(
         self,
         *,