vtrr-queue 0.1.0__py3-none-any.whl

vtrr_queue/__init__.py

@@ -0,0 +1,3 @@
+from .queue import VTRRQueue, VTRRTask
+
+__all__ = ["VTRRQueue", "VTRRTask"]

vtrr_queue/queue.py

@@ -0,0 +1,316 @@
+import json
+import logging
+import uuid
+from pathlib import Path
+from typing import Any, Callable
+from celery import Task
+
+
+import redis as redis_lib
+
+logger = logging.getLogger(__name__)
+
+_SCRIPTS_DIR = Path(__file__).parent / "scripts"
+
+
+class VTRRTask:
+    def __init__(self, fn: Callable, vtrr: "VTRRQueue", celery_task: Any) -> None:
+        self._fn = fn
+        self._vtrr = vtrr
+        self._celery_task = celery_task
+        self.__name__ = fn.__name__
+        self.__module__ = fn.__module__
+        self.__doc__ = fn.__doc__
+
+    def __call__(self, *args: Any, **kwargs: Any) -> Any:
+        return self._fn(*args, **kwargs)
+
+    @property
+    def name(self) -> str:
+        return f"{self.__module__}.{self.__name__}"
+
+    def queue(self, partition_key: str, tasks: list[dict[str, Any]]) -> None:
+        """
+        Bulk-enqueue tasks into the VTRR queue.
+
+        Each entry in `tasks` should contain "weight" (int) "args" (list) and/or "kwargs" (dict).
+        Celery dequeue workers are scheduled automatically after enqueuing.
+
+        Example:
+            process_file.queue(
+                partition_key="u_123",
+                tasks=[
+                    {"weight": 4, "args": ["s3://bucket/a.pdf"], "kwargs": {"force_ocr": True}},
+                    {"weight": 10, "args": ["s3://bucket/b.pdf"]},
+                ],
+            )
+        """
+        if not partition_key:
+            raise ValueError("key_id is required")
+        if not tasks:
+            return
+
+        argv: list[str] = []
+        for task in tasks:
+            task_id = str(task.get("id", uuid.uuid4()))
+            task_weight = int(task.get("weight", 1))
+            payload = json.dumps(
+                {
+                    "task_name": self.name,
+                    "args": task.get("args", []),
+                    "kwargs": task.get("kwargs", {}),
+                }
+            )
+            argv += [partition_key, task_id, task_weight, payload]
+
+        self._vtrr._schedule_workers(len(tasks), self._celery_task)
+        self._vtrr._enqueue(argv)
+
+
+class _VTRRCeleryTask(Task):
+    """Base task for VTRR-dispatched functions.
+
+    Overriding retry() means a task can only ever re-run *itself* with its
+    own payload
+    """
+
+    def retry(self, args=None, kwargs=None, exc=None, **options):
+        payload = getattr(self.request, "vtrr_payload", None)
+        return super().retry(
+            args=(),
+            kwargs={"task_payload": payload},
+            exc=exc,
+            **options,
+        )
+
+
+def _resolve_base(user_base: type | None) -> type:
+    """Weave _VTRRTask into the user's custom Task base.
+
+    _VTRRTask goes first in the MRO so its retry() normalizes the call into
+    the current payload before any user-defined retry runs.
+    """
+    if user_base is None or user_base is Task:
+        return _VTRRCeleryTask
+    if issubclass(user_base, _VTRRCeleryTask):
+        return user_base
+    return type(f"VTRR{user_base.__name__}", (_VTRRCeleryTask, user_base), {})
+
+
+class VTRRQueue:
+    DEFAULT_MAX_CONCURRENCY = 4
+
+    def __init__(
+        self,
+        redis_client: redis_lib.Redis,
+        celery_app: Any,
+        *,
+        name: str,
+        celery_queue: str = "vtrr_queue",
+        max_concurrency: int = DEFAULT_MAX_CONCURRENCY,
+    ) -> None:
+        self._redis = redis_client
+        self._celery_app = celery_app
+        self._celery_queue = celery_queue
+        self._max_concurrency = max_concurrency
+        self._registry: dict[str, VTRRTask] = {}
+
+        prefix = f"vtrr:{name}"
+        self._queue_key = f"{prefix}:queue"
+        self._current_vt_key = f"{prefix}:current_virtual_time"
+        self._task_key = f"{prefix}:task"
+        self._partitions_vt_key = f"{prefix}:partition_virtual_time"
+        self._enqueue_keys = [
+            self._current_vt_key,
+            self._partitions_vt_key,
+            self._queue_key,
+            self._task_key,
+        ]
+        self._dequeue_keys = [
+            self._queue_key,
+            self._current_vt_key,
+            self._task_key,
+            self._partitions_vt_key,
+        ]
+
+        self._enqueue_script = self._load_script("enqueue")
+        self._dequeue_script = self._load_script("dequeue")
+        self._broker: redis_lib.Redis | None = self._connect_broker()
+
+    def task(self, fn: Callable | None = None, **task_options: Any) -> Any:
+        """
+        Decorator that registers a function as a VTRR-dispatchable Celery task.
+
+        The first argument is always `self` (the bound Celery task), then any args/kwargs from .queue():
+
+            @vtrr.task(autoretry_for=(TransientError,), max_retries=3,
+                       retry_backoff=True)
+            def my_task(self, task_id, x, y): ...
+        """
+
+        _ALLOWED_TASK_OPTIONS = {
+            # execution limits
+            "soft_time_limit",
+            "time_limit",
+            # retry
+            "max_retries",
+            "default_retry_delay",
+            "autoretry_for",
+            "retry_backoff",
+            "retry_backoff_max",
+            "retry_jitter",
+            "retry_kwargs",
+            # base class
+            "base",
+        }
+
+        def decorator(f: Callable) -> VTRRTask:
+            vtrr = self
+            unsupported_task_options = set(task_options) - _ALLOWED_TASK_OPTIONS
+            if unsupported_task_options:
+                raise TypeError(
+                    f"@vtrr.task does not support option(s): {', '.join(sorted(unsupported_task_options))}. "
+                    f"Allowed: {', '.join(sorted(_ALLOWED_TASK_OPTIONS))}"
+                )
+            options = dict(task_options)
+            options.pop("bind", None)
+            base = _resolve_base(options.pop("base", None))
+            task_name = f"{f.__module__}.{f.__name__}"
+
+            @self._celery_app.task(name=task_name, bind=True, base=base, **options)
+            def celery_wrapper(
+                celery_task: Any,
+                task_payload: dict | None = None,
+                is_start: bool = False,
+            ) -> None:
+                dispatched = task_payload is None
+
+                if dispatched:
+                    result = vtrr._dequeue()
+                    if result is None:
+                        if is_start:
+                            # Race: worker arrived before enqueue settled — retry once after a short delay.
+                            celery_task.apply_async(
+                                kwargs={"is_start": False},
+                                queue=vtrr._celery_queue,
+                                countdown=3,
+                            )
+                        return  # queue empty — stop draining, no reschedule
+                    dequeued_name, args, kwargs = result
+                    task_payload = {
+                        "task_name": dequeued_name,
+                        "args": args,
+                        "kwargs": kwargs,
+                    }
+                else:
+                    dequeued_name = task_payload["task_name"]
+                    args = task_payload["args"]
+                    kwargs = task_payload["kwargs"]
+
+                # Per-invocation stash (safe under threaded/gevent pools);
+                # retry() reads this to re-run the same item.
+                celery_task.request.vtrr_payload = task_payload
+
+                try:
+                    registered = vtrr._registry.get(dequeued_name)
+                    if registered is None:
+                        logger.error(
+                            "vtrr_queue: unknown task %r — dropped", dequeued_name
+                        )
+                        return
+                    registered._fn(celery_task, *args, **kwargs)
+                finally:
+                    if dispatched:
+                        # In case there's an exception, schedule next dequeue
+                        vtrr._schedule_next(celery_task)
+
+            wrapped = VTRRTask(f, self, celery_wrapper)
+            self._registry[wrapped.name] = wrapped
+            return wrapped
+
+        if fn is not None:
+            return decorator(fn)
+        return decorator
+
+    # ------------------------------------------------------------------
+    # Internal: setup
+    # ------------------------------------------------------------------
+
+    def _load_script(self, name: str) -> Any:
+        src = (_SCRIPTS_DIR / f"{name}.lua").read_text()
+        return self._redis.register_script(src)
+
+    def _connect_broker(self) -> redis_lib.Redis | None:
+        try:
+            return redis_lib.from_url(self._celery_app.conf.broker_url)
+        except Exception as err:
+            logger.warning("vtrr_queue: could not connect to Celery broker: %s", err)
+            return None
+
+    # ------------------------------------------------------------------
+    # Internal: Redis operations
+    # ------------------------------------------------------------------
+
+    def _enqueue(self, argv: list[str]) -> None:
+        self._enqueue_script(keys=self._enqueue_keys, args=argv)
+
+    def _dequeue(self) -> tuple[str, str, list, dict] | None:
+        raw = self._dequeue_script(keys=self._dequeue_keys, args=[])
+        if not raw:
+            return None
+        _, payload_bytes = raw
+        if isinstance(payload_bytes, (bytes, bytearray)):
+            payload_bytes = payload_bytes.decode()
+        payload = json.loads(payload_bytes)
+        return (
+            payload["task_name"],
+            payload["args"],
+            payload["kwargs"],
+        )
+
+    # ------------------------------------------------------------------
+    # Internal: worker scheduling
+    # ------------------------------------------------------------------
+
+    def _get_workers_scheduled(self) -> int:
+        """
+        Count pending messages in the Celery broker queue.
+        Does NOT include workers already running; returns 0 on any error
+        so the caller may over-schedule slightly, which is safe.
+        """
+        if self._broker is None:
+            return 0
+        try:
+            q = self._celery_queue
+            # Celery-managed Redis priority suffixes: 0 = no suffix, 3/6/9 = :<p>
+            return sum(
+                self._broker.llen(q if p == 0 else f"{q}:{p}") for p in (0, 3, 6, 9)
+            )
+        except Exception as err:
+            logger.error(
+                "vtrr_queue: could not check broker queue length: %s",
+                err,
+                exc_info=True,
+            )
+            return 0
+
+    def _schedule_workers(self, num_tasks: int, dispatch_task: Any) -> None:
+        workers_scheduled = self._get_workers_scheduled()
+        to_schedule = min(self._max_concurrency - workers_scheduled, num_tasks)
+        for _ in range(to_schedule):
+            dispatch_task.apply_async(
+                kwargs={"is_start": True},
+                queue=self._celery_queue,
+            )
+
+    def _schedule_next(self, current_celery_task: Any) -> None:
+        """Schedule one more dequeue worker if tasks remain in the queue."""
+        try:
+            if self._redis.zcard(self._queue_key) > 0:
+                current_celery_task.apply_async(queue=self._celery_queue)
+        except Exception as err:
+            logger.error(
+                "vtrr_queue: could not schedule next dequeue worker: %s",
+                err,
+                exc_info=True,
+            )

