Skip to content

Commit

Permalink
feat(embed): add the ability to pass disnake.File to more Embed metho…
Browse files Browse the repository at this point in the history 
…ds (#1229)

Signed-off-by: Snipy7374 <100313469+Snipy7374@users.noreply.github.com>
Co-authored-by: shiftinv <8530778+shiftinv@users.noreply.github.com>
Co-authored-by: Eneg <42005170+Enegg@users.noreply.github.com>
  • Loading branch information
@Snipy7374 @shiftinv @Enegg
3 people authored Nov 16, 2024
1 parent 179de79 commit aedc1d1
Show file tree
Hide file tree
Showing 2 changed files with 77 additions and 11 deletions.
1 change: 1 addition & 0 deletions changelog/1184.feature.rst
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add the possibility to pass :class:`disnake.File` objects to :meth:`Embed.set_author` and :meth:`~Embed.set_footer`.
87 changes: 76 additions & 11 deletions disnake/embeds.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -106,7 +106,7 @@ class _EmbedAuthorProxy(Sized, Protocol):
icon_url: Optional[str]
proxy_icon_url: Optional[str]

_FileKey = Literal["image", "thumbnail"]
_FileKey = Literal["image", "thumbnail", "footer", "author"]


class Embed:
Expand Down Expand Up @@ -385,12 +385,32 @@ def footer(self) -> _EmbedFooterProxy:
"""
return cast("_EmbedFooterProxy", EmbedProxy(self._footer))

def set_footer(self, *, text: Any, icon_url: Optional[Any] = None) -> Self:
@overload
def set_footer(self, *, text: Any, icon_url: Optional[Any] = ...) -> Self:
...

@overload
def set_footer(self, *, text: Any, icon_file: File = ...) -> Self:
...

def set_footer(
self, *, text: Any, icon_url: Optional[Any] = MISSING, icon_file: File = MISSING
) -> Self:
"""Sets the footer for the embed content.
This function returns the class instance to allow for fluent-style
chaining.
At most one of ``icon_url`` or ``icon_file`` may be passed.
.. warning::
Passing a :class:`disnake.File` object will make the embed not
reusable.
.. warning::
If used with the other ``set_*`` methods, you must ensure
that the :attr:`.File.filename` is unique to avoid duplication.
Parameters
----------
text: :class:`str`
Expand All @@ -401,13 +421,18 @@ def set_footer(self, *, text: Any, icon_url: Optional[Any] = None) -> Self:
icon_url: Optional[:class:`str`]
The URL of the footer icon. Only HTTP(S) is supported.
icon_file: :class:`File`
The file to use as the footer icon.
.. versionadded:: 2.10
"""
self._footer = {
"text": str(text),
}

if icon_url is not None:
self._footer["icon_url"] = str(icon_url)
result = self._handle_resource(icon_url, icon_file, key="footer", required=False)
if result is not None:
self._footer["icon_url"] = result

return self

Expand Down Expand Up @@ -457,6 +482,10 @@ def set_image(self, url: Optional[Any] = MISSING, *, file: File = MISSING) -> Se
Passing a :class:`disnake.File` object will make the embed not
reusable.
.. warning::
If used with the other ``set_*`` methods, you must ensure
that the :attr:`.File.filename` is unique to avoid duplication.
.. versionchanged:: 1.4
Passing ``None`` removes the image.
Expand Down Expand Up @@ -508,6 +537,10 @@ def set_thumbnail(self, url: Optional[Any] = MISSING, *, file: File = MISSING) -
Passing a :class:`disnake.File` object will make the embed not
reusable.
.. warning::
If used with the other ``set_*`` methods, you must ensure
that the :attr:`.File.filename` is unique to avoid duplication.
.. versionchanged:: 1.4
Passing ``None`` removes the thumbnail.
Expand Down Expand Up @@ -559,18 +592,39 @@ def author(self) -> _EmbedAuthorProxy:
"""
return cast("_EmbedAuthorProxy", EmbedProxy(self._author))

@overload
def set_author(
self, *, name: Any, url: Optional[Any] = ..., icon_url: Optional[Any] = ...
) -> Self:
...

@overload
def set_author(self, *, name: Any, url: Optional[Any] = ..., icon_file: File = ...) -> Self:
...

def set_author(
self,
*,
name: Any,
url: Optional[Any] = None,
icon_url: Optional[Any] = None,
icon_url: Optional[Any] = MISSING,
icon_file: File = MISSING,
) -> Self:
"""Sets the author for the embed content.
This function returns the class instance to allow for fluent-style
chaining.
At most one of ``icon_url`` or ``icon_file`` may be passed.
.. warning::
Passing a :class:`disnake.File` object will make the embed not
reusable.
.. warning::
If used with the other ``set_*`` methods, you must ensure
that the :attr:`.File.filename` is unique to avoid duplication.
Parameters
----------
name: :class:`str`
Expand All @@ -579,6 +633,10 @@ def set_author(
The URL for the author.
icon_url: Optional[:class:`str`]
The URL of the author icon. Only HTTP(S) is supported.
icon_file: :class:`File`
The file to use as the author icon.
.. versionadded:: 2.10
"""
self._author = {
"name": str(name),
Expand All @@ -587,8 +645,9 @@ def set_author(
if url is not None:
self._author["url"] = str(url)

if icon_url is not None:
self._author["icon_url"] = str(icon_url)
result = self._handle_resource(icon_url, icon_file, key="author", required=False)
if result is not None:
self._author["icon_url"] = result

return self

Expand Down Expand Up @@ -821,9 +880,15 @@ def get_default_colour(cls) -> Optional[Colour]:

get_default_color = get_default_colour

def _handle_resource(self, url: Optional[Any], file: File, *, key: _FileKey) -> Optional[str]:
if not (url is MISSING) ^ (file is MISSING):
raise TypeError("Exactly one of url or file must be provided")
def _handle_resource(
self, url: Optional[Any], file: Optional[File], *, key: _FileKey, required: bool = True
) -> Optional[str]:
if required:
if not (url is MISSING) ^ (file is MISSING):
raise TypeError("Exactly one of url or file must be provided")
else:
if url is not MISSING and file is not MISSING:
raise TypeError("At most one of url or file may be provided, not both.")

if file:
if file.filename is None:
Expand All @@ -832,7 +897,7 @@ def _handle_resource(self, url: Optional[Any], file: File, *, key: _FileKey) ->
return f"attachment://{file.filename}"
else:
self._files.pop(key, None)
return str(url) if url is not None else None
return str(url) if url else None

def check_limits(self) -> None:
"""Checks if this embed fits within the limits dictated by Discord.
Expand Down

0 comments on commit aedc1d1

Please sign in to comment.