Merge: 5.6.0

5.6.0

Author: LordOfPolls

.pre-commit-config.yaml

@@ -30,7 +30,7 @@ repos:
     - id: check-merge-conflict
       name: Merge Conflicts
   - repo: https://github.com/charliermarsh/ruff-pre-commit
-    rev: 'v0.0.261'
+    rev: 'v0.0.270'
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]

docs/src/Guides/25 Error Tracking.md

@@ -4,6 +4,13 @@ So, you've finally got your bot running on a server somewhere.  Chances are, you
 
 You're going to want to have some way of tracking if errors occur.
 
+# Sending inline tracebacks
+
+By default, if a command throws an uncaught exception, it'll send the traceback to the user.  This is very useful when in development, but doesn't help you once you've gone public, and might not be in the same servers as your errors.  Non-technical users may also find it confusing to see trackbacks instead of user-friendly error messages.
+
+If you wish to turn this off, create your client with `Client(..., send_command_tracebacks=False)`
+
+
 # The simple and dirty method
 
 !!! Please don't actually do this.

examples/bot.py

@@ -1,7 +1,7 @@
 # This code shows a very brief and small example of how to create a bot with our library.
 # This example does not cover all the features of the library, but it is enough to get you started.
 # In order to learn more about how to use the library, please head over to our documentation:
-# https://interactionspy.readthedocs.io/en/latest/
+# https://interactions-py.github.io/interactions.py/
 
 # The first thing you need to do is import the library.
 import interactions
@@ -10,7 +10,11 @@
 # When you make a bot, we refer to it as the "client."
 # The client is the main object that interacts with the Gateway, what talks to Discord.
 # The client is also the main object that interacts with the API, what makes requests with Discord.
-client = interactions.Client()
+# The client can also have "intents" that are what the bot recieves,
+# in this case the default ones and message content (a privilaged intent that needs
+# to be enabled in the developer portal)
+intents = interactions.Intents.DEFAULT | interactions.Intents.MESSAGE_CONTENT
+client = interactions.Client(intents=intents)
 
 
 # With our client established, let's have the library inform us when the client is ready.
@@ -25,18 +29,21 @@ async def on_ready():
     print(f"Our latency is {round(client.latency)} ms.")
 
 
+# We can either pass in the event name or make the function name be the event name.
 @interactions.listen("on_message_create")
-async def name_this_however_you_want(message: interactions.Message):
+async def name_this_however_you_want(message_create: interactions.events.MessageCreate):
     # Whenever we specify any other event type that isn't "READY," the function underneath
     # the decorator will most likely have an argument required. This argument is the data
     # that is being supplied back to us developers, which we call a data model.
 
     # In this example, we're listening to messages being created. This means we can expect
-    # a "message" argument to be passed to the function, which will be the data model of such.
+    # a "message_create" argument to be passed to the function, which will contain the
+    # data model for the message
 
     # We can use the data model to access the data we need.
     # Keep in mind that you can only access the message content if your bot has the MESSAGE_CONTENT intent.
     # You can find more information on this in the migration section of the quickstart guide.
+    message: interactions.Message = message_create.message
     print(f"We've received a message from {message.author.username}. The message is: {message.content}.")
 
 
@@ -66,5 +73,6 @@ async def hello_world(ctx: interactions.SlashContext):
 #   object on line 13.
 # - we are not setting a presence.
 # - we are not automatically sharding, and registering the connection under 1 shard.
-# - we are using default intents, which are Gateway intents excluding privileged ones.
+# - we are using default intents, which are Gateway intents excluding privileged ones
+# - and the privilaged message content intent.
 client.start("Your token here.")

interactions/__init__.py

@@ -113,6 +113,7 @@
     CustomEmojiConverter,
     DateTrigger,
     DefaultNotificationLevel,
+    DefaultReaction,
     DM,
     dm_only,
     DMChannel,
@@ -233,12 +234,14 @@
     process_color,
     process_colour,
     process_components,
+    process_default_reaction,
     process_embeds,
     process_emoji,
     process_emoji_req_format,
     process_message_payload,
     process_message_reference,
     process_permission_overwrites,
+    process_thread_tag,
     Reaction,
     ReactionUsers,
     Resolved,
@@ -425,6 +428,7 @@
     "CustomEmojiConverter",
     "DateTrigger",
     "DefaultNotificationLevel",
+    "DefaultReaction",
     "DISCORD_EPOCH",
     "DM",
     "dm_only",
@@ -564,12 +568,14 @@
     "process_color",
     "process_colour",
     "process_components",
+    "process_default_reaction",
     "process_embeds",
     "process_emoji",
     "process_emoji_req_format",
     "process_message_payload",
     "process_message_reference",
     "process_permission_overwrites",
+    "process_thread_tag",
     "Reaction",
     "ReactionUsers",
     "Resolved",

interactions/api/events/discord.py