vtrr_queue/scripts/dequeue.lua

@@ -0,0 +1,24 @@
+-- Dequeue a task with the smallest virtual-time from the virutal time round-robin queue (vtrr:queue).
+-- Task info is fetched then deleted from the vtrr:task look-up table. And vtrr:current_virtual_time is
+-- updated to the virutal-time of the dequeued task.
+
+-- KEYS: 1=vtrr:queue  2=vtrr:current_virtual_time  3=vtrr:task  4=vtrr:partition_virtual_time
+local popped = redis.call('ZPOPMIN', KEYS[1])
+if #popped == 0 then
+  return {}
+end
+
+local task_id, task_virtual_time = popped[1], popped[2]
+local task = redis.call('HGET', KEYS[3], task_id)
+redis.call('HDEL', KEYS[3], task_id)
+
+if redis.call('ZCARD', KEYS[1]) == 0 then
+  -- reset all values when queue is drained
+  redis.call('SET', KEYS[2], 0)
+  redis.call('DEL', KEYS[3])
+  redis.call('DEL', KEYS[4])
+else
+  redis.call('SET', KEYS[2], task_virtual_time)
+end
+
+return {task_id, task}

vtrr_queue/scripts/enqueue.lua

@@ -0,0 +1,26 @@
+-- Bulk enqueue to the virutal time round-robin (vtrr). Each task is saved in vtrr:task look-up table, and the task_id
+-- is enqueued into the vtrr:queue with a virtual-time that's based off of how many tasks the partition has enqueued so far (managed by vtrr:partition_virtual_time)
+-- The vtrr:current_virtual_time is the lowest virtual-time of any task in the queue.
+
+-- KEYS: 1=vtrr:current_virtual_time  2=vtrr:partition_virtual_time  3=vtrr:queue  4=vtrr:task
+-- ARGV: flat triples of (partition_id, task_id, task_json)
+local current_virtual_time = tonumber(redis.call('GET', KEYS[1]) or '0')
+local partition_vt_cache = {}
+local i = 1
+while i <= #ARGV do
+  local partition_key, task_id, task_weight, task = ARGV[i], ARGV[i+1], tonumber(ARGV[i+2]), ARGV[i+3]
+  local partition_virtual_time = partition_vt_cache[partition_key]
+  if partition_virtual_time == nil then
+    partition_virtual_time = tonumber(redis.call('HGET', KEYS[2], partition_key) or '0')
+    if current_virtual_time + 1 > partition_virtual_time then partition_virtual_time = current_virtual_time + 1 end
+  end
+  redis.call('ZADD', KEYS[3], partition_virtual_time, task_id)
+  partition_virtual_time = partition_virtual_time + task_weight
+  redis.call('HSET', KEYS[4], task_id, task)
+  partition_vt_cache[partition_key] = partition_virtual_time
+  i = i + 4
+end
+for partition_key, uvt in pairs(partition_vt_cache) do
+  redis.call('HSET', KEYS[2], partition_key, uvt)
+end
+return redis.status_reply('OK')

