From 48c59501bbc6d3ad402fc2c4feba4d00eed0cfb0 Mon Sep 17 00:00:00 2001 From: Dark <58370174+BruhDark@users.noreply.github.com> Date: Sun, 3 Nov 2024 12:52:21 -0300 Subject: [PATCH] feat: add missing with_counts parameter to fetch_guilds method (#2615) * refactor: Add missing `with_counts` parameter to guild retrieval methods * Default with_counts to True in fetch_guilds * Being dumb enough to forget about making it an int * style(pre-commit): auto fixes from pre-commit.com hooks * Update discord/client.py Co-authored-by: Dorukyum <53639936+Dorukyum@users.noreply.github.com> Signed-off-by: Dark <58370174+BruhDark@users.noreply.github.com> * Update discord/iterators.py Co-authored-by: Dorukyum <53639936+Dorukyum@users.noreply.github.com> Signed-off-by: Dark <58370174+BruhDark@users.noreply.github.com> * Update CHANGELOG.md * Update discord/client.py Co-authored-by: JustaSqu1d <89910983+JustaSqu1d@users.noreply.github.com> Signed-off-by: Dark <58370174+BruhDark@users.noreply.github.com> * Update discord/iterators.py Co-authored-by: JustaSqu1d <89910983+JustaSqu1d@users.noreply.github.com> Signed-off-by: Dark <58370174+BruhDark@users.noreply.github.com> --------- Signed-off-by: Dark <58370174+BruhDark@users.noreply.github.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Dorukyum <53639936+Dorukyum@users.noreply.github.com> Co-authored-by: JustaSqu1d <89910983+JustaSqu1d@users.noreply.github.com> --- CHANGELOG.md | 2 ++ discord/client.py | 10 +++++++++- discord/http.py | 3 +++ discord/iterators.py | 16 +++++++++++++--- 4 files changed, 27 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d77dee89d3..a9f34fcfc0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -30,6 +30,8 @@ These changes are available on the `master` branch, but have not yet been releas ([#2587](https://github.com/Pycord-Development/pycord/pull/2587/)) - Added optional `filter` parameter to `utils.basic_autocomplete()`. ([#2590](https://github.com/Pycord-Development/pycord/pull/2590)) +- Added missing `with_counts` parameter to `fetch_guilds` method. + ([#2615](https://github.com/Pycord-Development/pycord/pull/2615)) ### Fixed diff --git a/discord/client.py b/discord/client.py index 1520952f04..cbc22813fd 100644 --- a/discord/client.py +++ b/discord/client.py @@ -1462,6 +1462,7 @@ def fetch_guilds( limit: int | None = 100, before: SnowflakeTime = None, after: SnowflakeTime = None, + with_counts: bool = True, ) -> GuildIterator: """Retrieves an :class:`.AsyncIterator` that enables receiving your guilds. @@ -1489,6 +1490,11 @@ def fetch_guilds( 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 member count information in guilds. This fills the + :attr:`.Guild.approximate_member_count` and :attr:`.Guild.approximate_presence_count` + fields. + Defaults to ``True``. Yields ------ @@ -1515,7 +1521,9 @@ def fetch_guilds( All parameters are optional. """ - return GuildIterator(self, limit=limit, before=before, after=after) + return GuildIterator( + self, limit=limit, before=before, after=after, with_counts=with_counts + ) async def fetch_template(self, code: Template | str) -> Template: """|coro| diff --git a/discord/http.py b/discord/http.py index 1ca3135f8d..464710daac 100644 --- a/discord/http.py +++ b/discord/http.py @@ -1445,6 +1445,7 @@ def get_guilds( limit: int, before: Snowflake | None = None, after: Snowflake | None = None, + with_counts: bool = True, ) -> Response[list[guild.Guild]]: params: dict[str, Any] = { "limit": limit, @@ -1454,6 +1455,8 @@ def get_guilds( params["before"] = before if after: params["after"] = after + if with_counts: + params["with_counts"] = int(with_counts) return self.request(Route("GET", "/users/@me/guilds"), params=params) diff --git a/discord/iterators.py b/discord/iterators.py index 13f67266ea..eca3c72091 100644 --- a/discord/iterators.py +++ b/discord/iterators.py @@ -585,9 +585,14 @@ class GuildIterator(_AsyncIterator["Guild"]): Object before which all guilds must be. after: Optional[Union[:class:`abc.Snowflake`, :class:`datetime.datetime`]] Object after which all guilds must be. + with_counts: :class:`bool` + Whether to include member count information in guilds. This fills the + :attr:`.Guild.approximate_member_count` and :attr:`.Guild.approximate_presence_count` + fields. + Defaults to ``True``. """ - def __init__(self, bot, limit, before=None, after=None): + def __init__(self, bot, limit, before=None, after=None, with_counts=True): if isinstance(before, datetime.datetime): before = Object(id=time_snowflake(before, high=False)) if isinstance(after, datetime.datetime): @@ -597,6 +602,7 @@ def __init__(self, bot, limit, before=None, after=None): self.limit = limit self.before = before self.after = after + self.with_counts = with_counts self._filter = None @@ -654,7 +660,9 @@ async def _retrieve_guilds(self, retrieve) -> list[Guild]: async def _retrieve_guilds_before_strategy(self, retrieve): """Retrieve guilds using before parameter.""" before = self.before.id if self.before else None - data: list[GuildPayload] = await self.get_guilds(retrieve, before=before) + data: list[GuildPayload] = await self.get_guilds( + retrieve, before=before, with_counts=self.with_counts + ) if len(data): if self.limit is not None: self.limit -= retrieve @@ -664,7 +672,9 @@ async def _retrieve_guilds_before_strategy(self, retrieve): async def _retrieve_guilds_after_strategy(self, retrieve): """Retrieve guilds using after parameter.""" after = self.after.id if self.after else None - data: list[GuildPayload] = await self.get_guilds(retrieve, after=after) + data: list[GuildPayload] = await self.get_guilds( + retrieve, after=after, with_counts=self.with_counts + ) if len(data): if self.limit is not None: self.limit -= retrieve