hikari-arc 0.4.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

arc/command/message.py

@@ -8,12 +8,12 @@ import hikari
 from arc.abc.command import CallableCommandBase
 from arc.context import AutodeferMode, Context
 from arc.errors import CommandInvokeError
-from arc.internal.types import ClientT, MessageContextCallbackT, ResponseBuilderT
+from arc.internal.types import ClientT, MessageCommandCallbackT, ResponseBuilderT
 
 if t.TYPE_CHECKING:
     import asyncio
 
-    from ..abc import CallableCommandProto
+    from arc.abc import CallableCommandProto
 
 __all__ = ("MessageCommand", "message_command")
 
@@ -63,33 +63,36 @@ class MessageCommand(CallableCommandBase[ClientT, hikari.api.ContextMenuCommandB
 def message_command(
     name: str,
     *,
-    guilds: t.Sequence[hikari.SnowflakeishOr[hikari.PartialGuild]] | None = None,
-    is_dm_enabled: bool = True,
-    is_nsfw: bool = False,
-    autodefer: bool | AutodeferMode = True,
-    default_permissions: hikari.UndefinedOr[hikari.Permissions] = hikari.UNDEFINED,
+    guilds: t.Sequence[hikari.PartialGuild | hikari.Snowflakeish] | hikari.UndefinedType = hikari.UNDEFINED,
+    is_dm_enabled: bool | hikari.UndefinedType = hikari.UNDEFINED,
+    is_nsfw: bool | hikari.UndefinedType = hikari.UNDEFINED,
+    autodefer: bool | AutodeferMode | hikari.UndefinedType = hikari.UNDEFINED,
+    default_permissions: hikari.Permissions | hikari.UndefinedType = hikari.UNDEFINED,
     name_localizations: t.Mapping[hikari.Locale, str] | None = None,
-) -> t.Callable[[MessageContextCallbackT[ClientT]], MessageCommand[ClientT]]:
+) -> t.Callable[[MessageCommandCallbackT[ClientT]], MessageCommand[ClientT]]:
     """A decorator that creates a context-menu command on a message.
 
     Parameters
     ----------
     name : str
         The name of the command.
-    guilds : t.Sequence[hikari.SnowflakeishOr[hikari.PartialGuild]] | None
-        The guilds this command is available in.
-    is_dm_enabled : bool
+    guilds : t.Sequence[hikari.PartialGuild | hikari.Snowflakeish] | hikari.UndefinedType
+        The guilds this command should be enabled in, if left as undefined, the command is global
+    is_dm_enabled : bool | hikari.UndefinedType
         Whether this command is enabled in DMs.
-    is_nsfw : bool
+    is_nsfw : bool | hikari.UndefinedType
         Whether this command is NSFW.
-    autodefer : bool | AutodeferMode
-        If True, this command will be automatically deferred if it takes longer than 2 seconds to respond, by default True
-    default_permissions : hikari.UndefinedOr[hikari.Permissions]
+    autodefer : bool | AutodeferMode | hikari.UndefinedType
+        If True, this command will be automatically deferred if it takes longer than 2 seconds to respond
+    default_permissions : hikari.Permissions | hikari.UndefinedType
         The default permissions for this command.
         Keep in mind that guild administrators can change this, it should only be used to provide safe defaults.
     name_localizations : t.Mapping[hikari.Locale, str] | None
         The localizations for this command's name.
 
+    !!! note
+        Parameters left as `hikari.UNDEFINED` will be inherited from the parent plugin or client.
+
     Usage
     -----
     ```py
@@ -102,13 +105,13 @@ def message_command(
     ```
     """
 
-    def decorator(callback: MessageContextCallbackT[ClientT]) -> MessageCommand[ClientT]:
-        guild_ids = [hikari.Snowflake(guild) for guild in guilds] if guilds else []
+    def decorator(callback: MessageCommandCallbackT[ClientT]) -> MessageCommand[ClientT]:
+        guild_ids = tuple(hikari.Snowflake(i) for i in guilds) if guilds is not hikari.UNDEFINED else hikari.UNDEFINED
 
         return MessageCommand(
             callback=callback,
             name=name,
-            autodefer=AutodeferMode(autodefer),
+            autodefer=AutodeferMode(autodefer) if isinstance(autodefer, bool) else autodefer,
             guilds=guild_ids,
             is_dm_enabled=is_dm_enabled,
             is_nsfw=is_nsfw,

arc/command/option/attachment.py

@@ -5,7 +5,7 @@ import typing as t
 import attr
 import hikari
 
-from arc.abc.option import CommandOptionBase, OptionParams
+from arc.abc.option import CommandOptionBase, OptionParams, OptionType
 from arc.internal.types import ClientT
 
 if t.TYPE_CHECKING:
@@ -14,15 +14,19 @@ if t.TYPE_CHECKING:
 __all__ = ("AttachmentOption", "AttachmentParams")
 
 
+@t.final
 class AttachmentParams(OptionParams[hikari.Attachment]):
     """The parameters for an attachment option.
 
     Parameters
     ----------
-    name : str
-        The name of the option
     description : str
         The description of the option
+
+    Other Parameters
+    ----------------
+    name : str
+        The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : Mapping[hikari.Locale, str] | None
         The name of the option in different locales
     description_localizations : Mapping[hikari.Locale, str] | None
@@ -42,8 +46,8 @@ class AttachmentOption(CommandOptionBase[hikari.Attachment, ClientT, AttachmentP
     """
 
     @property
-    def option_type(self) -> hikari.OptionType:
-        return hikari.OptionType.ATTACHMENT
+    def option_type(self) -> OptionType:
+        return OptionType.ATTACHMENT
 
     @classmethod
     def _from_params(cls, *, name: str, is_required: bool, params: AttachmentParams, **kwargs: t.Any) -> te.Self:

arc/command/option/bool.py

@@ -3,9 +3,8 @@ from __future__ import annotations
 import typing as t
 
 import attr
-import hikari
 
-from arc.abc.option import CommandOptionBase, OptionParams
+from arc.abc.option import CommandOptionBase, OptionParams, OptionType
 from arc.internal.types import ClientT
 
 if t.TYPE_CHECKING:
@@ -14,15 +13,19 @@ if t.TYPE_CHECKING:
 __all__ = ("BoolOption", "BoolParams")
 
 
+@t.final
 class BoolParams(OptionParams[bool]):
     """The parameters for a bool option.
 
     Parameters
     ----------
-    name : str
-        The name of the option. If not provided, the name of the parameter will be used.
     description : str
         The description of the option
+
+    Other Parameters
+    ----------------
+    name : str
+        The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : t.Optional[t.Mapping[str, str]]
         The localizations for the name of the option
     description_localizations : t.Optional[t.Mapping[str, str]]
@@ -42,8 +45,8 @@ class BoolOption(CommandOptionBase[bool, ClientT, BoolParams]):
     """
 
     @property
-    def option_type(self) -> hikari.OptionType:
-        return hikari.OptionType.BOOLEAN
+    def option_type(self) -> OptionType:
+        return OptionType.BOOLEAN
 
     @classmethod
     def _from_params(cls, *, name: str, is_required: bool, params: BoolParams, **kwargs: t.Any) -> te.Self:

arc/command/option/channel.py

@@ -5,7 +5,7 @@ import typing as t
 import attr
 import hikari
 
-from arc.abc.option import CommandOptionBase, OptionParams
+from arc.abc.option import CommandOptionBase, OptionParams, OptionType
 from arc.internal.types import ClientT
 
 if t.TYPE_CHECKING:
@@ -14,6 +14,7 @@ if t.TYPE_CHECKING:
 __all__ = ("ChannelOption", "ChannelParams")
 
 
+@t.final
 class ChannelParams(OptionParams[hikari.PartialChannel]):
     """The parameters for a channel option.
     The channel types are inferred from the type hint.
@@ -25,10 +26,13 @@ class ChannelParams(OptionParams[hikari.PartialChannel]):
 
     Parameters
     ----------
-    name : str
-        The name of the option
     description : str
         The description of the option
+
+    Other Parameters
+    ----------------
+    name : str
+        The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : Mapping[hikari.Locale, str]
         The name of the option in different locales
     description_localizations : Mapping[hikari.Locale, str]
@@ -53,8 +57,8 @@ class ChannelOption(CommandOptionBase[hikari.PartialChannel, ClientT, ChannelPar
     """The channel types that the option can be."""
 
     @property
-    def option_type(self) -> hikari.OptionType:
-        return hikari.OptionType.CHANNEL
+    def option_type(self) -> OptionType:
+        return OptionType.CHANNEL
 
     @classmethod
     def _from_params(cls, *, name: str, is_required: bool, params: ChannelParams, **kwargs: t.Any) -> te.Self:

arc/command/option/float.py

@@ -3,12 +3,12 @@ from __future__ import annotations
 import typing as t
 
 import attr
-import hikari
 
-from arc.abc.option import OptionWithChoices, OptionWithChoicesParams
+from arc.abc.option import OptionType, OptionWithChoices, OptionWithChoicesParams
 from arc.internal.types import ClientT
 
 if t.TYPE_CHECKING:
+    import hikari
     import typing_extensions as te
 
     from ...internal.types import AutocompleteCallbackT
@@ -16,15 +16,19 @@ if t.TYPE_CHECKING:
 __all__ = ("FloatOption", "FloatParams")
 
 
+@t.final
 class FloatParams(OptionWithChoicesParams[float, ClientT]):
     """The parameters for a float option.
 
     Parameters
     ----------
-    name : str
-        The name of the option
     description : str
         The description of the option
+
+    Other Parameters
+    ----------------
+    name : str
+        The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : Mapping[hikari.Locale, str] | None
         The name of the option in different locales
     description_localizations : Mapping[hikari.Locale, str] | None
@@ -44,9 +48,9 @@ class FloatParams(OptionWithChoicesParams[float, ClientT]):
 
     def __init__(
         self,
-        name: str | None = None,
         description: str = "No description provided.",
         *,
+        name: str | None = None,
         name_localizations: t.Mapping[hikari.Locale, str] = {},
         description_localizations: t.Mapping[hikari.Locale, str] = {},
         min: float | None = None,
@@ -93,8 +97,8 @@ class FloatOption(OptionWithChoices[float, ClientT, FloatParams[ClientT]]):
     """The maximum value of the option."""
 
     @property
-    def option_type(self) -> hikari.OptionType:
-        return hikari.OptionType.FLOAT
+    def option_type(self) -> OptionType:
+        return OptionType.FLOAT
 
     @classmethod
     def _from_params(cls, *, name: str, is_required: bool, params: FloatParams[ClientT], **kwargs: t.Any) -> te.Self:

arc/command/option/int.py

@@ -3,12 +3,12 @@ from __future__ import annotations
 import typing as t
 
 import attr
-import hikari
 
-from arc.abc.option import OptionWithChoices, OptionWithChoicesParams
+from arc.abc.option import OptionType, OptionWithChoices, OptionWithChoicesParams
 from arc.internal.types import ClientT
 
 if t.TYPE_CHECKING:
+    import hikari
     import typing_extensions as te
 
     from ...internal.types import AutocompleteCallbackT
@@ -16,15 +16,19 @@ if t.TYPE_CHECKING:
 __all__ = ("IntOption", "IntParams")
 
 
+@t.final
 class IntParams(OptionWithChoicesParams[int, ClientT]):
     """The parameters for an int option.
 
     Parameters
     ----------
-    name : str
-        The name of the option
     description : str
         The description of the option
+
+    Other Parameters
+    ----------------
+    name : str
+        The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : Mapping[hikari.Locale, str] | None
         The name of the option in different locales
     description_localizations : Mapping[hikari.Locale, str] | None
@@ -44,9 +48,9 @@ class IntParams(OptionWithChoicesParams[int, ClientT]):
 
     def __init__(
         self,
-        name: str | None = None,
         description: str = "No description provided.",
         *,
+        name: str | None = None,
         name_localizations: t.Mapping[hikari.Locale, str] | None = None,
         description_localizations: t.Mapping[hikari.Locale, str] | None = None,
         min: int | None = None,
@@ -93,8 +97,8 @@ class IntOption(OptionWithChoices[int, ClientT, IntParams[ClientT]]):
     """The maximum value of the option."""
 
     @property
-    def option_type(self) -> hikari.OptionType:
-        return hikari.OptionType.INTEGER
+    def option_type(self) -> OptionType:
+        return OptionType.INTEGER
 
     @classmethod
     def _from_params(cls, *, name: str, is_required: bool, params: IntParams[ClientT], **kwargs: t.Any) -> te.Self:

arc/command/option/mentionable.py

@@ -5,7 +5,7 @@ import typing as t
 import attr
 import hikari
 
-from arc.abc.option import CommandOptionBase, OptionParams
+from arc.abc.option import CommandOptionBase, OptionParams, OptionType
 from arc.internal.types import ClientT
 
 if t.TYPE_CHECKING:
@@ -14,16 +14,20 @@ if t.TYPE_CHECKING:
 __all__ = ("MentionableOption", "MentionableParams")
 
 
+@t.final
 class MentionableParams(OptionParams[hikari.Role | hikari.User]):
     """The parameters for a mentionable option.
     This is an option of type `hikari.Role | hikari.User`.
 
     Parameters
     ----------
-    name : str
-        The name of the option
     description : str
         The description of the option
+
+    Other Parameters
+    ----------------
+    name : str
+        The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : Mapping[hikari.Locale, str] | None
         The name of the option in different locales
     description_localizations : Mapping[hikari.Locale, str] | None
@@ -43,8 +47,8 @@ class MentionableOption(CommandOptionBase[hikari.Role | hikari.User, ClientT, Me
     """
 
     @property
-    def option_type(self) -> hikari.OptionType:
-        return hikari.OptionType.MENTIONABLE
+    def option_type(self) -> OptionType:
+        return OptionType.MENTIONABLE
 
     @classmethod
     def _from_params(cls, *, name: str, is_required: bool, params: MentionableParams, **kwargs: t.Any) -> te.Self:

arc/command/option/role.py

@@ -5,7 +5,7 @@ import typing as t
 import attr
 import hikari
 
-from arc.abc.option import CommandOptionBase, OptionParams
+from arc.abc.option import CommandOptionBase, OptionParams, OptionType
 from arc.internal.types import ClientT
 
 if t.TYPE_CHECKING:
@@ -14,15 +14,19 @@ if t.TYPE_CHECKING:
 __all__ = ("RoleOption", "RoleParams")
 
 
+@t.final
 class RoleParams(OptionParams[hikari.Role]):
     """The parameters for a user option.
 
     Parameters
     ----------
-    name : str
-        The name of the option. If not provided, the name of the parameter will be used.
     description : str
         The description of the option
+
+    Other Parameters
+    ----------------
+    name : str
+        The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : t.Optional[t.Mapping[str, str]]
         The localizations for the name of the option
     description_localizations : t.Optional[t.Mapping[str, str]]
@@ -42,8 +46,8 @@ class RoleOption(CommandOptionBase[hikari.Role, ClientT, RoleParams]):
     """
 
     @property
-    def option_type(self) -> hikari.OptionType:
-        return hikari.OptionType.ROLE
+    def option_type(self) -> OptionType:
+        return OptionType.ROLE
 
     @classmethod
     def _from_params(cls, *, name: str, is_required: bool, params: RoleParams, **kwargs: t.Any) -> te.Self:

arc/command/option/str.py

@@ -3,12 +3,12 @@ from __future__ import annotations
 import typing as t
 
 import attr
-import hikari
 
-from arc.abc.option import OptionWithChoices, OptionWithChoicesParams
+from arc.abc.option import OptionType, OptionWithChoices, OptionWithChoicesParams
 from arc.internal.types import ClientT
 
 if t.TYPE_CHECKING:
+    import hikari
     import typing_extensions as te
 
     from arc.internal.types import AutocompleteCallbackT
@@ -17,15 +17,19 @@ if t.TYPE_CHECKING:
 __all__ = ("StrOption", "StrParams")
 
 
+@t.final
 class StrParams(OptionWithChoicesParams[str, ClientT]):
     """The parameters for a string option.
 
     Parameters
     ----------
-    name : str
-        The name of the option
     description : str
         The description of the option
+
+    Other Parameters
+    ----------------
+    name : str
+        The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : Mapping[hikari.Locale, str]
         The name of the option in different locales
     description_localizations : Mapping[hikari.Locale, str]
@@ -45,9 +49,9 @@ class StrParams(OptionWithChoicesParams[str, ClientT]):
 
     def __init__(
         self,
-        name: str | None = None,
         description: str = "No description provided.",
         *,
+        name: str | None = None,
         name_localizations: t.Mapping[hikari.Locale, str] | None = None,
         description_localizations: t.Mapping[hikari.Locale, str] | None = None,
         min_length: int | None = None,
@@ -94,8 +98,8 @@ class StrOption(OptionWithChoices[str, ClientT, StrParams[ClientT]]):
     """The maximum length of the option."""
 
     @property
-    def option_type(self) -> hikari.OptionType:
-        return hikari.OptionType.STRING
+    def option_type(self) -> OptionType:
+        return OptionType.STRING
 
     @classmethod
     def _from_params(cls, *, name: str, is_required: bool, params: StrParams[ClientT], **kwargs: t.Any) -> te.Self:

arc/command/option/user.py

@@ -5,7 +5,7 @@ import typing as t
 import attr
 import hikari
 
-from arc.abc.option import CommandOptionBase, OptionParams
+from arc.abc.option import CommandOptionBase, OptionParams, OptionType
 from arc.internal.types import ClientT
 
 if t.TYPE_CHECKING:
@@ -15,15 +15,19 @@ if t.TYPE_CHECKING:
 __all__ = ("UserOption", "UserParams")
 
 
+@t.final
 class UserParams(OptionParams[hikari.User]):
     """The parameters for a user option.
 
     Parameters
     ----------
-    name : str
-        The name of the option. If not provided, the name of the parameter will be used.
     description : str
         The description of the option
+
+    Other Parameters
+    ----------------
+    name : str
+        The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : Mapping[hikari.Locale, str] | None
         The name of the option in different locales
     description_localizations : Mapping[hikari.Locale, str] | None
@@ -43,8 +47,8 @@ class UserOption(CommandOptionBase[hikari.User, ClientT, UserParams]):
     """
 
     @property
-    def option_type(self) -> hikari.OptionType:
-        return hikari.OptionType.USER
+    def option_type(self) -> OptionType:
+        return OptionType.USER
 
     @classmethod
     def _from_params(cls, *, name: str, is_required: bool, params: UserParams, **kwargs: t.Any) -> te.Self: