Skip to content

feat(params): Export AppCommandAttrs and SlashCommandAttrs. #20

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(params): Export AppCommandAttrs and SlashCommandAttrs. #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions examples/attributes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,17 @@ async def my_other_command(inter: disnake.CommandInteraction):
...


# You can also manually define and pass attribute "bundles". This is regular
# python "unpack" syntax, so you can't pass the same parameter both in the bundle
# and as a parameter. Additionally, annotating bundle's type will ensure that you
# don't accidentally make a typo or pass an extraneous parameter.

attrs: plugins.AppCommandAttrs = {"auto_sync": False}

# This command will not be automatically synced and will be only avail
@plugin.slash_command(**attrs)
async def another_command(inter: disnake.CommandInteraction):
...


setup, teardown = plugin.create_extension_handlers()
41 changes: 26 additions & 15 deletions src/disnake/ext/plugins/plugin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@
P = ParamSpec("P")


__all__ = ("Plugin", "PluginMetadata", "get_parent_plugin", "PluginKey")
__all__ = ("Plugin", "PluginMetadata", "get_parent_plugin", "PluginKey",
"AppCommandAttrs", "SlashCommandAttrs")

LOGGER = logging.getLogger(__name__)
_INVALID: t.Final[t.Sequence[str]] = (t.__file__, __file__)
Expand Down Expand Up @@ -87,15 +88,25 @@ class CommandParams(t.TypedDict, total=False):
extras: t.Dict[str, t.Any]


class AppCommandParams(t.TypedDict, total=False):
class AppCommandAttrs(t.TypedDict, total=False):
"""A :class:`TypedDict` of valid attributes (parameters) for app command decorators.

Specifically, the following decorators can accept this set of attributes:
- :func:`Plugin.user_command`;
- :func:`Plugin.message_command`;
- and :func:`Plugin.slash_command`.
"""

auto_sync: bool
dm_permission: bool
default_member_permissions: PermissionsOptional
guild_ids: t.Sequence[int]
extras: t.Dict[str, t.Any]


class SlashCommandParams(AppCommandParams, total=False):
class SlashCommandAttrs(AppCommandAttrs, total=False):
"""A :class:`TypedDict` of valid attributes (parameters) for :func:`Plugin.slash_command`."""

description: LocalizedOptional
connectors: t.Dict[str, str]

Expand Down Expand Up @@ -135,11 +146,11 @@ class PluginMetadata:

command_attrs: CommandParams = dataclasses.field(default_factory=CommandParams)
"""Parameters to apply to each prefix command in this plugin."""
slash_command_attrs: SlashCommandParams = dataclasses.field(default_factory=SlashCommandParams)
slash_command_attrs: SlashCommandAttrs = dataclasses.field(default_factory=SlashCommandAttrs)
"""Parameters to apply to each slash command in this plugin."""
message_command_attrs: AppCommandParams = dataclasses.field(default_factory=AppCommandParams)
message_command_attrs: AppCommandAttrs = dataclasses.field(default_factory=AppCommandAttrs)
"""Parameters to apply to each message command in this plugin."""
user_command_attrs: AppCommandParams = dataclasses.field(default_factory=AppCommandParams)
user_command_attrs: AppCommandAttrs = dataclasses.field(default_factory=AppCommandAttrs)
"""Parameters to apply to each user command in this plugin."""

@property
Expand Down Expand Up @@ -301,9 +312,9 @@ def __init__(
*,
name: t.Optional[str] = None,
command_attrs: t.Optional[CommandParams] = None,
message_command_attrs: t.Optional[AppCommandParams] = None,
slash_command_attrs: t.Optional[SlashCommandParams] = None,
user_command_attrs: t.Optional[AppCommandParams] = None,
message_command_attrs: t.Optional[AppCommandAttrs] = None,
slash_command_attrs: t.Optional[SlashCommandAttrs] = None,
user_command_attrs: t.Optional[AppCommandAttrs] = None,
logger: t.Union[logging.Logger, str, None] = None,
**extras: t.Any, # noqa: ANN401
) -> None:
Expand All @@ -315,9 +326,9 @@ def __init__(
*,
name: t.Optional[str] = None,
command_attrs: t.Optional[CommandParams] = None,
message_command_attrs: t.Optional[AppCommandParams] = None,
slash_command_attrs: t.Optional[SlashCommandParams] = None,
user_command_attrs: t.Optional[AppCommandParams] = None,
message_command_attrs: t.Optional[AppCommandAttrs] = None,
slash_command_attrs: t.Optional[SlashCommandAttrs] = None,
user_command_attrs: t.Optional[AppCommandAttrs] = None,
logger: t.Union[logging.Logger, str, None] = None,
**extras: t.Any, # noqa: ANN401
) -> None:
Expand All @@ -328,9 +339,9 @@ def __init__(
*,
name: t.Optional[str] = None,
command_attrs: t.Optional[CommandParams] = None,
message_command_attrs: t.Optional[AppCommandParams] = None,
slash_command_attrs: t.Optional[SlashCommandParams] = None,
user_command_attrs: t.Optional[AppCommandParams] = None,
message_command_attrs: t.Optional[AppCommandAttrs] = None,
slash_command_attrs: t.Optional[SlashCommandAttrs] = None,
user_command_attrs: t.Optional[AppCommandAttrs] = None,
logger: t.Union[logging.Logger, str, None] = None,
**extras: t.Any,
) -> None:
Expand Down