Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support specifying with_counts and with_expiration in RESTClient.fetch_invite #1330

Merged
merged 11 commits into from
Nov 6, 2022
Merged

Support specifying with_counts and with_expiration in RESTClient.fetch_invite #1330

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
90f7006
change fetch_invite request to use function parameters
null-domain Oct 26, 2022
70fe150
document new fetch_invite parameters
null-domain Oct 26, 2022
396b97a
Merge branch 'hikari-py:master' into fetch-invite-params
null-domain Oct 27, 2022
1c88897
Formatting changes
null-domain Oct 28, 2022
87b4122
Add changelog file
null-domain Oct 28, 2022
ffda254
Make changelog more verbose/descriptive
null-domain Oct 29, 2022
98a4871
Merge branch 'hikari-py:master' into fetch-invite-params
null-domain Oct 29, 2022
07898b4
Merge branch 'fetch-invite-params' of https://github.com/null-domain/…
null-domain Oct 29, 2022
0613d27
Modify test_fetch_invite to check that new params return intended values
null-domain Oct 29, 2022
1a32dc3
Update hikari/api/rest.py
davfsa Nov 5, 2022
baa2253
Remove whitespaces
davfsa Nov 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changes/1330.doc.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Improve RESTClientImpl.fetch_invite() to more closely match DAPI docs
null-domain marked this conversation as resolved.
Show resolved Hide resolved
8 changes: 7 additions & 1 deletion hikari/api/rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2762,14 +2762,20 @@ async def fetch_gateway_bot_info(self) -> sessions.GatewayBotInfo:
"""

@abc.abstractmethod
async def fetch_invite(self, invite: typing.Union[invites.InviteCode, str]) -> invites.Invite:
async def fetch_invite(
self, invite: typing.Union[invites.InviteCode, str], with_counts: bool = True, with_expiration: bool = True
) -> invites.Invite:
"""Fetch an existing invite.

Parameters
----------
invite : typing.Union[hikari.invites.InviteCode, builtins.str]
The invite to fetch. This may be an invite object or
the code of an existing invite.
with_counts : builtins.bool
Whether the invite should contain approximate member counts.
with_expiration: builtins.bool
Whether the invite should contain the expiration date.
davfsa marked this conversation as resolved.
Show resolved Hide resolved

Returns
-------
Expand Down
8 changes: 5 additions & 3 deletions hikari/impl/rest.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1960,11 +1960,13 @@ async def fetch_gateway_bot_info(self) -> sessions.GatewayBotInfo:
assert isinstance(response, dict)
return self._entity_factory.deserialize_gateway_bot_info(response)

async def fetch_invite(self, invite: typing.Union[invites.InviteCode, str]) -> invites.Invite:
async def fetch_invite(
self, invite: typing.Union[invites.InviteCode, str], with_counts: bool = True, with_expiration: bool = True
) -> invites.Invite:
route = routes.GET_INVITE.compile(invite_code=invite if isinstance(invite, str) else invite.code)
query = data_binding.StringMapBuilder()
query.put("with_counts", True)
query.put("with_expiration", True)
query.put("with_counts", with_counts)
query.put("with_expiration", with_expiration)
response = await self._request(route, query=query)
assert isinstance(response, dict)
return self._entity_factory.deserialize_invite(response)
Expand Down