hikari-arc 1.3.1__py3-none-any.whl → 1.3.3__py3-none-any.whl

arc/abc/client.py

@@ -333,8 +333,8 @@ class Client(t.Generic[AppT], abc.ABC):
         inj_ctx = alluka.OverridingContext.from_client(self.injector)
 
         for hook in self._injection_hooks:
-            if inspect.iscoroutinefunction(hook):
-                await hook(ctx, inj_ctx)
+            if inspect.isawaitable(hook):
+                await hook(ctx, inj_ctx)  # type: ignore
             else:
                 hook(ctx, inj_ctx)
         return inj_ctx
@@ -483,7 +483,7 @@ class Client(t.Generic[AppT], abc.ABC):
         CommandT[te.Self]
             The next command that matches the given criteria.
 
-        Examples
+        Example
         --------
         ```py
         for cmd in plugin.walk_commands(hikari.CommandType.SLASH):
@@ -561,7 +561,7 @@ class Client(t.Generic[AppT], abc.ABC):
         RuntimeError
             If the command is already added to a plugin.
 
-        Examples
+        Example
         --------
         ```py
         @client.include # Add the command to the client.
@@ -637,7 +637,7 @@ class Client(t.Generic[AppT], abc.ABC):
         !!! note
             Parameters left as `hikari.UNDEFINED` will be inherited from the parent client.
 
-        Examples
+        Example
         --------
         ```py
         group = client.include_slash_group("Group", "A group of commands.")
@@ -891,7 +891,7 @@ class Client(t.Generic[AppT], abc.ABC):
         te.Self
             The client for chaining calls.
 
-        Examples
+        Example
         --------
         ```py
         @client.set_error_handler
@@ -942,7 +942,7 @@ class Client(t.Generic[AppT], abc.ABC):
         te.Self
             The client for chaining calls.
 
-        Examples
+        Example
         --------
         ```py
         @client.add_startup_hook
@@ -989,7 +989,7 @@ class Client(t.Generic[AppT], abc.ABC):
         te.Self
             The client for chaining calls.
 
-        Examples
+        Example
         --------
         ```py
         @client.add_shutdown_hook
@@ -1040,7 +1040,7 @@ class Client(t.Generic[AppT], abc.ABC):
         te.Self
             The client for chaining calls.
 
-        Examples
+        Example
         --------
         ```py
         @client.set_startup_hook
@@ -1092,7 +1092,7 @@ class Client(t.Generic[AppT], abc.ABC):
         te.Self
             The client for chaining calls.
 
-        Examples
+        Example
         --------
         ```py
         @client.set_shutdown_hook
@@ -1140,7 +1140,7 @@ class Client(t.Generic[AppT], abc.ABC):
         te.Self
             The client for chaining calls.
 
-        Examples
+        Example
         --------
         ```py
         @client.set_command_locale_provider
@@ -1187,7 +1187,7 @@ class Client(t.Generic[AppT], abc.ABC):
         te.Self
             The client for chaining calls.
 
-        Examples
+        Example
         --------
         ```py
         @client.set_option_locale_provider
@@ -1229,7 +1229,7 @@ class Client(t.Generic[AppT], abc.ABC):
         provider : CustomLocaleRequestT
             The custom locale provider to set.
 
-        Examples
+        Example
         --------
         ```py
         @client.set_custom_locale_provider
@@ -1272,7 +1272,7 @@ class Client(t.Generic[AppT], abc.ABC):
         ValueError
             If the module does not have a loader.
 
-        Examples
+        Example
         --------
         ```py
         client = arc.GatewayClient(...)
@@ -1337,7 +1337,7 @@ class Client(t.Generic[AppT], abc.ABC):
         ExtensionLoadError
             If a module does not have a loader defined.
 
-        Examples
+        Example
         --------
         ```py
         client = arc.GatewayClient(...)
@@ -1438,7 +1438,7 @@ class Client(t.Generic[AppT], abc.ABC):
         te.Self
             The client for chaining calls.
 
-        Examples
+        Example
         --------
         ```py
         class MyDependency:
@@ -1513,7 +1513,7 @@ class Client(t.Generic[AppT], abc.ABC):
             Command callbacks are automatically injected with dependencies,
             thus this decorator is not needed for them.
 
-        Examples
+        Example
         --------
         ```py
         class MyDependency:

arc/abc/command.py

@@ -2,7 +2,6 @@ from __future__ import annotations
 
 import abc
 import asyncio
-import inspect
 import typing as t
 
 import attr
@@ -549,10 +548,7 @@ class CommandBase(
         try:
             hooks = command._resolve_hooks()
             for hook in hooks:
-                if inspect.iscoroutinefunction(hook):
-                    res = await ctx._injection_ctx.call_with_async_di(hook, ctx)
-                else:
-                    res = ctx._injection_ctx.call_with_di(hook, ctx)
+                res = await ctx._injection_ctx.call_with_async_di(hook, ctx)
 
                 res = t.cast(HookResult | None, res)
 
@@ -569,10 +565,7 @@ class CommandBase(
         try:
             post_hooks = command._resolve_post_hooks()
             for hook in post_hooks:
-                if inspect.iscoroutinefunction(hook):
-                    await ctx._injection_ctx.call_with_async_di(hook, ctx)
-                else:
-                    ctx._injection_ctx.call_with_di(hook, ctx)
+                await ctx._injection_ctx.call_with_async_di(hook, ctx)
         except Exception as e:
             await command._handle_exception(ctx, e)
         finally:

arc/abc/concurrency_limiting.py

@@ -86,7 +86,7 @@ def with_concurrency_limit(
     t.Callable[[HasConcurrencyLimiterT], HasConcurrencyLimiterT]
         The object with the concurrency limiter set.
 
-    Examples
+    Example
     --------
     ```py
     @client.include

arc/abc/error_handler.py

