Skip to content

Commit 73271b5

Browse files
committed
Document job priority order
1 parent b1303ac commit 73271b5

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

plain-worker/plain/worker/README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ When calling `run_in_worker()`, you can specify several parameters to control jo
7272
job.run_in_worker(
7373
queue="slow", # Target a specific queue (default: "default")
7474
delay=60, # Delay in seconds (or timedelta/datetime)
75-
priority=10, # Higher priority jobs run first (default: 0)
75+
priority=10, # Higher numbers run first (default: 0, use negatives for lower priority)
7676
retries=3, # Number of retry attempts (default: 0)
7777
unique_key="user-123-welcome", # Prevent duplicate jobs
7878
)
@@ -95,7 +95,9 @@ class MyJob(Job):
9595
return "default"
9696

9797
def get_priority(self) -> int:
98-
# Set the default priority (higher runs first)
98+
# Set the default priority
99+
# Higher numbers run first: 10 > 5 > 0 > -5 > -10
100+
# Use positive numbers for high priority, negative for low priority
99101
return 0
100102

101103
def get_retries(self) -> int:

plain-worker/plain/worker/jobs.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -198,6 +198,14 @@ def get_queue(self) -> str:
198198
return "default"
199199

200200
def get_priority(self) -> int:
201+
"""
202+
Return the default priority for this job.
203+
204+
Higher numbers run first: 10 > 5 > 0 > -5 > -10
205+
- Use positive numbers for high priority jobs
206+
- Use negative numbers for low priority jobs
207+
- Default is 0
208+
"""
201209
return 0
202210

203211
def get_retries(self) -> int:

0 commit comments

Comments
 (0)