feat(flags): add new flags to Embed and update Attachment flags by Snipy7374 · Pull Request #1283 · DisnakeDev/disnake

Snipy7374 · 2025-01-31T10:54:11Z

Summary

Closes Support Embed and new Attachment flags #1282

Checklist

If code changes were made, then they have been tested
- I have updated the documentation to reflect the changes
- I have formatted the code properly by running pdm lint
- I have type-checked the code by running pdm pyright
This PR fixes an issue
This PR adds something new (e.g. new method or parameters)
This PR is a breaking change (e.g. methods or parameters removed/renamed)
This PR is not a code change (e.g. documentation, README, ...)

Snipy7374 · 2025-01-31T10:58:25Z

+        if self._thumbnail and (thumbnail_flags := self._thumbnail.get("flags")):
+            self._thumbnail["flags"] = EmbedMediaFlags._from_value(thumbnail_flags)  # type: ignore
+
        self._video = data.get("video")
        self._provider = data.get("provider")
        self._author = data.get("author")
+
        self._image = data.get("image")
+        if self._image and (image_flags := self._image.get("flags")):
+            self._image["flags"] = EmbedMediaFlags._from_value(image_flags)  # type: ignore
+


I don't like how this is done but I don't see much alternatives

Rather than save it here, we could make the flags when we access the image or thumbnail, no?

This also no longer seems to be respected in serialisation.

This also no longer seems to be respected in serialisation.

What do you mean? It's not consistent with the lib?

Rather than save it here, we could make the flags when we access the image or thumbnail, no?

that was my idea as well. It's still a bit awkward, but a separate EmbedProxy subclass that special-cases flags should do, and doesn't result in weird consistency issues with from_dict and to_dict.

Co-authored-by: Eneg <42005170+Enegg@users.noreply.github.com> Signed-off-by: arielle <me@arielle.codes>

read-the-docs-community · 2025-09-29T02:22:28Z

Documentation build overview

📚 disnake | 🛠️ Build #33292325 | 📁 Comparing 19421ce against latest (57e1005)

🔍 Preview build

49 files changed · ± 49 modified

± Modified

onerandomusername · 2025-11-01T18:48:39Z

@Snipy7374 would you please resolve conflicts and rebase?

shiftinv · 2026-06-24T15:18:51Z

@@ -0,0 +1 @@
+Add :attr:`Embed.flags`, ``Embed.image.flags``, ``Embed.thumbnail.flags``, :class:`EmbedFlags`, :class:`EmbedMediaFlags` and update the :class:`AttachmentFlags`.


Seems like this is missing the unfurled media item flags, which were added later in the API docs PR.

shiftinv · 2026-06-24T15:22:38Z

    inline: NotRequired[bool]


 class EmbedThumbnail(TypedDict):


The API docs got rid of the image/thumbnail structure split, it would make sense to just add a EmbedThumbnail = EmbedImage alias here instead of updating the structures individually

shiftinv · 2026-06-24T15:26:54Z

+        .. versionchanged:: |vnext|
+
+            Added the ``flags`` attribute.

        If an attribute is not set, it will be :data:`None`.


Suggested change

.. versionchanged:: |vnext|

Added the ``flags`` attribute.

If an attribute is not set, it will be :data:`None`.

If an attribute is not set, it will be :data:`None`.

.. versionchanged:: |vnext|

Added the ``flags`` attribute.

shiftinv · 2026-06-24T15:27:11Z

+        .. versionchanged:: |vnext|
+
+            Added the ``flags`` attribute.

        If an attribute is not set, it will be :data:`None`.


Suggested change

.. versionchanged:: |vnext|

Added the ``flags`` attribute.

If an attribute is not set, it will be :data:`None`.

If an attribute is not set, it will be :data:`None`.

.. versionchanged:: |vnext|

Added the ``flags`` attribute.

shiftinv · 2026-06-24T15:30:24Z

+
+    @flag_value
+    def is_clip(self):
+        """:class:`bool`: Returns ``True`` if the attachment is a clip.


Suggested change

""":class:`bool`: Returns ``True`` if the attachment is a clip.