@@ -39,7 +39,7 @@ class HasErrorHandler(abc.ABC, t.Generic[ClientT]):
 
         This function will be called when an exception is raised during the invocation of a command.
 
-        Examples
+        Example
         --------
         ```py
         @client.include

arc/abc/hookable.py

@@ -97,7 +97,7 @@ def with_hook(hook: HookT[ClientT]) -> t.Callable[[HookableT], HookableT]:
     and returns either a [`HookResult`][arc.abc.hookable.HookResult] or
     `None` can be used as a hook.
 
-    Examples
+    Example
     --------
     ```py
     @client.include
@@ -127,7 +127,7 @@ def with_post_hook(hook: PostHookT[ClientT]) -> t.Callable[[HookableT], Hookable
         Post-execution hooks **are** called even if the command callback raises an exception.
         You can see if the command callback failed by checking [`Context.has_command_failed`][arc.context.base.Context.has_command_failed].
 
-    Examples
+    Example
     --------
     ```py
     @client.include

arc/abc/option.py

@@ -33,7 +33,7 @@ OriginT = t.TypeVar("OriginT")
 Option = t.Annotated
 """Alias for typing.Annotated.
 
-Examples
+Example
 --------
 ```py
 arc.Option[type, arc.TypeParams(...)]

arc/abc/plugin.py

@@ -295,7 +295,7 @@ class PluginBase(HasErrorHandler[ClientT], Hookable[ClientT], HasConcurrencyLimi
         !!! note
             Parameters left as `hikari.UNDEFINED` will be inherited from the parent plugin or client.
 
-        Examples
+        Example
         --------
         ```py
         group = client.include_slash_group("Group", "A group of commands.")
@@ -340,7 +340,7 @@ class PluginBase(HasErrorHandler[ClientT], Hookable[ClientT], HasConcurrencyLimi
             Command callbacks are automatically injected with dependencies,
             thus this decorator is not needed for them.
 
-        Examples
+        Example
         --------
         ```py
         class MyDependency:
@@ -439,7 +439,7 @@ class PluginBase(HasErrorHandler[ClientT], Hookable[ClientT], HasConcurrencyLimi
         CommandT[ClientT]
             The next command that matches the given criteria.
 
-        Examples
+        Example
         --------
         ```py
         for cmd in plugin.walk_commands(hikari.CommandType.SLASH):

arc/client.py

@@ -344,7 +344,7 @@ class GatewayClient(GatewayClientBase[hikari.GatewayBotAware]):
         If you already have an injector instance, you may pass it here.
         Otherwise, a new one will be created by default.
 
-    Examples
+    Example
     --------
     ```py
     import hikari
@@ -390,7 +390,7 @@ class RESTClient(RESTClientBase[hikari.RESTBotAware]):
         Otherwise, a new one will be created by default.
 
 
-    Examples
+    Example
     --------
     ```py
     import hikari

arc/command/message.py

@@ -96,7 +96,7 @@ def message_command(
     name_localizations : t.Mapping[hikari.Locale, str] | None
         The localizations for this command's name.
 
-    Examples
+    Example
     --------
     ```py
     @client.include

arc/command/option/attachment.py

@@ -22,9 +22,6 @@ class AttachmentParams(OptionParams[hikari.Attachment]):
     ----------
     description : str
         The description of the option
-
-    Other Parameters
-    ----------------
     name : str
         The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : Mapping[hikari.Locale, str] | None

arc/command/option/bool.py

@@ -21,9 +21,6 @@ class BoolParams(OptionParams[bool]):
     ----------
     description : str
         The description of the option
-
-    Other Parameters
-    ----------------
     name : str
         The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : t.Optional[t.Mapping[str, str]]

arc/command/option/channel.py

@@ -28,9 +28,6 @@ class ChannelParams(OptionParams[hikari.PartialChannel]):
     ----------
     description : str
         The description of the option
-
-    Other Parameters
-    ----------------
     name : str
         The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : Mapping[hikari.Locale, str]

arc/command/option/custom/color.py

@@ -24,9 +24,6 @@ class ColorParams(OptionParams[hikari.Color]):
     ----------
     description : str
         The description of the option
-
-    Other Parameters
-    ----------------
     name : str
         The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : Mapping[hikari.Locale, str] | None

arc/command/option/custom/member.py

@@ -24,9 +24,6 @@ class MemberParams(OptionParams[hikari.InteractionMember]):
     ----------
     description : str
         The description of the option
-
-    Other Parameters
-    ----------------
     name : str
         The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : Mapping[hikari.Locale, str] | None

arc/command/option/float.py

@@ -27,9 +27,6 @@ class FloatParams(OptionWithChoicesParams[float, ClientT]):
     ----------
     description : str
         The description of the option
-
-    Other Parameters
-    ----------------
     name : str
         The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : Mapping[hikari.Locale, str] | None

arc/command/option/int.py

@@ -27,9 +27,6 @@ class IntParams(OptionWithChoicesParams[int, ClientT]):
     ----------
     description : str
         The description of the option
-
-    Other Parameters
-    ----------------
     name : str
         The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : Mapping[hikari.Locale, str] | None

arc/command/option/mentionable.py

@@ -23,9 +23,6 @@ class MentionableParams(OptionParams[hikari.Role | hikari.User]):
     ----------
     description : str
         The description of the option
-
-    Other Parameters
-    ----------------
     name : str
         The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : Mapping[hikari.Locale, str] | None

arc/command/option/role.py

@@ -22,9 +22,6 @@ class RoleParams(OptionParams[hikari.Role]):
     ----------
     description : str
         The description of the option
-
-    Other Parameters
-    ----------------
     name : str
         The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : t.Optional[t.Mapping[str, str]]

arc/command/option/str.py

@@ -28,9 +28,6 @@ class StrParams(OptionWithChoicesParams[str, ClientT]):
     ----------
     description : str
         The description of the option
-
-    Other Parameters
-    ----------------
     name : str
         The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : Mapping[hikari.Locale, str]

arc/command/option/user.py

@@ -23,9 +23,6 @@ class UserParams(OptionParams[hikari.User]):
     ----------
     description : str
         The description of the option
-
-    Other Parameters
-    ----------------
     name : str
         The name of the option. If not provided, the name of the parameter will be used.
     name_localizations : Mapping[hikari.Locale, str] | None

arc/command/slash.py

@@ -546,7 +546,7 @@ class SlashSubGroup(SubCommandBase[ClientT, SlashGroup[ClientT]]):
                 raise exc
         except Exception as exc:
             assert self._parent is not None
-            await ctx._injection_ctx.call_with_async_di(self._parent._handle_exception, ctx, exc)
+            await self._parent._handle_exception(ctx, exc)
 
     def _request_option_locale(self, client: Client[t.Any], command: CommandProto) -> None:
         super()._request_option_locale(client, command)
@@ -694,12 +694,12 @@ class SlashSubCommand(
     async def _handle_exception(self, ctx: Context[ClientT], exc: Exception) -> None:
         try:
             if self.error_handler:
-                await self.error_handler(ctx, exc)
+                await ctx._injection_ctx.call_with_async_di(self.error_handler, ctx, exc)
             else:
                 raise exc
         except Exception as e:
             assert self._parent is not None
-            await self._handle_exception(ctx, e)
+            await self._parent._handle_exception(ctx, e)
 
     def _request_option_locale(self, client: Client[t.Any], command: CommandProto) -> None:
         super()._request_option_locale(client, command)
@@ -777,7 +777,7 @@ def slash_command(
     !!! note
         Parameters left as `hikari.UNDEFINED` will be inherited from the parent plugin or client.
 
-    Examples
+    Example
     --------
     ```py
     @client.include
@@ -843,7 +843,7 @@ def slash_subcommand(
     !!! note
         Parameters left as `hikari.UNDEFINED` will be inherited from the parent group, plugin or client.
 
-    Examples
+    Example
     --------
     ```py
     group = client.include_slash_group("group", "A group of slash commands.")

arc/command/user.py

@@ -99,7 +99,7 @@ def user_command(
     name_localizations : t.Mapping[hikari.Locale, str] | None
         The localizations for this command's name.
 
-    Examples
+    Example
     --------
     ```py
     @client.include

arc/context/base.py

@@ -468,7 +468,7 @@ class Context(t.Generic[ClientT]):
         ValueT | None
             The value of the option, or None if it does not exist, or is not of the correct type.
 
-        Examples
+        Example
         --------
         ```py
         value = ctx.get_option("name", arc.OptionType.STRING)

arc/extension.py

@@ -20,7 +20,7 @@ def loader(
 ) -> t.Callable[[ClientT], None] | t.Callable[[t.Callable[[ClientT], None]], t.Callable[[ClientT], None]]:
     """Decorator to set the load callback for this module.
 
-    Examples
+    Example
     --------
     ```py
     client.load_extension("my_extension")
@@ -61,7 +61,7 @@ def unloader(
 ) -> t.Callable[[ClientT], None] | t.Callable[[t.Callable[[ClientT], None]], t.Callable[[ClientT], None]]:
     """Decorator to set the unload callback for this module.
 
-    Examples
+    Example
     --------
     ```py
     client.unload_extension("my_extension")

arc/internal/about.py

@@ -5,7 +5,7 @@ __author_email__: t.Final[str] = "git@hypergonial.com"
 __maintainer__: t.Final[str] = "hypergonial"
 __license__: t.Final[str] = "MIT"
 __url__: t.Final[str] = "https://github.com/hypergonial/hikari-arc"
-__version__: t.Final[str] = "1.3.1"
+__version__: t.Final[str] = "1.3.3"
 
 # MIT License
 #

arc/plugin.py

@@ -42,7 +42,7 @@ class RESTPluginBase(PluginBase[RESTClientT]):
     is_nsfw : bool | hikari.UndefinedType
         Whether this plugin is only usable in NSFW channels
 
-    Examples
+    Example
     --------
     ```py
     plugin = arc.RESTPlugin("MyPlugin")
@@ -90,7 +90,7 @@ class GatewayPluginBase(PluginBase[GatewayClientT]):
     is_nsfw : bool | hikari.UndefinedType
         Whether this plugin is only usable in NSFW channels
 
-    Examples
+    Example
     --------
     ```py
     plugin = arc.GatewayPlugin("MyPlugin")

arc/utils/concurrency_limiter.py

@@ -256,7 +256,7 @@ def global_concurrency(limit: int) -> CommandConcurrencyLimiter[t.Any]:
     CommandConcurrencyLimiter[t.Any]
         A concurrency limiter for use with a command.
 
-    Examples
+    Example
     --------
     ```py
     @arc.with_concurrency_limit(arc.global_concurrency(1))
@@ -278,7 +278,7 @@ def guild_concurrency(limit: int) -> CommandConcurrencyLimiter[t.Any]:
     CommandConcurrencyLimiter[t.Any]
         A concurrency limiter for use with a command.
 
-    Examples
+    Example
     --------
     ```py
     @arc.with_concurrency_limit(arc.guild_concurrency(1))
@@ -300,7 +300,7 @@ def channel_concurrency(limit: int) -> CommandConcurrencyLimiter[t.Any]:
     CommandConcurrencyLimiter[t.Any]
         A concurrency limiter for use with a command.
 
-    Examples
+    Example
     --------
     ```py
     @arc.with_concurrency_limit(arc.channel_concurrency(1))
@@ -322,7 +322,7 @@ def user_concurrency(limit: int) -> CommandConcurrencyLimiter[t.Any]:
     CommandConcurrencyLimiter[t.Any]
         A concurrency limiter for use with a command.
 
-    Examples
+    Example
     --------
     ```py
     @arc.with_concurrency_limit(arc.user_concurrency(1))
@@ -344,7 +344,7 @@ def member_concurrency(limit: int) -> CommandConcurrencyLimiter[t.Any]:
     CommandConcurrencyLimiter[t.Any]
         A concurrency limiter for use with a command.
 
-    Examples
+    Example
     --------
     ```py
     @arc.with_concurrency_limit(arc.member_concurrency(1))
@@ -370,7 +370,7 @@ def custom_concurrency(
     CommandConcurrencyLimiter[t.Any]
         A concurrency limiter for use with a command.
 
-    Examples
+    Example
     --------
     ```py
     # This is identical to 'arc.guild_concurrency(1)'

arc/utils/hooks/basic.py

@@ -20,7 +20,7 @@ if t.TYPE_CHECKING:
 def guild_only(ctx: Context[t.Any]) -> HookResult:
     """A pre-execution hook that aborts the execution of a command if it is invoked outside of a guild.
 
-    Examples
+    Example
     --------
     ```py
     @arc.with_hook(arc.guild_only)
@@ -39,7 +39,7 @@ def guild_only(ctx: Context[t.Any]) -> HookResult:
 def dm_only(ctx: Context[t.Any]) -> HookResult:
     """A pre-execution hook that aborts the execution of a command if it is invoked outside of a DM.
 
-    Examples
+    Example
     --------
     ```py
     @arc.with_hook(arc.dm_only)
@@ -58,7 +58,7 @@ def dm_only(ctx: Context[t.Any]) -> HookResult:
 def owner_only(ctx: Context[t.Any]) -> HookResult:
     """A pre-execution hook that aborts the execution of a command if it is invoked by a non-owner.
 
-    Examples
+    Example
     --------
     ```py
     @arc.with_hook(arc.owner_only)
@@ -105,7 +105,7 @@ def has_permissions(perms: hikari.Permissions) -> t.Callable[[Context[t.Any]], H
     InvokerMissingPermissionsError
         If the invoker is missing some of the specified permissions.
 
-    Examples
+    Example
     --------
     ```py
     @arc.with_hook(arc.has_permissions(hikari.Permissions.MANAGE_CHANNELS | hikari.Permissions.MANAGE_GUILD))
@@ -149,7 +149,7 @@ def bot_has_permissions(perms: hikari.Permissions) -> t.Callable[[Context[t.Any]
     BotMissingPermissionsError
         If the bot is missing some of the specified permissions.
 
-    Examples
+    Example
     --------
     ```py
     @arc.with_hook(arc.bot_has_permissions(hikari.Permissions.MANAGE_CHANNELS | hikari.Permissions.MANAGE_GUILD))

arc/utils/hooks/limiters.py

@@ -82,7 +82,7 @@ def global_limiter(period: float, limit: int) -> LimiterHook[t.Any]:
     RateLimiterExhaustedError
         If the limiter is exhausted.
 
-    Examples
+    Example
     --------
     ```py
     @arc.with_hook(arc.global_limiter(5.0, 1))
@@ -108,7 +108,7 @@ def guild_limiter(period: float, limit: int) -> LimiterHook[t.Any]:
     RateLimiterExhaustedError
         If the limiter is exhausted.
 
-    Examples
+    Example
     --------
     ```py
     @arc.with_hook(arc.guild_limiter(5.0, 1))
@@ -134,7 +134,7 @@ def channel_limiter(period: float, limit: int) -> LimiterHook[t.Any]:
     RateLimiterExhaustedError
         If the limiter is exhausted.
 
-    Examples
+    Example
     --------
     ```py
     @arc.with_hook(arc.channel_limiter(5.0, 1))
@@ -160,7 +160,7 @@ def user_limiter(period: float, limit: int) -> LimiterHook[t.Any]:
     RateLimiterExhaustedError
         If the limiter is exhausted.
 
-    Examples
+    Example
     --------
     ```py
     @arc.with_hook(arc.user_limiter(5.0, 1))
@@ -187,7 +187,7 @@ def member_limiter(period: float, limit: int) -> LimiterHook[t.Any]:
     RateLimiterExhaustedError
         If the limiter is exhausted.
 
-    Examples
+    Example
     --------
     ```py
     @arc.with_hook(arc.member_limiter(5.0, 1))
@@ -215,7 +215,7 @@ def custom_limiter(period: float, limit: int, get_key_with: t.Callable[[Context[
     RateLimiterExhaustedError
         If the limiter is exhausted.
 
-    Examples
+    Example
     --------
     ```py
     # This is identical to 'arc.guild_limiter(5.0, 1)'

arc/utils/loops.py

@@ -152,7 +152,7 @@ class IntervalLoop(_LoopBase[P]):
     TypeError
         If the passed function is not a coroutine function.
 
-    Examples
+    Example
     --------
     ```py
     loop = IntervalLoop(my_coro, seconds=5)
@@ -189,6 +189,50 @@ class IntervalLoop(_LoopBase[P]):
     def _get_next_run(self) -> float:
         return self._sleep
 
+    def set_interval(
+        self,
+        *,
+        seconds: float | None = None,
+        minutes: float | None = None,
+        hours: float | None = None,
+        days: float | None = None,
+    ):
+        """Set a new specified interval.
+
+        !!! note
+            You need to restart the loop if you want these changes to take effect immediately.
+
+        Parameters
+        ----------
+        seconds : float | None, optional
+            The number of seconds to wait before running the coroutine again.
+        minutes : float | None, optional
+            The number of minutes to wait before running the coroutine again.
+        hours : float | None, optional
+            The number of hours to wait before running the coroutine again.
+        days : float | None, optional
+            The number of days to wait before running the coroutine again.
+
+        Example
+        --------
+        ```py
+        loop = IntervalLoop(my_coro, seconds=5)
+        loop.start()
+        loop.set_interval(seconds=10)
+        loop.cancel()
+        loop.start()
+        ```
+        """
+        if not seconds and not minutes and not hours and not days:
+            raise ValueError("At least one of 'seconds', 'minutes', 'hours' or 'days' must be not None.")
+        else:
+            seconds = seconds or 0
+            minutes = minutes or 0
+            hours = hours or 0
+            days = hours or 0
+
+        self._sleep: float = seconds + minutes * 60 + hours * 3600 + days * 24 * 3600
+
 
 class CronLoop(_LoopBase[P]):
     """A simple interval loop that runs a coroutine at a specified interval.
@@ -207,7 +251,7 @@ class CronLoop(_LoopBase[P]):
     cron_format : str
         The cron format to use. See https://en.wikipedia.org/wiki/Cron for more information.
     timezone : datetime.timezone
-        The timezone to use for the cron format. Defaults to UTC.
+        The timezone to use for the cron loop. Defaults to UTC.
 
     Raises
     ------
@@ -218,7 +262,7 @@ class CronLoop(_LoopBase[P]):
     TypeError
         If the passed function is not a coroutine function.
 
-    Examples
+    Example
     --------
     ```py
     loop = CronLoop(my_coro, "*/5 * * * *")
@@ -256,7 +300,12 @@ class CronLoop(_LoopBase[P]):
 
 
 def interval_loop(
-    *, seconds: float | None = None, minutes: float | None = None, hours: float | None = None, days: float | None = None
+    *,
+    seconds: float | None = None,
+    minutes: float | None = None,
+    hours: float | None = None,
+    days: float | None = None,
+    run_on_start: bool = True,
 ) -> t.Callable[[t.Callable[P, t.Awaitable[None]]], IntervalLoop[P]]:
     """A decorator to create an [`IntervalLoop`][arc.utils.loops.IntervalLoop] out of a coroutine function.
 
@@ -270,6 +319,9 @@ def interval_loop(
         The number of hours to wait before running the coroutine again.
     days : float, optional
         The number of days to wait before running the coroutine again.
+    run_on_start : bool, optional
+        Whether to run the callback immediately after starting the loop.
+        If set to false, the loop will wait for the specified interval before first running the callback.
 
     Returns
     -------
@@ -283,7 +335,7 @@ def interval_loop(
     TypeError
         If the decorated function is not a coroutine function.
 
-    Examples
+    Example
     --------
     ```py
     import arc
@@ -300,12 +352,14 @@ def interval_loop(
     """
 
     def decorator(coro: t.Callable[P, t.Awaitable[None]]) -> IntervalLoop[P]:
-        return IntervalLoop(coro, seconds=seconds, minutes=minutes, hours=hours, days=days)
+        return IntervalLoop(coro, seconds=seconds, minutes=minutes, hours=hours, days=days, run_on_start=run_on_start)
 
     return decorator
 
 
-def cron_loop(cron_format: str) -> t.Callable[[t.Callable[P, t.Awaitable[None]]], CronLoop[P]]:
+def cron_loop(
+    cron_format: str, timezone: datetime.timezone = datetime.timezone.utc
+) -> t.Callable[[t.Callable[P, t.Awaitable[None]]], CronLoop[P]]:
     """Decorator to create a [`CronLoop`][arc.utils.loops.CronLoop] out of a coroutine function.
 
     !!! warning
@@ -319,6 +373,8 @@ def cron_loop(cron_format: str) -> t.Callable[[t.Callable[P, t.Awaitable[None]]]
     ----------
     cron_format : str
         The cron format to use. See https://en.wikipedia.org/wiki/Cron for more information.
+    timezone : datetime.timezone
+        The timezone to use for the cron loop. Defaults to UTC.
 
     Returns
     -------
@@ -334,7 +390,7 @@ def cron_loop(cron_format: str) -> t.Callable[[t.Callable[P, t.Awaitable[None]]]
     TypeError
         If the decorated function is not a coroutine function.
 
-    Examples
+    Example
     --------
     ```py
     import arc
@@ -351,7 +407,7 @@ def cron_loop(cron_format: str) -> t.Callable[[t.Callable[P, t.Awaitable[None]]]
     """
 
     def decorator(coro: t.Callable[P, t.Awaitable[None]]) -> CronLoop[P]:
-        return CronLoop(coro, cron_format)
+        return CronLoop(coro, cron_format, timezone=timezone)
 
     return decorator
 

{hikari_arc-1.3.1.dist-info → hikari_arc-1.3.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hikari-arc
-Version: 1.3.1
+Version: 1.3.3
 Summary: A command handler for hikari with a focus on type-safety and correctness.
 Home-page: https://github.com/hypergonial/hikari-arc
 Author: hypergonial
@@ -31,7 +31,7 @@ Provides-Extra: cron
 Requires-Dist: croniter ==2.0.5 ; extra == 'cron'
 Requires-Dist: types-croniter ==2.0.0.20240423 ; extra == 'cron'
 Provides-Extra: dev
-Requires-Dist: ruff ==0.4.4 ; extra == 'dev'
+Requires-Dist: ruff ==0.4.5 ; extra == 'dev'
 Requires-Dist: pyright ==1.1.364 ; extra == 'dev'
 Requires-Dist: nox ==2024.4.15 ; extra == 'dev'
 Requires-Dist: typing-extensions ==4.11.0 ; extra == 'dev'
@@ -41,7 +41,7 @@ Requires-Dist: slotscheck ==0.19.0 ; extra == 'dev'
 Provides-Extra: docs
 Requires-Dist: mkdocs-material[imaging] ~=9.5.24 ; extra == 'docs'
 Requires-Dist: mkdocs ~=1.6.0 ; extra == 'docs'
-Requires-Dist: mkdocstrings-python ~=1.10.2 ; extra == 'docs'
+Requires-Dist: mkdocstrings-python ~=1.10.3 ; extra == 'docs'
 Requires-Dist: black ~=24.4.2 ; extra == 'docs'
 Requires-Dist: griffe-inherited-docstrings ~=1.0.0 ; extra == 'docs'
 Requires-Dist: mkdocs-glightbox ~=0.4.0 ; extra == 'docs'

hikari_arc-1.3.3.dist-info/RECORD

@@ -0,0 +1,59 @@
+arc/__init__.py,sha256=jNbK-SPm7T-O5Ej555Obxni9SyfQ05Z2i_G_DwGVggw,6029
+arc/__main__.py,sha256=ClAG2bqkzmJfKrEMYTVzi0O5--8eY_QFuNAqsMmwVQY,2012
+arc/client.py,sha256=NyuXMmm087SggW82Oekw-VjQ4LhqgeBJG2qhl7SThy4,17850
+arc/errors.py,sha256=_RLNY-iivsbogHlv_ofSU8TwoIewOGZ_ruf6EKtPvbY,6802
+arc/events.py,sha256=WRXTLH9PBwU4GTu5rZS5AJ4fNxhDgSD9Rx3M-02FcDQ,2782
+arc/extension.py,sha256=UgtORuV7D3_zUHG1LGXrnhHvz8nntxHRncMrxleoPM0,3371
+arc/locale.py,sha256=nEKKQi-oKdU8VZQdWdFTL-tNECwhtTVv3I3vTsU_1f8,4921
+arc/plugin.py,sha256=8-TGlfxPUYy6uRr-o_LXYD4t5CnQ1lQvQ0psGkkI6L0,8622
+arc/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+arc/abc/__init__.py,sha256=J9KxcN9gHHKW_GDrJD_5fu76Ya6l4XvPHe0Vdqza0Pk,2277
+arc/abc/client.py,sha256=yp8Do85Zf3H1XM4RoKmw_gjpY50e3NmVKMD_aha2x90,54155
+arc/abc/command.py,sha256=u2wjx4PHFWlCFz2OyuMNOUSCf5l0Y1rn0d8yjVPtGC0,28462
+arc/abc/concurrency_limiting.py,sha256=Ed3AUb0veY2H85X8nz9qnAPFC9aRpx9dc4xApxzaLwE,4665
+arc/abc/error_handler.py,sha256=MvT6Pl6iCuTyRi8KFQBLzoPJLDS6UcH_nzLtxFmeRHw,3701
+arc/abc/hookable.py,sha256=qDb-PLJcLE8cE49YKQGvNUQ6B2B5ALRcPVssEXeznNw,5484
+arc/abc/limiter.py,sha256=kAPzIcoXcanAFNWIRmdIxelJHT4lb6HVaIwiDcpOdWI,1766
+arc/abc/option.py,sha256=jpEmCFuWI8_Qq36MZrKUxeU2JsywuANdQ6MYqScXu_E,12981
+arc/abc/plugin.py,sha256=VtR6qcjF3QUlKWHinp8Z6xK2NSe-Pq0jPaERmn1erl0,19700
+arc/command/__init__.py,sha256=TrVhqqfVR9K_RyMbng9TKZuix4nVLbTYOb78GZNOd8U,2542
+arc/command/message.py,sha256=Q-kxmQV2SajXPoEfol6UlC7DM7tIsOPQRwzuTH5L3a8,5943
+arc/command/slash.py,sha256=Vl8npjqxf2Dt3Mc1wqbnPA1QeDeTsReyn-KOYwo0hd0,35491
+arc/command/user.py,sha256=W8a4wPqLF2rHODCLgR4CZpQD3wGZQcnZ-1vHq_X9nks,5995
+arc/command/option/__init__.py,sha256=hEldXTprteztvDjUIq6oTEhD8ayN5Dwfg56E_18abhY,2117
+arc/command/option/attachment.py,sha256=N9DEVg3zO8hcJbU2fQyJGARfJl1DZQSd_7T5tX3Bxts,3004
+arc/command/option/bool.py,sha256=2rKV60LzAlKVUG4lGyNKP41eWMu5cRFLnNBn_ucdfDE,2902
+arc/command/option/channel.py,sha256=RHGehb2zKEMxW35Y5m18p7oTaXUAJ_ARaMTeinAqNvE,3718
+arc/command/option/float.py,sha256=892XO8dd3IS3gJK0FL9tQQAoWcju-iU_nLqGBPSgaTs,5142
+arc/command/option/int.py,sha256=cjhrI8UueYqPpEfaxQTh7Fb6YlDpztAgi3MilhuwktY,5092
+arc/command/option/mentionable.py,sha256=_mVHoQbI-kxI9oM5IxIwo-P-Yh19qbO5l_2oa2OJxiE,3110
+arc/command/option/role.py,sha256=i-eC7Nj6rIqRyg1bwwXFKB6cZ9OspC9Rjc_kXVa5BoI,2934
+arc/command/option/str.py,sha256=3Qr9Y2uoyrUNGeJL49Jjh9ps12_nbOHioDEVWB8uSac,5267
+arc/command/option/user.py,sha256=Qf9dqqmsSPB-yBjT4qAupKRfF1UHh9P3rKXZnRahFYE,2922
+arc/command/option/custom/__init__.py,sha256=rAAtOTZNLN0jKLncUH7kP35zpVyIMTuYvRazqG31axQ,225
+arc/command/option/custom/color.py,sha256=eBO85edOVztUu_m5kdvVGm0XYUVl9bpmWYTWizzOnTo,3474
+arc/command/option/custom/member.py,sha256=Jjn0ZWex6fv9x1iSUqcyFSAr90Oq8cK6OFCIQcr5HHA,3338
+arc/context/__init__.py,sha256=MOc71Up8gUAN8WfZkIzu3lDQhwZlwZbWFYWy3V7yCVQ,1303
+arc/context/autocomplete.py,sha256=YOu6leCKH0mfGVj0vmo4kj1_cWUM6c_vjgooymQ6sYY,3797
+arc/context/base.py,sha256=4hF_p-_mnzhdw5MlVLN7EATfKg8jGAKRkkXtxRggQbc,39976
+arc/ext/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+arc/internal/__init__.py,sha256=kZKBSFOkaDLe5kBvxiCQ-MWRPUZ_GBZdWwINPMkSbvo,1436
+arc/internal/about.py,sha256=QrNIGe5nB4YTG4flqf2hfzv9ZBTH9-UmnFaOVVgaErA,1414
+arc/internal/deprecation.py,sha256=Lnirv1z_oj6QJvbnd38TwHQnhHhFD2rTqqvH96pxiWE,2204
+arc/internal/options.py,sha256=EODBho9BdHOgjqqOVAEEbwOkZJiVfjFDDpUztGKUdK4,3622
+arc/internal/sigparse.py,sha256=EsewKxcidtuoY0clEAVh8nVGmTq5hvAHxqokGOAcZPk,13518
+arc/internal/sync.py,sha256=ApiHD66Gi8BOSUcEKRiZ_n03u9MNkftNjSDZz5Wk1_M,12589
+arc/internal/types.py,sha256=NXemzM6cR2pH2vV9CCr6CSZFJZNY_yaovzNifppUkUA,4365
+arc/internal/version.py,sha256=bZFtIbhehFhsGU2yyTVHb8YIvCYhp9iyueTalCKFtsg,2201
+arc/utils/__init__.py,sha256=vc8QYVVVOe95_kfWWb5lc8dFkJrs5SnpIJta_t0l3UI,2334
+arc/utils/concurrency_limiter.py,sha256=YocMFU0sajLWnsajzZ7T2Qvpd9PKjc2koDqflQTJtPM,12959
+arc/utils/loops.py,sha256=CqRe6tpgzdyvD3POHiSoXATDhPklalMtswvGhcBt964,14009
+arc/utils/ratelimiter.py,sha256=YPETOjQOga8RazYoK3Ghueh2TsOdfkH7WM58dr3ybcU,9477
+arc/utils/hooks/__init__.py,sha256=pXlAQ1zGxQV-bBeeL8sKRkUyO1PmEazT_a_XKtf7GFA,515
+arc/utils/hooks/basic.py,sha256=q6aXAyV7qPGbaQXg0Z2piPAVr1L9uN2hJGjXsbyumLE,5889
+arc/utils/hooks/limiters.py,sha256=D0brZBnLqhUF7ycs16JllsW6gYqdlHnNOISH8iMBWkw,7490
+hikari_arc-1.3.3.dist-info/LICENSE,sha256=q_osUjCCfQVI7zzgteLMZ-RlhXlB4rqQE8I0DGh7ur4,1076
+hikari_arc-1.3.3.dist-info/METADATA,sha256=03tCSLM3Jn-XPLzRpx3JKTegwcjaocgozm_rEaN2rG0,5563
+hikari_arc-1.3.3.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+hikari_arc-1.3.3.dist-info/top_level.txt,sha256=kTs_REfGfSlIT6Hq_kxH-MtDlOO6LPwFwkOoNdDCnJ4,4
+hikari_arc-1.3.3.dist-info/RECORD,,

hikari_arc-1.3.1.dist-info/RECORD

@@ -1,59 +0,0 @@
-arc/__init__.py,sha256=jNbK-SPm7T-O5Ej555Obxni9SyfQ05Z2i_G_DwGVggw,6029
-arc/__main__.py,sha256=ClAG2bqkzmJfKrEMYTVzi0O5--8eY_QFuNAqsMmwVQY,2012
-arc/client.py,sha256=bvyxtIVomFGRNUgEP3-D_SPM2FoYx4lAYuwB4ThwW58,17852
-arc/errors.py,sha256=_RLNY-iivsbogHlv_ofSU8TwoIewOGZ_ruf6EKtPvbY,6802
-arc/events.py,sha256=WRXTLH9PBwU4GTu5rZS5AJ4fNxhDgSD9Rx3M-02FcDQ,2782
-arc/extension.py,sha256=PSK7XcwPCDoUAyGWbNQlr3qDNGpijsZl97RWxteMp9E,3373
-arc/locale.py,sha256=nEKKQi-oKdU8VZQdWdFTL-tNECwhtTVv3I3vTsU_1f8,4921
-arc/plugin.py,sha256=AKc5lLU8eXjnKyiQxxs7wZm27qLI8kLCKQcX5CP8Lcs,8624
-arc/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-arc/abc/__init__.py,sha256=J9KxcN9gHHKW_GDrJD_5fu76Ya6l4XvPHe0Vdqza0Pk,2277
-arc/abc/client.py,sha256=MPQe4ZHeZgxsR0en6GDh8u9CDtivoJgGh_RYAlI_Yu0,54162
-arc/abc/command.py,sha256=rWaBt4pD2ivZdLRtqAcLrURrFSOBW3Oqdj1s_s9ALGw,28769
-arc/abc/concurrency_limiting.py,sha256=NefJQgftC-WzQNYehzzqmVuFY4MNHwPfQ8B4wqvjvUs,4666
-arc/abc/error_handler.py,sha256=RCuO35mibkncSPxUbaDcUPRzOXhS-et0Sa_7VKMjpuk,3702
-arc/abc/hookable.py,sha256=x5SjMQ314nPdnWsTV6ZELeDCKQMck2e24Ybv7BripzI,5486
-arc/abc/limiter.py,sha256=kAPzIcoXcanAFNWIRmdIxelJHT4lb6HVaIwiDcpOdWI,1766
-arc/abc/option.py,sha256=NgIPl1mbSpxfoVt10V95aKDMAhdUE9fzTgxyQFZzx7s,12982
-arc/abc/plugin.py,sha256=Kl3n43XB2HE6DcCsU4eZ5O37WqTCsTemwAfPioraEJ8,19703
-arc/command/__init__.py,sha256=TrVhqqfVR9K_RyMbng9TKZuix4nVLbTYOb78GZNOd8U,2542
-arc/command/message.py,sha256=b0DjJoIQV9FlfGx3uZQPAmHfv0cBHJoIhXfVhusT9OA,5944
-arc/command/slash.py,sha256=kfOw26t7QdkfxGovf8pk4RaMmrTgvFekM87B33X31hc,35485
-arc/command/user.py,sha256=XJV_6gYwE4vpwBFw2shlQUwUIJL972N0qZpNVoxXa2c,5996
-arc/command/option/__init__.py,sha256=hEldXTprteztvDjUIq6oTEhD8ayN5Dwfg56E_18abhY,2117
-arc/command/option/attachment.py,sha256=wXv6AJT5F0500PKkkh3inR3QQafrPuX5a4gKk72o2H8,3047
-arc/command/option/bool.py,sha256=4dNCAZooDtzMXDdKPPQ3DFtY-EIXkmYMHRDZvATCxWs,2945
-arc/command/option/channel.py,sha256=dAWm0JNiq6z4JKloZZy00Sh3jrcvxFn5NpJWt7iugWc,3761
-arc/command/option/float.py,sha256=vonlUXPI8wID7Yh60WvmgW5mVYGlNtPMMMv5c4HAZUo,5185
-arc/command/option/int.py,sha256=SJuJWrVzrrot-dkDZe5B12crV2pCMVD73jxJwhLm3HY,5135
-arc/command/option/mentionable.py,sha256=QRzCFknERoNDHHqlzTRIsp-d307F2BhBIqHmlkRow9s,3153
-arc/command/option/role.py,sha256=Tdb1ep7otySvPPZuxutTPyUimBd_ZirHcCWIS8TMXA8,2977
-arc/command/option/str.py,sha256=DcovOnAVqQ3wnIdzXbxm8s_da6qcgtqWbbhwhNheAMo,5310
-arc/command/option/user.py,sha256=4R0GtzX5dNJYL27OZQNT7_rcD-jrTSxRnuKgpNyQk5c,2965
-arc/command/option/custom/__init__.py,sha256=rAAtOTZNLN0jKLncUH7kP35zpVyIMTuYvRazqG31axQ,225
-arc/command/option/custom/color.py,sha256=_vLHbaEo78bUrQXqPi0qmbDtBMtFsbX2icTDp74I8EE,3517
-arc/command/option/custom/member.py,sha256=5tK1weEryp9LH0RdE9XBzXKZt7mUdYCJwwTaXSGYfGk,3381
-arc/context/__init__.py,sha256=MOc71Up8gUAN8WfZkIzu3lDQhwZlwZbWFYWy3V7yCVQ,1303
-arc/context/autocomplete.py,sha256=YOu6leCKH0mfGVj0vmo4kj1_cWUM6c_vjgooymQ6sYY,3797
-arc/context/base.py,sha256=MUZe8abJUwzFUsnv_WsxHPKDQswI4IUImyozjgnGDs8,39977
-arc/ext/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-arc/internal/__init__.py,sha256=kZKBSFOkaDLe5kBvxiCQ-MWRPUZ_GBZdWwINPMkSbvo,1436
-arc/internal/about.py,sha256=AyaKo5EADmNJPkrNqjvdEswZXMy1LZyf67HwBLzL8Bw,1414
-arc/internal/deprecation.py,sha256=Lnirv1z_oj6QJvbnd38TwHQnhHhFD2rTqqvH96pxiWE,2204
-arc/internal/options.py,sha256=EODBho9BdHOgjqqOVAEEbwOkZJiVfjFDDpUztGKUdK4,3622
-arc/internal/sigparse.py,sha256=EsewKxcidtuoY0clEAVh8nVGmTq5hvAHxqokGOAcZPk,13518
-arc/internal/sync.py,sha256=ApiHD66Gi8BOSUcEKRiZ_n03u9MNkftNjSDZz5Wk1_M,12589
-arc/internal/types.py,sha256=NXemzM6cR2pH2vV9CCr6CSZFJZNY_yaovzNifppUkUA,4365
-arc/internal/version.py,sha256=bZFtIbhehFhsGU2yyTVHb8YIvCYhp9iyueTalCKFtsg,2201
-arc/utils/__init__.py,sha256=vc8QYVVVOe95_kfWWb5lc8dFkJrs5SnpIJta_t0l3UI,2334
-arc/utils/concurrency_limiter.py,sha256=7wz7bfzvCna5Ai50EAw1SaY8ZmZy-Bc68NwubhQExxc,12965
-arc/utils/loops.py,sha256=nCKGy0tTwpR49gDAZJaVwetMgIBM_WbqIpEyDIqBcjE,12064
-arc/utils/ratelimiter.py,sha256=YPETOjQOga8RazYoK3Ghueh2TsOdfkH7WM58dr3ybcU,9477
-arc/utils/hooks/__init__.py,sha256=pXlAQ1zGxQV-bBeeL8sKRkUyO1PmEazT_a_XKtf7GFA,515
-arc/utils/hooks/basic.py,sha256=e09raCnIcGMpBMd4uvzBCofNij2aGAmXPO2AuC8cXZY,5894
-arc/utils/hooks/limiters.py,sha256=So6BZxSy3AdexM1UHWt8cILGQ8b-Fp78DYfqqw4yvdM,7496
-hikari_arc-1.3.1.dist-info/LICENSE,sha256=q_osUjCCfQVI7zzgteLMZ-RlhXlB4rqQE8I0DGh7ur4,1076
-hikari_arc-1.3.1.dist-info/METADATA,sha256=juQrw3lZ5xNQINwBHMfq0o0z7yFIWhJS_c6nn-M6ymQ,5563
-hikari_arc-1.3.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-hikari_arc-1.3.1.dist-info/top_level.txt,sha256=kTs_REfGfSlIT6Hq_kxH-MtDlOO6LPwFwkOoNdDCnJ4,4
-hikari_arc-1.3.1.dist-info/RECORD,,