Skip to content

Remove positional arg support #214

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 18, 2021
Merged

Remove positional arg support #214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bb10b0f
remove positional arg support
LordOfPolls Jun 18, 2021
bd1a97f
add migration info
LordOfPolls Jun 18, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 1 addition & 4 deletions discord_slash/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1182,10 +1182,7 @@ async def invoke_command(self, func, ctx, args):
:param args: Args. Can be list or dict.
"""
try:
if isinstance(args, dict):
await func.invoke(ctx, **args)
else:
await func.invoke(ctx, *args)
await func.invoke(ctx, **args)
except Exception as ex:
if not await self._handle_invoke_error(func, ctx, ex):
await self.on_slash_command_error(ctx, ex)
Expand Down
34 changes: 33 additions & 1 deletion docs/migration.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,38 @@ Migration
+++++++++
This page contains instructions on how to migrate between versions with breaking changes.

Migrate To V2.0.0
=================
This update introduced component support, and removed support for positional arguments.

To resolve long standing issues with the library, we have removed positional argument support. From now on, only keyword arguments are supported. As such you may need to update your commands.

Put simply, you will need to make sure your command parameters are named the same as your options, or use the connector argument.


Example
*******

.. code-block:: python

# Example 1
@slash.slash(name="example_command", options=[
manage_commands.create_option(name="opt_one", [...]),
manage_commands.create_option(name="opt_two", [...])
])
async def example_command(ctx, opt_one, opt_two):
await ctx.send(f"{opt_one=}, {opt_two=}")

# Example 2
@slash.slash(name="example_command", options=[
manage_commands.create_option(name="opt_one", [...]),
manage_commands.create_option(name="opt_two", [...])
],
connector={"opt_one": "optone",
"opt_two": "opttwo"})
async def example_command(ctx, optone, opttwo):
await ctx.send(f"{optone=}, {opttwo=}")

Migrate To V1.1.0
==================
Changes that you'll need to make in this version are mainly because of a new ui from discord, more info `here <https://github.com/discord/discord-api-docs/pull/2615>`_
Expand All @@ -24,7 +56,7 @@ We suggest deferring if you might take more than three seconds to respond, but i
``ctx.channel.send`` does **not** count as responding.

Example
--------
*******

.. code-block:: python

Expand Down