🚧 WIP

Author: Paillat-dev

discord/http.py

@@ -33,7 +33,8 @@
 from urllib.parse import quote as _uriquote
 
 import aiohttp
-from typing_extensions import overload
+from pydantic import BaseModel, TypeAdapter
+from typing_extensions import overload, reveal_type
 
 from . import __version__, models, utils
 from .errors import (
@@ -53,8 +54,6 @@
 if TYPE_CHECKING:
     from types import TracebackType
 
-    from pydantic import BaseModel
-
     from .enums import AuditLogAction, InteractionResponseType
     from .file import File
     from .types import (
@@ -94,7 +93,8 @@
     Response = Coroutine[Any, Any, T]  # pyright: ignore [reportExplicitAny]
 
 API_VERSION: int = 10
-BM = TypeVar("BM", bound="BaseModel")
+TP = TypeVar("TP")
+BM = TypeVar("BM", bound=BaseModel)
 
 
 async def json_or_text(response: aiohttp.ClientResponse) -> dict[str, Any] | str:
@@ -242,15 +242,26 @@ async def request(
         **kwargs: Any,
     ) -> BM: ...
 
+    @overload
+    async def request(
+        self,
+        route: Route,
+        *,
+        files: None = ...,
+        form: None = ...,
+        model: TypeAdapter[TP],
+        **kwargs: Any,
+    ) -> TP: ...
+
     async def request(
         self,
         route: Route,
         *,
         files: Sequence[File] | None = None,
         form: Iterable[dict[str, Any]] | None = None,
-        model: type[BM] | None = None,
+        model: type[BM] | TypeAdapter[TP] | None = None,
         **kwargs: Any,
-    ) -> Any | BM:
+    ) -> Any | BM | TP:
         bucket = route.bucket
         method = route.method
         url = route.url
@@ -347,9 +358,12 @@ async def request(
                         if 300 > response.status >= 200:
                             _log.debug("%s %s has received %s", method, url, data)
                             if model:
-                                return model(
-                                    **data  # pyright: ignore [reportCallIssue]
-                                )
+                                if isinstance(model, TypeAdapter):
+                                    return model.validate_python(
+                                        data
+                                    )  # pyright: ignore [reportUnknownVariableType]
+                                return model.model_validate(data)
+
                             return data
 
                         # we are being rate limited
@@ -1630,11 +1644,11 @@ def create_from_template(
 
     def get_bans(
         self,
-        guild_id: Snowflake,
+        guild_id: models.Snowflake,
         limit: int | None = None,
-        before: Snowflake | None = None,
-        after: Snowflake | None = None,
-    ) -> Response[list[guild.Ban]]:
+        before: models.Snowflake | None = None,
+        after: models.Snowflake | None = None,
+    ) -> Response[list[models.Ban]]:
         params: dict[str, int | Snowflake] = {}
 
         if limit is not None:
@@ -1645,10 +1659,14 @@ def get_bans(
             params["after"] = after
 
         return self.request(
-            Route("GET", "/guilds/{guild_id}/bans", guild_id=guild_id), params=params
+            Route("GET", "/guilds/{guild_id}/bans", guild_id=guild_id),
+            params=params,
+            model=TypeAdapter(list[models.Ban]),
         )
 
-    def get_ban(self, user_id: Snowflake, guild_id: Snowflake) -> Response[models.Ban]:
+    def get_ban(
+        self, user_id: models.Snowflake, guild_id: models.Snowflake
+    ) -> Response[models.Ban]:
         return self.request(
             Route(
                 "GET",

discord/iterators.py

@@ -38,6 +38,9 @@
     Union,
 )
 
+from typing_extensions import Final, override, reveal_type
+
+from . import models
 from .audit_logs import AuditLogEntry
 from .errors import NoMoreItems
 from .monetization import Entitlement
@@ -57,9 +60,11 @@
 if TYPE_CHECKING:
     from .abc import Snowflake
     from .guild import BanEntry, Guild
+    from .http import HTTPClient
     from .member import Member
     from .message import Message
     from .scheduled_events import ScheduledEvent
+    from .state import ConnectionState
     from .threads import Thread
     from .types.audit_log import AuditLog as AuditLogPayload
     from .types.guild import Guild as GuildPayload
@@ -737,16 +742,26 @@ def create_member(self, data):
 
 
 class BanIterator(_AsyncIterator["BanEntry"]):
-    def __init__(self, guild, limit=None, before=None, after=None):
-        self.guild = guild
-        self.limit = limit
-        self.after = after
-        self.before = before
-
-        self.state = self.guild._state
-        self.get_bans = self.state.http.get_bans
-        self.bans = asyncio.Queue()
-
+    def __init__(
+        self,
+        guild: Guild,
+        limit: int | None = None,
+        before: models.Snowflake | None = None,
+        after: models.Snowflake | None = None,
+    ):
+        self.guild: Guild = guild
+        self.limit: int | None = limit
+        self.after: models.Snowflake | None = after
+        self.before: models.Snowflake | None = before
+        self.retrieve: int = 0
+
+        self.state: ConnectionState = (
+            self.guild._state
+        )  # pyright: ignore [reportPrivateUsage]
+        self.get_bans: Final = self.state.http.get_bans
+        self.bans: asyncio.Queue[BanEntry] = asyncio.Queue()
+
+    @override
     async def next(self) -> BanEntry:
         if self.bans.empty():
             await self.fill_bans()
@@ -757,20 +772,20 @@ async def next(self) -> BanEntry:
             raise NoMoreItems()
 
     def _get_retrieve(self):
-        l = self.limit
-        if l is None or l > 1000:
-            r = 1000
+        if self.limit is None or self.limit > 1000:
+            self.retrieve = 1000
         else:
-            r = l
-        self.retrieve = r
-        return r > 0
+            self.retrieve = self.limit
+        return self.retrieve > 0
 
     async def fill_bans(self):
         if not self._get_retrieve():
             return
-        before = self.before.id if self.before else None
-        after = self.after.id if self.after else None
-        data = await self.get_bans(self.guild.id, self.retrieve, before, after)
+        before: models.Snowflake | None = self.before if self.before else None
+        after: models.Snowflake | None = self.after if self.after else None
+        data = await self.get_bans(
+            models.Snowflake(self.guild.id), self.retrieve, before, after
+        )
         if not data:
             # no data, terminate
             return
@@ -780,18 +795,16 @@ async def fill_bans(self):
         if len(data) < 1000:
             self.limit = 0  # terminate loop
 
-        self.after = Object(id=int(data[-1]["user"]["id"]))
+        self.after = data[-1].user.id
 
         for element in reversed(data):
             await self.bans.put(self.create_ban(element))
 
-    def create_ban(self, data):
+    def create_ban(self, data: models.Ban) -> BanEntry:
         from .guild import BanEntry
         from .user import User
 
-        return BanEntry(
-            reason=data["reason"], user=User(state=self.state, data=data["user"])
-        )
+        return BanEntry(reason=data.reason, user=User(state=self.state, data=data.user))
 
 
 class ArchivedThreadIterator(_AsyncIterator["Thread"]):

discord/models/__init__.py

@@ -10,6 +10,7 @@
     UnavailableGuild,
     User,
 )
+from .types import Snowflake
 from .types.utils import MISSING
 
 __all__ = (
@@ -24,4 +25,5 @@
     "AvatarDecorationData",
     "gateway",
     "Ban",
+    "Snowflake",
 )

discord/models/api/__init__.py

@@ -13,8 +13,8 @@
 
 class flag_value:
     def __init__(
-        self, func: Callable[[Any], int]
-    ):  # pyright: ignore [reportExplicitAny]
+        self, func: Callable[[Any], int]  # pyright: ignore [reportExplicitAny]
+    ):
         self.flag: int = func(None)
         self.__doc__ = func.__doc__
 

discord/models/api/ban.py

@@ -43,6 +43,10 @@ def increment(self) -> int:
         """Returns the increment count."""
         return self & 0xFFF
 
+    @property
+    def id(self) -> int:
+        return int(self)
+
     @classmethod
     def __get_pydantic_core_schema__(
         cls,

discord/models/types/flags/base.py

@@ -1,4 +1,4 @@
-from typing_extensions import TypeAlias, final, override
+from typing_extensions import TypeAlias, final
 
 
 @final

discord/models/types/snowflake.py

@@ -25,6 +25,7 @@
 
 from __future__ import annotations
 
+import warnings
 from typing import TYPE_CHECKING, Any, TypeVar
 
 from typing_extensions import override
@@ -574,6 +575,12 @@ class User(BaseUser, discord.abc.Messageable):
     def __init__(self, *, state: ConnectionState, data: models.User) -> None:
         if isinstance(data, dict):
             data = models.User(**data)
+            warnings.warn(
+                "Passing a dict to User is deprecated and will be removed in a future version.",
+                DeprecationWarning,
+                stacklevel=2,
+            )
+
         super().__init__(state=state, data=data)
         self._stored: bool = False