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

discord/parts/components_v2.py

@@ -1,131 +1,57 @@
 from dataclasses import dataclass, field
-from typing import Literal, Optional
+from typing import 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
+class ComponentV2Types:
+    SECTION = 9
+    TEXT_DISPLAY = 10
+    THUMBNAIL = 11
+    MEDIA_GALLERY = 12
+    FILE = 13
+    SEPARATOR = 14
+    CONTAINER = 17
+    LABEL = 18
 
 @dataclass
-class Section(DataModel, ContainerChild):
+class SectionPart(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
+    """Component(s) representing the content of the section that is contextually associated to the accessory."""
+
+    type: int = field(init=False, default=ComponentV2Types.SECTION)
+    """Component type. Always `ComponentV2Types.SECTION` for this class. See [`ComponentV2Types`][discord.parts.components_v2.ComponentV2Types]."""
 
 @dataclass
-class _TextDisplay(DataModel, ContainerChild, SectionChild):
+class TextDisplay(DataModel, ContainerChild, SectionChild):
     """Represents the Text Display component."""
-    type: Literal[10] = field(init=False, default=10)
+
     content: str
+    """Text that will be displayed similar to a message."""
 
+    type: int = field(init=False, default=ComponentV2Types.TEXT_DISPLAY)
+    """Component type. Always `ComponentV2Types.TEXT_DISPLAY` for this class. See [`ComponentV2Types`][discord.parts.components_v2.ComponentV2Types]."""
 
 @dataclass
-class _Thumbnail(DataModel, SectionAccessory):
-    """Represents the _Thumbnail component."""
-    type: Literal[11] = field(init=False, default=11)
-    media: str  # http or attachment://<filename>
+class Thumbnail(DataModel, SectionAccessory):
+    """Represents the Thumbnail component."""
+    
+    media: str
+    """Media of the thumbnail. http or attachment://<filename> scheme."""
+
     description: Optional[str] = None
+    """Description for the media."""
+
     spoiler: Optional[bool] = False
+    """Whether the thumbnail should be a spoiler (or blurred out)."""
 
+    type: int = field(init=False, default=ComponentV2Types.THUMBNAIL)
+    """Component type. Always `ComponentV2Types.THUMBNAIL` for this class. See [`ComponentV2Types`][discord.parts.components_v2.ComponentV2Types]."""
 
 @dataclass
 class MediaGalleryItem(DataModel):
@@ -138,106 +64,56 @@ class MediaGalleryItem(DataModel):
     """Alt text for the media."""
 
     spoiler: Optional[bool] = False
-    """If the media should be blurred out."""
+    """Whether the thumbnail should be a spoiler (or blurred out)."""
 
 @dataclass
-class _MediaGallery(DataModel, ContainerChild):
+class MediaGallery(DataModel, ContainerChild):
     """Represents the Media Gallery component."""
-    type: Literal[12] = field(init=False, default=12)
+
     items: list[MediaGalleryItem] = field(default_factory=list)
+    """1 to 10 nedia gallery items. See [`MediaGalleryItem`][discord.parts.components_v2.MediaGalleryItem]."""
 
+    type: int = field(init=False, default=ComponentV2Types.MEDIA_GALLERY)
+    """Component type. Always `ComponentV2Types.MEDIA_GALLERY` for this class. See [`ComponentV2Types`][discord.parts.components_v2.ComponentV2Types]."""
 
 @dataclass
-class _File(DataModel, ContainerChild):
+class File(DataModel, ContainerChild):
     """Represents the File component."""
-    type: Literal[13] = field(init=False, default=13)
-    file: str # http or attachment://<filename>
+
+    file: str
+    """File name. ONLY supports attachment://<filename> scheme."""
+
     spoiler: Optional[bool] = False
+    """Whether the thumbnail should be a spoiler (or blurred out)."""
+
+    type: int = field(init=False, default=ComponentV2Types.FILE)
+    """Component type. Always `ComponentV2Types.File` for this class. See [`ComponentV2Types`][discord.parts.components_v2.ComponentV2Types]."""
 
-class _SeparatorTypes:
+class SeparatorTypes:
     """Represents separator types constants."""
+
     SMALL_PADDING = 1
+    """Small separator padding."""
+    
     LARGE_PADDING = 2
+    """Large separator padding."""
 
 @dataclass
-class _Separator(DataModel, ContainerChild):
+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."""
+    divider: bool = True
+    """Whether a visual divider should be displayed in the component. Defaults to True."""
 
-    description: Optional[str] = None
-    """An optional description text for the label."""
+    spacing: Optional[int] = SeparatorTypes.SMALL_PADDING
+    """Size of separator padding. Defaults to `SMALL_PADDING`. See [`SeparatorTypes`][discord.parts.components_v2.SeparatorTypes]."""
 
-    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
+    type: int = field(init=False, default=ComponentV2Types.SEPARATOR)
+    """Component type. Always `ComponentV2Types.SEPARATOR` for this class. See [`ComponentV2Types`][discord.parts.components_v2.ComponentV2Types]."""
 
 @dataclass
-class Container(DataModel):
+class ContainerPart(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."""
@@ -246,108 +122,23 @@ class Container(DataModel):
     """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.
+    """If the container should be blurred out. Defaults to False."""
 
-        Args:
-            items (list[MediaGalleryItem]): list of media gallery images
+    type: int = field(init=False, default=ComponentV2Types.CONTAINER)
+    """Component type. Always `ComponentV2Types.CONTAINER` for this class. See [`ComponentV2Types`][discord.parts.components_v2.ComponentV2Types]."""
 
-        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
+@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: int = field(init=False, default=ComponentV2Types.LABEL)
+    """Component type. Always `ComponentV2Types.LABEL` for this class. See [`ComponentV2Types`][discord.parts.components_v2.ComponentV2Types]."""

discord/parts/embed.py

@@ -1,42 +1,58 @@
-from dataclasses import dataclass
+from dataclasses import dataclass, field
 from typing import Optional
-from discord.model import DataModel
-from datetime import datetime, timezone
-from ..models.user import UserModel
+from ..model import DataModel
 
 @dataclass
-class _EmbedAuthor(DataModel):
+class EmbedAuthor(DataModel):
     """Embed author parameters."""
+
     name: str
+    """Name of the author."""
+
     url: Optional[str] = None
+    """URL of the author. http or attachment://<filename> scheme."""
+
     icon_url: Optional[str] = None
+    """URL of author's icon. http or attachment://<filename> scheme."""
 
 @dataclass
-class _EmbedThumbnail(DataModel):
+class EmbedThumbnail(DataModel):
     """Embed thumbnail."""
+
     url: str
+    """Thumbnail content. http or attachment://<filename> scheme."""
 
 @dataclass
-class _EmbedImage(DataModel):
+class EmbedField(DataModel):
+    """Embed field."""
+
+    name: str
+    """Name of the field."""
+
+    value: str
+    """Value of the field."""
+
+    inline: Optional[bool] = None
+    """Whether or not this field should display inline."""
+
+@dataclass
+class EmbedImage(DataModel):
     """Embed image."""
+
     url: str
+    """Image content. http or attachment://<filename> scheme."""
 
 @dataclass
-class _EmbedFooter(DataModel):
+class EmbedFooter(DataModel):
     """Embed footer."""
     text: str
-    url: Optional[str] = None
-    icon_url: Optional[str] = None
+    """Footer text."""
 
-@dataclass
-class _EmbedField(DataModel):
-    """Embed field."""
-    name: str
-    value: str
-    inline: Optional[bool] = None
+    icon_url: Optional[str] = None
+    """URL of the footer icon. http or attachment://<filename> scheme."""
 
 @dataclass
-class EmbedBuilder(DataModel):
+class EmbedPart(DataModel):
     """Represents the Embed portion of a message."""
 
     title: Optional[str] = None
@@ -51,104 +67,17 @@ class EmbedBuilder(DataModel):
     color: Optional[int] = None
     """Embed's accent color."""
 
-    author: Optional[_EmbedAuthor] = None
+    author: Optional[EmbedAuthor] = None
     """Embed's author."""
 
-    thumbnail: Optional[_EmbedThumbnail] = None
+    thumbnail: Optional[EmbedThumbnail] = None
     """Embed's thumbnail attachment."""
 
-    image: Optional[_EmbedImage] = None
+    image: Optional[EmbedImage] = None
     """Embed's image attachment."""
 
-    fields: Optional[list[_EmbedField]] = None
+    fields: Optional[list[EmbedField]] = field(default_factory=list)
     """List of embed's fields."""
 
-    footer: Optional[_EmbedFooter] = None
+    footer: Optional[EmbedFooter] = None
     """Embed's footer."""
-
-    def set_color(self, hex: str):
-        """Set this embed's color with a hex.
-
-        Args:
-            hex (str): color as a hex code (format: #FFFFFF)
-
-        Returns:
-            (EmbedBuilder): self
-        """
-        self.color=int(hex.strip('#'), 16)
-        return self
-    
-    def set_user_author(self, user: UserModel):
-        """Set this embed's author.
-
-        Args:
-            user (UserModel): the user model
-
-        Returns:
-            (EmbedBuilder): self
-        """
-        self.author = _EmbedAuthor(
-            name=user.username,
-            icon_url=f"https://cdn.discordapp.com/avatars/{user.id}/{user.avatar}.png"
-        )
-        return self
-    
-    def set_image(self, url: str):
-        """Set this embed's image.
-
-        Args:
-            url (str): attachment://<file> scheme or http(s) URL
-
-        Returns:
-            (EmbedBuilder): self
-        """
-        self.image = _EmbedImage(url=url)
-        return self
-    
-    def set_thumbnail(self, url: str):
-        """Set this embed's thumbnail.
-
-        Args:
-            url (str): attachment://<file> scheme or http(s) URL
-
-        Returns:
-            (EmbedBuilder): self
-        """
-        self.thumbnail = _EmbedThumbnail(url=url)
-        return self
-    
-    def set_footer(self, text: str, icon_url: str = None):
-        """Set this embed's footer.
-
-        Args:
-            text (str): footer's text
-            icon_url (str, optional): attachment://<file> scheme or http(s) URL.
-
-        Returns:
-            (EmbedBuilder): self
-        """
-        self.footer = _EmbedFooter(text=text, icon_url=icon_url)
-        return self
-    
-    def add_field(self, name: str, value: str, is_inline: bool = False):
-        """Add a field to this embed.
-
-        Args:
-            name (str): field's title
-            value (str): field's text
-            is_inline (bool): if this field should be inlined
-
-        Returns:
-            (EmbedBuilder): self
-        """
-        self.fields.append(_EmbedField(name=name, value=value, inline=is_inline))
-        return self
-    
-    def set_timestamp(self):
-        """Set this embed's timestamp.
-
-        Returns:
-            (EmbedBuilder): self
-        """
-        self.timestamp = datetime.now(timezone.utc).isoformat()
-        return self