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

scurrypy/__init__.py

@@ -0,0 +1,376 @@
+# scurrypy
+
+import importlib
+from typing import TYPE_CHECKING
+
+__all__ = [
+    "Logger",
+    "Client",
+    "Intents",
+    "set_intents",
+    "BaseConfig",
+
+    "InteractionTypes",  
+
+    "ReadyEvent",
+
+    "ReactionAddEvent",
+    "ReactionRemoveEvent",
+    "ReactionRemoveEmojiEvent",
+    "ReactionRemoveAllEvent",
+
+    "GuildCreateEvent",
+    "GuildUpdateEvent",
+    "GuildDeleteEvent",
+
+    "MessageCreateEvent",
+    "MessageUpdateEvent",
+    "MessageDeleteEvent",
+
+    "GuildChannelCreateEvent",
+    "GuildChannelUpdateEvent",
+    "GuildChannelDeleteEvent",
+    "ChannelPinsUpdateEvent",
+
+    "InteractionEvent",
+
+    "ApplicationModel",
+    "EmojiModel",
+    "GuildModel",
+    "MemberModel",
+    "UserModel",
+    "RoleModel",
+
+    "ChannelTypes",
+    "GuildChannel",
+
+    "CommandTypes",
+    "CommandOptionTypes",
+    "SlashCommand",
+    "UserCommand",
+    "MessageCommand",
+
+    "ComponentV2Types",
+    "SectionPart",
+    "TextDisplay",
+    "Thumbnail",
+    "MediaGalleryItem",
+    "MediaGallery",
+    "File",
+    "SeparatorTypes",
+    "Separator",
+    "ContainerPart",
+    "Label",
+
+    "ComponentTypes",
+    "ActionRowPart",
+    "ButtonStyles",
+    "Button",
+    "SelectOption",
+    "StringSelect",
+    "TextInputStyles",
+    "TextInput",
+    "DefaultValue",
+    "UserSelect",
+    "RoleSelect",
+    "MentionableSelect",
+    "ChannelSelect",
+
+    "EmbedAuthor",
+    "EmbedThumbnail",
+    "EmbedField",
+    "EmbedImage",
+    "EmbedFooter",
+    "EmbedPart",
+    
+    "MessageFlags",
+    "MessageReferenceTypes",
+    "MessageReference",
+    "Attachment",
+    "MessagePart",
+
+    "ModalPart",
+    "Role",
+
+    "ApplicationFlags",
+    "Application",
+
+    "BotEmojis",
+
+    "PinnedMessage",
+    "Channel",
+
+    "Guild",
+
+    "InteractionCallbackTypes",
+    "Interaction",
+    
+    "Message",
+    
+    "User",
+]
+
+# For editor support / autocomplete
+if TYPE_CHECKING:
+    from .logger import Logger
+    from .client import Client
+    from .intents import Intents, set_intents
+    from .config import BaseConfig
+
+    from .dispatch.command_dispatcher import InteractionTypes
+
+    # events
+    from .events.ready_event import ReadyEvent
+    from .events.reaction_events import (
+        ReactionAddEvent,
+        ReactionRemoveEvent,
+        ReactionRemoveEmojiEvent,
+        ReactionRemoveAllEvent,
+    )
+    from .events.guild_events import (
+        GuildCreateEvent,
+        GuildUpdateEvent,
+        GuildDeleteEvent,
+    )
+    from .events.message_events import (
+        MessageCreateEvent,
+        MessageUpdateEvent,
+        MessageDeleteEvent,
+    )
+    from .events.channel_events import (
+        GuildChannelCreateEvent,
+        GuildChannelUpdateEvent,
+        GuildChannelDeleteEvent,
+        ChannelPinsUpdateEvent,
+    )
+    from .events.interaction_events import InteractionEvent
+
+    # models
+    from .models.application import ApplicationModel
+    from .models.emoji import EmojiModel
+    from .models.guild import GuildModel
+    from .models.member import MemberModel
+    from .models.user import UserModel
+    from .models.role import RoleModel
+
+    # parts
+    from .parts.channel import (
+        ChannelTypes, 
+        GuildChannel
+    )
+
+    from .parts.command import (
+        CommandTypes,
+        CommandOptionTypes,
+        SlashCommand, 
+        UserCommand,
+        MessageCommand
+    )
+
+    from .parts.components_v2 import (
+        ComponentV2Types,
+        SectionPart,
+        TextDisplay,
+        Thumbnail,
+        MediaGalleryItem,
+        MediaGallery,
+        File,
+        SeparatorTypes,
+        Separator,
+        ContainerPart,
+        Label
+    )
+
+    from .parts.components import (
+        ComponentTypes,
+        ActionRowPart, 
+        ButtonStyles,
+        Button,
+        SelectOption,
+        StringSelect,
+        TextInputStyles,
+        TextInput,
+        DefaultValue,
+        # SelectMenu,
+        UserSelect,
+        RoleSelect,
+        MentionableSelect,
+        ChannelSelect
+    )
+
+    from .parts.embed import (
+        EmbedAuthor,
+        EmbedThumbnail,
+        EmbedField,
+        EmbedImage,
+        EmbedFooter,
+        EmbedPart
+    )
+
+    from .parts.message import (
+        MessageFlags,
+        # MessageFlagParams,
+        MessageReferenceTypes,
+        MessageReference,
+        Attachment,
+        MessagePart
+    )
+
+    from .parts.modal import ModalPart
+    from .parts.role import Role
+
+    # resources
+    from .resources.application import (
+        ApplicationFlags,
+        Application
+    )
+
+    from .resources.bot_emojis import BotEmojis
+
+    from .resources.channel import (
+        # MessagesFetchParams,
+        # PinsFetchParams,
+        # ThreadFromMessageParams,
+        PinnedMessage,
+        Channel
+    )
+
+    from .resources.guild import (
+        # FetchGuildMembersParams,
+        # FetchGuildParams,
+        Guild
+    )
+
+    from .resources.interaction import (
+        # InteractionDataTypes,
+        InteractionCallbackTypes,
+        Interaction
+    )
+
+    from .resources.message import Message
+
+    from .resources.user import (
+        # FetchUserGuildsParams,
+        User
+    )
+
+# Lazy loader
+def __getattr__(name: str):
+    if name not in __all__:
+        raise AttributeError(f"module {__name__} has no attribute {name}")
+
+    mapping = {
+        # top-level
+        "Logger": "scurrypy.logger",
+        "Client": "scurrypy.client",
+        "Intents": "scurrypy.intents",
+        "set_intents": "scurrypy.intents",
+        "BaseConfig": "scurrypy.config",
+
+        'InteractionTypes': "scurrypy.dispatch.command_dispatcher",
+
+        "ReadyEvent": "scurrypy.events.ready_event",
+        
+        "ReactionAddEvent": "scurrypy.events.reaction_events",
+        "ReactionRemoveEvent": "scurrypy.events.reaction_events",
+        "ReactionRemoveEmojiEvent": "scurrypy.events.reaction_events",
+        "ReactionRemoveAllEvent": "scurrypy.events.reaction_events",
+
+        "GuildCreateEvent": "scurrypy.events.guild_events",
+        "GuildUpdateEvent": "scurrypy.events.guild_events",
+        "GuildDeleteEvent": "scurrypy.events.guild_events",
+
+        "MessageCreateEvent": "scurrypy.events.message_events",
+        "MessageUpdateEvent": "scurrypy.events.message_events",
+        "MessageDeleteEvent": "scurrypy.events.message_events",
+
+        "GuildChannelCreateEvent": "scurrypy.events.channel_events",
+        "GuildChannelUpdateEvent": "scurrypy.events.channel_events",
+        "GuildChannelDeleteEvent": "scurrypy.events.channel_events",
+        "ChannelPinsUpdateEvent": "scurrypy.events.channel_events",
+
+        "InteractionEvent": "scurrypy.events.interaction_events",
+
+        'ApplicationModel': "scurrypy.models.application",
+        'EmojiModel': "scurrypy.models.emoji",
+        'GuildModel': "scurrypy.models.guild",
+        'MemberModel': "scurrypy.models.member",
+        'UserModel': "scurrypy.models.user",
+        'RoleModel': "scurrypy.models.role",
+
+        'ChannelTypes': "scurrypy.parts.channel",
+        'GuildChannel': "scurrypy.parts.channel",
+
+        'CommandTypes': "scurrypy.parts.command",
+        'CommandOptionTypes': "scurrypy.parts.command",
+        'SlashCommand': "scurrypy.parts.command",
+        'UserCommand': "scurrypy.parts.command",
+        'MessageCommand': "scurrypy.parts.command",
+
+        'ComponentV2Types': "scurrypy.parts.components_v2",
+        'SectionPart': "scurrypy.parts.components_v2",
+        'TextDisplay': "scurrypy.parts.components_v2",
+        'Thumbnail': "scurrypy.parts.components_v2",
+        'MediaGalleryItem': "scurrypy.parts.components_v2",
+        'MediaGallery': "scurrypy.parts.components_v2",
+        'File': "scurrypy.parts.components_v2",
+        'SeparatorTypes': "scurrypy.parts.components_v2",
+        'Separator': "scurrypy.parts.components_v2",
+        'ContainerPart': "scurrypy.parts.components_v2",
+        'Label': "scurrypy.parts.components_v2",
+
+        'ComponentTypes': "scurrypy.parts.components",
+        'ActionRowPart': "scurrypy.parts.components",
+        'ButtonStyles': "scurrypy.parts.components",
+        'Button': "scurrypy.parts.components",
+        'SelectOption': "scurrypy.parts.components",
+        'StringSelect': "scurrypy.parts.components",
+        'TextInputStyles': 'scurrypy.parts.components',
+        'TextInput': "scurrypy.parts.components",
+        'DefaultValue': "scurrypy.parts.components",
+        'UserSelect': "scurrypy.parts.components",
+        'RoleSelect': "scurrypy.parts.components",
+        'MentionableSelect': "scurrypy.parts.components",
+        'ChannelSelect': "scurrypy.parts.components",
+        
+        'EmbedAuthor': "scurrypy.parts.embed",
+        'EmbedThumbnail': "scurrypy.parts.embed",
+        'EmbedField': "scurrypy.parts.embed",
+        'EmbedImage': "scurrypy.parts.embed",
+        'EmbedFooter': "scurrypy.parts.embed",
+        'EmbedPart': "scurrypy.parts.embed",
+
+        'MessageFlags': "scurrypy.parts.message",
+        'MessageReferenceTypes': "scurrypy.parts.message",
+        'MessageReference': "scurrypy.parts.message",
+        'Attachment': "scurrypy.parts.message",
+        'MessagePart': "scurrypy.parts.message",
+
+        'ModalPart': "scurrypy.parts.modal",
+        'Role': "scurrypy.parts.role",
+
+        'ApplicationFlags': "scurrypy.resources.application",
+        'Application': "scurrypy.resources.application",
+
+        'BotEmojis': "scurrypy.resources.bot_emojis",
+
+        'PinnedMessage': "scurrypy.resources.channel",
+        'Channel': "scurrypy.resources.channel",
+
+        'Guild': "scurrypy.resources.guild",
+
+        'InteractionCallbackTypes': "scurrypy.resources.interaction",
+        'Interaction': "scurrypy.resources.interaction",
+
+        'Message': "scurrypy.resources.message",
+        
+        'User': "scurrypy.resources.user"
+    }
+
+    module = importlib.import_module(mapping[name])
+    attr = getattr(module, name)
+    globals()[name] = attr  # cache it for future lookups
+    return attr
+
+def __dir__():
+    return sorted(list(globals().keys()) + __all__)

