Add soundboard support. #2575

mplatypus · 2025-10-17T10:29:10Z

Summary

Added the soundboard sound object and all events/endpoints.

Checklist

I have run nox and all the pipelines have passed.
I have made unittests according to the code I have added/modified/deleted.

Added the soundboard sound object, multiple endpoints and events.

Copilot

Pull Request Overview

Adds full soundboard support across the library: model, REST endpoints, gateway events, and shard/bot helpers.

Introduces SoundboardSound entity and (de)serialization.
Adds REST endpoints for default/guild sounds, sending, creating, editing, and deleting sounds.
Wires new gateway events (soundboard sound create/update/delete/sounds update, and voice channel effect send) and a shard/bot request for soundboard sounds.

Reviewed Changes

Copilot reviewed 27 out of 27 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
hikari/soundboard.py	Adds SoundboardSound model.
hikari/impl/entity_factory.py	Deserializes soundboard sound payloads into entities.
hikari/impl/rest.py	Implements REST methods for soundboard endpoints.
hikari/internal/routes.py	Declares REST routes for soundboard.
hikari/impl/event_factory.py	Deserializes new gateway events (soundboard + channel effect send).
hikari/impl/event_manager.py	Dispatches new soundboard and channel effect events.
hikari/events/soundboard_events.py	Defines soundboard event classes.
hikari/events/channel_events.py	Adds GuildChannelEffectSendEvent type.
hikari/impl/shard.py	Implements OP 31 request for soundboard sounds.
hikari/impl/gateway_bot.py	Adds bot helper to request soundboard sounds.
hikari/api/*	Extends REST, shard, and event factory interfaces for soundboard.
hikari/emojis.py	Adds EmojiAnimationType enum.
hikari/intents.py	Updates intents docstring with soundboard events.
tests/*	Unit tests for soundboard model, REST, shard, bot, events, and factories.
hikari/init.*	Exposes soundboard symbols at package root.
changes/2575.feature.md	Change log entry for soundboard support.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-10-17T10:41:49Z

hikari/events/channel_events.py

+    @typing_extensions.override
+    def app(self) -> traits.RESTAware:
+        # <<inherited docstring from Event>>.
+        return self.app


The app property is recursively referencing itself, causing infinite recursion at runtime and there is no app field on this event. Return the application from the shard (minimal change), e.g. return self.shard.app. Alternatively, add an app: traits.RESTAware attrs field (as done in other events) and have the event factory pass app=self._app.

Suggested change

return self.app

return self.shard.app

Copilot · 2025-10-17T10:41:49Z

hikari/impl/event_factory.py

+            animation_id=snowflakes.Snowflake(payload["animation_id"])
+            if "animation_id" in payload
+            else undefined.UNDEFINED,
+            sound_id=snowflakes.Snowflake(payload["sound_id"]) if "sound_id" in payload else undefined.UNDEFINED,


If animation_id or sound_id are present but null, snowflakes.Snowflake(None) will raise; mirror the earlier pattern and guard against None, e.g. use value = payload.get("animation_id"); animation_id = snowflakes.Snowflake(value) if value is not None else None (or undefined.UNDEFINED if missing).

Suggested change

animation_id=snowflakes.Snowflake(payload["animation_id"])

if "animation_id" in payload

else undefined.UNDEFINED,

sound_id=snowflakes.Snowflake(payload["sound_id"]) if "sound_id" in payload else undefined.UNDEFINED,

animation_id=(

snowflakes.Snowflake(payload["animation_id"])

if "animation_id" in payload and payload["animation_id"] is not None

else (None if "animation_id" in payload else undefined.UNDEFINED)

),

sound_id=(

snowflakes.Snowflake(payload["sound_id"])

if "sound_id" in payload and payload["sound_id"] is not None

else (None if "sound_id" in payload else undefined.UNDEFINED)

),

Copilot · 2025-10-17T10:41:49Z

hikari/impl/rest.py

+        result = await self._request(routes.GET_GUILD_SOUNDBOARD_SOUND.compile(guild=guild, sound=sound))
+        assert isinstance(result, dict)
+        return self._entity_factory.deserialize_soundboard_sound(result)
+


The implementation never returns None, but the signature advertises Optional and API docs describe returning None when not found. Either update the return type (and API docs) to soundboard.SoundboardSound, or handle NotFoundError (and possibly 204) to return None as documented.

Suggested change

result = await self._request(routes.GET_GUILD_SOUNDBOARD_SOUND.compile(guild=guild, sound=sound))

assert isinstance(result, dict)

return self._entity_factory.deserialize_soundboard_sound(result)

try:

result = await self._request(routes.GET_GUILD_SOUNDBOARD_SOUND.compile(guild=guild, sound=sound))

except errors.NotFoundError:

return None

assert isinstance(result, dict)

return self._entity_factory.deserialize_soundboard_sound(result)

Copilot · 2025-10-17T10:41:50Z

hikari/api/rest.py

+    @abc.abstractmethod
+    async def fetch_guild_soundboard_sound(
+        self,
+        guild: snowflakes.SnowflakeishOr[guilds.PartialGuild],
+        sound: snowflakes.SnowflakeishOr[soundboard.SoundboardSound],
+        /,
+    ) -> soundboard.SoundboardSound | None:


This API contract states Optional[SoundboardSound] and the docstring promises None when not found, but the concrete implementation does not return None; align the contract and behavior (either drop None here and in docs, or specify/implement the NotFound-to-None behavior).

Copilot · 2025-10-17T10:41:50Z

hikari/soundboard.py

+# 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.
+"""Application and entities that are used to describe stage instances on Discord."""


Module docstring references "stage instances"; update to "soundboard sounds" to reflect this module's purpose.

Suggested change

"""Application and entities that are used to describe stage instances on Discord."""

"""Application and entities that are used to describe soundboard sounds on Discord."""

Copilot · 2025-10-17T10:41:51Z

hikari/events/soundboard_events.py

+@attrs_extensions.with_copy
+@attrs.define(kw_only=True, weakref_slot=False)
+class SoundboardSoundsUpdateEvent(SoundboardSoundEvent):
+    """Event fired when a guild soundboard sound is created."""


The class docstring is inaccurate for an update event; change to "Event fired when a guild's soundboard sounds are updated."

Suggested change

"""Event fired when a guild soundboard sound is created."""

"""Event fired when a guild's soundboard sounds are updated."""

Copilot · 2025-10-17T10:41:51Z

hikari/events/soundboard_events.py

+    guild_id: snowflakes.Snowflake = attrs.field(hash=True, repr=False)
+    """The guild ID of the stage instance."""


Replace "stage instance" with "soundboard sound" or "event" context; e.g., "The guild ID this sound belongs to."

Copilot · 2025-10-17T10:41:51Z

hikari/events/soundboard_events.py

+    guild_id: snowflakes.Snowflake = attrs.field(hash=True, repr=False)
+    """The guild ID of the stage instance."""


Update the docstring to reference the soundboard sound instead of a stage instance.

Copilot · 2025-10-17T10:41:52Z

hikari/events/soundboard_events.py

+    """The guilds soundboard sounds."""
+
+    guild_id: snowflakes.Snowflake = attrs.field(hash=True, repr=True)
+    """The guild ID of the stage instance."""


Update to "The guild ID these sounds belong to." to match the event context.

Suggested change

"""The guild ID of the stage instance."""

"""The guild ID these sounds belong to."""

Copilot · 2025-10-17T10:41:52Z

hikari/events/channel_events.py

+@attrs_extensions.with_copy
+@attrs.define(kw_only=True, weakref_slot=False)
+class GuildChannelEffectSendEvent(GuildChannelEvent):
+    """Event fired when a guild channel is created."""


The class docstring is misleading; this event represents a "voice channel effect send" (emoji/sound in a voice channel). Update the description accordingly.

Suggested change

"""Event fired when a guild channel is created."""

"""Event fired when a voice channel effect (emoji or sound) is sent in the connected voice channel."""

davfsa · 2025-10-17T10:40:59Z

hikari/impl/entity_factory.py

+        emoji_id = payload.get("emoji_id")
+        if emoji_id:
+            emoji_id = snowflakes.Snowflake(emoji_id)
+        emoji_name = payload.get("emoji_name")


Suggested change

emoji_id = payload.get("emoji_id")

if emoji_id:

emoji_id = snowflakes.Snowflake(emoji_id)

emoji_name = payload.get("emoji_name")

emoji_id = payload["emoji_id"]

if emoji_id:

emoji_id = snowflakes.Snowflake(emoji_id)

emoji_name = payload["emoji_name"]

davfsa · 2025-10-17T10:50:07Z

hikari/impl/entity_factory.py

+        emoji: emoji_models.CustomEmoji | emoji_models.UnicodeEmoji | None = None
+        emoji_id = payload.get("emoji_id")
+        if emoji_id:
+            emoji_id = snowflakes.Snowflake(emoji_id)
+        emoji_name = payload.get("emoji_name")
+        if emoji_id and emoji_name:
+            emoji = emoji_models.CustomEmoji(
+                id=emoji_id,
+                name=emoji_name,
+                is_animated=False,  # FIXME: I am unsure if this is correct, but I have no clue on how I could validate this. # noqa: TD001, E501
+            )
+        if emoji_id and not emoji_name:
+            emoji = emoji_models.CustomEmoji(
+                id=emoji_id,
+                name="",  # FIXME: I am unsure if this is correct, but I have no clue on how I could validate this. # noqa: TD001, E501
+                is_animated=False,  # FIXME: I am unsure if this is correct, but I have no clue on how I could validate this. # noqa: TD001, E501
+            )
+        if not emoji_id and emoji_name:
+            emoji = emoji_models.UnicodeEmoji(emoji_name)


Given we are not given animated, then lets always set it as False (Resolves the FIXMEs on it)

There will never be the case of emoji_id and not emoji_name, so that branch can be removed

mplatypus added 3 commits October 17, 2025 21:27

Add soundboard objects, events and endpoints.

c70651e

Added the soundboard sound object, multiple endpoints and events.

Merge branch 'master' into feature/soundboard-sounds

37a1e8a

add fragment

685faa7

davfsa added the enhancement New feature or request label Oct 17, 2025

davfsa requested review from Copilot and davfsa October 17, 2025 10:36

Copilot AI reviewed Oct 17, 2025

View reviewed changes

davfsa reviewed Oct 17, 2025

View reviewed changes

	"""Application and entities that are used to describe stage instances on Discord."""
	"""Application and entities that are used to describe soundboard sounds on Discord."""

	"""Event fired when a guild soundboard sound is created."""
	"""Event fired when a guild's soundboard sounds are updated."""

		guild_id: snowflakes.Snowflake = attrs.field(hash=True, repr=False)
		"""The guild ID of the stage instance."""

	"""The guild ID of the stage instance."""
	"""The guild ID these sounds belong to."""

	"""Event fired when a guild channel is created."""
	"""Event fired when a voice channel effect (emoji or sound) is sent in the connected voice channel."""

Uh oh!

Add soundboard support. #2575

Are you sure you want to change the base?

Add soundboard support. #2575

Uh oh!

Conversation

mplatypus commented Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 17, 2025 • edited by davfsa Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

davfsa Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

davfsa Oct 17, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mplatypus commented Oct 17, 2025 •

edited

Loading

Copilot AI Oct 17, 2025 •

edited by davfsa

Loading