@@ -29,6 +29,7 @@ def on_guild_join(event):
 from interactions.api.events.base import GuildEvent, BaseEvent
 from interactions.client.const import Absent
 from interactions.client.utils.attr_utils import docs
+from interactions.models.discord.snowflake import to_snowflake
 
 __all__ = (
     "ApplicationCommandPermissionsUpdate",
@@ -292,6 +293,9 @@ class GuildUpdate(BaseEvent):
 class GuildLeft(BaseEvent):
     """Dispatched when a guild is left."""
 
+    guild_id: "Snowflake_Type" = attrs.field(repr=True, converter=to_snowflake)
+    """The ID of the guild"""
+
     guild: "Guild" = attrs.field(repr=True)
     """The guild this event is dispatched from"""
 

interactions/api/events/processors/guild_events.py

@@ -69,7 +69,7 @@ async def _on_raw_guild_delete(self, event: "RawGatewayEvent") -> None:
             guild = self.cache.get_guild(guild_id)
             self.cache.delete_guild(guild_id)
 
-            self.dispatch(events.GuildLeft(guild))
+            self.dispatch(events.GuildLeft(guild_id, guild))
 
     @Processor.define()
     async def _on_raw_guild_ban_add(self, event: "RawGatewayEvent") -> None:

interactions/api/http/http_requests/members.py

@@ -80,7 +80,7 @@ async def modify_guild_member(
         roles: list["Snowflake_Type"] | None = None,
         mute: bool | None = None,
         deaf: bool | None = None,
-        channel_id: "Snowflake_Type | None" = None,
+        channel_id: "Snowflake_Type | MISSING" = MISSING,
         communication_disabled_until: str | datetime | Timestamp | None | Missing = MISSING,
         reason: str | None = None,
     ) -> discord_typings.GuildMemberData:
@@ -109,9 +109,10 @@ async def modify_guild_member(
             "roles": roles,
             "mute": mute,
             "deaf": deaf,
-            "channel_id": int(channel_id) if channel_id else None,
         }
         payload = dict_filter_none(payload)
+        if channel_id is not MISSING:
+            payload["channel_id"] = channel_id
 
         if not isinstance(nickname, Missing):
             payload["nick"] = nickname

interactions/api/voice/voice_gateway.py

@@ -280,6 +280,8 @@ def _udp_keep_alive(self) -> None:
             except socket.error as e:
                 self.logger.warning(f"Ending Keep Alive due to {e}")
                 return
+            except AttributeError:
+                return
             except Exception as e:
                 self.logger.debug("Keep Alive Error: ", exc_info=e)
         self.logger.debug("Ending UDP Keep Alive")

interactions/client/client.py

@@ -1801,7 +1801,7 @@ async def _dispatch_interaction(self, event: RawGatewayEvent) -> None:  # noqa:
                     elif autocomplete := self._global_autocompletes.get(str(auto_opt.name)):
                         callback = autocomplete
                     else:
-                        raise ValueError(f"Autocomplete callback for {str(auto_opt.name)} not found")
+                        raise ValueError(f"Autocomplete callback for {auto_opt.name!s} not found")
 
                     await self.__dispatch_interaction(
                         ctx=ctx,

interactions/ext/debug_extension/utils.py

@@ -112,7 +112,7 @@ def _make_data_line(
     if isinstance(aligns, str):
         aligns = [aligns for _ in column_widths]
 
-    line = (f"{str(value): {align}{width}}" for width, align, value in zip(column_widths, aligns, line, strict=False))
+    line = (f"{value!s: {align}{width}}" for width, align, value in zip(column_widths, aligns, line, strict=False))
     return f"{left_char}{f'{middle_char}'.join(line)}{right_char}"
 
 

interactions/ext/prefixed_commands/command.py

@@ -253,7 +253,7 @@ def _greedy_parse(greedy: Greedy, param: inspect.Parameter) -> Any:
         args = typing.get_args(arg)
 
         if len(args) > 2 or NoneType not in args:
-            raise ValueError(f"Greedy[{repr(arg)}] is invalid.")
+            raise ValueError(f"Greedy[{arg!r}] is invalid.")
 
         arg = args[0]
         default = None
@@ -317,7 +317,7 @@ async def _greedy_convert(
         if param.default:
             greedy_args = param.default  # im sorry, typehinters
         else:
-            raise BadArgument(f"Failed to find any arguments for {repr(param.type)}.")
+            raise BadArgument(f"Failed to find any arguments for {param.type!r}.")
 
     return greedy_args, broke_off
 

interactions/ext/sentry.py

@@ -91,12 +91,13 @@ def setup(
     bot: Client,
     token: str = None,
     filter: Optional[Callable[[dict[str, Any], dict[str, Any]], Optional[dict[str, Any]]]] = None,
+    **kwargs,
 ) -> None:
     if not token:
         bot.logger.error("Cannot enable sentry integration, no token provided")
         return
     if filter is None:
         filter = default_sentry_filter
-    sentry_sdk.init(token, before_send=filter)
+    sentry_sdk.init(token, before_send=filter, **kwargs)
     Task.on_error_sentry_hook = HookedTask.on_error_sentry_hook  # type: ignore
     SentryExtension(bot)

interactions/models/__init__.py

@@ -44,6 +44,7 @@
     ComponentType,
     CustomEmoji,
     DefaultNotificationLevel,
+    DefaultReaction,
     DM,
     DMChannel,
     DMGroup,
@@ -117,12 +118,14 @@
     process_color,
     process_colour,
     process_components,
+    process_default_reaction,
     process_embeds,
     process_emoji,
     process_emoji_req_format,
     process_message_payload,
     process_message_reference,
     process_permission_overwrites,
+    process_thread_tag,
     Reaction,
     ReactionUsers,
     Role,
@@ -373,6 +376,7 @@
     "CustomEmojiConverter",
     "DateTrigger",
     "DefaultNotificationLevel",
+    "DefaultReaction",
     "DM",
     "dm_only",
     "DMChannel",
@@ -493,12 +497,14 @@
     "process_color",
     "process_colour",
     "process_components",
+    "process_default_reaction",
     "process_embeds",
     "process_emoji",
     "process_emoji_req_format",
     "process_message_payload",
     "process_message_reference",
     "process_permission_overwrites",
+    "process_thread_tag",
     "Reaction",
     "ReactionUsers",
     "Resolved",

interactions/models/discord/__init__.py

@@ -160,7 +160,7 @@
 from .stage_instance import StageInstance
 from .sticker import Sticker, StickerItem, StickerPack
 from .team import Team, TeamMember
-from .thread import ThreadList, ThreadMember, ThreadTag
+from .thread import ThreadList, ThreadMember, ThreadTag, DefaultReaction, process_thread_tag, process_default_reaction
 from .timestamp import Timestamp, TimestampStyles
 from .user import BaseUser, Member, User, ClientUser
 from .voice_state import VoiceRegion, VoiceState
@@ -211,6 +211,7 @@
     "ComponentType",
     "CustomEmoji",
     "DefaultNotificationLevel",
+    "DefaultReaction",
     "DM",
     "DMChannel",
     "DMGroup",
@@ -284,12 +285,14 @@
     "process_color",
     "process_colour",
     "process_components",
+    "process_default_reaction",
     "process_embeds",
     "process_emoji",
     "process_emoji_req_format",
     "process_message_payload",
     "process_message_reference",
     "process_permission_overwrites",
+    "process_thread_tag",
     "Reaction",
     "ReactionUsers",
     "Role",

interactions/models/discord/channel.py

@@ -23,7 +23,7 @@
     to_optional_snowflake,
     SnowflakeObject,
 )
-from interactions.models.discord.thread import ThreadTag
+from interactions.models.discord.thread import DefaultReaction, ThreadTag
 from interactions.models.misc.context_manager import Typing
 from interactions.models.misc.iterator import AsyncIterator
 from .enums import (
@@ -348,8 +348,9 @@ async def fetch_messages(
         messages_data = await self._client.http.get_channel_messages(
             self.id, limit, around=around, before=before, after=after
         )
-        for m in messages_data:
-            m["guild_id"] = self._guild_id
+        if isinstance(self, GuildChannel):
+            for m in messages_data:
+                m["guild_id"] = self._guild_id
 
         return [self._client.cache.place_message_data(m) for m in messages_data]
 
@@ -2387,6 +2388,8 @@ async def close_stage(self, reason: Absent[Optional[str]] = MISSING) -> None:
 class GuildForum(GuildChannel):
     available_tags: List[ThreadTag] = attrs.field(repr=False, factory=list)
     """A list of tags available to assign to threads"""
+    default_reaction_emoji: Optional[DefaultReaction] = attrs.field(repr=False, default=None)
+    """The default emoji to react with for posts"""
     last_message_id: Optional[Snowflake_Type] = attrs.field(repr=False, default=None)
     # TODO: Implement "template" once the API supports them
 

interactions/models/discord/emoji.py

@@ -11,7 +11,7 @@
 from interactions.client.utils.attr_converters import optional
 from interactions.client.utils.serializer import dict_filter_none, no_export_meta
 from interactions.models.discord.base import ClientObject
-from interactions.models.discord.snowflake import SnowflakeObject, to_snowflake
+from interactions.models.discord.snowflake import SnowflakeObject, to_snowflake, to_snowflake_list
 
 if TYPE_CHECKING:
     from interactions.client import Client
@@ -185,7 +185,7 @@ async def edit(
         data_payload = dict_filter_none(
             {
                 "name": name,
-                "roles": roles,
+                "roles": to_snowflake_list(roles) if roles else None,
             }
         )