{discord → scurrypy}/client_like.py

@@ -5,7 +5,7 @@ from .http import HTTPClient
 from .logger import Logger
 
 class ClientLike(Protocol):
-    """Exposes a common interface for [`Client`][discord.client.Client]."""
+    """Exposes a common interface for [`Client`][scurrypy.client.Client]."""
     application_id: int
     """Bot's application ID."""
 

{discord → scurrypy}/dispatch/command_dispatcher.py

@@ -1,3 +1,5 @@
+import fnmatch
+
 from ..client_like import ClientLike
 
 from ..events.interaction_events import ApplicationCommandData, MessageComponentData, ModalData, InteractionEvent
@@ -23,7 +25,7 @@ class CommandDispatcher:
         InteractionTypes.MESSAGE_COMPONENT: MessageComponentData,
         InteractionTypes.MODAL_SUBMIT: ModalData
     }
-    """Maps [`InteractionTypes`][discord.dispatch.command_dispatcher.InteractionTypes] to their respective dataclass."""
+    """Maps [`InteractionTypes`][scurrypy.dispatch.command_dispatcher.InteractionTypes] to their respective dataclass."""
 
     def __init__(self, client: ClientLike):
         self.application_id = client.application_id
@@ -64,7 +66,7 @@ class CommandDispatcher:
             await self._http.request(
                 'PUT', 
                 f"applications/{self.application_id}/guilds/{guild_id}/commands", 
-                data=[command._to_dict() for command in cmds]
+                data=[command.to_dict() for command in cmds]
             )
     
     async def _register_global_commands(self, commands: list):
