celery-bittensor 0.1__py3-none-any.whl

celery_bittensor/__init__.py

@@ -0,0 +1,9 @@
+from .schedules import (
+    schedule,
+)
+from .version import __version__
+
+__all__ = [
+    "__version__",
+    "schedule",
+]

celery_bittensor/client.py

@@ -0,0 +1,106 @@
+import asyncio
+import contextlib
+import datetime
+import logging
+import threading
+from typing import NamedTuple
+
+logger = logging.getLogger(__name__)
+
+
+class Block(NamedTuple):
+    number: int
+    timestamp: datetime.datetime
+
+
+class BittensorSynced:
+    RETRY = datetime.timedelta(seconds=5)
+
+    def __init__(
+        self,
+        network: str,
+        finalized: bool,
+    ):
+        self.network = network
+        self.finalized = finalized
+
+        self.block: Block | None = None
+        self.block_time: float | None = None
+
+        self._thread = threading.Thread(
+            daemon=True,
+            name=f"BittensorSynced[{self.network}]",
+            target=self._run,
+        )
+        self._stop = threading.Event()
+
+        self._loop: asyncio.AbstractEventLoop | None = None
+        self._task: asyncio.Task | None = None
+
+    def start(self) -> None:
+        self._thread.start()
+
+    def stop(self) -> None:
+        self._stop.set()
+
+        loop, task = self._loop, self._task
+
+        if loop and task:
+            with contextlib.suppress(RuntimeError):
+                loop.call_soon_threadsafe(task.cancel)
+
+    def join(self) -> None:
+        self._thread.join()
+
+    def _run(self) -> None:
+        try:
+            asyncio.run(self._main())
+        except asyncio.CancelledError:
+            pass
+        finally:
+            self._loop = None
+            self._task = None
+
+    async def _main(self) -> None:
+        self._loop = asyncio.get_running_loop()
+        self._task = asyncio.current_task()
+
+        if self._stop.is_set():
+            return
+
+        while True:
+            try:
+                await self._blocks_generator()
+            except Exception:
+                self.block = None
+
+                logger.exception(
+                    "Error occured during processing on %s. Reconnecting in %ds",
+                    self.network,
+                    self.RETRY.total_seconds(),
+                )
+
+            await asyncio.sleep(self.RETRY.total_seconds())
+
+    async def _blocks_generator(self) -> None:
+        import bittensor
+
+        logger.info("Connecting to %s", self.network)
+
+        async with bittensor.Subtensor(
+            network=self.network,
+            retry_forever=True,
+        ) as client:
+            logger.info("Connected to %s. Checking block time", self.network)
+
+            self.block_time = await client.block_time()
+
+            logger.info("Awaiting for blocks on %s", self.network)
+
+            async for block in client.blocks(finalized=self.finalized):
+                logger.info("New block received on %s: %d", self.network, block.number)
+
+                self.block = Block(
+                    block.number,
+                    datetime.datetime.now(datetime.timezone.utc),
+                )

celery_bittensor/schedules.py

@@ -0,0 +1,185 @@
+import atexit
+import datetime
+import threading
+from collections.abc import Callable
+from typing import ClassVar
+
+import celery.schedules
+
+from .client import BittensorSynced, Block
+
+
+class BaseBittensorSchedule(celery.schedules.BaseSchedule):
+    INIT_PULL = datetime.timedelta(microseconds=100)
+
+    _lock: ClassVar[threading.Lock] = threading.Lock()
+    _clients: ClassVar[dict[tuple[str, bool], BittensorSynced]] = {}
+
+    def __init__(
+        self,
+        network: str = "finney",
+        finalized: bool = True,
+        nowfun: Callable | None = None,
+        app: celery.Celery | None = None,
+    ):
+        super().__init__(nowfun, app)
+
+        self.network = network
+        self.finalized = finalized
+        self.last_run_at = Block(0, self.maybe_make_aware(datetime.datetime.min))
+
+        self._bittensor: BittensorSynced | None = None
+
+    def __eq__(self, other: object) -> bool:
+        if isinstance(other, BaseBittensorSchedule):
+            return (
+                self.network == other.network
+                and self.finalized == other.finalized
+                and super().__eq__(other)
+            )
+
+        return NotImplemented
+
+    def __getstate__(self) -> dict:
+        return {
+            "finalized": self.finalized,
+            "last_run_at": self.last_run_at,
+            "network": self.network,
+            "nowfun": self.nowfun,
+        }
+
+    def __setstate__(self, state: dict) -> None:
+        self.__dict__.update(state)
+        self._app = None
+        self._bittensor = None
+
+    @property
+    def bittensor(self) -> BittensorSynced:
+        if not self._bittensor:
+            with BaseBittensorSchedule._lock:
+                if (self.network, self.finalized) not in BaseBittensorSchedule._clients:
+                    BaseBittensorSchedule._clients[(self.network, self.finalized)] = (
+                        BittensorSynced(
+                            network=self.network,
+                            finalized=self.finalized,
+                        )
+                    )
+                    BaseBittensorSchedule._clients[
+                        (self.network, self.finalized)
+                    ].start()
+
+                self._bittensor = BaseBittensorSchedule._clients[
+                    (self.network, self.finalized)
+                ]
+
+        return self._bittensor
+
+    def is_due(self, last_run_at: datetime.datetime) -> celery.schedules.schedstate:
+        if not self.bittensor.block_time:
+            return celery.schedules.schedstate(
+                is_due=False, next=self.INIT_PULL.total_seconds()
+            )
+
+        block = self.bittensor.block
+
+        if not block:
+            return celery.schedules.schedstate(
+                is_due=False, next=self.INIT_PULL.total_seconds()
+            )
+
+        if self.last_run_at.number == 0:
+            self.last_run_at = block
+
+        is_due = self._prev_block(block.number) > self.last_run_at.number
+
+        if is_due:
+            self.last_run_at = block
+
+        return celery.schedules.schedstate(
+            is_due=is_due,
+            next=self._time_until_next(block).total_seconds(),
+        )
+
+    def _next_block(self, block: int) -> int:
+        raise NotImplementedError
+
+    def _prev_block(self, block: int) -> int:
+        raise NotImplementedError
+
+    def _time_until_next(self, block: Block) -> datetime.timedelta:
+        assert self.bittensor.block_time is not None
+
+        target = self._next_block(block.number)
+        elapsed = self.maybe_make_aware(self.now()) - block.timestamp
+        remaining = (target - block.number) * datetime.timedelta(
+            seconds=self.bittensor.block_time
+        ) - elapsed
+
+        return max(remaining, self.INIT_PULL)
+
+
+class schedule(BaseBittensorSchedule):
+    def __init__(
+        self,
+        run_every: int,
+        relative: bool = False,
+        network: str = "finney",
+        finalized: bool = True,
+        nowfun: Callable | None = None,
+        app: celery.Celery | None = None,
+    ):
+        if not isinstance(run_every, int):
+            raise TypeError("run_every must be an integer")
+
+        if run_every <= 0:
+            raise ValueError("run_every must be a positive integer")
+
+        super().__init__(
+            network,
+            finalized,
+            nowfun,
+            app,
+        )
+
+        self.run_every = run_every
+        self.relative = relative
+
+    def __eq__(self, other: object) -> bool:
+        if isinstance(other, schedule):
+            return (
+                self.run_every == other.run_every
+                and self.relative == other.relative
+                and super().__eq__(other)
+            )
+
+        return self.run_every == other
+
+    def __getstate__(self) -> dict:
+        state = super().__getstate__()
+        state.update({
+            "run_every": self.run_every,
+            "relative": self.relative,
+        })
+
+        return state
+
+    def _next_block(self, block: int) -> int:
+        return self._prev_block(block) + self.run_every
+
+    def _prev_block(self, block: int) -> int:
+        if self.relative:
+            base = self.last_run_at.number
+            return base + (block - base) // self.run_every * self.run_every
+
+        return block - block % self.run_every
+
+
+def stop_watchers() -> None:
+    for watcher in BaseBittensorSchedule._clients.values():
+        watcher.stop()
+
+    for watcher in BaseBittensorSchedule._clients.values():
+        watcher.join()
+
+
+atexit.register(stop_watchers)

