scurrypy 0.4.2__tar.gz → 0.5.2__tar.gz

{scurrypy-0.4.2 → scurrypy-0.5.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scurrypy
-Version: 0.4.2
+Version: 0.5.2
 Summary: Dataclass-driven Discord API Wrapper in Python
 Author: Furmissile
 Requires-Python: >=3.10
@@ -8,7 +8,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Dynamic: license-file
 
-# __Welcome to ScurryPy__
+# __ScurryPy__
 
 [![PyPI version](https://badge.fury.io/py/scurrypy.svg)](https://badge.fury.io/py/scurrypy)
 
@@ -20,22 +20,17 @@ A dataclass-driven Discord API wrapper in Python!
 
 While this wrapper is mainly used for various squirrel-related shenanigans, it can also be used for more generic bot purposes.
 
----
-
 ## Features
-* Command and event handling  
-* Declarative style using decorators  
-* Supports both legacy and new features  
-* Respects Discord’s rate limits  
-
----
+* Command, and event handling
+* Unix shell-style wildcards for component routing
+* Declarative style using decorators
+* Supports both legacy and new features
+* Respects Discord’s rate limits
 
-## Some Things to Consider...
+## Notes & Early Status
 * This is an early version — feedback, ideas, and contributions are very welcome! That said, there may be bumps along the way, so expect occasional bugs and quirks.  
 * Certain features are not yet supported, while others are intentionally omitted. See the [docs](https://furmissile.github.io/scurrypy) for full details.  
 
----
-
 ## Getting Started
 *Note: This section also appears in the documentation, but here are complete examples ready to use with your bot credentials.*
 
@@ -58,7 +53,7 @@ load_dotenv(dotenv_path='./path/to/env')
 
 client = discord.Client(
     token=os.getenv("DISCORD_TOKEN"),
-    application_id=APPLICATION_ID  # replace with your bot's user ID
+    application_id=APPLICATION_ID  # your bot’s application ID
 )
 
 @client.command(
@@ -84,7 +79,7 @@ load_dotenv(dotenv_path='./path/to/env')
 
 client = discord.Client(
     token=os.getenv("DISCORD_TOKEN"),
-    application_id=APPLICATION_ID,  # replace with your bot's user ID
+    application_id=APPLICATION_ID  # your bot’s application ID
     intents=discord.set_intents(message_content=True),
     prefix='!'  # your custom prefix
 )
@@ -126,5 +121,4 @@ If you plan to make substantial changes or release your own variant:
 See the [License](./LICENSE) for details.
 
 ## Like What You See?
-Check out the full [documentation](https://furmissile.github.io/scurrypy)
- for more examples, guides, and API reference!
+Explore the full [documentation](https://furmissile.github.io/scurrypy) for more examples, guides, and API reference.

{scurrypy-0.4.2 → scurrypy-0.5.2}/README.md

@@ -1,4 +1,4 @@
-# __Welcome to ScurryPy__
+# __ScurryPy__
 
 [![PyPI version](https://badge.fury.io/py/scurrypy.svg)](https://badge.fury.io/py/scurrypy)
 
@@ -10,22 +10,17 @@ A dataclass-driven Discord API wrapper in Python!
 
 While this wrapper is mainly used for various squirrel-related shenanigans, it can also be used for more generic bot purposes.
 
----
-
 ## Features
-* Command and event handling  
-* Declarative style using decorators  
-* Supports both legacy and new features  
-* Respects Discord’s rate limits  
-
----
+* Command, and event handling
+* Unix shell-style wildcards for component routing
+* Declarative style using decorators
+* Supports both legacy and new features
+* Respects Discord’s rate limits
 
-## Some Things to Consider...
+## Notes & Early Status
 * This is an early version — feedback, ideas, and contributions are very welcome! That said, there may be bumps along the way, so expect occasional bugs and quirks.  
 * Certain features are not yet supported, while others are intentionally omitted. See the [docs](https://furmissile.github.io/scurrypy) for full details.  
 
----
-
 ## Getting Started
 *Note: This section also appears in the documentation, but here are complete examples ready to use with your bot credentials.*
 
@@ -48,7 +43,7 @@ load_dotenv(dotenv_path='./path/to/env')
 
 client = discord.Client(
     token=os.getenv("DISCORD_TOKEN"),
-    application_id=APPLICATION_ID  # replace with your bot's user ID
+    application_id=APPLICATION_ID  # your bot’s application ID
 )
 
 @client.command(
@@ -74,7 +69,7 @@ load_dotenv(dotenv_path='./path/to/env')
 
 client = discord.Client(
     token=os.getenv("DISCORD_TOKEN"),
-    application_id=APPLICATION_ID,  # replace with your bot's user ID
+    application_id=APPLICATION_ID  # your bot’s application ID
     intents=discord.set_intents(message_content=True),
     prefix='!'  # your custom prefix
 )
@@ -116,5 +111,4 @@ If you plan to make substantial changes or release your own variant:
 See the [License](./LICENSE) for details.
 
 ## Like What You See?
-Check out the full [documentation](https://furmissile.github.io/scurrypy)
- for more examples, guides, and API reference!
+Explore the full [documentation](https://furmissile.github.io/scurrypy) for more examples, guides, and API reference.

{scurrypy-0.4.2 → scurrypy-0.5.2}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "scurrypy"
-version = "0.4.2"
+version = "0.5.2"
 
 description = "Dataclass-driven Discord API Wrapper in Python"
 readme = "README.md"
@@ -14,10 +14,10 @@ dependencies = []
 
 [tool.setuptools]
 packages = [
-  "discord",
-  "discord.dispatch",
-  "discord.events",
-  "discord.models",
-  "discord.resources",
-  "discord.parts"
+  "scurrypy",
+  "scurrypy.dispatch",
+  "scurrypy.events",
+  "scurrypy.models",
+  "scurrypy.resources",
+  "scurrypy.parts"
 ]

scurrypy-0.5.2/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__)

{scurrypy-0.4.2/discord → scurrypy-0.5.2/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."""
 

{scurrypy-0.4.2/discord → scurrypy-0.5.2/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}'")

{scurrypy-0.4.2/discord → scurrypy-0.5.2/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...
     }

{scurrypy-0.4.2/discord → scurrypy-0.5.2/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."""