On branch DiscordProfile
Initial commit
This commit is contained in:
@@ -0,0 +1,206 @@
|
||||
"""
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2015-2021 Rapptz
|
||||
Copyright (c) 2021-present Pycord Development
|
||||
|
||||
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
|
||||
|
||||
import io
|
||||
import os
|
||||
from typing import TYPE_CHECKING
|
||||
|
||||
__all__ = (
|
||||
"File",
|
||||
"VoiceMessage",
|
||||
)
|
||||
|
||||
|
||||
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``.
|
||||
|
||||
filename: Optional[: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.
|
||||
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",
|
||||
"description",
|
||||
)
|
||||
|
||||
if TYPE_CHECKING:
|
||||
fp: io.BufferedIOBase
|
||||
filename: str | None
|
||||
description: str | None
|
||||
spoiler: bool
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
fp: str | bytes | os.PathLike | io.BufferedIOBase,
|
||||
filename: str | None = None,
|
||||
*,
|
||||
description: str | None = None,
|
||||
spoiler: bool = False,
|
||||
):
|
||||
|
||||
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 = 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):
|
||||
_, self.filename = os.path.split(fp)
|
||||
else:
|
||||
self.filename = getattr(fp, "name", None)
|
||||
else:
|
||||
self.filename = filename
|
||||
|
||||
if (
|
||||
spoiler
|
||||
and self.filename is not None
|
||||
and not self.filename.startswith("SPOILER_")
|
||||
):
|
||||
self.filename = f"SPOILER_{self.filename}"
|
||||
|
||||
self.spoiler = spoiler or (
|
||||
self.filename is not None and self.filename.startswith("SPOILER_")
|
||||
)
|
||||
self.description = description
|
||||
|
||||
def reset(self, *, seek: 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()
|
||||
|
||||
|
||||
class VoiceMessage(File):
|
||||
"""A special case of the File class that represents a voice message.
|
||||
|
||||
.. versionadded:: 2.7
|
||||
|
||||
.. note::
|
||||
|
||||
Similar to File objects, VoiceMessage objects are single use and are not meant to be reused in
|
||||
multiple requests.
|
||||
|
||||
Attributes
|
||||
----------
|
||||
fp: Union[:class:`os.PathLike`, :class:`io.BufferedIOBase`]
|
||||
A audio 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``.
|
||||
|
||||
filename: Optional[: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.
|
||||
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.
|
||||
waveform: Optional[:class:`str`]
|
||||
The base64 encoded bytearray representing a sampled waveform.
|
||||
duration_secs: Optional[:class:`float`]
|
||||
The duration of the voice message.
|
||||
"""
|
||||
|
||||
__slots__ = (
|
||||
"waveform",
|
||||
"duration_secs",
|
||||
)
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
fp: str | bytes | os.PathLike | io.BufferedIOBase,
|
||||
filename: str | None = None,
|
||||
*,
|
||||
waveform: str = "",
|
||||
duration_secs: float = 0.0,
|
||||
**kwargs,
|
||||
):
|
||||
super().__init__(fp, filename, **kwargs)
|
||||
self.waveform = waveform
|
||||
self.duration_secs = duration_secs
|
||||
Reference in New Issue
Block a user