celery_bittensor/version.py

@@ -0,0 +1 @@
+__version__ = "0.1"

celery_bittensor-0.1.dist-info/METADATA

@@ -0,0 +1,53 @@
+Metadata-Version: 2.5
+Name: celery-bittensor
+Version: 0.1
+Summary: Celery's Bittensor Schedule
+Project-URL: Homepage, https://github.com/zyzniewski/celery-bittensor
+Project-URL: Issues, https://github.com/zyzniewski/celery-bittensor/issues
+Author-email: Tomasz Żyźniewski <zyzniewski@gmail.com>
+License-Expression: BSD-3-Clause
+License-File: LICENSE
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: bittensor==11.*
+Requires-Dist: celery==5.*
+Description-Content-Type: text/markdown
+
+# celery-bittensor
+Bittensor's Schedule for Celery
+
+## Installation
+
+```
+pip install celery-bittensor
+```
+
+Requires Python 3.10+.
+
+
+## Example
+
+```python
+import celery
+import celery_bittensor
+
+app = celery.Celery()
+
+
+@app.on_after_configure.connect
+def setup_periodic_tasks(sender: celery.Celery, **kwargs):
+    # Calls test('hello') every 10 blocks.
+    sender.add_periodic_task(
+        celery_bittensor.schedule(10), test.s("hello"), name="add every 10"
+    )
+
+
+@app.task
+def test(arg):
+    print(arg)
+```
+
+## License
+
+BSD 3-Clause License, see [LICENSE](LICENSE).

celery_bittensor-0.1.dist-info/RECORD

@@ -0,0 +1,8 @@
+celery_bittensor/__init__.py,sha256=ZhV5pfKa7xb3hGP0nc9rrIhn2rxLJ6NYH8pg2oBuGeI,124
+celery_bittensor/client.py,sha256=PPqWvigm76FyTVRYGfDs7MsHBmLrvGAqEm7-MViqyEo,2782
+celery_bittensor/schedules.py,sha256=cQGkw3pknLlI9ccXBJlL0uYGDdoxHshrPB_kWMnNPnI,5476
+celery_bittensor/version.py,sha256=Lgf9keBX7aG_JEFt6UYSyiFKcm-BYGtmk9ohpQhYpyk,20
+celery_bittensor-0.1.dist-info/METADATA,sha256=9U73-H_zo6cnfwV2yIefoNrXHCyb07FN2RnXLWwMoxA,1138
+celery_bittensor-0.1.dist-info/WHEEL,sha256=2iZrJkDIkeDh0k9SikKMqFuRP-ua6mb4Ir1AsER4BEw,87
+celery_bittensor-0.1.dist-info/licenses/LICENSE,sha256=OnbdkWVXvRm9va0E0Q0DESJIxEM-wrmwVTku_pEwGdM,1506
+celery_bittensor-0.1.dist-info/RECORD,,

celery_bittensor-0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.33.0
+Root-Is-Purelib: true
+Tag: py3-none-any

celery_bittensor-0.1.dist-info/licenses/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Tomasz Żyźniewski
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.