chore!: pre-release 4.1.1-beta.2 (#652)

chore!: pre-release 4.1.1-beta.2

Author: i0bs

docs/api.http.rst

@@ -1,8 +1,68 @@
 .. currentmodule:: interactions
 
-HTTP Client
-===========
+HTTP
+====
 
-.. automodule:: interactions.api.http
+.. autoclass:: interactions.api.http.route.Route
+    :members:
+    :noindex:
+
+.. autoclass:: interactions.api.http.limiter.Limiter
+    :members:
+    :noindex:
+
+.. autoclass:: interactions.api.http.request._Request
+    :members:
+    :noindex:
+
+.. autoclass:: interactions.api.http.client.HTTPClient
+    :members:
+    :noindex:
+
+.. autoclass:: interactions.api.http.channel._ChannelRequest
+    :members:
+    :noindex:
+
+.. autoclass:: interactions.api.http.emoji._EmojiRequest
+    :members:
+    :noindex:
+
+.. autoclass:: interactions.api.http.guild._GuildRequest
+    :members:
+    :noindex:
+
+.. autoclass:: interactions.api.http.interaction._InteractionRequest
+    :members:
+    :noindex:
+
+.. autoclass:: interactions.api.http.member._MemberRequest
+    :members:
+    :noindex:
+
+.. autoclass:: interactions.api.http.message._MessageRequest
+    :members:
+    :noindex:
+
+.. autoclass:: interactions.api.http.reaction._ReactionRequest
+    :members:
+    :noindex:
+
+.. autoclass:: interactions.api.http.scheduledEvent._ScheduledEventRequest
+    :members:
+    :noindex:
+
+.. autoclass:: interactions.api.http.sticker._StickerRequest
+    :members:
+    :noindex:
+
+.. autoclass:: interactions.api.http.thread._ThreadRequest
+    :members:
+    :noindex:
+
+.. autoclass:: interactions.api.http.user._UserRequest
+    :members:
+    :noindex:
+
+.. autoclass:: interactions.api.http.webhook._WebhookRequest
     :members:
     :noindex:

docs/api.models.flags.rst

@@ -0,0 +1,8 @@
+.. currentmodule:: interactions
+
+Flag Bitshift Models
+====================
+
+.. automodule:: interactions.api.models.flags
+    :members:
+    :noindex:

docs/api.models.intents.rst

@@ -9,7 +9,7 @@ Model Objects
     api.models.channel.rst
     api.models.guild.rst
     api.models.gw.rst
-    api.models.intents.rst
+    api.models.flags.rst
     api.models.member.rst
     api.models.message.rst
     api.models.misc.rst

docs/api.models.rst

@@ -274,7 +274,7 @@ implementation of a component:
     async def button_test(ctx):
         await ctx.send("testing", components=button)
 
-    @bot.component("hello"")
+    @bot.component("hello")
     async def button_response(ctx):
         await ctx.send("You clicked the Button :O", ephemeral=True)
 
@@ -337,7 +337,7 @@ tables, if you so wish to choose to not use our class objects instead.
 
 Creating a TextInput
 ^^^^^^^^^^^^^^^^^^^^
-You want to get a Text from a user? You can use ``TextInput``s for that.
+You want to get a Text from a user? You can use ``TextInput`` for that.
 
 .. code-block:: python
 
@@ -354,7 +354,7 @@ But how to send it? You can't use ``ctx.send`` for it. Take a look at :ref:`Moda
 
 Modals
 ******
-Modals are a new way to interact with a user. Currently only a ``TextInput`` component is supported. You can have up to three ``TextInput``s in a Modal.
+Modals are a new way to interact with a user. Currently only a ``TextInput`` component is supported. You can have up to three ``TextInput`` in a Modal.
 
 .. code-block:: python
 

docs/quickstart.rst

@@ -25,14 +25,13 @@
 from .dispatch import Listener
 from .enums import OpCodeType
 from .error import GatewayException
-from .http import HTTPClient
+from .http.client import HTTPClient
 from .models.flags import Intents
 from .models.misc import MISSING
 from .models.presence import ClientPresence
 
 log = get_logger("gateway")
 
-
 __all__ = ("_Heartbeat", "WebSocketClient")
 
 
@@ -280,7 +279,7 @@ async def wait_until_ready(self):
         """Waits for the client to become ready according to the Gateway."""
         await self.ready.wait()
 
-    def _dispatch_event(self, event: str, data: dict) -> None:
+    def _dispatch_event(self, event: str, data: dict) -> None:  # sourcery no-metrics
         """
         Dispatches an event from the Gateway.
 
@@ -291,97 +290,88 @@ def _dispatch_event(self, event: str, data: dict) -> None:
         """
         path: str = "interactions"
         path += ".models" if event == "INTERACTION_CREATE" else ".api.models"
-
-        if event != "TYPING_START":
-            if event != "INTERACTION_CREATE":
-                name: str = event.lower()
-                try:
-                    _event_path: list = [section.capitalize() for section in name.split("_")]
-                    _name: str = (
-                        _event_path[0] if len(_event_path) < 3 else "".join(_event_path[:-1])
-                    )
-                    __obj: object = getattr(__import__(path), _name)
-
-                    if name in {"_create", "_add"}:
-                        data["_client"] = self._http
-
-                    self._dispatch.dispatch(f"on_{name}", __obj(**data))  # noqa
-                except AttributeError as error:
-                    log.fatal(f"An error occured dispatching {name}: {error}")
+        if event == "INTERACTION_CREATE":
+            if not data.get("type"):
+                log.warning(
+                    "Context is being created for the interaction, but no type is specified. Skipping..."
+                )
             else:
-                if not data.get("type"):
-                    log.warning(
-                        "Context is being created for the interaction, but no type is specified. Skipping..."
-                    )
-                else:
-                    _context = self.__contextualize(data)
-                    _name: str = ""
-                    __args: list = [_context]
-                    __kwargs: dict = {}
-
-                    if data["type"] == InteractionType.APPLICATION_COMMAND:
-                        _name = f"command_{_context.data.name}"
-
-                        if _context.data._json.get("options"):
-                            for option in _context.data.options:
-                                _type = self.__option_type_context(
-                                    _context,
-                                    (
-                                        option["type"]
-                                        if isinstance(option, dict)
-                                        else option.type.value
-                                    ),
-                                )
-                                if _type:
-                                    if isinstance(option, dict):
-                                        _type[option["value"]]._client = self._http
-                                        option.update({"value": _type[option["value"]]})
-                                    else:
-                                        _type[option.value]._client = self._http
-                                        option._json.update({"value": _type[option.value]})
-                                _option = self.__sub_command_context(option, _context)
-                                __kwargs.update(_option)
-
-                        self._dispatch.dispatch("on_command", _context)
-                    elif data["type"] == InteractionType.MESSAGE_COMPONENT:
-                        _name = f"component_{_context.data.custom_id}"
-
-                        if _context.data._json.get("values"):
-                            __args.append(_context.data.values)
-
-                        self._dispatch.dispatch("on_component", _context)
-                    elif data["type"] == InteractionType.APPLICATION_COMMAND_AUTOCOMPLETE:
-                        _name = f"autocomplete_{_context.data.id}"
-
-                        if _context.data._json.get("options"):
-                            for option in _context.data.options:
-                                __name, _value = self.__sub_command_context(option, _context)
-                                _name += f"_{__name}" if __name else ""
-
-                                if _value:
-                                    __args.append(_value)
-
-                        self._dispatch.dispatch("on_autocomplete", _context)
-                    elif data["type"] == InteractionType.MODAL_SUBMIT:
-                        _name = f"modal_{_context.data.custom_id}"
-
-                        if _context.data._json.get("components"):
-                            for component in _context.data.components:
-                                if component.get("components"):
-                                    __args.append(
-                                        [_value["value"] for _value in component["components"]][0]
-                                    )
+                # sourcery skip: extract-method
+                _context = self.__contextualize(data)
+                _name: str = ""
+                __args: list = [_context]
+                __kwargs: dict = {}
+
+                if data["type"] == InteractionType.APPLICATION_COMMAND:
+                    _name = f"command_{_context.data.name}"
+
+                    if _context.data._json.get("options"):
+                        for option in _context.data.options:
+                            _type = self.__option_type_context(
+                                _context,
+                                (option["type"] if isinstance(option, dict) else option.type.value),
+                            )
+                            if _type:
+                                if isinstance(option, dict):
+                                    _type[option["value"]]._client = self._http
+                                    option.update({"value": _type[option["value"]]})
                                 else:
-                                    __args.append(
-                                        [_value.value for _value in component.components][0]
-                                    )
-
-                        self._dispatch.dispatch("on_modal", _context)
-
-                    self._dispatch.dispatch(_name, *__args, **__kwargs)
-                    self._dispatch.dispatch("on_interaction", _context)
-                    self._dispatch.dispatch("on_interaction_create", _context)
-
+                                    _type[option.value]._client = self._http
+                                    option._json.update({"value": _type[option.value]})
+                            _option = self.__sub_command_context(option, _context)
+                            __kwargs.update(_option)
+
+                    self._dispatch.dispatch("on_command", _context)
+                elif data["type"] == InteractionType.MESSAGE_COMPONENT:
+                    _name = f"component_{_context.data.custom_id}"
+
+                    if _context.data._json.get("values"):
+                        __args.append(_context.data.values)
+
+                    self._dispatch.dispatch("on_component", _context)
+                elif data["type"] == InteractionType.APPLICATION_COMMAND_AUTOCOMPLETE:
+                    _name = f"autocomplete_{_context.data.id}"
+
+                    if _context.data._json.get("options"):
+                        for option in _context.data.options:
+                            __name, _value = self.__sub_command_context(option, _context)
+                            _name += f"_{__name}" if __name else ""
+
+                            if _value:
+                                __args.append(_value)
+
+                    self._dispatch.dispatch("on_autocomplete", _context)
+                elif data["type"] == InteractionType.MODAL_SUBMIT:
+                    _name = f"modal_{_context.data.custom_id}"
+
+                    if _context.data._json.get("components"):
+                        for component in _context.data.components:
+                            if component.get("components"):
+                                __args.append(
+                                    [_value["value"] for _value in component["components"]][0]
+                                )
+                            else:
+                                __args.append([_value.value for _value in component.components][0])
+
+                    self._dispatch.dispatch("on_modal", _context)
+
+                self._dispatch.dispatch(_name, *__args, **__kwargs)
+                self._dispatch.dispatch("on_interaction", _context)
+                self._dispatch.dispatch("on_interaction_create", _context)
+        elif event != "TYPING_START":
+            name: str = event.lower()
+            try:
+                _event_path: list = [section.capitalize() for section in name.split("_")]
+                _name: str = _event_path[0] if len(_event_path) < 3 else "".join(_event_path[:-1])
+                __obj: object = getattr(__import__(path), _name)
+
+                # name in {"_create", "_add"} returns False (tested w message_create)
+                if any(_ in name for _ in {"_create", "_update", "_add", "_remove", "_delete"}):
+                    data["_client"] = self._http
+
+                self._dispatch.dispatch(f"on_{name}", __obj(**data))  # noqa
+            except AttributeError as error:
+                log.fatal(f"An error occured dispatching {name}: {error}")
         self._dispatch.dispatch("raw_socket_create", data)
 
     def __contextualize(self, data: dict) -> object:
@@ -621,3 +611,20 @@ def shard(self) -> Optional[List[Tuple[int]]]:
     def presence(self) -> Optional[ClientPresence]:
         """Returns the current presence."""
         return self.__presence
+
+    async def _update_presence(self, presence: ClientPresence) -> None:
+        """
+        Sends an ``UPDATE_PRESENCE`` packet to the gateway.
+
+        .. note::
+            There is a ratelimit to using this method (5 per minute).
+            As there's no gateway ratelimiter yet, breaking this ratelimit
+            will force your bot to disconnect.
+
+        :param presence: The presence to change the bot to on identify.
+        :type presence: ClientPresence
+        """
+        payload: dict = {"op": OpCodeType.PRESENCE, "d": presence._json}
+        await self._send_packet(payload)
+        log.debug(f"UPDATE_PRESENCE: {presence._json}")
+        self.__presence = presence

interactions/api/gateway.py

@@ -12,7 +12,7 @@ from ..models import Option
 from ..api.models.misc import MISSING
 from ..api.models.presence import ClientPresence
 from .dispatch import Listener
-from .http import HTTPClient
+from .http.client import HTTPClient
 from .models.flags import Intents
 
 log: Logger
@@ -79,3 +79,4 @@ class WebSocketClient:
     @property
     def presence(self) -> None: ...
     async def restart(self): ...
+    async def _update_presence(self, presence: ClientPresence) -> None: ...