scurrypy 0.4.2__py3-none-any.whl → 0.5__py3-none-any.whl

discord/parts/command.py

@@ -1,8 +1,12 @@
 from dataclasses import dataclass, field
-from typing import Literal
 
 from ..model import DataModel
 
+class CommandTypes:
+    CHAT_INPUT = 1
+    USER_COMMAND = 2
+    MESSAGE_COMMAND = 3
+
 class CommandOptionTypes:
     """Slash command option input types."""
 
@@ -34,69 +38,53 @@ class CommandOptionTypes:
     """file upload"""
 
 @dataclass
-class MessageCommand(DataModel):
-    """Represents the message command object."""
-    type: Literal[3] = field(init=False, default=3) # MESSAGE
+class CommandOption(DataModel):
+    """Option for a slash command."""
+
+    type: int
+    """Type of option. See [`CommandOptionTypes`][discord.parts.command.CommandOptionTypes]."""
+
     name: str
+    """Name of option."""
+
+    description: str
+    """Description of option."""
+
+    required: bool = False
+    """Whether this option is required. Defaults to False."""
 
 @dataclass
-class UserCommand(DataModel):
-    """Represents the user command object"""
-    type: Literal[2] = field(init=False, default=2) # USER
+class SlashCommand(DataModel):
+    """Represents the slash command object."""
+
     name: str
+    """Name of the command."""
+
+    description: str
+    """Description of the command."""
+
+    options: list[CommandOption] = field(default_factory=list)
+    """Parameters or options for the command."""
+
+    type: int = field(init=False, default=CommandTypes.CHAT_INPUT)
+    """Command type. Always `CommandTypes.CHAT_INPUT` for this class. See [`CommandTypes`][discord.parts.command.CommandTypes]."""
 
 @dataclass
-class _CommandOption(DataModel):
-    """Option for a slash command."""
-    type: int   # refer to CommandOptionTypes
+class UserCommand(DataModel):
+    """Represents the user command object"""
+
     name: str
-    description: str
-    required: bool = True
+    """Name of the command."""
+
+    type: int = field(init=False, default=CommandTypes.USER_COMMAND)
+    """Command type. Always `CommandTypes.USER_COMMAND` for this class. See [`CommandTypes`][discord.parts.command.CommandTypes]."""
 
 @dataclass
-class SlashCommand(DataModel):
-    type: Literal[1] = field(init=False, default=1) # CHAT_INPUT
+class MessageCommand(DataModel):
+    """Represents the message command object."""
+    
     name: str
-    description: str
-    options: list[_CommandOption] = field(default_factory=list)
-
-    def add_option(
-        self,
-        command_type: Literal['String', 'Integer', 'Boolean', 'User', 'Channel', 'Role', 'Mentionable', 'Number', 'Attachment'],
-        name: str,
-        description: str,
-        required: bool = False
-    ):
-        """Add an option to this slash command.
-
-        Args:
-            command_type (Literal['String', 'Integer', 'Boolean', 'User', 'Channel', 'Role', 'Mentionable', 'Number', 'Attachment']): 
-                input type for the option
-            name (str): name of the option
-            description (str): description for the option
-            required (bool, optional): if the option is required. Defaults to False.
-
-        Returns:
-            (SlashCommand): self
-        """
-        _command_types = {
-            'STRING': CommandOptionTypes.STRING,
-            'INTEGER': CommandOptionTypes.INTEGER,
-            'BOOLEAN': CommandOptionTypes.BOOLEAN,
-            'USER': CommandOptionTypes.BOOLEAN,
-            'CHANNEL': CommandOptionTypes.CHANNEL,
-            'ROLE': CommandOptionTypes.ROLE,
-            'MENTIONABLE': CommandOptionTypes.MENTIONABLE,
-            'NUMBER': CommandOptionTypes.NUMBER,
-            'ATTACHMENT': CommandOptionTypes.ATTACHMENT
-        }
-
-        self.options.append(
-            _CommandOption(
-                type=_command_types.get(command_type.upper()), 
-                name=name, 
-                description=description, 
-                required=required
-            )
-        )
-        return self
+    """Name of the command."""
+
+    type: int = field(init=False, default=CommandTypes.MESSAGE_COMMAND)
+    """Command type. Always `CommandTypes.MESSAGE_COMMAND` for this class. See [`CommandTypes`][discord.parts.command.CommandTypes]."""

discord/parts/components.py

@@ -0,0 +1,224 @@
+from dataclasses import dataclass, field
+from typing import Literal, Optional
+from ..model import DataModel
+
+from .component_types import *
+
+from ..models.emoji import EmojiModel
+
+class ComponentTypes:
+    ACTION_ROW = 1
+    BUTTON = 2
+    STRING_SELECT = 3
+    TEXT_INPUT = 4
+    USER_SELECT = 5
+    ROLE_SELECT = 6
+    MENTIONABLE_SELECT = 7
+    CHANNEL_SELECT = 8
+
+@dataclass
+class ActionRowPart(DataModel, ContainerChild):
+    """Represents a container of interactable components."""
+    
+    components: list[ActionRowChild] = field(default_factory=list)
+    """Up to 5 interactive button components or a single select component."""
+
+    type: int = field(init=False, default=ComponentTypes.ACTION_ROW)
+    """Component type. Always `ComponentTypes.ACTION_ROW` for this class. See [`ComponentTypes`][discord.parts.components.ComponentTypes]."""
+
+class ButtonStyles:
+    """Represents button styles for a Button component."""
+
+    PRIMARY = 1
+    """The most important or recommended action in a group of options. (Blurple)"""
+
+    SECONDARY = 2
+    """Alternative or supporting actions. (Gray)"""
+
+    SUCCESS = 3
+    """Positive confirmation or completion actions. (Green)"""
+
+    DANGER = 4
+    """An action with irreversible consequences. (Red)"""
+
+    LINK = 5
+    """Navigates to a URL. (Gray + window)"""
+
+@dataclass
+class Button(DataModel, ActionRowChild, SectionAccessory):
+    """Represents the Button component."""
+
+    style: int
+    """A button style. See [`ButtonStyles`][discord.parts.components.ButtonStyles]."""
+
+    custom_id: str
+    """ID for the button."""
+
+    label: Optional[str] = None
+    """Text that appears on the button."""
+
+    emoji: EmojiModel = None
+    """Partial emoji icon."""
+
+    url: Optional[str] = None
+    """URL for link-style buttons."""
+
+    disabled: Optional[bool] = False
+    """Whether the button is disabled. Defaults to False."""
+
+    type: int = field(init=False, default=ComponentTypes.BUTTON)
+    """Component type. Always `ComponentTypes.BUTTON` for this class. See [`ComponentTypes`][discord.parts.components.ComponentTypes]."""
+
+@dataclass
+class SelectOption(DataModel):
+    """Represents the Select Option component"""
+
+    label: str
+    """User-facing name of the option."""
+
+    value: str
+    """Developer-defined value of the option."""
+
+    description: Optional[str] = None
+    """Additional description of the option."""
+
+    emoji: Optional[EmojiModel] = None
+    """Partial emoji obhect."""
+
+    default: Optional[bool] = False
+    """Whether this option is selected by default."""
+
+@dataclass
+class StringSelect(DataModel, ActionRowChild, LabelChild):
+    """Represents the String Select component."""
+
+    custom_id: str
+    """ID for the select menu."""
+
+    options: list[SelectOption] = field(default_factory=list)
+    """Specified choices in a select menu. See [`SelectOption`][discord.parts.components.SelectOption]."""
+
+    placeholder: Optional[str] = None
+    """Placeholder text if nothing is selected or default."""
+
+    min_values: Optional[int] = 1
+    """Minimum number of items that must be chosen."""
+
+    max_values: Optional[int] = 1
+    """Maximum number of items that can be chosen."""
+
+    required: Optional[bool] = False
+    """Whether the string select is required to answer in a modal. Defaults to False."""
+
+    disabled: Optional[bool] = False # does not work on Modals!
+    """Whether select menu is disabled in a message. Defaults to False."""
+
+    type: int = field(init=False, default=ComponentTypes.STRING_SELECT)
+    """Component type. Always `ComponentTypes.STRING_SELECT` for this class. See [`ComponentTypes`][discord.parts.components.ComponentTypes]."""
+
+class TextInputStyles:
+    """Represents the types of Text Inputs."""
+
+    SHORT = 1
+    """One line text input."""
+
+    PARAGRAPH = 2
+    """Multi-line text input."""
+
+@dataclass
+class TextInput(DataModel, LabelChild):
+    """Represents the Text Input component."""
+
+    style: TextInputStyles = TextInputStyles.SHORT
+    """Text input style. See [`TextInputStyles`][discord.parts.components.TextInputStyles]."""
+
+    custom_id: str = None
+    """ID for the input."""
+
+    required: Optional[bool] = False
+    """Whether this component is required to be filled."""
+
+    min_length: Optional[int] = None
+    """Minimum input length for a text input."""
+
+    max_length: Optional[int] = None
+    """Maximum input length for a text input."""
+
+    required: Optional[bool] = True
+    """Whether this component is required to be filled. Defaults to True."""
+
+    value: Optional[str] = None
+    """Pre-filled value for this component."""
+
+    placeholder: Optional[str] = None
+    """Custom placeholder text if the input is empty."""
+
+    type: int = field(init=False, default=ComponentTypes.TEXT_INPUT)
+    """Component type. Always `ComponentTypes.TEXT_INPUT` for this class. See [`ComponentTypes`][discord.parts.components.ComponentTypes]."""
+
+@dataclass
+class DefaultValue(DataModel):
+    """Represents the Default Value for Select components."""
+
+    id: int
+    """ID of role, user, or channel."""
+
+    type: Literal["role", "user", "channel"]
+    """Type of value that `id` represents."""
+
+@dataclass
+class SelectMenu(DataModel):
+    """Represents common fields for Discord's select menus."""
+
+    custom_id: str
+    """ID for the select menu."""
+
+    placeholder: Optional[str] = None
+    """Placeholder text if nothing is selected."""
+
+    default_values: list[DefaultValue] = field(default_factory=list)
+    """
+        List of default values for auto-populated select menu components. See [`DefaultValue`][discord.parts.components.DefaultValue].
+        Number of default values must be in the range of `min_values` to `max_values`.
+    """
+
+    min_values: Optional[int] = 1
+    """Minimum number of items that must be chosen. Defaults to 1."""
+
+    max_values: Optional[int] = 1
+    """Maximum number of items that can be chosen. Defaults to 1."""
+
+    required: Optional[bool] = False
+    """Whether the user select is required to answer in a modal. Defaults to False."""
+
+    disabled: Optional[bool] = False
+    """Whether select menu is disabled in a message. Defaults to False."""
+
+
+@dataclass
+class UserSelect(SelectMenu, ActionRowChild, LabelChild):
+    """Represents the User Select component."""
+
+    type: int = field(init=False, default=ComponentTypes.USER_SELECT)
+    """Component type. Always `ComponentTypes.USER_SELECT` for this class. See [`ComponentTypes`][discord.parts.components.ComponentTypes]."""
+
+@dataclass
+class RoleSelect(SelectMenu, ActionRowChild, LabelChild):
+    """Represents the Role Select component."""
+
+    type: int = field(init=False, default=ComponentTypes.ROLE_SELECT)
+    """Component type. Always `ComponentTypes.ROLE_SELECT` for this class. See [`ComponentTypes`][discord.parts.components.ComponentTypes]."""
+
+@dataclass
+class MentionableSelect(SelectMenu, ActionRowChild, LabelChild):
+    """Represents the Mentionable Select component."""
+
+    type: int = field(init=False, default=ComponentTypes.MENTIONABLE_SELECT)
+    """Component type. Always `ComponentTypes.MENTIONABLE_SELECT` for this class. See [`ComponentTypes`][discord.parts.components.ComponentTypes]."""
+
+@dataclass
+class ChannelSelect(SelectMenu, ActionRowChild, LabelChild):
+    """Represents the Channel Select component."""
+
+    type: int = field(init=False, default=ComponentTypes.CHANNEL_SELECT)
+    """Component type. Always `ComponentTypes.CHANNEL_SELECT` for this class. See [`ComponentTypes`][discord.parts.components.ComponentTypes]."""