refactor!: rename prelude to context

README.md

@@ -62,18 +62,18 @@ async def on_ready() -> None:
 
 # give a high five to a user
 @bot.command()
-async def highfive(pre: pycord.Prelude) -> None:
+async def highfive(ctx: pycord.Context) -> None:
     # send a response to the command
-    await pre.send(':raised_hand: High Five!')
+    await ctx.send(':raised_hand: High Five!')
 
 # this is only for certain things, which we allow the builder api for
 view = pycord.View().url_button('Google it!', 'https://google.com')
 
 # a command which sends a button to go to Google.
 @bot.command()
-async def google(pre: pycord.Prelude) -> None:
+async def google(ctx: pycord.Context) -> None:
     iview = view()
-    await pre.send('Just go to Google!', view=iview)
+    await ctx.send('Just go to Google!', view=iview)
 
 # REMEMBER TO CHANGE THIS!
 bot.run('token')
@@ -103,6 +103,6 @@ bot.run('token')
 
         ```py
         @bot.command()
-        async def push(pre: pycord.Prelude, user: pycord.User) -> None:
-            await pre.send(f'{pre.user.mention} pushed {user.mention}!')
+        async def push(ctx: pycord.Context, user: pycord.User) -> None:
+            await pre.send(f'{ctx.user.mention} pushed {user.mention}!')
         ```

examples/interactions/commands/application_commands.py

@@ -18,7 +18,7 @@
 # this has the option anime, displayed as a Parameter,
 # which is parsed by Pycord to give you the information the user gave.
 async def favorite(
-    pre: pycord.Prelude,
+    ctx: pycord.Context,
     # The name of this option,
     # can be set to anything but
     # try to keep it short
@@ -52,17 +52,17 @@ async def favorite(
     # it responds with a custom response.
     match anime:
         case 'Attack on Titan':
-            await pre.send('It seems like you like Attack on Titan, Nice!')
+            await ctx.send('It seems like you like Attack on Titan, Nice!')
         case "JoJo's Bizzare Adventure":
-            await pre.send("おにいちゃんありがとう. You like JoJo's Bizzare Adventure. Nice!")
+            await ctx.send("おにいちゃんありがとう. You like JoJo's Bizzare Adventure. Nice!")
         case 'Cowboy Bebop':
-            await pre.send('良い！あなたはカウボーイビバップが好きです')
+            await ctx.send('良い！あなたはカウボーイビバップが好きです')
         case 'Hunter x Hunter':
-            await pre.send(
+            await ctx.send(
                 'I ran out of responses... Well anyway, you like Hunter x Hunter which is Nice!'
             )
         case 'Spy x Family':
-            await pre.send(
+            await ctx.send(
                 'I have a friend which really likes this anime, '
                 "it's good seeing you like it too. Of course, Spy x Family!"
             )

pycord/commands/application/__init__.py

@@ -8,4 +8,4 @@
 """
 from .command import *
 from .errors import *
-from .prelude import *
+from .context import *

pycord/commands/application/command.py

@@ -41,7 +41,7 @@
 from ..command import Command
 from ..group import Group
 from .errors import ApplicationCommandException
-from .prelude import Prelude
+from .context import Context
 
 if TYPE_CHECKING:
     from ...state import State
@@ -360,7 +360,7 @@ class ApplicationCommand(Command):
         Defaults to False.
     """
 
-    _processor_event = InteractionCreate(Prelude)
+    _processor_event = InteractionCreate(Context)
     sub_level: int = 0
 
     def __init__(
@@ -535,7 +535,7 @@ def _parse_arguments(self) -> None:
         for name, v in arg_defaults.items():
             if name == 'self':
                 continue
-            elif v[1] is Interaction or v[1] is Prelude:
+            elif v[1] is Interaction or v[1] is Context:
                 continue
             elif not isinstance(v[0], Option) and v[0] is not None:
                 raise ApplicationCommandException(

pycord/commands/application/prelude.py → pycord/commands/application/context.py

@@ -34,7 +34,7 @@
     from ...types import Interaction as InteractionData
 
 
-class Prelude(Interaction):
+class Context(Interaction):
     """
     Contextual prelude to Interactions.
     """

pycord/ext/gears/gear.py

@@ -62,12 +62,15 @@ class Gear(Generic[ContextT]):
 
     ctx: ContextT
 
-    def __init__(self, name: str, ctx: ContextT) -> None:
+    def __init__(self, name: str, ctx: ContextT | None = None) -> None:
         self.name = name
         self._listener_functions: dict[Type[Event], list[AsyncFunc]] = {}
         self.bot: Bot
         self._commands: list[Command | Group] = []
-        self.ctx = ctx
+        if ctx is None:
+            self.ctx = BaseContext()
+        else:
+            self.ctx = ctx
 
     async def on_attach(self, *args, **kwargs) -> None:
         ...