vtrr_queue-0.1.0.dist-info/METADATA

@@ -0,0 +1,334 @@
+Metadata-Version: 2.5
+Name: vtrr-queue
+Version: 0.1.0
+Summary: Virtual-time round-robin fair queue on Redis
+Author-email: Nicolas Johnson <nicolas.johnson@c4ads.org>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Celery
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: System :: Distributed Computing
+Requires-Python: >=3.12
+Requires-Dist: celery>=5.0
+Requires-Dist: fakeredis[lua]<3.0.0,>=2.37.0
+Requires-Dist: pytest<10.0.0,>=9.1.1
+Requires-Dist: redis>=4.5.4
+Provides-Extra: dev
+Requires-Dist: fakeredis; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# vtrr-queue
+
+Virtual-time round-robin (VTRR) fair queue on Redis. Tasks from different users are interleaved so that no single user can starve others, regardless of how many tasks they submit. Each user's tasks are processed in proportion to their share of the queue.
+
+Integrates with an existing Celery + Redis setup. The library owns the dequeue loop; your code just defines tasks and enqueues them.
+
+
+## Requirements
+
+- Python >= 3.12
+- Redis (used for both the VTRR queue state and as the Celery broker)
+- Celery >= 5.0
+
+
+## Installation
+
+Install directly from GitHub until the package is published to a package registry:
+
+```
+pip install git+https://github.com/C-Research/vtrr-queue.git
+```
+
+Or pin a specific commit or tag for stability:
+
+```
+pip install git+https://github.com/C-Research/vtrr-queue.git@v0.1.0
+```
+
+Add to your `requirements.txt` or `pyproject.toml` dependencies the same way.
+
+
+## How it works
+
+```
+User A submits 10 tasks ──┐
+User B submits  2 tasks ──┼──► Redis sorted set (score = virtual time)
+User C submits  5 tasks ──┘          │
+                                     ▼
+                          Your @vtrr.task Celery worker runs,
+                          pops the highest-priority task from Redis,
+                          and calls your function directly
+```
+
+When `.queue()` is called the library:
+1. Atomically writes all tasks to Redis with fair virtual-time scores (Lua script, no race conditions).
+2. Schedules `min(max_concurrency - workers_already_queued, num_tasks_just_enqueued)` Celery workers.
+
+Each `@vtrr.task` is itself the Celery task — when a worker picks it up, it dequeues from Redis and calls your function in one hop. There is no intermediate dispatcher task.
+
+
+## Setup
+
+### 1. Create the VTRRQueue instance
+
+Create a module that constructs the `VTRRQueue` instance. This module must be imported before Celery workers start (same requirement as Celery's own `@app.task` decorators).
+
+```python
+# myapp/vtrr.py
+import redis
+from celery import Celery
+from vtrr_queue import VTRRQueue
+
+celery_app = Celery(...)  # or import your existing app
+
+vtrr = VTRRQueue(
+    redis_client=redis.from_url("redis://localhost:6379/3"),
+    celery_app=celery_app,
+    name="files",                # namespaces Redis keys as vtrr:files:*
+    celery_queue="vtrr_queue",   # name of the Celery queue workers will consume (separate from the round-robin queue)
+    max_concurrency=8,           # cap on dequeue workers queued in the broker at once
+)
+```
+
+Use a dedicated Redis DB index for the VTRR queue so its keys don't collide with your application cache, session store, or Celery broker.
+#### VTRRQueue parameters
+
+| Parameter | Type | Default | Description |
+|---|---|---|---|
+| `redis_client` | `redis.Redis` | required | Redis client pointed at the VTRR database |
+| `celery_app` | `Celery` | required | Your application's Celery instance |
+| `name` | `str` | required | Unique name for this queue instance; namespaces all Redis keys as `vtrr:{name}:*` |
+| `celery_queue` | `str` | `"vtrr_queue"` | Celery queue name for the dispatcher task |
+| `max_concurrency` | `int` | `4` | Max dequeue workers held in the broker at once |
+
+
+### 2. Register a dedicated Celery worker
+
+The VTRR dispatcher runs on its own Celery queue. Start a worker that consumes only that queue so it doesn't compete with your other task queues:
+
+```
+celery -A myapp worker -Q vtrr_queue --concurrency=8 --loglevel=info
+```
+
+The `--concurrency` here is the OS-level worker pool size. `max_concurrency` in `VTRRQueue` controls how many dispatcher tasks are *pre-queued* in the broker at once, which is this concurrency value multiplied by the number of worker instances you deploy.
+
+#### One `celery_queue` per `VTRRQueue` instance
+
+Give each `VTRRQueue` instance its own `celery_queue` name. Otherwise, if two or more instances share the same name, the library may under-schedule the celery workers.
+
+```python
+# Good — each queue manages its own worker budget independently
+files_vtrr = VTRRQueue(..., name="files",  celery_queue="vtrr_files",  max_concurrency=8)
+search_vtrr = VTRRQueue(..., name="search", celery_queue="vtrr_search", max_concurrency=4)
+```
+
+Start a worker per queue so you can also size the pools independently:
+
+```
+celery -A myapp worker -Q vtrr_files  --concurrency=8 --loglevel=info
+celery -A myapp worker -Q vtrr_search --concurrency=4 --loglevel=info
+```
+
+If you genuinely want both queues served by a single shared worker pool, you can point both workers at both queues (`-Q vtrr_files,vtrr_search`), but keep the queue names distinct so scheduling counts stay accurate.
+
+
+### 3. Define tasks
+
+Import the `vtrr` instance and decorate functions with `@vtrr.task`. The decorator accepts many of the same keyword arguments as Celery's `@app.task`:
+
+```python
+# myapp/tasks.py
+from myapp.vtrr import vtrr
+from myapp.celery_utils import LogErrorsTask
+
+# No options — plain decorator
+@vtrr.task(
+    base=LogErrorsTask,
+    max_retries=3,
+    soft_time_limit=3600,
+)
+def process_file(self, task_id: str, file_key: str, dataset_id: str, force_ocr: bool = False):
+    try:
+        ...
+    except TransientError as exc:
+        # Retry will requeue the specific task to the broker
+        raise self.retry(exc=exc, countdown=10)
+```
+
+`self` is the bound Celery task and is always the first argument, followed by any args/kwargs passed to `.queue()`. bound is always True despite what you may set in the decorator.
+
+Each task gets its own Celery task registration with its own retry and timeout settings.
+
+
+### 4. Enqueue tasks
+
+Call `.queue()` from anywhere in your application to enqueue the task in the round-robin for celery to run.
+
+```python
+from myapp.tasks import process_file
+
+# Bulk enqueue — all tasks from one partition in a single Redis round-trip
+process_file.queue(
+    partition_key="u_123",
+    tasks=[
+        {"weight": 4, "args": ["s3://bucket/a.pdf"], "kwargs": {"dataset_id": "d_1", "force_ocr": True}},
+        {"weight": 2, "args": ["s3://bucket/b.pdf"], "kwargs": {"dataset_id": "d_2"}},
+        {"weight": 2, "args": ["s3://bucket/c.pdf"], "kwargs": {"dataset_id": "d_3"}},
+    ],
+)
+```
+
+#### .queue() parameters
+
+| Parameter | Type | Description |
+|---|---|---|
+| `partition_key` | `str` | Required. Identifies whose virtual-time slot to use. |
+| `tasks` | `list[dict]` | Required. Each dict has optional `"weight"` (int), `"args"` (list), and `"kwargs"` (dict). |
+
+Each task dict may also include an `"id"` key to supply a stable task ID; otherwise a UUID is generated.
+
+`"weight"` defaults to `1`, which gives standard one-turn-per-task round-robin fairness. A weight of `N` advances the partition's virtual time by `N` after that task is enqueued, yielding up to `N` turns to other partitions before the next task in this partition is served. Use higher weights for tasks that are known to be proportionally more expensive.
+
+
+## Celery task options
+
+`@vtrr.task` accepts an explicit subset of `@celery_app.task()` options. Passing anything outside this list raises a `TypeError` at decoration time.
+
+| Option | Description |
+|---|---|
+| `base` | Custom base task class (e.g. for structured error reporting) |
+| `max_retries` | Number of times to retry on exception |
+| `default_retry_delay` | Seconds to wait before retrying (default: 180) |
+| `autoretry_for` | Tuple of exception types to retry on automatically |
+| `retry_backoff` | Enable exponential backoff between retries |
+| `retry_backoff_max` | Cap on backoff delay in seconds |
+| `retry_jitter` | Add random jitter to backoff delays |
+| `retry_kwargs` | Dict of kwargs passed to `self.retry()`, e.g. `{"countdown": 10}` |
+| `soft_time_limit` | Seconds before a `SoftTimeLimitExceeded` is raised in the worker |
+| `time_limit` | Hard kill timeout in seconds |
+
+Since each `@vtrr.task` becomes its own Celery task, different task functions can have different retry policies and time limits.
+
+
+## Django-specific setup
+
+A complete Django project integration:
+
+```python
+# myproject/celery.py  (standard Celery Django setup)
+import os
+from celery import Celery
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "myproject.settings")
+app = Celery("myproject")
+app.config_from_object("django.conf:settings", namespace="CELERY")
+app.autodiscover_tasks()
+```
+
+```python
+# myproject/settings.py
+CACHES = {
+    # ... your existing cache entries ...
+    "vtrr": {
+        "BACKEND": "django_redis.cache.RedisCache",
+        "LOCATION": "redis://localhost:6379",
+        "OPTIONS": {
+            "DB": 3,                                        # dedicated database index
+            "CLIENT_CLASS": "django_redis.client.DefaultClient",
+        },
+    },
+}
+
+VTRR_CELERY_SCHEDULER_QUEUE = "vtrr_queue"
+VTRR_MAX_CONCURRENCY = 8
+```
+
+```python
+# myapp/vtrr.py
+from django.conf import settings
+from django_redis import get_redis_connection
+from myproject.celery import app as celery_app
+from vtrr_queue import VTRRQueue
+
+vtrr = VTRRQueue(
+    redis_client=get_redis_connection("vtrr"),  # uses the "vtrr" CACHES entry
+    celery_app=celery_app,
+    name="files",
+    celery_queue=settings.VTRR_CELERY_SCHEDULER_QUEUE,
+    max_concurrency=settings.VTRR_MAX_CONCURRENCY,
+)
+```
+
+`get_redis_connection` is the recommended approach over a bare `redis.from_url()` in Django projects since it integrates with Django's connection management.
+
+```python
+# myapp/apps.py
+from django.apps import AppConfig
+
+class MyAppConfig(AppConfig):
+    name = "myapp"
+
+    def ready(self):
+        import myapp.tasks  # registers @vtrr.task functions with the dispatcher if needed
+```
+
+```python
+# myapp/tasks.py
+from myapp.vtrr import vtrr
+from myapp.celery_utils import LogErrorsTask
+
+@vtrr.task(
+    base=LogErrorsTask,
+    max_retries=3,
+    retry_kwargs={"countdown": 10},
+    soft_time_limit=3600,
+)
+def process_upload(self, task_id: str, file_key: str, dataset_id: str):
+    ...
+```
+
+```python
+# myapp/views.py
+from myapp.tasks import process_upload
+
+class UploadView(View):
+    def post(self, request):
+        files = request.FILES.getlist("files")
+        process_upload.queue(
+            partition_key=str(request.user.id),
+            tasks=[
+                {"weight": 1, "args": [f.name], "kwargs": {"dataset_id": request.POST["dataset_id"]}}
+                for f in files
+            ],
+        )
+        return JsonResponse({"queued": len(files)})
+```
+
+
+## Redis keys
+
+Each `VTRRQueue` instance manages four keys namespaced under `vtrr:{name}:*`.
+
+| Key | Type | Description |
+|---|---|---|
+| `vtrr:{name}:queue` | Sorted Set | Task IDs scored by virtual time; lowest score = highest priority |
+| `vtrr:{name}:current_virtual_time` | String | Virtual time of the last dequeued task; resets to 0 when queue drains |
+| `vtrr:{name}:partition_virtual_time` | Hash | Per-partition virtual time counter; deleted when queue drains |
+| `vtrr:{name}:task` | Hash | `task_id → JSON payload`; deleted when queue drains |
+
+Multiple `VTRRQueue` instances in the same application can safely share a Redis database as long as they have distinct `name` values.
+
+All enqueue and dequeue operations are atomic Lua scripts, so concurrent writers and workers are safe.
+
+# Development
+
+Run `poetry install`
+
+Tests: `poetry run pytest tests`

vtrr_queue-0.1.0.dist-info/RECORD

@@ -0,0 +1,9 @@
+vtrr_queue/__init__.py,sha256=JnO3CnxRbr6Mo0vWo7qIr-a1nhHomWzwo5hoEAVhJic,76
+vtrr_queue/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+vtrr_queue/queue.py,sha256=2_xWwIwJfghtwbDQFaAk-2KwxPGEenONmhIcSu1rTTQ,11325
+vtrr_queue/scripts/dequeue.lua,sha256=j_3LRDrCzYfSF0pPaQ2TnpU7ZOmg_LLbQtrM6KhH2os,840
+vtrr_queue/scripts/enqueue.lua,sha256=x5WA4qYhxDWQh1mB67faYD6t8srEZSsHRA0cP-b8Pmo,1471
+vtrr_queue-0.1.0.dist-info/METADATA,sha256=ZBlVr9Ue130KnRUzfm3F3_g5XaiFuF_7Zor1QdEAVYs,12223
+vtrr_queue-0.1.0.dist-info/WHEEL,sha256=zOwg4jB6zX2kU910N-cMawjivD6tO8NEWvE12je1bVk,87
+vtrr_queue-0.1.0.dist-info/licenses/LICENSE,sha256=GeDK5Wa9F3kdSd3u7aptMF5cn9HFpOgt_d4UfdpBnAo,11336
+vtrr_queue-0.1.0.dist-info/RECORD,,

vtrr_queue-0.1.0.dist-info/WHEEL

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

vtrr_queue-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 C4ADS
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.