mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-06-07 12:18:59 +00:00
Code Issues Projects Releases Wiki Activity

Add with_counts param to fetch_guilds

Browse Source
This commit is contained in:
Andrin S 2023-05-20 02:47:16 +02:00 committed by GitHub
parent 53ce05b0d0
commit 66689e16e8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 15 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
discord/client.py
View File

@ -2059,13 +2059,15 @@ class Client:
limit: Optional[int] = 200,
before: Optional[SnowflakeTime] = None,
after: Optional[SnowflakeTime] = None,
with_counts: bool = True,
) -> AsyncIterator[Guild]:
"""Retrieves an :term:`asynchronous iterator` that enables receiving your guilds.
.. note::
Using this, you will only receive :attr:`.Guild.owner`, :attr:`.Guild.icon`,
:attr:`.Guild.id`, and :attr:`.Guild.name` per :class:`.Guild`.
:attr:`.Guild.id`, :attr:`.Guild.name`, :attr:`.Guild.approximate_member_count`,
and :attr:`.Guild.approximate_presence_count` per :class:`.Guild`.
.. note::
@ -2106,6 +2108,12 @@ class Client:
Retrieve guilds after this date or object.
If a datetime is provided, it is recommended to use a UTC aware datetime.
If the datetime is naive, it is assumed to be local time.
with_counts: :class:`bool`
Whether to include count information in the guilds. This fills the
:attr:`.Guild.approximate_member_count` and :attr:`.Guild.approximate_presence_count`
attributes without needing any privileged intents. Defaults to ``True``.
.. versionadded:: 2.3
Raises
------
@ -2120,7 +2128,7 @@ class Client:
async def _before_strategy(retrieve: int, before: Optional[Snowflake], limit: Optional[int]):
before_id = before.id if before else None
data = await self.http.get_guilds(retrieve, before=before_id)
data = await self.http.get_guilds(retrieve, before=before_id, with_counts=with_counts)
if data:
if limit is not None:
@ -2132,7 +2140,7 @@ class Client:
async def _after_strategy(retrieve: int, after: Optional[Snowflake], limit: Optional[int]):
after_id = after.id if after else None
data = await self.http.get_guilds(retrieve, after=after_id)
data = await self.http.get_guilds(retrieve, after=after_id, with_counts=with_counts)
if data:
if limit is not None:

4
discord/guild.py
View File

@ -250,13 +250,13 @@ class Guild(Hashable):
approximate_member_count: Optional[:class:`int`]
The approximate number of members in the guild. This is ``None`` unless the guild is obtained
using :meth:`Client.fetch_guild` with ``with_counts=True``.
using :meth:`Client.fetch_guild` or :meth:`Client.fetch_guilds` with ``with_counts=True``.
.. versionadded:: 2.0
approximate_presence_count: Optional[:class:`int`]
The approximate number of members currently active in the guild.
Offline members are excluded. This is ``None`` unless the guild is obtained using
:meth:`Client.fetch_guild` with ``with_counts=True``.
:meth:`Client.fetch_guild` or :meth:`Client.fetch_guilds` with ``with_counts=True``.
.. versionchanged:: 2.0
premium_progress_bar_enabled: :class:`bool`

2
discord/http.py
View File

@ -1373,9 +1373,11 @@ class HTTPClient:
limit: int,
before: Optional[Snowflake] = None,
after: Optional[Snowflake] = None,
with_counts: bool = True,
) -> Response[List[guild.Guild]]:
params: Dict[str, Any] = {
'limit': limit,
'with_counts': int(with_counts),
}
if before: