mirrors/discord.py
1
0
Fork 0
mirror of https://github.com/Rapptz/discord.py.git synced 2025-07-06 18:11:59 +00:00
Code Issues Projects Releases Wiki Activity

Remove setting sku_id explicitly via button decorator

Browse Source 
Co-authored-by: Danny <1695103+Rapptz@users.noreply.github.com>
This commit is contained in:
DA344 2024-06-15 13:38:58 +02:00 committed by GitHub
parent 9eac36501a
commit be9edf8deb
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
discord/ui/button.py
View File

@ -78,7 +78,8 @@ class Button(Item[V]):
For example, row=1 will show up before row=2. Defaults to ``None``, which is automatic For example, row=1 will show up before row=2. Defaults to ``None``, which is automatic
ordering. The row number must be between 0 and 4 (i.e. zero indexed). ordering. The row number must be between 0 and 4 (i.e. zero indexed).
sku_id: Optional[:class:`int`] sku_id: Optional[:class:`int`]
The SKU ID this button sends you to. Can't be combined with ``url``. The SKU ID this button sends you to. Can't be combined with ``url``, ``label``, ``emoji``
nor ``custom_id``.
.. versionadded:: 2.4 .. versionadded:: 2.4
""" """
@ -222,7 +223,8 @@ class Button(Item[V]):
@sku_id.setter @sku_id.setter
def sku_id(self, value: Optional[int]) -> None: def sku_id(self, value: Optional[int]) -> None:
self.style = ButtonStyle.premium if value is not None:
self.style = ButtonStyle.premium
self._underlying.sku_id = value self._underlying.sku_id = value
@classmethod @classmethod
@ -265,7 +267,6 @@ def button(
style: ButtonStyle = ButtonStyle.secondary, style: ButtonStyle = ButtonStyle.secondary,
emoji: Optional[Union[str, Emoji, PartialEmoji]] = None, emoji: Optional[Union[str, Emoji, PartialEmoji]] = None,
row: Optional[int] = None, row: Optional[int] = None,
sku_id: Optional[int] = None,
) -> Callable[[ItemCallbackType[V, Button[V]]], Button[V]]: ) -> Callable[[ItemCallbackType[V, Button[V]]], Button[V]]:
"""A decorator that attaches a button to a component. """A decorator that attaches a button to a component.
@ -275,11 +276,11 @@ def button(
.. note:: .. note::
Buttons with a URL cannot be created with this function. Buttons with a URL or an SKU cannot be created with this function.
Consider creating a :class:`Button` manually instead. Consider creating a :class:`Button` manually instead.
This is because buttons with a URL do not have a callback This is because these buttons cannot have a callback
associated with them since Discord does not do any processing associated with them since Discord does not do any processing
with it. with them.
Parameters Parameters
------------ ------------
@ -303,10 +304,6 @@ def button(
like to control the relative positioning of the row then passing an index is advised. like to control the relative positioning of the row then passing an index is advised.
For example, row=1 will show up before row=2. Defaults to ``None``, which is automatic For example, row=1 will show up before row=2. Defaults to ``None``, which is automatic
ordering. The row number must be between 0 and 4 (i.e. zero indexed). ordering. The row number must be between 0 and 4 (i.e. zero indexed).
sku_id: Optional[:class:`int`]
The SKU ID this button sends you to. Can't be combined with ``url``.
.. versionadded:: 2.4
""" """
def decorator(func: ItemCallbackType[V, Button[V]]) -> ItemCallbackType[V, Button[V]]: def decorator(func: ItemCallbackType[V, Button[V]]) -> ItemCallbackType[V, Button[V]]:
@ -322,7 +319,7 @@ def button(
'label': label, 'label': label,
'emoji': emoji, 'emoji': emoji,
'row': row, 'row': row,
'sku_id': sku_id, 'sku_id': None,
} }
return func return func

2
docs/interactions/api.rst
View File

@ -336,7 +336,7 @@ Enumerations
Represents a link button. Represents a link button.
.. attribute:: premium .. attribute:: premium
Represents a gradient button denoting that buying a SKU is Represents a button denoting that buying a SKU is
required to perform this action. required to perform this action.
.. versionadded:: 2.4 .. versionadded:: 2.4