quick fix 2

Lib/site-packages/discord/file.py

@@ -0,0 +1,173 @@
+"""
+The MIT License (MIT)
+
+Copyright (c) 2015-present Rapptz
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the "Software"),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
+OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
+DEALINGS IN THE SOFTWARE.
+"""
+
+from __future__ import annotations
+from typing import Any, Dict, Optional, Tuple, Union
+
+import os
+import io
+
+from .utils import MISSING
+
+# fmt: off
+__all__ = (
+    'File',
+)
+# fmt: on
+
+
+def _strip_spoiler(filename: str) -> Tuple[str, bool]:
+    stripped = filename
+    while stripped.startswith('SPOILER_'):
+        stripped = stripped[8:]  # len('SPOILER_')
+    spoiler = stripped != filename
+    return stripped, spoiler
+
+
+class File:
+    r"""A parameter object used for :meth:`abc.Messageable.send`
+    for sending file objects.
+
+    .. note::
+
+        File objects are single use and are not meant to be reused in
+        multiple :meth:`abc.Messageable.send`\s.
+
+    Attributes
+    -----------
+    fp: Union[:class:`os.PathLike`, :class:`io.BufferedIOBase`]
+        A file-like object opened in binary mode and read mode
+        or a filename representing a file in the hard drive to
+        open.
+
+        .. note::
+
+            If the file-like object passed is opened via ``open`` then the
+            modes 'rb' should be used.
+
+            To pass binary data, consider usage of ``io.BytesIO``.
+
+    spoiler: :class:`bool`
+        Whether the attachment is a spoiler. If left unspecified, the :attr:`~File.filename` is used
+        to determine if the file is a spoiler.
+    description: Optional[:class:`str`]
+        The file description to display, currently only supported for images.
+
+        .. versionadded:: 2.0
+    """
+
+    __slots__ = ('fp', '_filename', 'spoiler', 'description', '_original_pos', '_owner', '_closer')
+
+    def __init__(
+        self,
+        fp: Union[str, bytes, os.PathLike[Any], io.BufferedIOBase],
+        filename: Optional[str] = None,
+        *,
+        spoiler: bool = MISSING,
+        description: Optional[str] = None,
+    ):
+        if isinstance(fp, io.IOBase):
+            if not (fp.seekable() and fp.readable()):
+                raise ValueError(f'File buffer {fp!r} must be seekable and readable')
+            self.fp: io.BufferedIOBase = fp
+            self._original_pos = fp.tell()
+            self._owner = False
+        else:
+            self.fp = open(fp, 'rb')
+            self._original_pos = 0
+            self._owner = True
+
+        # aiohttp only uses two methods from IOBase
+        # read and close, since I want to control when the files
+        # close, I need to stub it so it doesn't close unless
+        # I tell it to
+        self._closer = self.fp.close
+        self.fp.close = lambda: None
+
+        if filename is None:
+            if isinstance(fp, str):
+                _, filename = os.path.split(fp)
+            else:
+                filename = getattr(fp, 'name', 'untitled')
+
+        self._filename, filename_spoiler = _strip_spoiler(filename)  # type: ignore  # pyright doesn't understand the above getattr
+        if spoiler is MISSING:
+            spoiler = filename_spoiler
+
+        self.spoiler: bool = spoiler
+        self.description: Optional[str] = description
+
+    @property
+    def filename(self) -> str:
+        """:class:`str`: 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.
+        """
+        return 'SPOILER_' + self._filename if self.spoiler else self._filename
+
+    @filename.setter
+    def filename(self, value: str) -> None:
+        self._filename, self.spoiler = _strip_spoiler(value)
+
+    @property
+    def uri(self) -> str:
+        """:class:`str`: Returns the ``attachment://<filename>`` URI for this file.
+        This is used in certain places such as embeds or components to refer
+        to an uploaded file via URL.
+
+        .. note::
+            Due to Discord's filename processing, the filename must be ASCII aphanumeric
+            with underscores, dashes, and periods.
+
+        .. versionadded:: 2.6
+        """
+        return f'attachment://{self.filename}'
+
+    def reset(self, *, seek: Union[int, bool] = True) -> None:
+        # The `seek` parameter is needed because
+        # the retry-loop is iterated over multiple times
+        # starting from 0, as an implementation quirk
+        # the resetting must be done at the beginning
+        # before a request is done, since the first index
+        # is 0, and thus false, then this prevents an
+        # unnecessary seek since it's the first request
+        # done.
+        if seek:
+            self.fp.seek(self._original_pos)
+
+    def close(self) -> None:
+        self.fp.close = self._closer
+        if self._owner:
+            self._closer()
+
+    def to_dict(self, index: int) -> Dict[str, Any]:
+        payload = {
+            'id': index,
+            'filename': self.filename,
+        }
+
+        if self.description is not None:
+            payload['description'] = self.description
+
+        return payload