refactor: allow file sending in all send and editing methods (except context) (#706)

EepyElvyra · web-flow · commit 51d824c2f645 · 2022-04-05T12:56:41.000-04:00
* refactor: allow file sending in all send and editing methods (except context)

* refactor: update headers

* refactor: update headers
diff --git a/interactions/api/http/message.py b/interactions/api/http/message.py
@@ -143,16 +143,35 @@ async def delete_messages(
 
         return await self._req.request(r, json=payload, reason=reason)
 
-    async def edit_message(self, channel_id: int, message_id: int, payload: dict) -> dict:
+    async def edit_message(
+        self, channel_id: int, message_id: int, payload: dict, files: Optional[List[File]] = MISSING
+    ) -> dict:
         """
         Edits a message that already exists.
 
         :param channel_id: Channel snowflake ID.
         :param message_id: Message snowflake ID.
         :param payload: Any new data that needs to be changed.
+        :param files: An optional list of files to send attached to the message.
         :type payload: dict
         :return: A message object with edited attributes.
         """
+        data = None
+        if files is not MISSING and len(files) > 0:
+
+            data = MultipartWriter("form-data")
+            part = data.append_json(payload)
+            part.set_content_disposition("form-data", name="payload_json")
+            payload = None
+
+            for id, file in enumerate(files):
+                part = data.append(
+                    file._fp,
+                )
+                part.set_content_disposition(
+                    "form-data", name="files[" + str(id) + "]", filename=file._filename
+                )
+
         return await self._req.request(
             Route(
                 "PATCH",
@@ -161,6 +180,7 @@ async def edit_message(self, channel_id: int, message_id: int, payload: dict) ->
                 message_id=message_id,
             ),
             json=payload,
+            data=data,
         )
 
     async def pin_message(self, channel_id: int, message_id: int) -> None:
diff --git a/interactions/api/http/message.pyi b/interactions/api/http/message.pyi
@@ -2,7 +2,7 @@ from typing import List, Optional, Union
 
 from ...api.cache import Cache
 from ..models.message import Embed, Message
-from ..models.misc import Snowflake, File
+from ..models.misc import Snowflake, File, MISSING
 from .request import _Request
 
 
@@ -29,9 +29,11 @@ class _MessageRequest:
         self, channel_id: int, message_id: int, reason: Optional[str] = None
     ) -> None: ...
     async def delete_messages(
-            self, channel_id: int, message_ids: List[int], reason: Optional[str] = None
+        self, channel_id: int, message_ids: List[int], reason: Optional[str] = None
     ) -> None: ...
-    async def edit_message(self, channel_id: int, message_id: int, payload: dict) -> dict: ...
+    async def edit_message(
+        self, channel_id: int, message_id: int, payload: dict, files: Optional[List[File]] = MISSING
+    ) -> dict: ...
     async def pin_message(self, channel_id: int, message_id: int) -> None: ...
     async def unpin_message(self, channel_id: int, message_id: int) -> None: ...
     async def publish_message(self, channel_id: int, message_id: int) -> dict: ...
diff --git a/interactions/api/models/gw.py b/interactions/api/models/gw.py
@@ -1,11 +1,11 @@
 from datetime import datetime
 from typing import List, Optional, Union
 
-from ...client.models.component import ActionRow, Button, SelectMenu
+from ...client.models.component import ActionRow, Button, SelectMenu, _build_components
 from .channel import Channel, ThreadMember
 from .member import Member
 from .message import Embed, Emoji, Message, MessageInteraction, Sticker
-from .misc import MISSING, ClientStatus, DictSerializerMixin, Snowflake
+from .misc import MISSING, ClientStatus, DictSerializerMixin, File, Snowflake
 from .presence import PresenceActivity
 from .role import Role
 from .user import User
@@ -347,7 +347,7 @@ async def send(
             ]
         ] = MISSING,
         tts: Optional[bool] = MISSING,
-        # attachments: Optional[List[Any]] = None,  # TODO: post-v4: Replace with own file type.
+        files: Optional[Union[File, List[File]]] = MISSING,
         embeds: Optional[Union[Embed, List[Embed]]] = MISSING,
         allowed_mentions: Optional[MessageInteraction] = MISSING,
     ) -> Message:
