Skip to content

Commit c1a3f4b

Browse files
refactor: Change type of parameters in scheduled event requests from Snowflake to int (#1067)
* refactor * ci: correct from checks. * Minor rephrase of docstring param Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 21bd3cd commit c1a3f4b

File tree

1 file changed

+20
-35
lines changed

1 file changed

+20
-35
lines changed
Lines changed: 20 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
from typing import List
22

33
from ...api.cache import Cache
4-
from ..models import Snowflake
54
from .request import _Request
65
from .route import Route
76

@@ -16,15 +15,14 @@ class ScheduledEventRequest:
1615
def __init__(self) -> None:
1716
pass
1817

19-
async def create_scheduled_event(self, guild_id: Snowflake, payload: dict) -> dict:
18+
async def create_scheduled_event(self, guild_id: int, payload: dict) -> dict:
2019
"""
2120
Creates a scheduled event.
2221
2322
:param guild_id: Guild ID snowflake.
2423
:param payload: The dictionary containing the parameters and values to edit the associated event.
2524
:return: A dictionary containing the new guild scheduled event object on success.
2625
"""
27-
guild_id = int(guild_id)
2826
valid_keys = (
2927
"channel_id",
3028
"name",
@@ -42,50 +40,42 @@ async def create_scheduled_event(self, guild_id: Snowflake, payload: dict) -> di
4240
)
4341

4442
async def get_scheduled_event(
45-
self, guild_id: Snowflake, guild_scheduled_event_id: Snowflake, with_user_count: bool
43+
self, guild_id: int, guild_scheduled_event_id: int, with_user_count: bool
4644
) -> dict:
4745
"""
4846
Gets a guild scheduled event.
4947
5048
:param guild_id: Guild ID snowflake.
5149
:param guild_scheduled_event_id: Guild Scheduled Event ID snowflake.
52-
:param with_user_count: A boolean to include number of users subscribed to the associated event, if given.
50+
:param with_user_count: Whether the number of users subscribed to the events is returned.
5351
:return: A dictionary containing the guild scheduled event object on success.
5452
"""
55-
guild_id, event_id = int(guild_id), int(guild_scheduled_event_id)
56-
params = {}
57-
if with_user_count:
58-
params["with_user_count"] = str(with_user_count)
5953

6054
return await self._req.request(
6155
Route(
6256
"GET",
6357
"/guilds/{guild_id}/scheduled-events/{event_id}",
6458
guild_id=guild_id,
65-
event_id=event_id,
59+
event_id=guild_scheduled_event_id,
6660
),
67-
params=params,
61+
params={"with_user_count": str(with_user_count).lower()},
6862
)
6963

70-
async def get_scheduled_events(self, guild_id: Snowflake, with_user_count: bool) -> List[dict]:
64+
async def get_scheduled_events(self, guild_id: int, with_user_count: bool) -> List[dict]:
7165
"""
7266
Gets all guild scheduled events in a guild.
7367
7468
:param guild_id: Guild ID snowflake.
75-
:param with_user_count: A boolean to include number of users subscribed to the associated event, if given.
69+
:param with_user_count: Whether the number of users subscribed to the associated event is returned.
7670
:return: A List of a dictionary containing the guild scheduled event objects on success.
7771
"""
78-
guild_id = int(guild_id)
79-
params = {}
80-
if with_user_count:
81-
params["with_user_count"] = with_user_count
82-
8372
return await self._req.request(
84-
Route("GET", "/guilds/{guild_id}/scheduled-events", guild_id=guild_id), params=params
73+
Route("GET", "/guilds/{guild_id}/scheduled-events", guild_id=guild_id),
74+
params={"with_user_count": str(with_user_count).lower()},
8575
)
8676

8777
async def modify_scheduled_event(
88-
self, guild_id: Snowflake, guild_scheduled_event_id: Snowflake, payload: dict
78+
self, guild_id: int, guild_scheduled_event_id: int, payload: dict
8979
) -> dict:
9080
"""
9181
Modifies a scheduled event.
@@ -95,7 +85,6 @@ async def modify_scheduled_event(
9585
:param payload: The dictionary containing the parameters and values to edit the associated event.
9686
:return: A dictionary containing the updated guild scheduled event object on success.
9787
"""
98-
guild_id, event_id = int(guild_id), int(guild_scheduled_event_id)
9988
valid_keys = (
10089
"channel_id",
10190
"name",
@@ -112,40 +101,37 @@ async def modify_scheduled_event(
112101
"PATCH",
113102
"/guilds/{guild_id}/scheduled-events/{event_id}",
114103
guild_id=guild_id,
115-
event_id=event_id,
104+
event_id=guild_scheduled_event_id,
116105
),
117106
json=data,
118107
)
119108

120-
async def delete_scheduled_event(
121-
self, guild_id: Snowflake, guild_scheduled_event_id: Snowflake
122-
) -> None:
109+
async def delete_scheduled_event(self, guild_id: int, guild_scheduled_event_id: int) -> None:
123110
"""
124111
Deletes a guild scheduled event.
125112
126113
:param guild_id: Guild ID snowflake.
127114
:param guild_scheduled_event_id: Guild Scheduled Event ID snowflake.
128115
:return: Nothing on success.
129116
"""
130-
guild_id, event_id = int(guild_id), int(guild_scheduled_event_id)
131117

132118
return await self._req.request(
133119
Route(
134120
"DELETE",
135121
"/guilds/{guild_id}/scheduled-events/{event_id}",
136122
guild_id=guild_id,
137-
event_id=event_id,
123+
event_id=guild_scheduled_event_id,
138124
)
139125
)
140126

141127
async def get_scheduled_event_users(
142128
self,
143-
guild_id: Snowflake,
144-
guild_scheduled_event_id: Snowflake,
129+
guild_id: int,
130+
guild_scheduled_event_id: int,
145131
limit: int = 100,
146132
with_member: bool = False,
147-
before: Snowflake = None,
148-
after: Snowflake = None,
133+
before: int = None,
134+
after: int = None,
149135
) -> dict:
150136
"""
151137
Get the registered users of a scheduled event.
@@ -158,22 +144,21 @@ async def get_scheduled_event_users(
158144
:param after: Considers only users after given user ID snowflake. Defaults to None.
159145
:return: Returns a list of guild scheduled event user objects on success.
160146
"""
161-
guild_id, event_id = int(guild_id), int(guild_scheduled_event_id)
162147
params = {
163148
"limit": limit,
164149
"with_member": with_member,
165150
}
166151
if before:
167-
params["before"] = int(before)
152+
params["before"] = before
168153
if after:
169-
params["after"] = int(after)
154+
params["after"] = after
170155

171156
return await self._req.request(
172157
Route(
173158
"GET",
174159
"/guilds/{guild_id}/scheduled-events/{event_id}/users",
175160
guild_id=guild_id,
176-
event_id=event_id,
161+
event_id=guild_scheduled_event_id,
177162
),
178163
params=params,
179164
)

0 commit comments

Comments
 (0)