""":class:`bool`: Returns ``True`` if the attachment is a clip from a stream.

shiftinv · 2026-06-24T15:33:17Z

+        return 1 << 3
+
+    @flag_value
+    def contains_explicit_media(self):


This flag seems to have been removed from the docs again

shiftinv · 2026-06-24T15:34:36Z

+        ) -> None: ...
+
+    @flag_value
+    def contains_explicit_media(self):


Same here, was removed from the docs

shiftinv · 2026-06-24T15:38:16Z

+
+    @flag_value
+    def is_animated(self):
+        """:class:`bool`: Returns ``True`` if the embed media is animated."""


Suggested change

""":class:`bool`: Returns ``True`` if the embed media is animated."""

""":class:`bool`: Returns ``True`` if the embed image is animated."""

"media" is plural, at least in this context (apparently it can be singular when referring to mass media?). "embed medium" also sounds a bit weird, so "embed image" seems like a good compromise to me

shiftinv · 2026-06-24T15:40:53Z

+    clip_participants: List[:class:`User`]
+        If this attachment is a clip returns a list of users who were in the stream.
+
+        .. versionadded:: |vnext|
+
+    clip_created_at: Optional[:class:`datetime.datetime`]
+        If this attachment is a clip returns the creation timestamp.
+
+        .. versionadded:: |vnext|


Suggested change

clip_participants: List[:class:`User`]

If this attachment is a clip returns a list of users who were in the stream.

.. versionadded:: |vnext|

clip_created_at: Optional[:class:`datetime.datetime`]

If this attachment is a clip returns the creation timestamp.

.. versionadded:: |vnext|

clip_participants: :class:`list`\[:class:`User`]

The list of users who were in the stream, if this attachment is a clip.

.. versionadded:: |vnext|

clip_created_at: :class:`datetime.datetime` | :data:`None`

The creation timestamp, if this attachment is a clip.

.. versionadded:: |vnext|

shiftinv · 2026-06-24T15:43:42Z

+        self.clip_participants: list[User] = [
+            User(state=state, data=d) for d in data.get("clip_participants", [])
+        ]
+        self.clip_created_at: datetime.datetime | None = utils.parse_time(
+            data.get("clip_created_at")
+        )


There are a few more non-flags-related additions in the API docs PR - I'd say this PR should either only add the new flags, or everything

Snipy7374 added 2 commits January 31, 2025 11:48

feat: implement new flags

e423ff4

add changelog entry

cad882c

This comment was marked as off-topic.

Sign in to view

Snipy7374 commented Jan 31, 2025

View reviewed changes

Comment thread disnake/flags.py

Comment thread disnake/flags.py

Snipy7374 commented Jan 31, 2025

View reviewed changes

Snipy7374 added t: enhancement New feature t: api support Support of Discord API features s: waiting for api/docs Issue/PR is waiting for API support/documentation labels Jan 31, 2025

Enegg reviewed Jan 31, 2025

View reviewed changes

Comment thread disnake/embeds.py Outdated

Comment thread disnake/embeds.py Outdated

Snipy7374 added 2 commits January 31, 2025 16:18

run codemod

5ec2135

make 0 the default value for the _flags member

b56f99c

Snipy7374 requested review from Enegg and shiftinv and removed request for Enegg August 22, 2025 09:25

Enegg reviewed Aug 22, 2025

View reviewed changes

Comment thread disnake/embeds.py

onerandomusername added this to the disnake v2.11 milestone Sep 7, 2025

Apply suggestion from @Enegg

46fc41b

Co-authored-by: Eneg <42005170+Enegg@users.noreply.github.com> Signed-off-by: arielle <me@arielle.codes>

onerandomusername removed the s: waiting for api/docs Issue/PR is waiting for API support/documentation label Sep 9, 2025

shiftinv removed this from the disnake v2.11 milestone Sep 10, 2025

Merge branch 'master' into feat/flags

9ae0716

onerandomusername added 2 commits September 29, 2025 01:02

fix: update all versionaddeds to use vnext

9f61729

remove clip_application

b00e4d4

onerandomusername approved these changes Sep 29, 2025

View reviewed changes

Snipy7374 and others added 2 commits November 2, 2025 10:53

Merge remote-tracking branch 'snipy/master' into feat/flags

56c1ff9

Merge remote-tracking branch 'upstream/master' into pr/1283

19421ce

shiftinv requested changes Jun 24, 2026

View reviewed changes

		@@ -0,0 +1 @@
		Add :attr:`Embed.flags`, ``Embed.image.flags``, ``Embed.thumbnail.flags``, :class:`EmbedFlags`, :class:`EmbedMediaFlags` and update the :class:`AttachmentFlags`.

	""":class:`bool`: Returns ``True`` if the attachment is a clip.
	""":class:`bool`: Returns ``True`` if the attachment is a clip from a stream.

Uh oh!

Conversation

Snipy7374 commented Jan 31, 2025

Summary

Checklist

Uh oh!

This comment was marked as off-topic.

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

read-the-docs-community Bot commented Sep 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation build overview

Uh oh!

onerandomusername commented Nov 1, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

read-the-docs-community Bot commented Sep 29, 2025 •

edited

Loading