@@ -360,6 +360,8 @@ async def send(
         :type components: Optional[Union[ActionRow, Button, SelectMenu, List[Actionrow], List[Button], List[SelectMenu]]]
         :param tts?: Whether the message utilizes the text-to-speech Discord programme or not.
         :type tts: Optional[bool]
+        :param files?: A file or list of files to be attached to the message.
+        :type files: Optional[Union[File, List[File]]]
         :param embeds?: An embed, or list of embeds for the message.
         :type embeds: Optional[Union[Embed, List[Embed]]]
         :param allowed_mentions?: The message interactions/mention limits that the message can refer to.
@@ -383,117 +385,30 @@ async def send(
 
         if not components or components is MISSING:
             _components = []
-        # TODO: Break this obfuscation pattern down to a "builder" method.
         else:
-            _components: List[dict] = [{"type": 1, "components": []}]
-            if isinstance(components, list) and all(
-                isinstance(action_row, ActionRow) for action_row in components
-            ):
-                _components = [
-                    {
-                        "type": 1,
-                        "components": [
-                            (
-                                component._json
-                                if component._json.get("custom_id") or component._json.get("url")
-                                else []
-                            )
-                            for component in action_row.components
-                        ],
-                    }
-                    for action_row in components
-                ]
-            elif isinstance(components, list) and all(
-                isinstance(component, (Button, SelectMenu)) for component in components
-            ):
-                for component in components:
-                    if isinstance(component, SelectMenu):
-                        component._json["options"] = [
-                            options._json if not isinstance(options, dict) else options
-                            for options in component._json["options"]
-                        ]
-                _components = [
-                    {
-                        "type": 1,
-                        "components": [
-                            (
-                                component._json
-                                if component._json.get("custom_id") or component._json.get("url")
-                                else []
-                            )
-                            for component in components
-                        ],
-                    }
-                ]
-            elif isinstance(components, list) and all(
-                isinstance(action_row, (list, ActionRow)) for action_row in components
-            ):
-                _components = []
-                for action_row in components:
-                    for component in (
-                        action_row if isinstance(action_row, list) else action_row.components
-                    ):
-                        if isinstance(component, SelectMenu):
-                            component._json["options"] = [
-                                option._json for option in component.options
-                            ]
-                    _components.append(
-                        {
-                            "type": 1,
-                            "components": [
-                                (
-                                    component._json
-                                    if component._json.get("custom_id")
-                                    or component._json.get("url")
-                                    else []
-                                )
-                                for component in (
-                                    action_row
-                                    if isinstance(action_row, list)
-                                    else action_row.components
-                                )
-                            ],
-                        }
-                    )
-            elif isinstance(components, ActionRow):
-                _components[0]["components"] = [
-                    (
-                        component._json
-                        if component._json.get("custom_id") or component._json.get("url")
-                        else []
-                    )
-                    for component in components.components
-                ]
-            elif isinstance(components, Button):
-                _components[0]["components"] = (
-                    [components._json]
-                    if components._json.get("custom_id") or components._json.get("url")
-                    else []
-                )
-            elif isinstance(components, SelectMenu):
-                components._json["options"] = [
-                    options._json if not isinstance(options, dict) else options
-                    for options in components._json["options"]
-                ]
-                _components[0]["components"] = (
-                    [components._json]
-                    if components._json.get("custom_id") or components._json.get("url")
-                    else []
-                )
-
-        # TODO: post-v4: Add attachments into Message obj.
+            _components = _build_components(components=components)
+
+        if not files or files is MISSING:
+            _files = []
+        elif isinstance(files, list):
+            _files = [file._json_payload(id) for id, file in enumerate(files)]
+        else:
+            _files = [files._json_payload(0)]
+            files = [files]
+
         payload = Message(
             content=_content,
             tts=_tts,
-            # file=file,
-            # attachments=_attachments,
+            attachments=_files,
             embeds=_embeds,
             components=_components,
             allowed_mentions=_allowed_mentions,
         )
 
         channel = Channel(**await self._client.create_dm(recipient_id=int(self.user.id)))
-        res = await self._client.create_message(channel_id=int(channel.id), payload=payload._json)
+        res = await self._client.create_message(
+            channel_id=int(channel.id), payload=payload._json, files=files
+        )
 
         return Message(**res, _client=self._client)
 
diff --git a/interactions/api/models/gw.pyi b/interactions/api/models/gw.pyi
@@ -5,7 +5,7 @@ from ...models.component import ActionRow, Button, SelectMenu
 from .channel import Channel, ThreadMember
 from .member import Member
 from .message import Embed, Emoji, Message, MessageInteraction, Sticker
-from .misc import MISSING, ClientStatus, DictSerializerMixin, Snowflake
+from .misc import MISSING, ClientStatus, DictSerializerMixin, Snowflake, File
 from .presence import PresenceActivity
 from .role import Role
 from .user import User
@@ -114,7 +114,7 @@ class GuildMember(DictSerializerMixin):
             ]
         ] = MISSING,
         tts: Optional[bool] = MISSING,
-        # attachments: Optional[List[Any]] = None,  # TODO: post-v4: Replace with own file type.
+        files: Optional[Union[File, List[File]]] = MISSING,
         embeds: Optional[Union[Embed, List["Embed"]]] = MISSING,
         allowed_mentions: Optional[MessageInteraction] = MISSING,
     ) -> Message: ...
diff --git a/interactions/api/models/member.py b/interactions/api/models/member.py
@@ -3,7 +3,7 @@
 
 from .channel import Channel
 from .flags import Permissions
-from .misc import MISSING, DictSerializerMixin, Snowflake
+from .misc import MISSING, DictSerializerMixin, File, Snowflake
 from .role import Role
 from .user import User
 
@@ -230,7 +230,7 @@ async def send(
             ]
         ] = MISSING,
         tts: Optional[bool] = MISSING,
-        # attachments: Optional[List[Any]] = None,  # TODO: post-v4: Replace with own file type.
+        files: Optional[Union[File, List[File]]] = MISSING,
         embeds: Optional[Union["Embed", List["Embed"]]] = MISSING,  # noqa
         allowed_mentions: Optional["MessageInteraction"] = MISSING,  # noqa
     ) -> "Message":  # noqa
@@ -243,6 +243,8 @@ async def send(
         :type components: Optional[Union[ActionRow, Button, SelectMenu, List[Actionrow], List[Button], List[SelectMenu]]]
         :param tts?: Whether the message utilizes the text-to-speech Discord programme or not.
         :type tts: Optional[bool]
+        :param files?: A file or list of files to be attached to the message.
+        :type files: Optional[Union[File, List[File]]]
         :param embeds?: An embed, or list of embeds for the message.
         :type embeds: Optional[Union[Embed, List[Embed]]]
         :param allowed_mentions?: The message interactions/mention limits that the message can refer to.
@@ -271,19 +273,28 @@ async def send(
         else:
             _components = _build_components(components=components)
 
+        if not files or files is MISSING:
+            _files = []
+        elif isinstance(files, list):
+            _files = [file._json_payload(id) for id, file in enumerate(files)]
+        else:
+            _files = [files._json_payload(0)]
+            files = [files]
+
         # TODO: post-v4: Add attachments into Message obj.
         payload = Message(
             content=_content,
             tts=_tts,
-            # file=file,
-            # attachments=_attachments,
+            attachments=_files,
             embeds=_embeds,
             components=_components,
             allowed_mentions=_allowed_mentions,
         )
 
         channel = Channel(**await self._client.create_dm(recipient_id=int(self.user.id)))
-        res = await self._client.create_message(channel_id=int(channel.id), payload=payload._json)
+        res = await self._client.create_message(
+            channel_id=int(channel.id), payload=payload._json, files=files
+        )
 
         return Message(**res, _client=self._client)
 
diff --git a/interactions/api/models/member.pyi b/interactions/api/models/member.pyi
@@ -1,7 +1,7 @@
 from datetime import datetime
 from typing import Any, List, Optional, Union
 
-from .misc import DictSerializerMixin, MISSING, Snowflake
+from .misc import DictSerializerMixin, MISSING, Snowflake, File
 from .role import Role
 from .user import User
 from .flags import Permissions
@@ -71,7 +71,7 @@ class Member(DictSerializerMixin):
             ]
         ] = MISSING,
         tts: Optional[bool] = MISSING,
-        # attachments: Optional[List[Any]] = None,  # TODO: post-v4: Replace with own file type.
+        files: Optional[Union[File, List[File]]] = MISSING,
         embeds: Optional[Union[Embed, List["Embed"]]] = MISSING,
         allowed_mentions: Optional[MessageInteraction] = MISSING,
     ) -> Message: ...
diff --git a/interactions/api/models/message.py b/interactions/api/models/message.py
diff --git a/interactions/api/models/message.pyi b/interactions/api/models/message.pyi
