Add description to Attachments and Files (#509)

Author: plun1331

discord/file.py

@@ -61,22 +61,26 @@ class File:
         The filename to display when uploading to Discord.
         If this is not given then it defaults to ``fp.name`` or if ``fp`` is
         a string then the ``filename`` will default to the string given.
+    description: Optional[:class`str`]
+        The description of a file, used by Discord to display alternative text on images.
     spoiler: :class:`bool`
         Whether the attachment is a spoiler.
     """
 
-    __slots__ = ('fp', 'filename', 'spoiler', '_original_pos', '_owner', '_closer')
+    __slots__ = ('fp', 'filename', 'spoiler', '_original_pos', '_owner', '_closer', 'description')
 
     if TYPE_CHECKING:
         fp: io.BufferedIOBase
         filename: Optional[str]
+        description: Optional[str]
         spoiler: bool
 
     def __init__(
         self,
         fp: Union[str, bytes, os.PathLike, io.BufferedIOBase],
         filename: Optional[str] = None,
         *,
+        description: Optional[str] = None,
         spoiler: bool = False,
     ):
         if isinstance(fp, io.IOBase):
@@ -109,6 +113,7 @@ def __init__(
             self.filename = 'SPOILER_' + self.filename
 
         self.spoiler = spoiler or (self.filename is not None and self.filename.startswith('SPOILER_'))
+        self.description = description
 
     def reset(self, *, seek: Union[int, bool] = True) -> None:
         # The `seek` parameter is needed because

discord/http.py

@@ -267,7 +267,7 @@ async def request(
                         f.reset(seek=tries)
 
                 if form:
-                    form_data = aiohttp.FormData()
+                    form_data = aiohttp.FormData(quote_fields=False)
                     for params in form:
                         form_data.add_field(**params)
                     kwargs['data'] = form_data
@@ -497,28 +497,20 @@ def send_multipart_helper(
         if stickers:
             payload['sticker_ids'] = stickers
 
-        form.append({'name': 'payload_json', 'value': utils._to_json(payload)})
-        if len(files) == 1:
-            file = files[0]
+        attachments = []
+        form.append({'name': 'payload_json'})
+        for index, file in enumerate(files):
+            attachments.append({'id': index, 'filename': file.filename, 'description': file.description})
             form.append(
                 {
-                    'name': 'file',
+                    'name': f'files[{index}]',
                     'value': file.fp,
                     'filename': file.filename,
                     'content_type': 'application/octet-stream',
                 }
             )
-        else:
-            for index, file in enumerate(files):
-                form.append(
-                    {
-                        'name': f'file{index}',
-                        'value': file.fp,
-                        'filename': file.filename,
-                        'content_type': 'application/octet-stream',
-                    }
-                )
-
+        payload['attachments'] = attachments
+        form[0]['value'] = utils._to_json(payload)
         return self.request(route, form=form, files=files)
 
     def send_files(
@@ -559,27 +551,23 @@ def edit_multipart_helper(
     ) -> Response[message.Message]:
         form = []
 
-        form.append({'name': 'payload_json', 'value': utils._to_json(payload)})
-        if len(files) == 1:
-            file = files[0]
+        attachments = []
+        form.append({'name': 'payload_json'})
+        for index, file in enumerate(files):
+            attachments.append({'id': index, 'filename': file.filename, 'description': file.description})
             form.append(
                 {
-                    'name': 'file',
+                    'name': f'files[{index}]',
                     'value': file.fp,
                     'filename': file.filename,
                     'content_type': 'application/octet-stream',
                 }
             )
+        if 'attachments' not in payload:
+            payload['attachments'] = attachments
         else:
-            for index, file in enumerate(files):
-                form.append(
-                    {
-                        'name': f'file{index}',
-                        'value': file.fp,
-                        'filename': file.filename,
-                        'content_type': 'application/octet-stream',
-                    }
-                )
+            payload['attachments'].extend(attachments)
+        form[0]['value'] = utils._to_json(payload)
 
         return self.request(route, form=form, files=files)
 

discord/interactions.py

@@ -713,7 +713,6 @@ async def edit_message(
                 payload['components'] = []
             else:
                 payload['components'] = view.to_components()
-
         adapter = async_context.get()
         await adapter.create_interaction_response(
             parent.id,

discord/message.py

@@ -154,9 +154,14 @@ class Attachment(Hashable):
         Whether the attachment is ephemeral or not.
 
         .. versionadded:: 1.7
+
+    description: Optional[:class:`str`]
+        The attachment's description. 
+
+        .. versionadded:: 2.0
     """
 
-    __slots__ = ('id', 'size', 'height', 'width', 'filename', 'url', 'proxy_url', '_http', 'content_type', 'ephemeral')
+    __slots__ = ('id', 'size', 'height', 'width', 'filename', 'url', 'proxy_url', '_http', 'content_type', 'ephemeral', 'description')
 
     def __init__(self, *, data: AttachmentPayload, state: ConnectionState):
         self.id: int = int(data['id'])
@@ -169,6 +174,7 @@ def __init__(self, *, data: AttachmentPayload, state: ConnectionState):
         self._http = state.http
         self.content_type: Optional[str] = data.get('content_type')
         self.ephemeral: bool = data.get('ephemeral', False)
+        self.description: Optional[str] = data.get('description')
 
     def is_spoiler(self) -> bool:
         """:class:`bool`: Whether this attachment contains a spoiler."""
@@ -305,7 +311,7 @@ async def to_file(self, *, use_cached: bool = False, spoiler: bool = False) -> F
         """
 
         data = await self.read(use_cached=use_cached)
-        return File(io.BytesIO(data), filename=self.filename, spoiler=spoiler)
+        return File(io.BytesIO(data), filename=self.filename, spoiler=spoiler, description=self.description)
 
     def to_dict(self) -> AttachmentPayload:
         result: AttachmentPayload = {
@@ -322,6 +328,8 @@ def to_dict(self) -> AttachmentPayload:
             result['width'] = self.width
         if self.content_type:
             result['content_type'] = self.content_type
+        if self.description:
+            result['description'] = self.description
         return result
 
 
@@ -1312,6 +1320,9 @@ async def edit(
             raise InvalidArgument('cannot pass both file and files parameter to edit()')
 
         if file is not MISSING:
+            if 'attachments' not in payload:
+                # don't want it to remove any attachments when we just add a new file
+                payload['attachments'] = [a.to_dict() for a in self.attachments]
             if not isinstance(file, File):
                 raise InvalidArgument('file parameter must be File')
 
@@ -1330,6 +1341,9 @@ async def edit(
                 raise InvalidArgument('files parameter must be a list of up to 10 elements')
             elif not all(isinstance(file, File) for file in files):
                 raise InvalidArgument('files parameter must be a list of File')
+            if 'attachments' not in payload:
+                # don't want it to remove any attachments when we just add a new file
+                payload['attachments'] = [a.to_dict() for a in self.attachments]
 
             try:
                 data = await self._state.http.edit_files(

discord/webhook/async_.py

@@ -145,7 +145,7 @@ async def request(
                     file.reset(seek=attempt)
 
                 if multipart:
-                    form_data = aiohttp.FormData()
+                    form_data = aiohttp.FormData(quote_fields=False)
                     for p in multipart:
                         form_data.add_field(**p)
                     to_send = form_data
@@ -379,28 +379,21 @@ def create_interaction_response(
 
         if data is not None:
             payload['data'] = data
-        form = [{'name': 'payload_json', 'value': utils._to_json(payload)}]
+        form = [{'name': 'payload_json'}]
+        attachments = []
         files = files or []
-        if len(files) == 1:
-            file = files[0]
+        for index, file in enumerate(files):
+            attachments.append({'id': index, 'filename': file.filename, 'description': file.description})
             form.append(
                 {
-                    'name': 'file',
+                    'name': f'files[{index}]',
                     'value': file.fp,
                     'filename': file.filename,
                     'content_type': 'application/octet-stream',
                 }
             )
-        else:
-            for index, file in enumerate(files):
-                form.append(
-                    {
-                        'name': f'file{index}',
-                        'value': file.fp,
-                        'filename': file.filename,
-                        'content_type': 'application/octet-stream',
-                    }
-                )
+        payload['attachments'] = attachments
+        form[0]['value'] = utils._to_json(payload)
 
         route = Route(
             'POST',