scurrypy 0.4__py3-none-any.whl → 0.6.6__py3-none-any.whl

discord/parts/action_row.py

@@ -1,208 +0,0 @@
-from dataclasses import dataclass, field
-from typing import Literal, Optional
-from ..model import DataModel
-
-from .component_types import *
-
-from ..models.emoji import EmojiModel
-
-class _ButtonStyles:
-    """Represents button styles for a Button component."""
-    PRIMARY = 1
-    SECONDARY = 2
-    SUCCESS = 3
-    DANGER = 4
-    LINK = 5
-
-@dataclass
-class _Button(DataModel, ActionRowChild, SectionAccessory):
-    """Represents the Button component."""
-    style: int
-    custom_id: str
-    label: Optional[str] = None
-    emoji: EmojiModel = None
-    url: Optional[str] = None
-    disabled: Optional[bool] = False
-    type: Literal[2] = field(init=False, default=2)
-
-@dataclass
-class _SelectOption(DataModel):
-    """Represents the Select Option component"""
-    label: str
-    value: str
-    description: Optional[str] = None # appears below the label
-    emoji: Optional[EmojiModel] = None
-    default: Optional[bool] = False
-
-@dataclass
-class StringSelect(DataModel, ActionRowChild, LabelChild):
-    """Represents the String Select component."""
-    custom_id: str
-    options: list[_SelectOption] = field(default_factory=list)
-    placeholder: Optional[str] = None
-    min_values: Optional[int] = 0
-    max_values: Optional[int] = 1
-    required: Optional[bool] = False
-    disabled: Optional[bool] = False # does not work on Modals!
-    type: Literal[3] = field(init=False, default=3)
-
-    def add_option(self,
-        *,
-        label: str,
-        value: str,
-        description: str = None,
-        emoji: str | EmojiModel = None,
-        default: bool = False
-    ):
-        """Add an option to this string select component.
-
-        Args:
-            label (str): option text
-            value (str): analogous to button's custom ID
-            description (str, optional): option subtext
-            emoji (str | EmojiModel, optional): string if unicode emoji, EmojiModel if custom
-            default (bool, optional): if this option should be the default option. Defaults to False.
-
-        Returns:
-            (StringSelect): self
-        """
-        if isinstance(emoji, str):
-            emoji = EmojiModel(name=emoji)
-
-        self.options.append(
-            _SelectOption(
-                label=label,
-                value=value,
-                description=description,
-                emoji=emoji,
-                default=default
-            )
-        )
-        return self
-
-@dataclass
-class _DefaultValue(DataModel):
-    """Represents the Default Value for Select components."""
-    id: int   # ID of role, user, or channel
-    type: Literal["role", "user", "channel"]
-
-@dataclass
-class UserSelect(DataModel, ActionRowChild, LabelChild):
-    """Represents the User Select component."""
-    custom_id: str
-    placeholder: Optional[str] = None
-    default_values: list[_DefaultValue] = field(default_factory=list)
-    min_values: Optional[int] = 0
-    max_values: Optional[int] = 1
-    disabled: Optional[bool] = False
-    type: Literal[5] = field(init=False, default=5)
-
-    def add_default_value(self, user_id: int):
-        self.default_values.append(_DefaultValue(user_id, 'user'))
-        return self
-
-@dataclass
-class RoleSelect(DataModel, ActionRowChild, LabelChild):
-    """Represents the Role Select component."""
-    custom_id: str
-    placeholder: Optional[str] = None
-    default_values: list[_DefaultValue] = field(default_factory=list)
-    min_values: Optional[int] = 0
-    max_values: Optional[int] = 1
-    disabled: Optional[bool] = False
-    type: Literal[6] = field(init=False, default=6)
-
-    def add_default_value(self, role_id: int):
-        self.default_values.append(_DefaultValue(role_id, 'role'))
-        return self
-
-@dataclass
-class MentionableSelect(DataModel, ActionRowChild, LabelChild):
-    """Represents the Mentionable Select component."""
-    custom_id: str
-    placeholder: Optional[str] = None
-    default_values: list[_DefaultValue] = field(default_factory=list)
-    min_values: Optional[int] = 0
-    max_values: Optional[int] = 1
-    disabled: Optional[bool] = False
-    type: Literal[7] = field(init=False, default=7)
-
-    def add_default_value(self, role_or_user_id: int, role_or_user: Literal['user', 'role']):
-        self.default_values.append(_DefaultValue(role_or_user_id, role_or_user))
-        return self
-
-@dataclass
-class ChannelSelect(DataModel, ActionRowChild, LabelChild):
-    """Represents the Channel Select component."""
-    custom_id: str
-    placeholder: Optional[str] = None
-    default_values: list[_DefaultValue] = field(default_factory=list)
-    min_values: Optional[int] = 0
-    max_values: Optional[int] = 1
-    disabled: Optional[bool] = False
-    type: Literal[8] = field(init=False, default=8)
-
-    def add_default_value(self, channel_id: int):
-        self.default_values.append(_DefaultValue(channel_id, 'channel'))
-        return self
-
-@dataclass
-class ActionRow(DataModel, ContainerChild):
-    """Represents a container of interactable components."""
-    type: Literal[1] = field(init=False, default=1)
-    components: list[ActionRowChild] = field(default_factory=list)
-
-    def add_button(self, 
-        *,
-        style: Literal['Primary', 'Secondary', 'Success', 'Danger', 'Link'],
-        label: str, 
-        custom_id: str,
-        emoji: str | EmojiModel = None,
-        disable: bool = False
-    ):
-        """Add a button to this action row. (5 per row)
-        
-        Args:
-            style (Literal['Primary', 'Secondary', 'Success', 'Danger', 'Link']): 
-                button style as a string
-            label (str): button text
-            custom_id (str): developer-defined button ID
-            emoji (str | EmojiModel, Optional): str if unicode emoji, EmojiModal if custom
-            disable (bool, Optional): if this button should be pressable. Defaults to False.
-
-        Returns:
-            (ActionRow): self
-        """
-        _styles = {
-            'PRIMARY': _ButtonStyles.PRIMARY,
-            'SECONDARY': _ButtonStyles.SECONDARY,
-            'SUCCESS': _ButtonStyles.SUCCESS,
-            'DANGER': _ButtonStyles.DANGER,
-            'LINK': _ButtonStyles.LINK
-        }
-
-        if isinstance(emoji, str):
-            emoji = EmojiModel(name=emoji)
-
-        self.components.append(
-            _Button(
-                style=_styles.get(style.upper()),
-                label=label,
-                custom_id=custom_id,
-                emoji=emoji,
-                disabled=disable
-            )
-        )
-        return self
-
-    def set_select_menu(self, select: StringSelect | UserSelect | RoleSelect | ChannelSelect | MentionableSelect):
-        """Add a select menu component to this action row. (1 per row)
-
-        Args:
-            select (StringSelect | UserSelect | RoleSelect | ChannelSelect | MentionableSelect): the select menu component
-
-        Returns:
-            (ActionRow): self
-        """
-        self.components.append(select)
-        return self

discord/parts/channel.py

@@ -1,20 +0,0 @@
-from dataclasses import dataclass
-from typing import Optional
-from ..model import DataModel
-
-# NOTE: Supported Channel Types listed here
-class ChannelTypes:
-    """Constants for channel types."""
-    GUILD_TEXT = 0
-    GUILD_CATEGORY = 4
-    GUILD_ANNOUNCEMENT = 5
-
-@dataclass
-class GuildChannel(DataModel):
-    """Parameters for creating/editing a guild channel."""
-    name: Optional[str] = None
-    type: Optional[int] = None
-    topic: Optional[str] = None
-    position: Optional[int] = None
-    parent_id: Optional[int] = None
-    nsfw: Optional[bool] = None

discord/parts/command.py

@@ -1,102 +0,0 @@
-from dataclasses import dataclass, field
-from typing import Literal
-
-from ..model import DataModel
-
-class CommandOptionTypes:
-    """Slash command option input types."""
-
-    STRING = 3
-    """string (text)"""
-
-    INTEGER = 4
-    """integer (whole)"""
-
-    BOOLEAN = 5
-    """boolean (true/false)"""
-
-    USER = 6
-    """user pangination"""
-
-    CHANNEL = 7
-    """channel pangination"""
-
-    ROLE = 8
-    """role pangination"""
-
-    MENTIONABLE = 9
-    """any pangination (role, channel, user)"""
-
-    NUMBER = 10
-    """number (float, integer)"""
-
-    ATTACHMENT = 11
-    """file upload"""
-
-@dataclass
-class MessageCommand(DataModel):
-    """Represents the message command object."""
-    type: Literal[3] = field(init=False, default=3) # MESSAGE
-    name: str
-
-@dataclass
-class UserCommand(DataModel):
-    """Represents the user command object"""
-    type: Literal[2] = field(init=False, default=2) # USER
-    name: str
-
-@dataclass
-class _CommandOption(DataModel):
-    """Option for a slash command."""
-    type: int   # refer to CommandOptionTypes
-    name: str
-    description: str
-    required: bool = True
-
-@dataclass
-class SlashCommand(DataModel):
-    type: Literal[1] = field(init=False, default=1) # CHAT_INPUT
-    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

discord/parts/components_v2.py

@@ -1,353 +0,0 @@
-from dataclasses import dataclass, field
-from typing import Literal, Optional
-from ..model import DataModel
-
-from .component_types import *
-from ..models.emoji import EmojiModel
-
-from .action_row import (
-    StringSelect, 
-    ActionRow, 
-    ChannelSelect, 
-    MentionableSelect, 
-    RoleSelect, 
-    UserSelect, 
-    _Button, 
-    _ButtonStyles
-)
-
-class _TextInputStyles:
-    """Represents the types of Text Inputs."""
-    SHORT = 1 # one line
-    PARAGRAPH = 2 # multiple lines
-
-@dataclass
-class _TextInput(DataModel, LabelChild):
-    """Represents the Text Input component."""
-    type: Literal[4] = field(init=False, default=4)
-    style: _TextInputStyles = _TextInputStyles.SHORT # refer to _TextInputStyles for details
-    custom_id: str = None
-    required: Optional[bool] = False
-    min_length: Optional[int] = None
-    max_length: Optional[int] = None
-    value: Optional[str] = None
-    placeholder: Optional[str] = None
-
-@dataclass
-class Section(DataModel, ContainerChild):
-    """Represents the Section component."""
-    type: Literal[9] = field(init=False, default=9)
-
-    accessory: Optional[SectionAccessory] = None
-    """A component that is contextually associated to the content of the section."""
-
-    components: list[SectionChild] = field(default_factory=list)
-    """Component(s) representing the content of the section that is contextually associated to the accessory"""
-
-    def set_thumbnail(self, media: str, description: str = None, has_spoiler: bool = False):
-        """Set the thumbnail for this section.
-
-        Args:
-            media (str): Image data. http or attachment://<filename> scheme.
-            description (str, optional): Alt text for the media
-            has_spoiler (bool, optional): If the media should be blurred out. Defaults to False.
-
-        Returns:
-            (Section): self
-        """
-        self.accessory = _Thumbnail(media, description, has_spoiler)
-        return self
-
-    def add_text_display(self, content: str):
-        """Add a text display to this section.
-
-        Args:
-            content (str): the content to display
-        
-        Returns:
-            (Section): self
-        """
-        self.components.append(_TextDisplay(content))
-        return self
-
-    def set_button(self, 
-        *,
-        style: Literal['Primary', 'Secondary', 'Success', 'Danger', 'Link'],
-        label: str, 
-        custom_id: str,
-        emoji: str | EmojiModel = None,
-        disable: bool = False
-    ):
-        """Set this section's accessory as a button.
-        
-        Args:
-            style (Literal['Primary', 'Secondary', 'Success', 'Danger', 'Link']): 
-                button style as a string
-            label (str): button text
-            custom_id (str): developer-defined button ID
-            emoji (str | EmojiModel, Optional): str if unicode emoji, EmojiModal if custom
-            disable (bool, Optional): if this button should be pressable. Defaults to False.
-
-        Returns:
-            (Section): self
-        """
-        _styles = {
-            'PRIMARY': _ButtonStyles.PRIMARY,
-            'SECONDARY': _ButtonStyles.SECONDARY,
-            'SUCCESS': _ButtonStyles.SUCCESS,
-            'DANGER': _ButtonStyles.DANGER,
-            'LINK': _ButtonStyles.LINK
-        }
-
-        if isinstance(emoji, str):
-            emoji = EmojiModel(name=emoji)
-
-        self.accessory = _Button(
-            style=_styles.get(style.upper()),
-            label=label,
-            custom_id=custom_id,
-            emoji=emoji,
-            disabled=disable
-        )
-        return self
-
-@dataclass
-class _TextDisplay(DataModel, ContainerChild, SectionChild):
-    """Represents the Text Display component."""
-    type: Literal[10] = field(init=False, default=10)
-    content: str
-
-
-@dataclass
-class _Thumbnail(DataModel, SectionAccessory):
-    """Represents the _Thumbnail component."""
-    type: Literal[11] = field(init=False, default=11)
-    media: str  # http or attachment://<filename>
-    description: Optional[str] = None
-    spoiler: Optional[bool] = False
-
-
-@dataclass
-class MediaGalleryItem(DataModel):
-    """Represents the Media Gallery Item component."""
-
-    media: str
-    """Image data. http or attachment://<filename> scheme."""
-
-    description: Optional[str] = None
-    """Alt text for the media."""
-
-    spoiler: Optional[bool] = False
-    """If the media should be blurred out."""
-
-@dataclass
-class _MediaGallery(DataModel, ContainerChild):
-    """Represents the Media Gallery component."""
-    type: Literal[12] = field(init=False, default=12)
-    items: list[MediaGalleryItem] = field(default_factory=list)
-
-
-@dataclass
-class _File(DataModel, ContainerChild):
-    """Represents the File component."""
-    type: Literal[13] = field(init=False, default=13)
-    file: str # http or attachment://<filename>
-    spoiler: Optional[bool] = False
-
-class _SeparatorTypes:
-    """Represents separator types constants."""
-    SMALL_PADDING = 1
-    LARGE_PADDING = 2
-
-@dataclass
-class _Separator(DataModel, ContainerChild):
-    """Represents the Separator component."""
-    type: Literal[14] = field(init=False, default=14)
-    divider: bool = True
-    spacing: Optional[int] = _SeparatorTypes.SMALL_PADDING # refer to _SeparatorTypes
-
-@dataclass
-class Label(DataModel):
-    """Represents the Discord Label component."""
-
-    label: str
-    """Label text."""
-
-    component: LabelChild = None
-    """A component within the label."""
-
-    description: Optional[str] = None
-    """An optional description text for the label."""
-
-    type: Literal[18] = field(init=False, default=18)
-
-    def set_select_menu(self, select: StringSelect | UserSelect | RoleSelect | ChannelSelect | MentionableSelect):
-        """Set this label to be a select menu component.
-
-        Args:
-            select (StringSelect | UserSelect | RoleSelect | ChannelSelect | MentionableSelect): the select menu component
-
-        Returns:
-            (Label): self
-        """
-        self.component = select
-        return self
-
-    def set_text_input(self,
-        *,
-        custom_id: str,
-        min_length: int,
-        max_length: int,
-        value: str = None,
-        style: Literal['Short', 'Paragraph'] = 'Short',
-        placeholder: str = None,
-        require: bool = False
-    ):
-        """Set this label to be a text input component.
-
-        Args:
-            custom_id (str): developer-defined component ID
-            min_length (int): minimum number of characters required
-            max_length (int): maximum number of characters required
-            value (str, optional): component value
-            style (Literal['Short', 'Paragraph'], optional): 
-                text format. Defaults to 'Short'.
-            placeholder (str, optional): custom placeholder text if empty
-            require (bool, optional): if input is required. Defaults to False.
-
-        Returns:
-            (Label): self
-        """
-        _styles = {
-            'SHORT': _TextInputStyles.SHORT,
-            'PARAGRAPH': _TextInputStyles.PARAGRAPH
-        }
-
-        self.component = _TextInput(
-            style = _styles.get(style.upper()),
-            placeholder=placeholder,
-            custom_id=custom_id,
-            min_length=min_length,
-            max_length=max_length,
-            value=value,
-            required=require
-        )
-        return self
-
-@dataclass
-class Container(DataModel):
-    """Represents a container of display and interactable components."""
-    type: Literal[17] = field(init=False, default=17)
-
-    components: list[ContainerChild] = field(default_factory=list)
-    """Child components that are encapsulated within the Container."""
-
-    accent_color: Optional[int] = None
-    """Color for the accent as an integer."""
-
-    spoiler: Optional[bool] = False
-    """If the container should be blurred out."""
-
-    def set_color(self, hex: str):
-        """Set this container's color with a hex. (format: #FFFFFF)
-
-        Args:
-            hex (str): color as a hex code
-
-        Returns:
-            (Container): self
-        """
-        self.accent_color = int(hex.strip('#'), 16)
-        return self
-
-    def add_row(self, row: ActionRow):
-        """Add an action row to this container.
-
-        Args:
-            row (ActionRow): the ActionRow object
-        
-        Returns:
-            (Container): self
-        """
-        self.components.append(row)
-        return self
-    
-    def add_section(self, section: Section):
-        """Add a section to this container.
-
-        Args:
-            section (Section): the Section object
-        
-        Returns:
-            (Container): self
-        """
-        self.components.append(section)
-        return self
-    
-    def add_text_display(self, content: str):
-        """Add a text display to this container.
-
-        Args:
-            content (str): the content to display
-        
-        Returns:
-            (Container): self
-        """
-        self.components.append(_TextDisplay(content))
-        return self
-    
-    def set_thumbnail(self, media: str, description: str = None, has_spoiler: bool = False):
-        """Set the thumbnail for this container
-
-        Args:
-            media (str): Image data. http or attachment://<filename> scheme.
-            description (str, optional): Alt text for the media
-            has_spoiler (bool, optional): If the media should be blurred out. Defaults to False.
-
-        Returns:
-            (Container): self
-        """
-        self.components.append(_Thumbnail(media, description, has_spoiler))
-        return self
-    
-    def set_media_gallery(self, items: list[MediaGalleryItem]):
-        """Add a media gallery to this container.
-
-        Args:
-            items (list[MediaGalleryItem]): list of media gallery images
-
-        Returns:
-            (Container): self
-        """
-        self.components.append(_MediaGallery(items))
-        return self
-    
-    def add_attachment(self, file: str, has_spoiler: bool = False):
-        """Add a single attachment to this container.
-
-        Args:
-            file (str): Image data. http or attachment://<filename> scheme
-            has_spoiler (bool, optional): If the media should be blurred out. Defaults to False.
-
-        Returns:
-            (Container): self
-        """
-        self.components.append(_File(file, has_spoiler))
-        return self
-    
-    def add_separator(self, spacing: Literal['Small', 'Large'] = 'Small', has_divider: bool = True):
-        """Add a separator to this container. Positionally accurate.
-
-        Args:
-            spacing (Literal['Small', 'Large'], optional): size of separator padding. Defaults to 'Small'.
-            has_divider (bool, optional): if a visual divider should be shown. Defaults to True.
-
-        Returns:
-            (Container): self
-        """
-        _spacing_types = {
-            'SMALL': _SeparatorTypes.SMALL_PADDING,
-            'LARGE': _SeparatorTypes.LARGE_PADDING
-        }
-        self.components.append(_Separator(divider=has_divider, spacing=_spacing_types.get(spacing.upper())))
-        return self