scurrypy 0.1.0__py3-none-any.whl

discord/parts/components_v2.py

@@ -0,0 +1,270 @@
+from dataclasses import dataclass, field
+from typing import Literal, Optional
+from ..model import DataModel
+
+from .component_types import *
+from .action_row import StringSelect, ActionRow
+
+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
+    components: list[SectionChild] = field(default_factory=list)
+
+@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 string_select(self, select: StringSelect):
+        """Set this label to be a string select component.
+
+        Args:
+            select (StringSelect): the string select component
+
+        Returns:
+            (Label): self
+        """
+        self.component = select
+        return self
+
+    def 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

discord/parts/embed.py

@@ -0,0 +1,154 @@
+from dataclasses import dataclass
+from typing import Optional
+from discord.model import DataModel
+from datetime import datetime, timezone
+from ..models.user import UserModel
+
+@dataclass
+class _EmbedAuthor(DataModel):
+    """Embed author parameters."""
+    name: str
+    url: Optional[str] = None
+    icon_url: Optional[str] = None
+
+@dataclass
+class _EmbedThumbnail(DataModel):
+    """Embed thumbnail."""
+    url: str
+
+@dataclass
+class _EmbedImage(DataModel):
+    """Embed image."""
+    url: str
+
+@dataclass
+class _EmbedFooter(DataModel):
+    """Embed footer."""
+    text: str
+    url: Optional[str] = None
+    icon_url: Optional[str] = None
+
+@dataclass
+class _EmbedField(DataModel):
+    """Embed field."""
+    name: str
+    value: str
+    inline: Optional[bool] = None
+
+@dataclass
+class EmbedBuilder(DataModel):
+    """Represents the Embed portion of a message."""
+
+    title: Optional[str] = None
+    """This embed's title."""
+
+    description: Optional[str] = None
+    """This embed's description."""
+
+    timestamp: Optional[str] = None
+    """Timestamp of when the embed was sent."""
+
+    color: Optional[int] = None
+    """Embed's accent color."""
+
+    author: Optional[_EmbedAuthor] = None
+    """Embed's author."""
+
+    thumbnail: Optional[_EmbedThumbnail] = None
+    """Embed's thumbnail attachment."""
+
+    image: Optional[_EmbedImage] = None
+    """Embed's image attachment."""
+
+    fields: Optional[list[_EmbedField]] = None
+    """List of embed's fields."""
+
+    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

discord/parts/message.py