@@ -74,7 +76,7 @@ class CommandDispatcher:
             commands (list): list of serialized commands
         """
 
-        global_commands = [command._to_dict() for command in commands]
+        global_commands = [command.to_dict() for command in commands]
 
         await self._http.request('PUT', f"applications/{self.application_id}/commands", data=global_commands)
 
@@ -146,11 +148,17 @@ class CommandDispatcher:
 
             case InteractionTypes.MESSAGE_COMPONENT:
                 name = event.data.custom_id
-                handler = self._component_handlers.get(name)
+                for k, v in self._component_handlers.items():
+                    if fnmatch.fnmatch(name, k) == True:
+                        handler = v
+                # handler = self._component_handlers.get(name)
 
             case InteractionTypes.MODAL_SUBMIT:
                 name = event.data.custom_id
-                handler = self._component_handlers.get(name)
+                for k, v in self._component_handlers.items():
+                    if fnmatch.fnmatch(name, k) == True:
+                        handler = v
+                # handler = self._component_handlers.get(name)
 
         if not handler:
             self._logger.log_warn(f"No handler registered for interaction '{name}'")

{discord → scurrypy}/dispatch/event_dispatcher.py

@@ -7,25 +7,25 @@ class EventDispatcher:
     """Central hub for handling Discord Gateway events."""
 
     RESOURCE_MAP = { # maps discord events to their respective dataclass (lazy loading)
-        'READY': ('discord.events.ready_event', 'ReadyEvent'),
+        'READY': ('scurrypy.events.ready_event', 'ReadyEvent'),
 
-        'GUILD_CREATE': ('discord.events.guild_events', 'GuildCreateEvent'),
-        'GUILD_UPDATE': ('discord.events.guild_events', 'GuildUpdateEvent'),
-        'GUILD_DELETE': ('discord.events.guild_events', 'GuildDeleteEvent'),
+        'GUILD_CREATE': ('scurrypy.events.guild_events', 'GuildCreateEvent'),
+        'GUILD_UPDATE': ('scurrypy.events.guild_events', 'GuildUpdateEvent'),
+        'GUILD_DELETE': ('scurrypy.events.guild_events', 'GuildDeleteEvent'),
 
-        'CHANNEL_CREATE': ('discord.events.channel_events', 'GuildChannelCreateEvent'),
-        'CHANNEL_UPDATE': ('discord.events.channel_events', 'GuildChannelUpdateEvent'),
-        'CHANNEL_DELETE': ('discord.events.channel_events', 'GuildChannelDeleteEvent'),
-        'CHANNEL_PINS_UPDATE': ('discord.events.channel_events', 'ChannelPinsUpdateEvent'),
+        'CHANNEL_CREATE': ('scurrypy.events.channel_events', 'GuildChannelCreateEvent'),
+        'CHANNEL_UPDATE': ('scurrypy.events.channel_events', 'GuildChannelUpdateEvent'),
+        'CHANNEL_DELETE': ('scurrypy.events.channel_events', 'GuildChannelDeleteEvent'),
+        'CHANNEL_PINS_UPDATE': ('scurrypy.events.channel_events', 'ChannelPinsUpdateEvent'),
 
-        'MESSAGE_CREATE': ('discord.events.message_events', 'MessageCreateEvent'),
-        'MESSAGE_UPDATE': ('discord.events.message_events', 'MessageUpdateEvent'),
-        'MESSAGE_DELETE': ('discord.events.message_events', 'MessageDeleteEvent'),
+        'MESSAGE_CREATE': ('scurrypy.events.message_events', 'MessageCreateEvent'),
+        'MESSAGE_UPDATE': ('scurrypy.events.message_events', 'MessageUpdateEvent'),
+        'MESSAGE_DELETE': ('scurrypy.events.message_events', 'MessageDeleteEvent'),
         
-        'MESSAGE_REACTION_ADD': ('discord.events.reaction_events', 'ReactionAddEvent'),
-        'MESSAGE_REACTION_REMOVE': ('discord.events.reaction_events', 'ReactionRemoveEvent'),
-        'MESSAGE_REACTION_REMOVE_ALL': ('discord.events.reaction_events', 'ReactionRemoveAllEvent'),
-        'MESSAGE_REACTION_REMOVE_EMOJI': ('discord.events.reaction_events', 'ReactionRemoveEmojiEvent'),
+        'MESSAGE_REACTION_ADD': ('scurrypy.events.reaction_events', 'ReactionAddEvent'),
+        'MESSAGE_REACTION_REMOVE': ('scurrypy.events.reaction_events', 'ReactionRemoveEvent'),
+        'MESSAGE_REACTION_REMOVE_ALL': ('scurrypy.events.reaction_events', 'ReactionRemoveAllEvent'),
+        'MESSAGE_REACTION_REMOVE_EMOJI': ('scurrypy.events.reaction_events', 'ReactionRemoveEmojiEvent'),
 
         # and other events...
     }

{discord → scurrypy}/events/channel_events.py

@@ -46,7 +46,7 @@ class GuildChannelDeleteEvent(GuildChannelEvent):
     pass
 
 @dataclass
-class ChannelPinsUpdateEvent:
+class ChannelPinsUpdateEvent(DataModel):
     """Pin update event."""
     channel_id: int
     """ID of channel where the pins were updated."""

{discord → scurrypy}/events/interaction_events.py

@@ -3,17 +3,19 @@ from typing import Optional
 from ..model import DataModel
 
 from ..resources.interaction import Interaction
+from ..parts.components import ComponentTypes
 
 # ----- Command Interaction -----
 
 @dataclass
 class ApplicationCommandOptionData(DataModel):
     """Represents the response options from a slash command."""
+    
     name: str
     """Name of the command option."""
 
     type: int
-    """Type of command option. See [`CommandOptionTypes`][discord.parts.command.CommandOptionTypes]."""
+    """Type of command option. See [`CommandOptionTypes`][scurrypy.parts.command.CommandOptionTypes]."""
 
     value: str | int | float | bool
     """Input value for option."""
@@ -21,6 +23,7 @@ class ApplicationCommandOptionData(DataModel):
 @dataclass
 class ApplicationCommandData(DataModel):
     """Represents the response from a command."""
+
     id: int
     """ID of the command."""
 
@@ -39,7 +42,7 @@ class ApplicationCommandData(DataModel):
     options: Optional[list[ApplicationCommandOptionData]] = field(default_factory=list)
     """Options of the command (slash command only)."""
 
-    def get_command_option_value(self, option_name: str):
+    def get_command_option_value(self, option_name: str, default = None):
         """Get the input for a command option by name.
 
         Args:
@@ -52,12 +55,13 @@ class ApplicationCommandData(DataModel):
             (str | int | float | bool): input data of specified option
         """
         for option in self.options:
-            if option_name != option.name:
-                continue
-
-            return option.value
+            if option.name == option_name:
+                return option.value
         
-        raise ValueError(f"Option name '{option_name}' could not be found.")
+        if default is not None:
+            return default
+        
+        raise ValueError(f"Option '{option_name}' not found")
 
 # ----- Component Interaction -----
 
@@ -79,6 +83,7 @@ class MessageComponentData(DataModel):
 @dataclass
 class ModalComponentData(DataModel):
     """Represents the modal field response from a modal."""
+
     type: int
     """Type of component."""
     
@@ -94,6 +99,7 @@ class ModalComponentData(DataModel):
 @dataclass
 class ModalComponent(DataModel):
     """Represents the modal component response from a modal."""
+
     type: int
     """Type of component."""
 
@@ -128,7 +134,13 @@ class ModalData(DataModel):
 
             t = component.component.type
 
-            if t in [3,5,6,7,8]: # select menus (w. possibly many option selects!)
+            if t in [
+                ComponentTypes.STRING_SELECT, 
+                ComponentTypes.USER_SELECT, 
+                ComponentTypes.ROLE_SELECT, 
+                ComponentTypes.MENTIONABLE_SELECT, 
+                ComponentTypes.CHANNEL_SELECT      # select menus (w. possibly many option selects!)
+            ]:
                 return component.component.values
             
             # text input
@@ -141,7 +153,7 @@ class InteractionEvent(DataModel):
     """Represents the interaction response."""
 
     interaction: Interaction
-    """Interaction resource object. See [`Interaction`][discord.resources.interaction.Interaction]."""
+    """Interaction resource object. See [`Interaction`][scurrypy.resources.interaction.Interaction]."""
 
     data: Optional[ApplicationCommandData | MessageComponentData | ModalData] = None
     """Interaction response data."""

{discord → scurrypy}/events/message_events.py

@@ -9,25 +9,25 @@ from ..models.member import MemberModel
 class MessageCreateEvent(DataModel):
     """Received when a message is created."""
     message: Message
-    """Message resource object. See [`Resource.Message`][discord.resources.message.Message]."""
+    """Message resource object. See [`Resource.Message`][scurrypy.resources.message.Message]."""
 
     guild_id: Optional[int]
     """Guild ID of the updated message (if in a guild channel)."""
 
     member: Optional[MemberModel]  # guild-only author info
-    """Partial Member object of the author of the message. See [`MemberModel`][discord.models.member.MemberModel]."""
+    """Partial Member object of the author of the message. See [`MemberModel`][scurrypy.models.member.MemberModel]."""
     
 @dataclass
 class MessageUpdateEvent(DataModel):
     """Received when a message is updated."""
     message: Message
-    """Message resource object. See [`Resource.Message`][discord.resources.message.Message]."""
+    """Message resource object. See [`Resource.Message`][scurrypy.resources.message.Message]."""
 
     guild_id: Optional[int]
     """Guild ID of the updated message (if in a guild channel)."""
 
     member: Optional[MemberModel]
-    """Partial Member object of the author of the message. See [`MemberModel`][discord.models.member.MemberModel]."""
+    """Partial Member object of the author of the message. See [`MemberModel`][scurrypy.models.member.MemberModel]."""
 
 @dataclass
 class MessageDeleteEvent(DataModel):

{discord → scurrypy}/http.py

@@ -152,7 +152,7 @@ class HTTPClient:
                         if data.get("global"):
                             self.global_reset = asyncio.get_event_loop().time() + retry
                         self.logger.log_warn(
-                            f"Rate limited {retry}s ({'global' if data.get('global') else 'bucket'})"
+                            f"Rate limited {retry}s ({endpoint})"
                         )
                         await asyncio.sleep(retry + 0.5)
                         continue

{discord → scurrypy}/intents.py

@@ -54,7 +54,7 @@ class IntentFlagParams(TypedDict, total=False):
     message_content: bool
 
 def set_intents(**flags: Unpack[IntentFlagParams]):
-    """Set bot intents using [`IntentFlagParams`][discord.intents.IntentFlagParams].  
+    """Set bot intents using [`IntentFlagParams`][scurrypy.intents.IntentFlagParams].  
     `Intents.DEFAULT` = (GUILDS | GUILD_MESSAGES) will also be set.
 
     Args: