scurrypy 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

discord/__init__.py

@@ -3,6 +3,7 @@
 from .logger import Logger
 from .client import Client
 from .intents import Intents, set_intents
+from .config import BaseConfig
 
 from .events import *
 from .resources import *

discord/client.py

@@ -5,6 +5,7 @@ from .gateway import GatewayClient
 from .http import HTTPClient
 from .intents import Intents
 from .error import DiscordError
+from .config import BaseConfig
 
 from .resources.guild import Guild
 from .resources.channel import Channel
@@ -28,6 +29,7 @@ class Client:
         token: str,
         application_id: int,
         intents: int = Intents.DEFAULT,
+        config: BaseConfig = None,
         debug_mode: bool = False,
         prefix = None,
         quiet: bool = False
@@ -43,6 +45,7 @@ class Client:
         """
         self.token = token
         self.application_id = application_id
+        self.config = config
 
         self._logger = Logger(debug_mode, quiet)
         self._ws = GatewayClient(token, intents, self._logger)
@@ -51,15 +54,16 @@ class Client:
         if prefix and (intents & Intents.MESSAGE_CONTENT == 0):
             self._logger.log_warn('Prefix set without message content enabled.')
 
-        self.dispatcher = EventDispatcher(self.application_id, self._http, self._logger)
-        self.prefix_dispatcher = PrefixDispatcher(self._http, self._logger, prefix)
-        self.command_dispatcher = CommandDispatcher(self.application_id, self._http, self._logger)
+        self.dispatcher = EventDispatcher(self.application_id, self._http, self._logger, config)
+        self.prefix_dispatcher = PrefixDispatcher(self._http, self._logger, prefix, config)
+        self.command_dispatcher = CommandDispatcher(self.application_id, self._http, self._logger, config)
 
         self._global_commands = [] # SlashCommand
         self._guild_commands = {} # {guild_id : [commands], ...}
 
         self._is_set_up = False
         self._setup_hooks = []
+        self._shutdown_hooks = []
         
         self.emojis = BotEmojis(self._http, self.application_id)
 
@@ -125,6 +129,15 @@ class Client:
         """
         self._setup_hooks.append(func)
 
+    def shutdown_hook(self, func):
+        """Decorator registers a shutdown hook.
+            (Runs once before the bot exits the loop)
+
+        Args:
+            func (callable): callback to the shutdown function
+        """
+        self._shutdown_hooks.append(func)
+
     def application_from_id(self, application_id: int):
         """Creates an interactable application resource.
 
@@ -265,7 +278,7 @@ class Client:
                     if self._setup_hooks:
                         for hook in self._setup_hooks:
                             self._logger.log_info(f"Setting hook {hook.__name__}")
-                            await hook()
+                            await hook(self)
                         self._logger.log_high_priority("Hooks set up.")
 
                     # register GUILD commands
@@ -293,8 +306,25 @@ class Client:
                 self._logger.log_error(f"Unspecified Error Type {type(e).__name__} - {e}")
                 break
             finally:
-                await self._ws.close()
-                await self._http.close_session()
+                # Run hooks (with safe catching)
+                for hook in self._shutdown_hooks:
+                    try:
+                        self._logger.log_info(f"Executing shutdown hook {hook.__name__}")
+                        await hook(self)
+                    except Exception as e:
+                        self._logger.log_error(f"{type(e).__name__}: {e}")
+
+                # Always close resources
+                try:
+                    await self._ws.close()
+                except Exception as e:
+                    self._logger.log_warn(f"WebSocket close failed: {e}")
+
+                try:
+                    await self._http.close_session()
+                except Exception as e:
+                    self._logger.log_warn(f"HTTP session close failed: {e}")
+
 
     def run(self):
         """Starts the bot.

discord/config.py

@@ -0,0 +1,6 @@
+from dataclasses import dataclass
+
+@dataclass
+class BaseConfig:
+    """Config class that lives inside Client and can be extended by the dev to add persistent data (like a database)."""
+    pass

discord/dispatch/command_dispatcher.py

@@ -2,6 +2,7 @@ import asyncio
 
 from ..http import HTTPClient
 from ..logger import Logger
+from ..config import BaseConfig
 
 from ..events.interaction_events import ApplicationCommandData, MessageComponentData, ModalData, InteractionEvent
 from ..resources.interaction import Interaction, InteractionDataTypes
@@ -28,7 +29,7 @@ class CommandDispatcher:
     }
     """Maps [`InteractionTypes`][discord.dispatch.command_dispatcher.InteractionTypes] to their respective dataclass."""
 
-    def __init__(self, application_id: int, http: HTTPClient, logger: Logger):
+    def __init__(self, application_id: int, http: HTTPClient, logger: Logger, config: BaseConfig):
         self.application_id = application_id
         """Bot's application ID."""
 
@@ -38,6 +39,8 @@ class CommandDispatcher:
         self._logger = logger
         """Logger instance to log events."""
 
+        self.config = config
+
         self._component_handlers = {}
         """Mapping of component custom IDs to handler."""
 
@@ -114,7 +117,7 @@ class CommandDispatcher:
         Args:
             data (dict): interaction data
         """
-        event = InteractionEvent(interaction=Interaction.from_dict(data, self._http))
+        event = InteractionEvent(config=self.config, interaction=Interaction.from_dict(data, self._http))
 
         event_data_obj = self.RESOURCE_MAP.get(event.interaction.type)
 

discord/dispatch/event_dispatcher.py

@@ -1,5 +1,6 @@
 from ..http import HTTPClient
 from ..logger import Logger
+from ..config import BaseConfig
 
 from ..events.ready_event import *
 from ..events.reaction_events import *
@@ -40,7 +41,7 @@ class EventDispatcher:
     }
     """Mapping of event names to respective dataclass."""
     
-    def __init__(self, application_id: int, http: HTTPClient, logger: Logger):
+    def __init__(self, application_id: int, http: HTTPClient, logger: Logger, config: BaseConfig):
         self.application_id = application_id
         """Bot's ID."""
 
@@ -50,6 +51,9 @@ class EventDispatcher:
         self._logger = logger
         """HTTP session for requests"""
 
+        self.config = config
+        """User-defined bot config for persistent data."""
+
         self._handlers = {}
         """Mapping of event names to handler."""
 
@@ -81,5 +85,6 @@ class EventDispatcher:
         handler = self._handlers.get(event_name, None)
         if handler:
             obj = cls.from_dict(data, self._http)
+            obj.config = self.config
             await handler(obj)
             self._logger.log_info(f"Event {event_name} Acknowledged.")

discord/dispatch/prefix_dispatcher.py

@@ -1,5 +1,6 @@
 from ..http import HTTPClient
 from ..logger import Logger
+from ..config import BaseConfig
 
 from ..events.message_events import MessageCreateEvent
 
@@ -8,7 +9,7 @@ from ..models.member import MemberModel
 
 class PrefixDispatcher:
     """Handles text-based command messages that start with a specific prefix."""
-    def __init__(self, http: HTTPClient, logger: Logger, prefix: str):
+    def __init__(self, http: HTTPClient, logger: Logger, prefix: str, config: BaseConfig):
         self._http = http
         """HTTP session for requests."""
 
@@ -18,6 +19,9 @@ class PrefixDispatcher:
         self.prefix = prefix
         """User-defined command prefix."""
 
+        self.config = config
+        """User-defined bot config for persistent data."""
+
         self._handlers = {}
         """Mapping of command prefix names to handler"""
 
@@ -37,6 +41,7 @@ class PrefixDispatcher:
             data (dict): Discord's raw event payload
         """
         event = MessageCreateEvent(
+            config=self.config,
             guild_id=data.get('guild_id'),
             message=Message.from_dict(data, self._http),
             member=MemberModel.from_dict(data.get('member'))

discord/events/channel_events.py

@@ -1,10 +1,11 @@
 from dataclasses import dataclass
 from typing import Optional
-from ..model import DataModel
+from .event_model import EventModel
 
 @dataclass
-class GuildChannelEvent(DataModel):
+class GuildChannelEvent(EventModel):
     """Base guild channel event."""
+
     id: int
     """ID of the guild channel."""
 
@@ -45,7 +46,7 @@ class GuildChannelDeleteEvent(GuildChannelEvent):
     pass
 
 @dataclass
-class ChannelPinsUpdateEvent(DataModel):
+class ChannelPinsUpdateEvent(EventModel):
     """Pin update event."""
     channel_id: int
     guild_id: Optional[int]

discord/events/event_model.py

@@ -0,0 +1,10 @@
+from dataclasses import dataclass
+from ..model import DataModel
+from ..config import BaseConfig
+
+@dataclass
+class EventModel(DataModel):
+    """Event Model for event-driven fields common among all events."""
+
+    config: BaseConfig
+    """User-defined bot config for persistent data."""

discord/events/guild_events.py

@@ -1,11 +1,10 @@
 from dataclasses import dataclass
-from typing import Optional
-from ..model import DataModel
+from .event_model import EventModel
 from ..models import MemberModel
 from ..resources.channel import Channel
 
 @dataclass
-class GuildEvent(DataModel):
+class GuildEvent(EventModel):
     """Base guild event."""
     joined_at: str
     """ISO8601 timestamp of when app joined the guild."""
@@ -22,9 +21,6 @@ class GuildEvent(DataModel):
     channels: list[Channel]
     """Channels in the guild."""
 
-    unavailable: Optional[bool]
-    """If the guild is unavailable due to an outage."""
-
 class GuildCreateEvent(GuildEvent):
     """Received when the bot has joined a guild."""
     pass

discord/events/interaction_events.py

@@ -1,6 +1,7 @@
 from dataclasses import dataclass, field
 from typing import Optional
 from ..model import DataModel
+from ..config import BaseConfig
 
 from ..resources.interaction import Interaction
 
@@ -141,5 +142,8 @@ class InteractionEvent(DataModel):
     interaction: Interaction
     """Interaction resource object. See [`Interaction`][discord.resources.interaction.Interaction]."""
 
+    config: BaseConfig
+    """User-defined bot config for persistent data."""
+
     data: Optional[ApplicationCommandData | MessageComponentData | ModalData] = None
     """Interaction response data."""

discord/events/message_events.py

@@ -1,12 +1,12 @@
 from dataclasses import dataclass
 from typing import Optional
-from ..model import DataModel
+from .event_model import EventModel
 
 from ..resources.message import Message
 from ..models.member import MemberModel
 
 @dataclass
-class MessageCreateEvent(DataModel):
+class MessageCreateEvent(EventModel):
     """Received when a message is created."""
     message: Message
     """Message resource object. See [`Resource.Message`][discord.resources.message.Message]."""
@@ -18,7 +18,7 @@ class MessageCreateEvent(DataModel):
     """Partial Member object of the author of the message. See [`MemberModel`][discord.models.member.MemberModel]."""
     
 @dataclass
-class MessageUpdateEvent(DataModel):
+class MessageUpdateEvent(EventModel):
     """Received when a message is updated."""
     message: Message
     """Message resource object. See [`Resource.Message`][discord.resources.message.Message]."""
@@ -30,7 +30,7 @@ class MessageUpdateEvent(DataModel):
     """Partial Member object of the author of the message. See [`MemberModel`][discord.models.member.MemberModel]."""
 
 @dataclass
-class MessageDeleteEvent(DataModel):
+class MessageDeleteEvent(EventModel):
     """Received when a message is deleted."""
 
     id: int

discord/events/reaction_events.py

@@ -1,6 +1,6 @@
 from dataclasses import dataclass
 from typing import Optional
-from ..model import DataModel
+from .event_model import EventModel
 
 from ..models.member import MemberModel
 from ..models.emoji import EmojiModel
@@ -15,7 +15,7 @@ class ReactionType:
     """A super emoji."""
 
 @dataclass
-class ReactionAddEvent(DataModel):
+class ReactionAddEvent(EventModel):
     """Reaction added event."""
 
     type: int
@@ -46,7 +46,7 @@ class ReactionAddEvent(DataModel):
     """ID of the user who sent the message where the reaction was added."""
 
 @dataclass
-class ReactionRemoveEvent(DataModel):
+class ReactionRemoveEvent(EventModel):
     """Reaction removed event."""
 
     type: int
@@ -70,7 +70,7 @@ class ReactionRemoveEvent(DataModel):
     burst: bool
     """If the emoji of the removed reaction is super."""
 
-class ReactionRemoveAllEvent(DataModel):
+class ReactionRemoveAllEvent(EventModel):
     """Remove all reactions event."""
 
     channel_id: int
@@ -83,7 +83,7 @@ class ReactionRemoveAllEvent(DataModel):
     """ID of the guild where all reaction were removed (if in a guild)."""
 
 @dataclass
-class ReactionRemoveEmojiEvent(DataModel):
+class ReactionRemoveEmojiEvent(EventModel):
     """All reactions of a specific emoji removed."""
 
     emoji: EmojiModel

discord/events/ready_event.py

@@ -1,5 +1,7 @@
 from dataclasses import dataclass
 from ..model import DataModel
+from ..config import BaseConfig
+
 from ..models.user import UserModel
 from ..models.guild import ReadyGuildModel
 from ..models.application import ApplicationModel
@@ -28,3 +30,6 @@ class ReadyEvent(DataModel):
 
     application: ApplicationModel
     """Partial application object. Contains ID and flags."""
+
+    config: BaseConfig
+    """User-defined bot config for persistent data."""

{scurrypy-0.1.0.dist-info → scurrypy-0.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: scurrypy
-Version: 0.1.0
+Version: 0.2.0
 Summary: Discord API Wrapper in Python
 Author: Furmissile
 Requires-Python: >=3.10

{scurrypy-0.1.0.dist-info → scurrypy-0.2.0.dist-info}/RECORD

@@ -1,5 +1,6 @@
-discord/__init__.py,sha256=2mkaOJP7-7iT_aSkrstLuq10QykiDa3Y2vvl-wD9r1c,185
-discord/client.py,sha256=kLwVFjUkl4qQWSj6hsxUk4F_6FDbW462roeHgRXxfW4,11986
+discord/__init__.py,sha256=DPE5laK7mMQPeF2ky8D8QpokCDqsGlq6slHHhbNXmso,217
+discord/client.py,sha256=sVgr5y_bci9aFUMgpOytiHlAljQyPS0Wl2C_yUvtJ-E,13139
+discord/config.py,sha256=OH1A2mNKhDlGvQYASEsVUx2pNxP1YQ2a7a7z-IM5xFg,200
 discord/error.py,sha256=AlislRTna554cM6KC0KrwKugzYDYtx_9C8_3QFe4XDc,2070
 discord/gateway.py,sha256=H_WaUrpK8rl3rGlT3qNexpru7R6O6Y6GQPkQcDt_KX8,6555
 discord/http.py,sha256=cGFhGEeNebf1sgSUB4Xfnlj00twWLFi9AwO85gAAUDA,10955
@@ -7,17 +8,18 @@ discord/intents.py,sha256=Lf2fogFFDqilZeKJv7tcUgKmMW3D7ykK4bBNi-zDzYA,2866
 discord/logger.py,sha256=GBcvldIrSBnwNSgus-oa1NsYV8hU7f8_4J4VX_GmkxA,4700
 discord/model.py,sha256=Fr0PO_8UCgEep_Dk9eVtHmgzrlxkdsEYeuiS3EYK4hY,3015
 discord/dispatch/__init__.py,sha256=m7ixrbNhOV9QRORXPw6LSwxofQMAvLmPFBweBZu9ACc,20
-discord/dispatch/command_dispatcher.py,sha256=jOfO6GEQvp0muY3iE9otucsyBE36-xhMcZKMwHGnstU,5543
-discord/dispatch/event_dispatcher.py,sha256=CX-7htyG7Gi9KobFIZJYHx78km3BT0M8gymZEVCi9LM,2902
-discord/dispatch/prefix_dispatcher.py,sha256=IV2xKqCVaz-PGvg9etgqqUpMWQgvRnYEk6eURt4UqQc,1894
+discord/dispatch/command_dispatcher.py,sha256=EZJfogU5YggOTVhQ3DGjOJgABjtU2EaDslCOfdleRl0,5648
+discord/dispatch/event_dispatcher.py,sha256=EWLGYyjFtUTCKHN9MdYChm8KjIlMF41Iaa8KDCmpdfI,3085
+discord/dispatch/prefix_dispatcher.py,sha256=Zt3eYhHPJjgTYdJi-lqLD4v-hvllI8yz5M8EjdbNTP8,2072
 discord/events/__init__.py,sha256=BcmwAj84-nzMZEkip-V903jD0ZCKqhySzlAx5wDwJoo,630
-discord/events/channel_events.py,sha256=lkBzNI-gKNgIPfIrOJhx-zjbK5v4bErEUurWp9L-VWw,1369
-discord/events/guild_events.py,sha256=4rDPbldG4kjsBmSuRasDoXc-2cYmjdJOP5PTAdEbRw8,1008
+discord/events/channel_events.py,sha256=1Hle3UyYHRQr0ewNwsioMg2tmyAoiQ1ljsXiNd-J7l0,1379
+discord/events/event_model.py,sha256=8KwIZl38mXVI7ExWwn4t4Va9lF8h4ed1UhnCv3aKqMY,297
+discord/events/guild_events.py,sha256=-aDWbDKbaDRAG_gFKx2qMVejtbyenWFnPRl-LsytUbM,894
 discord/events/hello_event.py,sha256=O8Ketu_N943cnGaFkGsAHfWhgKXFQCYCqSD3EqdsXjA,225
-discord/events/interaction_events.py,sha256=5hlYOsV1ROiRXISAGCKcZo8vfk6oqiZcNzzZjSteiag,4361
-discord/events/message_events.py,sha256=M5xdaJH1zRzdZk0oN0Jykaeu9k09EjgZjeiIT_EkL1A,1475
-discord/events/reaction_events.py,sha256=xx7GD-fqakhJmS-X-HbuAUg9pg6Gqo_KRtLTdPJu7UE,2643
-discord/events/ready_event.py,sha256=iDuCTegyrN05FdYVPY0hsfJn1NABslkzsa_b2WxrRu0,792
+discord/events/interaction_events.py,sha256=KdaKJ2xJeGJnPTywU5jHiyWP5dNO0PiWPZbrxwmIWFU,4476
+discord/events/message_events.py,sha256=WCqt2EnrnlUqdd-Ue1RHfom5Wxw3OYkCwRh7C1X5suk,1484
+discord/events/reaction_events.py,sha256=zilWFUVzreVo99TM5oAb6R8RIyr3sjCb47Q3D238l9k,2653
+discord/events/ready_event.py,sha256=WvIp9teknvxV87ukraSMWk96YsBe2xWTbr4Ev9bsHQ8,909
 discord/models/__init__.py,sha256=T6C5C8RdkEPurA_zQas5riq3nrThMaSWl9Yasha0xXc,216
 discord/models/application.py,sha256=2sXtRysUc2TJ40FjdcrWgosmwMrp_h3ybddubQMixKM,924
 discord/models/emoji.py,sha256=6iz1DhWj_eTUj2KHmwMewjB3AdEBm68EmIZp2WFFCQg,932
@@ -45,8 +47,8 @@ discord/resources/guild.py,sha256=Unld1lWY3XynmRHU2FCi3-LA9VNp2thMI2BlILUTTxk,81
 discord/resources/interaction.py,sha256=8z91X49KSknaT1syBfLr0SHRgAxaQ-8lbhkb3LU21fg,4911
 discord/resources/message.py,sha256=RtvcCRx0lwW-mHPl3aNYoEvGffrvtpLsQ2fVWckywVI,7527
 discord/resources/user.py,sha256=vk89TnCVi-6ZgbDs_TZTCXrx_NfFS5Q9Wi_itYoaoyg,3085
-scurrypy-0.1.0.dist-info/licenses/LICENSE,sha256=NtspfRMAlryd1Eev4BYi9EFbKhvdmlCJJ2-ADUoEBoI,426
-scurrypy-0.1.0.dist-info/METADATA,sha256=uRHnWjovcV97VB7PQrhVDFUotTd53CGoAY9IVEmv0Ww,186
-scurrypy-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-scurrypy-0.1.0.dist-info/top_level.txt,sha256=fJkrNbR-_8ubMBUcDEJBcfkpECrvSEmMrNKgvLlQFoM,8
-scurrypy-0.1.0.dist-info/RECORD,,
+scurrypy-0.2.0.dist-info/licenses/LICENSE,sha256=NtspfRMAlryd1Eev4BYi9EFbKhvdmlCJJ2-ADUoEBoI,426
+scurrypy-0.2.0.dist-info/METADATA,sha256=SllPDZjo5X0dVp8-MLDL6_Bdk3xL9MxChDoC2v1gtrQ,186
+scurrypy-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+scurrypy-0.2.0.dist-info/top_level.txt,sha256=fJkrNbR-_8ubMBUcDEJBcfkpECrvSEmMrNKgvLlQFoM,8
+scurrypy-0.2.0.dist-info/RECORD,,