@@ -0,0 +1,179 @@
+import os
+from dataclasses import dataclass, field
+from typing import Optional, TypedDict, Unpack, Literal
+from discord.model import DataModel
+from .embed import EmbedBuilder
+from .action_row import ActionRow
+from .components_v2 import Container
+from .attachment import _Attachment
+
+class MessageFlags:
+    """Flags that can be applied to a message."""
+    CROSSPOSTED = 1 << 0
+    """Message has been published."""
+
+    IS_CROSSPOST = 1 << 1
+    """Message originated from another channel."""
+
+    SUPPRESS_EMBEDS = 1 << 2
+    """Hide embeds (if any)."""
+
+    EPHEMERAL = 1 << 6
+    """Only visible to the invoking user."""
+
+    LOADING = 1 << 7
+    """Thinking response."""
+
+    IS_COMPONENTS_V2 = 1 << 15
+    """This message includes Discord's V2 Components."""
+
+class MessageFlagParams(TypedDict, total=False):
+    """Parameters for setting message flags."""
+    crossposted: bool
+    is_crosspost: bool
+    suppress_embeds: bool
+    ephemeral: bool
+    loading: bool
+    is_components_v2: bool
+
+@dataclass
+class _MessageReference(DataModel):
+    message_id: int
+    channel_id: int
+    type: int = 0
+
+@dataclass
+class MessageBuilder(DataModel):
+    """Describes expected params when editing/creating a message."""
+
+    content: Optional[str] = None
+    """Message text content."""
+
+    flags: Optional[int] = 0
+    """Message flags. See [`MessageFlags`][discord.parts.message.MessageFlags] for details."""
+
+    components: Optional[list[ActionRow | Container]] = field(default_factory=list)
+    """Components to be attached to this message."""
+
+    attachments: Optional[list[_Attachment]] = field(default_factory=list)
+    """Attachments to be attached to this message."""
+
+    embeds: Optional[list[EmbedBuilder]] = field(default_factory=list)
+    """Embeds to be attached to this message."""
+
+    message_reference: Optional[_MessageReference] = None
+    """Message reference if reply."""
+
+    def add_row(self, row: ActionRow):
+        """Add an action row to this message.
+
+        Args:
+            row (ActionRow): the ActionRow object
+
+        Returns:
+            (MessageBuilder): self
+        """
+        self.components.append(row)
+        return self
+    
+    def add_container(self, container: Container, *, has_container_boarder: bool = False):
+        """Add a container to this message.
+
+        Args:
+            container (Container): the Container object.
+            has_container_boarder (bool, optional): If message should be contained in an Embed-like container. Defaults to False.
+
+        Returns:
+            (MessageBuilder): self
+        """
+        if has_container_boarder:
+            self.components.append(container)
+        else:
+            self.components.extend(container.components)
+        return self
+    
+    def add_embed(self, embed: EmbedBuilder):
+        """Add an embed to this message.
+
+        Args:
+            embed (EmbedBuilder): The EmbedBuilder object.
+
+        Returns:
+            (MessageBuilder): self
+        """
+        self.embeds.append(embed)
+        return self
+
+    def add_attachment(self, file_path: str, description: str = None):
+        """Add an attachment to this message
+
+        Args:
+            file_path (str): full qualifying path to file
+            description (str, optional): file descriptor. Defaults to None.
+
+        Returns:
+            (MessageBuilder): self
+        """
+        self.attachments.append(
+            _Attachment(
+                id=len(self.attachments), 
+                filename=os.path.basename(file_path), 
+                path=file_path,
+                description=description
+            )
+        )
+        return self
+    
+    def set_flags(self, **flags: Unpack[MessageFlagParams]):
+        """Set this message's flags using MessageFlagParams.
+
+        Args:
+            flags (Unpack[MessageFlagParams]): message flags to set. (set respective flag to True to toggle.)
+
+        Raises:
+            (ValueError): invalid flag
+
+        Returns:
+            (MessageBuilder): self
+        """
+        _flag_map = {
+            'crossposted': MessageFlags.CROSSPOSTED,
+            'is_crosspost': MessageFlags.IS_CROSSPOST,
+            'suppress_embeds': MessageFlags.SUPPRESS_EMBEDS,
+            'ephemeral': MessageFlags.EPHEMERAL,
+            'loading': MessageFlags.LOADING,
+            'is_components_v2': MessageFlags.IS_COMPONENTS_V2,
+        }
+
+        # each flag maps to a specific combined bit!
+        for name, value in flags.items():
+            if name not in _flag_map:
+                raise ValueError(f"Invalid flag: {name}")
+            if value:
+                self.flags |= _flag_map[name]
+                
+        return self
+
+    def _set_reference(self, 
+        message_id: int, 
+        channel_id: int,
+        ref_type: Literal['Default', 'Forward'] = 'Default'
+    ):
+        """Internal helper for setting this message's reference message. Used in replies.
+
+        Args:
+            message_id (int): message to reference
+
+        Returns:
+            (MessageBuilder): self
+        """
+        _ref_types = {
+            'DEFAULT': 0,
+            'FORWARD': 1
+        }
+        self.message_reference = _MessageReference(
+            type=_ref_types.get(ref_type.upper()), 
+            channel_id=channel_id,
+            message_id=message_id
+        )
+        return self

discord/parts/modal.py

@@ -0,0 +1,21 @@
+from dataclasses import dataclass, field
+from discord.model import DataModel
+from .components_v2 import Label
+
+@dataclass
+class ModalBuilder(DataModel):
+    title: str
+    custom_id: str = None
+    components: list[Label] = field(default_factory=list)
+
+    def add_label(self, component: Label):
+        """Add a label component to this modal.
+
+        Args:
+            component (Label): the label component
+
+        Returns:
+            ModalBuilder: self
+        """
+        self.components.append(component)
+        return self

discord/parts/role.py

@@ -0,0 +1,39 @@
+from dataclasses import dataclass
+from typing import Optional
+from discord.model import DataModel
+
+from ..models.role import RoleColors
+
+@dataclass
+class Role(DataModel):
+    """Parameters for creating/editing a role."""
+
+    colors: RoleColors
+    """Colors of the role."""
+
+    name: str = None
+    """Name of the role."""
+
+    permissions: int = 0
+    """Permission bit set."""
+
+    hoist: bool = False
+    """If the role is pinned in the user listing."""
+
+    mentionable: bool = False
+    """If the role is mentionable."""
+
+    unicode_emoji: Optional[str] = None
+    """Unicode emoji of the role."""
+
+    def set_color(self, hex: str):
+        """Set this role's color with a hex. (format: #FFFFFF)
+
+        Args:
+            hex (str): color as a hex code
+
+        Returns:
+            (Role): self
+        """
+        self.color=int(hex.strip('#'), 16)
+        return self

discord/resources/__init__.py

@@ -0,0 +1,10 @@
+# discord/resources
+
+from .guild import Guild
+from .channel import Channel
+from .message import Message
+from .bot_emojis import BotEmojis
+from .user import User
+from .interaction import Interaction
+from .application import Application
+from .interaction import Interaction