5.11.0

5.11.0

Author: LordOfPolls

.pre-commit-config.yaml

@@ -1,6 +1,6 @@
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
+    rev: v4.5.0
     hooks:
     - id: requirements-txt-fixer
       name: Requirements
@@ -30,12 +30,12 @@ repos:
     - id: check-merge-conflict
       name: Merge Conflicts
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: 'v0.0.282'
+    rev: 'v0.1.5'
     hooks:
       - id: ruff
         args: [--fix, --exit-non-zero-on-fix]
   - repo: https://github.com/psf/black
-    rev: 23.7.0
+    rev: 23.11.0
     hooks:
       - id: black
         name: Black Formatting

docs/src/API Reference/API Reference/ext/hybrid_commands/index.md

@@ -1,3 +1,8 @@
+---
+search:
+  exclude: true
+---
+
 # Hybrid Commands Index
 
 - [Context](context)

docs/src/API Reference/API Reference/ext/index.md

@@ -1,3 +1,8 @@
+---
+search:
+  exclude: true
+---
+
 # Ext Index
 
 These files contain useful features that help you develop a bot

docs/src/API Reference/API Reference/ext/prefixed_commands/index.md

@@ -1,3 +1,8 @@
+---
+search:
+  exclude: true
+---
+
 # Prefixed Commands Index
 
 - [Command](command)

docs/src/API Reference/API Reference/models/Discord/index.md

@@ -1,3 +1,8 @@
+---
+search:
+  exclude: true
+---
+
 # Discord Models Index
 
 - [Activity](activity)

docs/src/API Reference/API Reference/models/Internal/index.md

@@ -1,3 +1,8 @@
+---
+search:
+  exclude: true
+---
+
 # Internal Models Index
 
 - [Active Voice State](active_voice_state)

docs/src/API Reference/API Reference/models/Misc/index.md

@@ -1,3 +1,8 @@
+---
+search:
+  exclude: true
+---
+
 # Misc Models Index
 
 - [Iterator](iterator)

docs/src/API Reference/API Reference/models/index.md

@@ -1,3 +1,8 @@
+---
+search:
+  exclude: true
+---
+
 # Models
 
 Within these pages, you will find a list of all available models within interactions.py.

docs/src/Guides/01 Getting Started.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Introduction
 
 Ready to get your Python on and create a Discord bot? This guide's got you covered with installation options and a basic bot code example.

docs/src/Guides/02 Creating Your Bot.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Creating Your Bot
 
 To make a bot on Discord, you must first create an application on Discord. Thankfully, Discord has made this process very simple:

docs/src/Guides/03 Creating Commands.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Slash Commands
 
 So you want to make a slash command (or interaction, as they are officially called), but don't know how to get started?
@@ -263,7 +268,7 @@ In there, you have three seconds to return whatever choices you want to the user
 from interactions import AutocompleteContext
 
 @my_command_function.autocomplete("string_option")
-async def autocomplete(self, ctx: AutocompleteContext):
+async def autocomplete(ctx: AutocompleteContext):
     string_option_input = ctx.input_text  # can be empty
     # you can use ctx.kwargs.get("name") to get the current state of other options - note they can be empty too
 
@@ -507,7 +512,7 @@ import traceback
 from interactions.api.events import CommandError
 
 @listen(CommandError, disable_default_listeners=True)  # tell the dispatcher that this replaces the default listener
-async def on_command_error(self, event: CommandError):
+async def on_command_error(event: CommandError):
     traceback.print_exception(event.error)
     if not event.ctx.responded:
         await event.ctx.send("Something went wrong.")
@@ -521,13 +526,16 @@ If your bot is complex enough, you might find yourself wanting to use custom mod
 
 To do this, you'll want to use a string option, and define a converter. Information on how to use converters can be found [on the converter page](../08 Converters).
 
-## Prefixed/Text Commands
+## Hybrid Commands
+
+!!! note
+    Prefixed commands, called by Discord as "text commands" and sometimes called "message commands" (not to be confused with Context Menu Message Commands), are commands that are triggered when a user sends a normal message with a designated "prefix" in front of them (ie `!my_command`).
 
-To use prefixed commands, instead of typing `/my_command`, you will need to type instead `!my_command`, provided that the prefix you set is `!`.
+    interactions.py contains an extension for making these commands, which you can [read about here](/interactions.py/Guides/26 Prefixed Commands).
 
 Hybrid commands are are slash commands that also get converted to an equivalent prefixed command under the hood. They are their own extension, and require [prefixed commands to be set up beforehand](/interactions.py/Guides/26 Prefixed Commands). After that, use the `setup` function in the `hybrid_commands` extension in your main bot file.
 
-Your setup can (but doesn't necessarily have to) look like this:
+Your setup should look similar to this:
 
 ```python
 import interactions
@@ -549,7 +557,7 @@ async def my_command_function(ctx: HybridContext):
     await ctx.send("Hello World")
 ```
 
-Suggesting you are using the default mention settings for your bot, you should be able to run this command by `@BotPing my_command`.
+Suggesting you are using the default mention settings for your bot, you should be able to run this command by typing out `@BotPing my_command` or using the slash command `/my_command`. Both will work largely equivalently.
 
 As you can see, the only difference between hybrid commands and slash commands, from a developer perspective, is that they use `HybridContext`, which attempts
 to seamlessly allow using the same context for slash and prefixed commands. You can always get the underlying context via `inner_context`, though.

docs/src/Guides/04 Context Menus.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Context Menus
 
 Context menus are interactions under the hood. Defining them is very similar.

docs/src/Guides/05 Components.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Components
 
 Components (Buttons, Select Menus and soon Text Input Fields) can be added to any message by passing them to the `components` argument in any `.send()` method.

docs/src/Guides/06 Modals.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Modals
 
 Modals are basically popups which a user can use to send text information to your bot. As of the writing of this guide, you can use two components in a modal:

docs/src/Guides/08 Converters.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Converters
 
 If your bot is complex enough, you might find yourself wanting to use custom models in your commands. Converters are classes that allow you to do just that, and can be used in both slash and prefixed commands.

docs/src/Guides/10 Events.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Events
 
 Events (in interactions.py) are pieces of information that are sent whenever something happens in Discord or in the library itself - this includes channel updates, message sending, the bot starting up, and more.

docs/src/Guides/20 Extensions.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Extensions
 
 ## Introduction

docs/src/Guides/22 Live Patching.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Live Patching
 
 interactions.py has a few built-in extensions that add some features, primarily for debugging. One of these extensions that you can enable separately is to add [`jurigged`](https://github.com/breuleux/jurigged) for live patching of code.

docs/src/Guides/23 Voice.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Voice Support
 
 So you want to start playing some 🎵tunes🎶 in voice channels? Well let's get that going for you.

docs/src/Guides/24 Localisation.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Localising
 
 So your bot has grown, and now you need to ~~localize~~ localise your bot. Well thank god we support localisation then, huh?

docs/src/Guides/25 Error Tracking.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Error Tracking
 
 So, you've finally got your bot running on a server somewhere.  Chances are, you're not checking the console output 24/7, looking for exceptions.

docs/src/Guides/26 Prefixed Commands.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Creating Prefixed Commands
 
 Prefixed commands, called by Discord as "text commands" and sometimes called "message commands" (not to be confused with Context Menu Message Commands), are commands that are triggered when a user sends a normal message with a designated "prefix" in front of them.

docs/src/Guides/30 Pagination.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Pagination
 
 > Pagination, also known as paging, is the process of dividing a document into discrete pages, either electronic pages or printed pages.

docs/src/Guides/40 Tasks.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Tasks
 
 Tasks are background processes that can be used to asynchronously run code with a specified trigger.

docs/src/Guides/80 Sharding.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Sharding
 
 Oh damn, your bot is getting pretty big, huh? Well I guess its time we discuss sharding.

docs/src/Guides/90 Example.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Examples
 
 ## `main.py`

docs/src/Guides/97 Migration From D.py.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Migrating from discord.py
 
 1. interactions.py requires python 3.10 (as compared to dpy's 3.5), you may need to upgrade python.

docs/src/Guides/98 Migration from 4.X.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Migrating from 4.X
 
 Version 5.X (and beyond) is a major rewrite of interactions.py compared to 4.X, though there have been major improvements to compensate for the change. 5.X was designed to be more stable and flexible, solving many of the bugs and UX issues 4.X had while also adding additional features you may like.

docs/src/Guides/99 2.x Migration_NAFF.md

@@ -1,3 +1,8 @@
+---
+search:
+  boost: 3
+---
+
 # Migrating from NAFF
 
 Oh hey! So you're migrating from NAFF to interactions.py? Well lets get you sorted.

docs/src/Guides/index.md

@@ -1,3 +1,8 @@
+---
+search:
+  exclude: true
+---
+
 Let's be honest; reading API documentation is a bit of a pain.
 These guides are meant to help you get started with the library and offer a point of reference.
 

docs/src/index.md

@@ -3,6 +3,8 @@ hide:
   - navigation
   - toc
   - feedback
+search:
+  exclude: true
 ---
 
 We hope this documentation is helpful for you, but don't just ++ctrl+c++ and ++ctrl+v++.

interactions/api/events/processors/scheduled_events.py

@@ -37,14 +37,16 @@ async def _on_raw_guild_scheduled_event_delete(self, event: "RawGatewayEvent") -
 
     @Processor.define()
     async def _on_raw_guild_scheduled_event_user_add(self, event: "RawGatewayEvent") -> None:
-        scheduled_event = self.cache.get_scheduled_event(event.data.get("guild_scheduled_event_id"))
-        user = self.cache.get_user(event.data.get("user_id"))
-
-        self.dispatch(events.GuildScheduledEventUserAdd(event.data.get("guild_id"), scheduled_event, user))
+        self.dispatch(
+            events.GuildScheduledEventUserAdd(
+                event.data["guild_id"], event.data["guild_scheduled_event_id"], event.data["user_id"]
+            )
+        )
 
     @Processor.define()
     async def _on_raw_guild_scheduled_event_user_remove(self, event: "RawGatewayEvent") -> None:
-        scheduled_event = self.cache.get_scheduled_event(event.data.get("guild_scheduled_event_id"))
-        user = self.cache.get_user(event.data.get("user_id"))
-
-        self.dispatch(events.GuildScheduledEventUserRemove(event.data.get("guild_id"), scheduled_event, user))
+        self.dispatch(
+            events.GuildScheduledEventUserRemove(
+                event.data["guild_id"], event.data["guild_scheduled_event_id"], event.data["user_id"]
+            )
+        )

interactions/api/gateway/state.py

@@ -128,7 +128,7 @@ async def _ws_connect(self) -> None:
 
         except Exception as e:
             self.client.dispatch(events.Disconnect())
-            self.wrapped_logger("".join(traceback.format_exception(type(e), e, e.__traceback__)))
+            self.wrapped_logger(logging.ERROR, "".join(traceback.format_exception(type(e), e, e.__traceback__)))
 
     def wrapped_logger(self, level: int, message: str, **kwargs) -> None:
         """

interactions/api/http/http_requests/scheduled_events.py

@@ -58,11 +58,11 @@ async def get_scheduled_event(
         return await self.request(
             Route(
                 "GET",
-                "/guilds/{guild_id}/scheduled-events/{scheduled_event_id}",
+                "/guilds/{guild_id}/scheduled-events/{scheduled_event_id}?with_user_count={with_user_count}",
                 guild_id=guild_id,
                 scheduled_event_id=scheduled_event_id,
+                with_user_count=with_user_count,
             ),
-            params={"with_user_count": with_user_count},
         )
 
     async def create_scheduled_event(