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

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.0"
+__version__: t.Final[str] = "1.3.1"
 
 # MIT License
 #

arc/utils/loops.py

@@ -25,12 +25,13 @@ class _LoopBase(abc.ABC, t.Generic[P]):
     - [`CronLoop`][arc.utils.loops.CronLoop]
     """
 
-    __slots__ = ("_coro", "_task", "_failed", "_stop_next")
+    __slots__ = ("_coro", "_task", "_failed", "_stop_next", "_run_on_start")
 
-    def __init__(self, callback: t.Callable[P, t.Awaitable[None]]) -> None:
+    def __init__(self, callback: t.Callable[P, t.Awaitable[None]], *, run_on_start: bool = True) -> None:
         self._coro = callback
         self._task: asyncio.Task[None] | None = None
         self._failed: int = 0
+        self._run_on_start: bool = run_on_start
         self._stop_next: bool = False
 
         if not inspect.iscoroutinefunction(self._coro):
@@ -51,23 +52,28 @@ class _LoopBase(abc.ABC, t.Generic[P]):
             The number of seconds to wait before running the coroutine again.
         """
 
+    async def _call_callback(self, *args: P.args, **kwargs: P.kwargs) -> None:
+        """Call the callback and handle exceptions."""
+        try:
+            await self._coro(*args, **kwargs)
+        except Exception as e:
+            traceback_msg = "\n".join(traceback.format_exception(type(e), e, e.__traceback__))
+            print(f"Loop encountered exception: {e}", file=sys.stderr)
+            print(traceback_msg, file=sys.stderr)
+
+            if self._failed < 3:
+                self._failed += 1
+            else:
+                raise RuntimeError(f"Loop failed repeatedly, stopping it. Exception: {e}")
+
     async def _loopy_loop(self, *args: P.args, **kwargs: P.kwargs) -> None:
         """Main loop logic."""
+        if self._run_on_start:
+            await self._call_callback(*args, **kwargs)
+
         while not self._stop_next:
-            try:
-                await self._coro(*args, **kwargs)
-            except Exception as e:
-                traceback_msg = "\n".join(traceback.format_exception(type(e), e, e.__traceback__))
-                print(f"Loop encountered exception: {e}", file=sys.stderr)
-                print(traceback_msg, file=sys.stderr)
-
-                if self._failed < 3:
-                    self._failed += 1
-                    await asyncio.sleep(self._get_next_run())
-                else:
-                    raise RuntimeError(f"Loop failed repeatedly, stopping it. Exception: {e}")
-            else:
-                await asyncio.sleep(self._get_next_run())
+            await asyncio.sleep(self._get_next_run())
+            await self._call_callback(*args, **kwargs)
         self.cancel()
 
     def _create_task(self, *args: P.args, **kwargs: P.kwargs) -> asyncio.Task[None]:
@@ -135,6 +141,9 @@ class IntervalLoop(_LoopBase[P]):
         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.
 
     Raises
     ------
@@ -164,8 +173,9 @@ class IntervalLoop(_LoopBase[P]):
         minutes: float | None = None,
         hours: float | None = None,
         days: float | None = None,
+        run_on_start: bool = True,
     ) -> None:
-        super().__init__(callback)
+        super().__init__(callback, run_on_start=run_on_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:
@@ -196,6 +206,8 @@ class CronLoop(_LoopBase[P]):
         The coroutine to run at the specified interval.
     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.
 
     Raises
     ------
@@ -217,20 +229,30 @@ class CronLoop(_LoopBase[P]):
     create a [`CronLoop`][arc.utils.loops.CronLoop] from a coroutine function.
     """
 
-    __slots__ = ("_iter",)
+    __slots__ = ("_iter", "_tz")
 
-    def __init__(self, callback: t.Callable[P, t.Awaitable[None]], cron_format: str) -> None:
-        super().__init__(callback)
+    def __init__(
+        self,
+        callback: t.Callable[P, t.Awaitable[None]],
+        cron_format: str,
+        *,
+        timezone: datetime.timezone = datetime.timezone.utc,
+    ) -> None:
+        super().__init__(callback, run_on_start=False)
+        self._tz = timezone
 
         try:
             import croniter
 
-            self._iter = croniter.croniter(cron_format, datetime.datetime.now())
+            self._iter = croniter.croniter(cron_format)
         except ImportError:
             raise ImportError("Missing dependency for CronLoop: 'croniter'")
 
     def _get_next_run(self) -> float:
-        return self._iter.get_next(float) - datetime.datetime.now().timestamp()
+        return (
+            self._iter.get_next(float, start_time=datetime.datetime.now(self._tz))
+            - datetime.datetime.now(self._tz).timestamp()
+        )
 
 
 def interval_loop(

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: hikari-arc
-Version: 1.3.0
+Version: 1.3.1
 Summary: A command handler for hikari with a focus on type-safety and correctness.
 Home-page: https://github.com/hypergonial/hikari-arc
 Author: hypergonial
@@ -32,16 +32,16 @@ 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: pyright ==1.1.362 ; 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'
-Requires-Dist: pytest ==8.2.0 ; extra == 'dev'
-Requires-Dist: pytest-asyncio ==0.23.6 ; extra == 'dev'
+Requires-Dist: pytest ==8.2.1 ; extra == 'dev'
+Requires-Dist: pytest-asyncio ==0.23.7 ; extra == 'dev'
 Requires-Dist: slotscheck ==0.19.0 ; extra == 'dev'
 Provides-Extra: docs
-Requires-Dist: mkdocs-material[imaging] ~=9.5.21 ; 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.0 ; extra == 'docs'
+Requires-Dist: mkdocstrings-python ~=1.10.2 ; 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.0.dist-info → hikari_arc-1.3.1.dist-info}/RECORD

@@ -38,7 +38,7 @@ arc/context/autocomplete.py,sha256=YOu6leCKH0mfGVj0vmo4kj1_cWUM6c_vjgooymQ6sYY,3
 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=yqP06bxBoLWzl0pwQGr-attZc9syZZvAf3uebXTAWKc,1414
+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
@@ -47,13 +47,13 @@ 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=Fj8G6QdvqgZa2VNGE1gJGR0kSyUqlGTjoSlGomWkhe0,11222
+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.0.dist-info/LICENSE,sha256=q_osUjCCfQVI7zzgteLMZ-RlhXlB4rqQE8I0DGh7ur4,1076
-hikari_arc-1.3.0.dist-info/METADATA,sha256=p0QVNaLrtoJvmZa4kA6jzk5cRKu_h_P2G31MtbLdb3Q,5563
-hikari_arc-1.3.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-hikari_arc-1.3.0.dist-info/top_level.txt,sha256=kTs_REfGfSlIT6Hq_kxH-MtDlOO6LPwFwkOoNdDCnJ4,4
-hikari_arc-1.3.0.dist-info/RECORD,,
+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,,