abstract-block-dumper 0.0.4__tar.gz → 0.0.6__tar.gz

{abstract_block_dumper-0.0.4 → abstract_block_dumper-0.0.6}/CHANGELOG.md

@@ -9,6 +9,11 @@ upcoming release can be found in [changelog.d](changelog.d).
 
 <!-- towncrier release notes start -->
 
+## [0.0.6](https://github.com/bactensor/abstract-block-dumper/releases/tag/v0.0.6) - 2025-11-26
+
+No significant changes.
+
+
 ## [0.0.4](https://github.com/bactensor/abstract-block-dumper/releases/tag/v0.0.4) - 2025-11-17
 
 No significant changes.

{abstract_block_dumper-0.0.4 → abstract_block_dumper-0.0.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: abstract-block-dumper
-Version: 0.0.4
+Version: 0.0.6
 Project-URL: Source, https://github.com/bactensor/abstract-block-dumper
 Project-URL: Issue Tracker, https://github.com/bactensor/abstract-block-dumper/issues
 Author-email: Reef Technologies <opensource@reef.pl>
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Topic :: Software Development :: Libraries
 Requires-Python: >=3.11
 Requires-Dist: bittensor>=9.10.1
-Requires-Dist: celery>=5.5.3
+Requires-Dist: celery>=5.3
 Requires-Dist: django<6.0,>=3.2
 Requires-Dist: structlog>=25.4.0
 Description-Content-Type: text/markdown
@@ -104,18 +104,21 @@ In your project's `celery.py` file, add the following to ensure Celery workers c
 
 ```python
 from celery import Celery
-from celery.signals import worker_ready
+from celery.signals import celeryd_init
 from django.conf import settings
 
 app = Celery('your_project')
 app.config_from_object('django.conf:settings', namespace='CELERY')
 app.autodiscover_tasks()
 
-@worker_ready.connect
-def on_worker_ready(**kwargs):
-    """Load block tasks when worker starts."""
+
+
+@celeryd_init.connect
+def on_worker_init(**kwargs) -> None:
+    """Load block tasks when worker initializes."""
     from abstract_block_dumper.v1.celery import setup_celery_tasks
     setup_celery_tasks()
+
 ```
 
 > **Important:** Without this step, Celery workers will not recognize your `@block_task` decorated functions, and you'll see "Received unregistered task" errors.
@@ -154,7 +157,7 @@ from abstract_block_dumper.v1.decorators import block_task
 
 
 # Process every block
-@block_task(condition=lambda bn: True)
+@block_task
 def process_every_block(block_number: int):
     print(f"Processing every block: {block_number}")
 

{abstract_block_dumper-0.0.4 → abstract_block_dumper-0.0.6}/README.md

@@ -82,18 +82,21 @@ In your project's `celery.py` file, add the following to ensure Celery workers c
 
 ```python
 from celery import Celery
-from celery.signals import worker_ready
+from celery.signals import celeryd_init
 from django.conf import settings
 
 app = Celery('your_project')
 app.config_from_object('django.conf:settings', namespace='CELERY')
 app.autodiscover_tasks()
 
-@worker_ready.connect
-def on_worker_ready(**kwargs):
-    """Load block tasks when worker starts."""
+
+
+@celeryd_init.connect
+def on_worker_init(**kwargs) -> None:
+    """Load block tasks when worker initializes."""
     from abstract_block_dumper.v1.celery import setup_celery_tasks
     setup_celery_tasks()
+
 ```
 
 > **Important:** Without this step, Celery workers will not recognize your `@block_task` decorated functions, and you'll see "Received unregistered task" errors.
@@ -132,7 +135,7 @@ from abstract_block_dumper.v1.decorators import block_task
 
 
 # Process every block
-@block_task(condition=lambda bn: True)
+@block_task
 def process_every_block(block_number: int):
     print(f"Processing every block: {block_number}")
 

{abstract_block_dumper-0.0.4 → abstract_block_dumper-0.0.6}/example_project/block_explorer/tasks.py

@@ -1,18 +1,37 @@
 from abstract_block_dumper.v1.decorators import block_task
 
 
-@block_task(
-    condition=lambda bn: True,
-)
-def process_every_block(block_number: int, netuid: int | None = None):
+@block_task
+def process_every_block(block_number: int, netuid: int | None = None) -> str:
+    """
+    Example task that processes every block.
+
+    Args:
+        block_number (int): The block number to process.
+        netuid (int | None): The NetUID to process, if applicable.
+
+    Returns:
+        str: A message indicating the block has been processed.
+
+    """
     return f"Processed block {block_number} for NetUID {netuid}"
 
 
 @block_task(
-    condition=lambda bn: True,
     backfilling_lookback=100,
 )
-def backfill_previous_100_blocks(block_number: int, netuid: int | None = None):
+def backfill_previous_100_blocks(block_number: int, netuid: int | None = None) -> str:
+    """
+    Example task that backfills the previous 100 blocks.
+
+    Args:
+        block_number (int): The block number to process.
+        netuid (int | None): The NetUID to process, if applicable.
+
+    Returns:
+        str: A message indicating the block has been processed.
+
+    """
     return f"Processed block {block_number} for NetUID {netuid}"
 
 

{abstract_block_dumper-0.0.4 → abstract_block_dumper-0.0.6}/noxfile.py

@@ -18,6 +18,7 @@ MAIN_BRANCH_NAME = "master"
 PYTHON_VERSIONS = ["3.11", "3.12"]
 PYTHON_DEFAULT_VERSION = PYTHON_VERSIONS[-1]
 DJANGO_VERSIONS = ["3.2", "4.2"]
+CELERY_VERSIONS = ["5.3", "5.4", "5.5"]
 DEMO_APP_DIR = ROOT / "demo"
 
 nox.options.default_venv_backend = "venv"
@@ -152,9 +153,11 @@ def lint(session):
 
 @nox.session(python=PYTHON_VERSIONS, tags=["test", "check"])
 @nox.parametrize("django", DJANGO_VERSIONS)
-def test(session, django: str):
+@nox.parametrize("celery", CELERY_VERSIONS)
+def test(session, django: str, celery: str):
     install(session, "test", editable=True)
     session.run("pip", "install", f"django~={django}.0")
+    session.run("pip", "install", f"celery~={celery}.0")
     session.run("pytest", "-vv", "-n", "auto", *session.posargs)
 
 

{abstract_block_dumper-0.0.4 → abstract_block_dumper-0.0.6}/pyproject.toml

@@ -22,7 +22,7 @@ dynamic = [
 ]
 dependencies = [
     "bittensor>=9.10.1",
-    "celery>=5.5.3",
+    "celery>=5.3",
     "django>=3.2,<6.0",
     "structlog>=25.4.0",
 ]
@@ -91,7 +91,7 @@ ignore = [
 
 [tool.ruff.lint.per-file-ignores]
 "__init__.py" = ["F401"]
-"test/**" = ["D", "F403", "F405"]
+"tests/**" = ["D", "ANN", "F403", "F405", "S101"]
 
 [tool.codespell]
 skip = "*.min.js,uv.lock"

{abstract_block_dumper-0.0.4 → abstract_block_dumper-0.0.6}/src/abstract_block_dumper/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.0.4'
-__version_tuple__ = version_tuple = (0, 0, 4)
+__version__ = version = '0.0.6'
+__version_tuple__ = version_tuple = (0, 0, 6)
 
 __commit_id__ = commit_id = None

{abstract_block_dumper-0.0.4 → abstract_block_dumper-0.0.6}/src/abstract_block_dumper/v1/decorators.py

@@ -134,24 +134,39 @@ def _celery_task_wrapper(
 
 
 def block_task(
-    condition: Callable[..., bool],
+    func: Callable[..., Any] | None = None,
+    *,
+    condition: Callable[..., bool] | None = None,
     args: list[dict[str, Any]] | None = None,
     backfilling_lookback: int | None = None,
     celery_kwargs: dict[str, Any] | None = None,
 ) -> Callable[..., Any]:
     """
-    Register a block task.
+    Decorator to register a function as a block task.
+
+    Block task is a function that will be executed conditionally on each new block.
+    The condition is a callable that takes the block number and any additional arguments,
+    and returns a boolean indicating whether to execute the task.
 
     Args:
-        condition: Lambda function that determines when to execute
+        func: The function to decorate (used when decorator is applied without parentheses)
+        condition: Lambda function that determines when to execute the task. It should accept
+                   block_number and any additional args as parameters and return a boolean.
+                   Defaults to always True (run on every block).
         args: List of argument dictionaries for multi-execution
         backfilling_lookback: Number of blocks to backfill
         celery_kwargs: Additional Celery task parameters
 
     Examples:
-        @block_task(
-            condition=lambda bn: bn % 100 == 0
-        )
+        @block_task
+        def run_on_every_block(block_number: int):
+            pass
+
+        @block_task()
+        def also_runs_on_every_block(block_number: int):
+            pass
+
+        @block_task(condition=lambda bn: bn % 100 == 0)
         def simple_task(block_number: int):
             pass
 
@@ -165,9 +180,11 @@ def block_task(
             pass
 
     """
+    # Default condition: always run
+    effective_condition = condition if condition is not None else (lambda *_args, **_kwargs: True)
 
-    def decorator(func: Callable[..., Any]) -> Any:
-        if not callable(condition):
+    def decorator(fn: Callable[..., Any]) -> Any:
+        if not callable(effective_condition):
             msg = "condition must be a callable."
             raise TypeError(msg)
 
@@ -179,22 +196,22 @@ def block_task(
 
             This entire wrapper becomes a Celery task.
             """
-            return _celery_task_wrapper(func, block_number, **kwargs)
+            return _celery_task_wrapper(fn, block_number, **kwargs)
 
         # Wrap with celery shared_task
         celery_task = shared_task(
-            name=abd_utils.get_executable_path(func),
+            name=abd_utils.get_executable_path(fn),
             bind=False,
             **celery_kwargs or {},
         )(shared_celery_task)
 
         # Store original function referefence for introspection
-        celery_task._original_func = func  # noqa: SLF001
+        celery_task._original_func = fn  # noqa: SLF001
 
         # Register the Celery task
         task_registry.register_item(
             RegistryItem(
-                condition=condition,
+                condition=effective_condition,
                 function=cast("Task", celery_task),
                 args=args,
                 backfilling_lookback=backfilling_lookback,
@@ -203,4 +220,9 @@ def block_task(
         )
         return celery_task
 
+    # If func is provided, decorator was used without parentheses: @block_task
+    if func is not None:
+        return decorator(func)
+
+    # Otherwise, decorator was used with parentheses: @block_task() or @block_task(condition=...)
     return decorator

{abstract_block_dumper-0.0.4 → abstract_block_dumper-0.0.6}/tests/integration/test_registered_celery_tasks.py

@@ -47,7 +47,7 @@ def test_task_execution_failure_and_retry():
         executable_path=executable_path,
     )
 
-    block_task(condition=lambda bn: True)(failing_task_func)
+    block_task()(failing_task_func)
 
     registry_item = task_registry.get_by_executable_path(task_attempt.executable_path)
     assert registry_item is not None
@@ -68,7 +68,6 @@ def test_process_backfill():
     backfill_amount = 10
 
     block_task(
-        condition=lambda bn: True,
         backfilling_lookback=backfill_amount,
     )(backfill_task)
 

{abstract_block_dumper-0.0.4 → abstract_block_dumper-0.0.6}/tests/integration/test_scheduler.py

@@ -41,7 +41,7 @@ def test_task_failure_triggers_retry():
     executable_path = abd_utils.get_executable_path(failing_task)
     task_attempt, _ = abd_dal.task_create_or_get_pending(block_number, executable_path)
 
-    block_task(condition=lambda _bn: True)(failing_task)
+    block_task(failing_task)
 
     registry_item = task_registry.get_by_executable_path(executable_path)
 
@@ -68,7 +68,7 @@ def test_successful_retry_completes_task() -> None:
     executable_path = abd_utils.get_executable_path(flaky_function)
     task_attempt, _ = abd_dal.task_create_or_get_pending(current_block, executable_path)
 
-    block_task(lambda _bn: True)(flaky_function)
+    block_task(flaky_function)
 
     registry_item = task_registry.get_by_executable_path(executable_path)
     assert registry_item is not None
@@ -90,7 +90,7 @@ def test_restry_schedules_celery_task_with_eta():
     executable_path = abd_utils.get_executable_path(failing_task)
     task_attempt, _ = abd_dal.task_create_or_get_pending(current_block, executable_path)
 
-    block_task(condition=lambda _bn: True)(failing_task)
+    block_task(failing_task)
 
     registry_item = task_registry.get_by_executable_path(executable_path)
     assert registry_item is not None
@@ -137,7 +137,7 @@ def test_retry_recover_mechanism():
         size=batch_size, is_success=True, executable_path=executable_path, next_retry_at=past_time, attempt_count=1
     )
 
-    block_task(lambda _bn: True)(successful_task)
+    block_task(successful_task)
 
     task_registry.get_by_executable_path(executable_path)
 

{abstract_block_dumper-0.0.4 → abstract_block_dumper-0.0.6}/uv.lock

@@ -42,7 +42,7 @@ test = [
 [package.metadata]
 requires-dist = [
     { name = "bittensor", specifier = ">=9.10.1" },
-    { name = "celery", specifier = ">=5.5.3" },
+    { name = "celery", specifier = ">=5.3" },
     { name = "django", specifier = ">=3.2,<6.0" },
     { name = "structlog", specifier = ">=25.4.0" },
 ]