Rewrite options #1251

Dorukyum · 2022-04-11T17:56:22Z

Summary

This modifies methods of slash commands related to option parsing and validation in order to optimize them and fix as many issues as possible.
Also allows a new design for creating options:

async def command(
    ctx,
    parameter: type = Option(**other_values),
)

Checklist

If code changes were made then they have been tested.
- I have updated the documentation to reflect the changes.
If type: ignore comments were used, a comment is also left explaining why
This PR fixes an issue.
This PR adds something new (e.g. new method or parameters).
This PR is a breaking change (e.g. methods or parameters removed/renamed)
This PR is not a code change (e.g. documentation, README, typehinting, examples, ...)

Lulalaby · 2022-04-12T13:20:53Z

Thank you clone ❤️

Dorukyum · 2022-04-18T17:16:17Z

~~Status: trying to solve a bug caused by the value of the cog atrribute of ext.bridge commands changing~~
Update: fixed

discord/commands/core.py

krittick · 2022-04-25T19:42:06Z

Getting an error when using either of the following two methods to define an option:

@slash_command(name="opt_test")
async def opt_test(ctx: discord.ApplicationContext, test_option: Option(str, "Test")):
    await ctx.respond("test")

@slash_command(name="opt_test")
async def opt_test(ctx: discord.ApplicationContext, test_option: str = Option(description="Test")):
    await ctx.respond("test")

Traceback (most recent call last):
  File "C:\Users\ben\PycharmProjects\BasicBot\bot.py", line 48, in <module>
    async def opt_test(ctx: discord.ApplicationContext, test_option: Option(str, "Test")):
  File "C:\Users\ben\PycharmProjects\BasicBot\venv\lib\site-packages\discord\commands\core.py", line 1560, in decorator
    return cls(func, **attrs)
  File "C:\Users\ben\PycharmProjects\BasicBot\venv\lib\site-packages\discord\commands\core.py", line 637, in __init__
    self.options: List[Option] = self._parse_options(params)
  File "C:\Users\ben\PycharmProjects\BasicBot\venv\lib\site-packages\discord\commands\core.py", line 690, in _parse_options
    option = Option(option, "No description provided")
  File "C:\Users\ben\PycharmProjects\BasicBot\venv\lib\site-packages\discord\commands\options.py", line 133, in __init__
    _type = SlashCommandOptionType.from_datatype(input_type)
  File "C:\Users\ben\PycharmProjects\BasicBot\venv\lib\site-packages\discord\enums.py", line 670, in from_datatype
    if datatype.__name__ in ["Member", "User"]:
AttributeError: 'str' object has no attribute '__name__'. Did you mean: '__ne__'?

codecov · 2022-04-30T23:32:29Z

Codecov Report

Merging #1251 (80fafa0) into master (217da10) will decrease coverage by 0.00%.
The diff coverage is 10.52%.

@@            Coverage Diff             @@
##           master    #1251      +/-   ##
==========================================
- Coverage   33.42%   33.42%   -0.01%     
==========================================
  Files          93       93              
  Lines       17615    17621       +6     
==========================================
+ Hits         5888     5890       +2     
- Misses      11727    11731       +4

Flag	Coverage Δ
pytest	`33.42% <10.52%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
discord/enums.py	`78.14% <0.00%> (-0.31%)`	⬇️
discord/commands/core.py	`18.00% <10.00%> (+0.24%)`	⬆️
discord/commands/options.py	`16.49% <20.00%> (-0.53%)`	⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 217da10...80fafa0. Read the comment docs.

EmmmaTech · 2022-05-05T17:14:13Z

Getting an error when using either of the following two methods to define an option:

@slash_command(name="opt_test")
async def opt_test(ctx: discord.ApplicationContext, test_option: Option(str, "Test")):
    await ctx.respond("test")

@slash_command(name="opt_test")
async def opt_test(ctx: discord.ApplicationContext, test_option: str = Option(description="Test")):
    await ctx.respond("test")

Traceback (most recent call last):
  File "C:\Users\ben\PycharmProjects\BasicBot\bot.py", line 48, in <module>
    async def opt_test(ctx: discord.ApplicationContext, test_option: Option(str, "Test")):
  File "C:\Users\ben\PycharmProjects\BasicBot\venv\lib\site-packages\discord\commands\core.py", line 1560, in decorator
    return cls(func, **attrs)
  File "C:\Users\ben\PycharmProjects\BasicBot\venv\lib\site-packages\discord\commands\core.py", line 637, in __init__
    self.options: List[Option] = self._parse_options(params)
  File "C:\Users\ben\PycharmProjects\BasicBot\venv\lib\site-packages\discord\commands\core.py", line 690, in _parse_options
    option = Option(option, "No description provided")
  File "C:\Users\ben\PycharmProjects\BasicBot\venv\lib\site-packages\discord\commands\options.py", line 133, in __init__
    _type = SlashCommandOptionType.from_datatype(input_type)
  File "C:\Users\ben\PycharmProjects\BasicBot\venv\lib\site-packages\discord\enums.py", line 670, in from_datatype
    if datatype.__name__ in ["Member", "User"]:
AttributeError: 'str' object has no attribute '__name__'. Did you mean: '__ne__'?

Are you including from __future__ import annotations?

EmmmaTech

Looks good, I think someone should test it with the options decorator.

krittick · 2022-05-05T21:12:10Z

Getting an error when using either of the following two methods to define an option:

@slash_command(name="opt_test")
async def opt_test(ctx: discord.ApplicationContext, test_option: Option(str, "Test")):
    await ctx.respond("test")

@slash_command(name="opt_test")
async def opt_test(ctx: discord.ApplicationContext, test_option: str = Option(description="Test")):
    await ctx.respond("test")

Traceback (most recent call last):
  File "C:\Users\ben\PycharmProjects\BasicBot\bot.py", line 48, in <module>
    async def opt_test(ctx: discord.ApplicationContext, test_option: Option(str, "Test")):
  File "C:\Users\ben\PycharmProjects\BasicBot\venv\lib\site-packages\discord\commands\core.py", line 1560, in decorator
    return cls(func, **attrs)
  File "C:\Users\ben\PycharmProjects\BasicBot\venv\lib\site-packages\discord\commands\core.py", line 637, in __init__
    self.options: List[Option] = self._parse_options(params)
  File "C:\Users\ben\PycharmProjects\BasicBot\venv\lib\site-packages\discord\commands\core.py", line 690, in _parse_options
    option = Option(option, "No description provided")
  File "C:\Users\ben\PycharmProjects\BasicBot\venv\lib\site-packages\discord\commands\options.py", line 133, in __init__
    _type = SlashCommandOptionType.from_datatype(input_type)
  File "C:\Users\ben\PycharmProjects\BasicBot\venv\lib\site-packages\discord\enums.py", line 670, in from_datatype
    if datatype.__name__ in ["Member", "User"]:
AttributeError: 'str' object has no attribute '__name__'. Did you mean: '__ne__'?

Are you including from __future__ import annotations?

Oh, whoops. Removing that resolves the issue.

krittick · 2022-05-05T21:17:24Z

Decorator works great, Union[TextChannel, VoiceChannel] and all the other good stuff work as well.

Lulalaby

@krittick its fucking 11pm xd
But here we go
Yeet

jab416171 · 2022-05-18T21:05:47Z

@martinbndr please create a new issue here: https://github.com/Pycord-Development/pycord/issues/new/choose

Initial commit for the rewrite of options

d2aac60

Dorukyum self-assigned this Apr 11, 2022

Dorukyum added bug Something isn't working priority: high High Priority status: in progress Work in Progess feature Implements a feature Merge with squash labels Apr 11, 2022

This comment was marked as off-topic.

Sign in to view

Lulalaby mentioned this pull request Apr 11, 2022

Option Redesign (fix for #513) #863

Closed

10 tasks

Minor code changes

5ba9478

BobDotCom previously approved these changes Apr 12, 2022

View reviewed changes

Dorukyum mentioned this pull request Apr 12, 2022

Slash command option types are broken by stringized annotations #513

Closed

3 tasks

Dorukyum linked an issue Apr 12, 2022 that may be closed by this pull request

Slash command option types are broken by stringized annotations #513

Closed

3 tasks

Lulalaby previously approved these changes Apr 12, 2022

View reviewed changes

krittick added 2 commits April 14, 2022 22:23

Merge branch 'master' into options-rewrite

1dd59b8

Merge branch 'master' into options-rewrite

7626d67

krittick added this to the v2.0 milestone Apr 17, 2022

Support passing option types as Union

f5c1243

Dorukyum dismissed stale reviews from Lulalaby and BobDotCom via f5c1243 April 18, 2022 08:58

Dorukyum mentioned this pull request Apr 18, 2022

Support providing option channel types as list #1000

Merged

7 tasks

krittick and others added 2 commits April 18, 2022 11:38

Merge branch 'master' into options-rewrite

7cbe74d

Fix an issue with the self parameter being ignored

48fd30a

Dorukyum marked this pull request as ready for review April 19, 2022 06:54

Dorukyum requested review from BobDotCom, krittick, ChickenDevs and Middledot and removed request for ChickenDevs April 19, 2022 13:42

plun1331 reviewed Apr 21, 2022

View reviewed changes

discord/commands/core.py Show resolved Hide resolved

Merge branch 'master' into options-rewrite

0680876

Merge branch 'master' into options-rewrite

ffa498b

Merge branch 'master' into options-rewrite

dd9e569

Lulalaby enabled auto-merge (squash) May 5, 2022 17:47

EmmmaTech approved these changes May 5, 2022

View reviewed changes

Merge branch 'master' into options-rewrite

80fafa0

krittick approved these changes May 5, 2022

View reviewed changes

krittick requested a review from Lulalaby May 5, 2022 21:18

Lulalaby disabled auto-merge May 5, 2022 21:20

Lulalaby enabled auto-merge (squash) May 5, 2022 21:20

Lulalaby merged commit 6a21ede into master May 5, 2022

Lulalaby approved these changes May 5, 2022

View reviewed changes

Lulalaby deleted the options-rewrite branch May 5, 2022 21:21

krittick restored the options-rewrite branch May 5, 2022 21:55

This comment was marked as off-topic.

Sign in to view

Lulalaby deleted the options-rewrite branch June 9, 2022 08:09

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Rewrite options #1251

Rewrite options #1251

Dorukyum commented Apr 11, 2022 •

edited

Loading

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

Lulalaby commented Apr 12, 2022

Dorukyum commented Apr 18, 2022 •

edited

Loading

krittick commented Apr 25, 2022

codecov bot commented Apr 30, 2022 •

edited

Loading

EmmmaTech commented May 5, 2022 •

edited

Loading

EmmmaTech left a comment

krittick commented May 5, 2022

krittick commented May 5, 2022

Lulalaby left a comment

This comment was marked as off-topic.

jab416171 commented May 18, 2022

Rewrite options #1251

Rewrite options #1251

Conversation

Dorukyum commented Apr 11, 2022 • edited Loading

Summary

Checklist

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

Lulalaby commented Apr 12, 2022

Dorukyum commented Apr 18, 2022 • edited Loading

krittick commented Apr 25, 2022

codecov bot commented Apr 30, 2022 • edited Loading

Codecov Report

EmmmaTech commented May 5, 2022 • edited Loading

EmmmaTech left a comment

Choose a reason for hiding this comment

krittick commented May 5, 2022

krittick commented May 5, 2022

Lulalaby left a comment

Choose a reason for hiding this comment

This comment was marked as off-topic.

jab416171 commented May 18, 2022

Dorukyum commented Apr 11, 2022 •

edited

Loading

Dorukyum commented Apr 18, 2022 •

edited

Loading

codecov bot commented Apr 30, 2022 •

edited

Loading

EmmmaTech commented May 5, 2022 •

edited

Loading