1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486
|
import logging
import sys
import traceback
import uuid
import warnings
from collections import namedtuple
from collections.abc import Iterable, Sequence
from datetime import datetime, timedelta
from functools import total_ordering
# TODO: Change import path to "collections.abc" after we stop supporting Python 3.8
from typing import (
TYPE_CHECKING,
Any,
Callable,
Optional,
Union,
cast,
)
from redis import WatchError
from .timeouts import BaseDeathPenalty, UnixSignalDeathPenalty
if TYPE_CHECKING:
from redis import Redis
from redis.client import Pipeline
from .job import Retry
from .defaults import DEFAULT_RESULT_TTL
from .dependency import Dependency
from .exceptions import DequeueTimeout, NoSuchJobError
from .intermediate_queue import IntermediateQueue
from .job import Callback, Job, JobStatus
from .logutils import blue, green
from .repeat import Repeat
from .serializers import Serializer, resolve_serializer
from .types import FunctionReferenceType, JobDependencyType
from .utils import as_text, backend_class, compact, get_version, import_attribute, now, parse_timeout
logger = logging.getLogger('rq.queue')
class EnqueueData(
namedtuple(
'EnqueueData',
[
'func',
'args',
'kwargs',
'timeout',
'result_ttl',
'ttl',
'failure_ttl',
'description',
'depends_on',
'job_id',
'at_front',
'meta',
'retry',
'on_success',
'on_failure',
'on_stopped',
'repeat',
],
)
):
"""Helper type to use when calling enqueue_many
NOTE: Does not support `depends_on` yet.
"""
__slots__ = ()
@total_ordering
class Queue:
job_class: type['Job'] = Job
death_penalty_class: type[BaseDeathPenalty] = UnixSignalDeathPenalty
DEFAULT_TIMEOUT: int = 180 # Default timeout seconds.
redis_queue_namespace_prefix: str = 'rq:queue:'
redis_queues_keys: str = 'rq:queues'
@classmethod
def all(
cls,
connection: 'Redis',
job_class: Optional[type['Job']] = None,
serializer=None,
death_penalty_class: Optional[type[BaseDeathPenalty]] = None,
) -> list['Queue']:
"""Returns an iterable of all Queues.
Args:
connection (Optional[Redis], optional): The Redis Connection. Defaults to None.
job_class (Optional[Job], optional): The Job class to use. Defaults to None.
serializer (optional): The serializer to use. Defaults to None.
death_penalty_class (Optional[Job], optional): The Death Penalty class to use. Defaults to None.
Returns:
queues (List[Queue]): A list of all queues.
"""
def to_queue(queue_key: Union[bytes, str]):
return cls.from_queue_key(
as_text(queue_key),
connection=connection,
job_class=job_class,
serializer=serializer,
death_penalty_class=death_penalty_class,
)
all_registered_queues = connection.smembers(cls.redis_queues_keys)
all_queues = [to_queue(rq_key) for rq_key in all_registered_queues if rq_key]
return all_queues
@classmethod
def from_queue_key(
cls,
queue_key: str,
connection: 'Redis',
job_class: Optional[type['Job']] = None,
serializer: Optional[Union[Serializer, str]] = None,
death_penalty_class: Optional[type[BaseDeathPenalty]] = None,
) -> 'Queue':
"""Returns a Queue instance, based on the naming conventions for naming
the internal Redis keys. Can be used to reverse-lookup Queues by their
Redis keys.
Args:
queue_key (str): The queue key
connection (Redis): Redis connection. Defaults to None.
job_class (Optional[Job], optional): Job class. Defaults to None.
serializer (Optional[Union[Serializer, str]], optional): Serializer. Defaults to None.
death_penalty_class (Optional[BaseDeathPenalty], optional): Death penalty class. Defaults to None.
Raises:
ValueError: If the queue_key doesn't start with the defined prefix
Returns:
queue (Queue): The Queue object
"""
prefix = cls.redis_queue_namespace_prefix
if not queue_key.startswith(prefix):
raise ValueError(f'Not a valid RQ queue key: {queue_key}')
name = queue_key[len(prefix) :]
return cls(
name,
connection=connection,
job_class=job_class,
serializer=serializer,
death_penalty_class=death_penalty_class,
)
def __init__(
self,
name: str = 'default',
connection: Optional['Redis'] = None,
default_timeout: Optional[int] = None,
is_async: bool = True,
job_class: Optional[Union[str, type['Job']]] = None,
serializer: Optional[Union[Serializer, str]] = None,
death_penalty_class: Optional[type[BaseDeathPenalty]] = UnixSignalDeathPenalty,
**kwargs,
):
"""Initializes a Queue object.
Args:
name (str, optional): The queue name. Defaults to 'default'.
default_timeout (Optional[int], optional): Queue's default timeout. Defaults to None.
connection (Optional[Redis], optional): Redis connection. Defaults to None.
is_async (bool, optional): Whether jobs should run "async" (using the worker).
If `is_async` is false, jobs will run on the same process from where it was called. Defaults to True.
job_class (Union[str, 'Job', optional): Job class or a string referencing the Job class path.
Defaults to None.
serializer (Optional[Union[Serializer, str]], optional): Serializer. Defaults to None.
death_penalty_class (Type[BaseDeathPenalty, optional): Job class or a string referencing the Job class path.
Defaults to UnixSignalDeathPenalty.
"""
if not connection:
raise TypeError("Queue() missing 1 required positional argument: 'connection'")
self.connection = connection
prefix = self.redis_queue_namespace_prefix
self.name = name
self._key = f'{prefix}{name}'
self._default_timeout = parse_timeout(default_timeout) or self.DEFAULT_TIMEOUT
self._is_async = is_async
self.log = logger
if 'async' in kwargs:
self._is_async = kwargs['async']
warnings.warn('The `async` keyword is deprecated. Use `is_async` instead', DeprecationWarning)
# override class attribute job_class if one was passed
if job_class is not None:
if isinstance(job_class, str):
self.job_class = import_attribute(job_class) # type: ignore[assignment]
else:
self.job_class = job_class
self.death_penalty_class = death_penalty_class # type: ignore[assignment]
self.serializer = resolve_serializer(serializer)
self.redis_server_version: Optional[tuple[int, int, int]] = None
def __len__(self):
return self.count
def __bool__(self):
return True
def __iter__(self):
yield self
def get_redis_server_version(self) -> tuple[int, int, int]:
"""Return Redis server version of connection
Returns:
redis_version (Tuple): A tuple with the parsed Redis version (eg: (5,0,0))
"""
if not self.redis_server_version:
self.redis_server_version = get_version(self.connection)
return self.redis_server_version
@property
def key(self):
"""Returns the Redis key for this Queue."""
return self._key
@property
def intermediate_queue_key(self):
"""Returns the Redis key for intermediate queue."""
return IntermediateQueue.get_intermediate_queue_key(self._key)
@property
def intermediate_queue(self) -> IntermediateQueue:
"""Returns the IntermediateQueue instance for this Queue."""
return IntermediateQueue(self.key, connection=self.connection)
@property
def registry_cleaning_key(self):
"""Redis key used to indicate this queue has been cleaned."""
return 'rq:clean_registries:%s' % self.name
@property
def scheduler_pid(self) -> Optional[int]:
from rq.scheduler import RQScheduler
pid = self.connection.get(RQScheduler.get_locking_key(self.name))
return int(pid.decode()) if pid is not None else None
def acquire_maintenance_lock(self) -> bool:
"""Returns a boolean indicating whether a lock to clean this queue
is acquired. A lock expires in 899 seconds (15 minutes - 1 second)
Returns:
lock_acquired (bool)
"""
lock_acquired = self.connection.set(self.registry_cleaning_key, 1, nx=True, ex=899)
if not lock_acquired:
return False
return lock_acquired
def release_maintenance_lock(self):
"""Deletes the maintenance lock after registries have been cleaned"""
self.connection.delete(self.registry_cleaning_key)
def empty(self):
"""Removes all messages on the queue.
This is currently being done using a Lua script,
which iterates all queue messages and deletes the jobs and it's dependents.
It registers the Lua script and calls it.
Even though is currently being returned, this is not strictly necessary.
Returns:
script (...): The Lua Script is called.
"""
script = f"""
local prefix = "{self.job_class.redis_job_namespace_prefix}"
local q = KEYS[1]
local count = 0
while true do
local job_id = redis.call("lpop", q)
if job_id == false then
break
end
-- Delete the relevant keys
redis.call("del", prefix..job_id)
redis.call("del", prefix..job_id..":dependents")
count = count + 1
end
return count
""".encode()
script = self.connection.register_script(script)
return script(keys=[self.key])
def delete(self, delete_jobs: bool = True):
"""Deletes the queue.
Args:
delete_jobs (bool): If true, removes all the associated messages on the queue first.
"""
if delete_jobs:
self.empty()
with self.connection.pipeline() as pipeline:
pipeline.srem(self.redis_queues_keys, self._key)
pipeline.delete(self._key)
pipeline.execute()
def is_empty(self) -> bool:
"""Returns whether the current queue is empty.
Returns:
is_empty (bool): Whether the queue is empty
"""
return self.count == 0
@property
def is_async(self) -> bool:
"""Returns whether the current queue is async."""
return bool(self._is_async)
def fetch_job(self, job_id: str) -> Optional['Job']:
"""Fetch a single job by Job ID.
If the job key is not found, will run the `remove` method, to exclude the key.
If the job has the same name as as the current job origin, returns the Job
Args:
job_id (str): The Job ID
Returns:
job (Optional[Job]): The job if found
"""
try:
job = self.job_class.fetch(job_id, connection=self.connection, serializer=self.serializer)
except NoSuchJobError:
self.remove(job_id)
else:
if job.origin == self.name:
return job
return None
def get_job_position(self, job_or_id: Union['Job', str]) -> Optional[int]:
"""Returns the position of a job within the queue
Using Redis before 6.0.6 and redis-py before 3.5.4 has a complexity of
worse than O(N) and should not be used for very long job queues. Redis
and redis-py version afterwards should support the LPOS command
handling job positions within Redis c implementation.
Args:
job_or_id (Union[Job, str]): The Job instance or Job ID
Returns:
_type_: _description_
"""
job_id = cast(str, job_or_id.id if isinstance(job_or_id, self.job_class) else job_or_id)
if self.get_redis_server_version() >= (6, 0, 6):
try:
return self.connection.lpos(self.key, job_id)
except AttributeError:
# not yet implemented by redis-py
pass
if job_id in self.job_ids:
return self.job_ids.index(job_id)
return None
def get_job_ids(self, offset: int = 0, length: int = -1) -> list[str]:
"""Returns a slice of job IDs in the queue.
Args:
offset (int, optional): The offset. Defaults to 0.
length (int, optional): The slice length. Defaults to -1 (last element).
Returns:
_type_: _description_
"""
start = offset
if length >= 0:
end = offset + (length - 1)
else:
end = length
job_ids = [as_text(job_id) for job_id in self.connection.lrange(self.key, start, end)]
self.log.debug('Getting jobs for queue %s: %d found.', green(self.name), len(job_ids))
return job_ids
def get_jobs(self, offset: int = 0, length: int = -1) -> list['Job']:
"""Returns a slice of jobs in the queue.
Args:
offset (int, optional): The offset. Defaults to 0.
length (int, optional): The slice length. Defaults to -1.
Returns:
_type_: _description_
"""
job_ids = self.get_job_ids(offset, length)
return compact([self.fetch_job(job_id) for job_id in job_ids])
@property
def job_ids(self) -> list[str]:
"""Returns a list of all job IDS in the queue."""
return self.get_job_ids()
@property
def jobs(self) -> list['Job']:
"""Returns a list of all (valid) jobs in the queue."""
return self.get_jobs()
@property
def count(self) -> int:
"""Returns a count of all messages in the queue."""
return self.connection.llen(self.key)
@property
def failed_job_registry(self):
"""Returns this queue's FailedJobRegistry."""
from rq.registry import FailedJobRegistry
return FailedJobRegistry(queue=self, job_class=self.job_class, serializer=self.serializer)
@property
def started_job_registry(self):
"""Returns this queue's StartedJobRegistry."""
from rq.registry import StartedJobRegistry
return StartedJobRegistry(queue=self, job_class=self.job_class, serializer=self.serializer)
@property
def finished_job_registry(self):
"""Returns this queue's FinishedJobRegistry."""
from rq.registry import FinishedJobRegistry
# TODO: Why was job_class only omitted here before? Was it intentional?
return FinishedJobRegistry(queue=self, job_class=self.job_class, serializer=self.serializer)
@property
def deferred_job_registry(self):
"""Returns this queue's DeferredJobRegistry."""
from rq.registry import DeferredJobRegistry
return DeferredJobRegistry(queue=self, job_class=self.job_class, serializer=self.serializer)
@property
def scheduled_job_registry(self):
"""Returns this queue's ScheduledJobRegistry."""
from rq.registry import ScheduledJobRegistry
return ScheduledJobRegistry(queue=self, job_class=self.job_class, serializer=self.serializer)
@property
def canceled_job_registry(self):
"""Returns this queue's CanceledJobRegistry."""
from rq.registry import CanceledJobRegistry
return CanceledJobRegistry(queue=self, job_class=self.job_class, serializer=self.serializer)
def remove(self, job_or_id: Union['Job', str], pipeline: Optional['Pipeline'] = None):
"""Removes Job from queue, accepts either a Job instance or ID.
Args:
job_or_id (Union[Job, str]): The Job instance or Job ID string.
pipeline (Optional[Pipeline], optional): The Redis Pipeline. Defaults to None.
Returns:
_type_: _description_
"""
job_id = cast(str, job_or_id.id if isinstance(job_or_id, self.job_class) else job_or_id)
if pipeline is not None:
return pipeline.lrem(self.key, 1, job_id)
return self.connection.lrem(self.key, 1, job_id)
def compact(self):
"""Removes all "dead" jobs from the queue by cycling through it,
while guaranteeing FIFO semantics.
"""
COMPACT_QUEUE = '{0}_compact:{1}'.format(self.redis_queue_namespace_prefix, uuid.uuid4()) # noqa
self.connection.rename(self.key, COMPACT_QUEUE)
while True:
job_id = self.connection.lpop(COMPACT_QUEUE)
if job_id is None:
break
if self.job_class.exists(as_text(job_id), self.connection):
self.connection.rpush(self.key, job_id)
def push_job_id(self, job_id: str, pipeline: Optional['Pipeline'] = None, at_front: bool = False):
"""Pushes a job ID on the corresponding Redis queue.
'at_front' allows you to push the job onto the front instead of the back of the queue
Args:
job_id (str): The Job ID
pipeline (Optional[Pipeline], optional): The Redis Pipeline to use. Defaults to None.
at_front (bool, optional): Whether to push the job to front of the queue. Defaults to False.
"""
connection = pipeline if pipeline is not None else self.connection
push = connection.lpush if at_front else connection.rpush
result = push(self.key, job_id)
if pipeline is None:
self.log.debug('Pushed job %s into %s, %s job(s) are in queue.', blue(job_id), green(self.name), result)
else:
# Pipelines do not return the number of jobs in the queue.
self.log.debug('Pushed job %s into %s', blue(job_id), green(self.name))
def create_job(
self,
func: 'FunctionReferenceType',
args: Union[tuple, list, None] = None,
kwargs: Optional[dict] = None,
timeout: Optional[int] = None,
result_ttl: Optional[int] = None,
ttl: Optional[int] = None,
failure_ttl: Optional[int] = None,
description: Optional[str] = None,
depends_on: Optional['JobDependencyType'] = None,
job_id: Optional[str] = None,
meta: Optional[dict] = None,
status: JobStatus = JobStatus.QUEUED,
retry: Optional['Retry'] = None,
repeat: Optional['Repeat'] = None,
*,
on_success: Optional[Union[Callback, Callable]] = None,
on_failure: Optional[Union[Callback, Callable]] = None,
on_stopped: Optional[Union[Callback, Callable]] = None,
group_id: Optional[str] = None,
) -> Job:
"""Creates a job based on parameters given
Args:
func (FunctionReferenceType): The function reference: a callable or the path.
args (Union[Tuple, List, None], optional): The `*args` to pass to the function. Defaults to None.
kwargs (Optional[Dict], optional): The `**kwargs` to pass to the function. Defaults to None.
timeout (Optional[int], optional): Function timeout. Defaults to None, use -1 for infinite timeout.
result_ttl (Optional[int], optional): Result time to live. Defaults to None.
ttl (Optional[int], optional): Time to live. Defaults to None.
failure_ttl (Optional[int], optional): Failure time to live. Defaults to None.
description (Optional[str], optional): The description. Defaults to None.
depends_on (Optional[JobDependencyType], optional): The job dependencies. Defaults to None.
job_id (Optional[str], optional): Job ID. Defaults to None.
meta (Optional[Dict], optional): Job metadata. Defaults to None.
status (JobStatus, optional): Job status. Defaults to JobStatus.QUEUED.
retry (Optional[Retry], optional): The Retry Object. Defaults to None.
repeat (Optional[Repeat], optional): The Repeat Object. Defaults to None.
on_success (Optional[Union[Callback, Callable[..., Any]]], optional): Callback for on success. Defaults to
None. Callable is deprecated.
on_failure (Optional[Union[Callback, Callable[..., Any]]], optional): Callback for on failure. Defaults to
None. Callable is deprecated.
on_stopped (Optional[Union[Callback, Callable[..., Any]]], optional): Callback for on stopped. Defaults to
None. Callable is deprecated.
pipeline (Optional[Pipeline], optional): The Redis Pipeline. Defaults to None.
group_id (Optional[str], optional): A group ID that the job is being added to. Defaults to None.
Raises:
ValueError: If the timeout is 0
ValueError: If the job TTL is 0 or negative
Returns:
Job: The created job
"""
timeout = parse_timeout(timeout)
if timeout is None:
timeout = self._default_timeout
elif timeout == 0:
raise ValueError('0 timeout is not allowed. Use -1 for infinite timeout')
result_ttl = parse_timeout(result_ttl)
failure_ttl = parse_timeout(failure_ttl)
ttl = parse_timeout(ttl)
if ttl is not None and ttl <= 0:
raise ValueError('Job ttl must be greater than 0')
job = self.job_class.create(
func,
args=args,
kwargs=kwargs,
connection=self.connection,
result_ttl=result_ttl,
ttl=ttl,
failure_ttl=failure_ttl,
status=status,
description=description,
depends_on=depends_on,
timeout=timeout,
id=job_id,
origin=self.name,
meta=meta,
serializer=self.serializer,
on_success=on_success,
on_failure=on_failure,
on_stopped=on_stopped,
group_id=group_id,
)
if retry:
job.retries_left = retry.max
job.retry_intervals = retry.intervals
if repeat:
job.repeats_left = repeat.times
job.repeat_intervals = repeat.intervals
return job
def setup_dependencies(self, job: 'Job', pipeline: Optional['Pipeline'] = None) -> 'Job':
"""If a _dependent_ job depends on any unfinished job, register all the
_dependent_ job's dependencies instead of enqueueing it.
`Job#fetch_dependencies` sets WATCH on all dependencies. If
WatchError is raised in the when the pipeline is executed, that means
something else has modified either the set of dependencies or the
status of one of them. In this case, we simply retry.
Args:
job (Job): The job
pipeline (Optional[Pipeline], optional): The Redis Pipeline. Defaults to None.
Returns:
job (Job): The Job
"""
if len(job._dependency_ids) > 0:
orig_status = job.get_status(refresh=False)
pipe = pipeline if pipeline is not None else self.connection.pipeline()
while True:
try:
# Also calling watch even if caller
# passed in a pipeline since Queue#create_job
# is called from within this method.
pipe.watch(job.dependencies_key)
dependencies = job.fetch_dependencies(watch=True, pipeline=pipe)
pipe.multi()
for dependency in dependencies:
if dependency.get_status(refresh=False) != JobStatus.FINISHED:
# NOTE: If the following code changes local variables, those values probably have
# to be set back to their original values in the handling of WatchError below!
job.set_status(JobStatus.DEFERRED, pipeline=pipe)
job.register_dependency(pipeline=pipe)
job.save(pipeline=pipe)
job.cleanup(ttl=job.ttl, pipeline=pipe)
if pipeline is None:
pipe.execute()
return job
break
except WatchError:
if pipeline is None:
# The call to job.set_status(JobStatus.DEFERRED, pipeline=pipe) above has changed the
# internal "_status". We have to reset it to its original value (probably QUEUED), so
# if during the next run no unfinished dependencies exist anymore, the job gets
# enqueued correctly by enqueue_call().
job._status = orig_status
continue
else:
# if pipeline comes from caller, re-raise to them
raise
elif pipeline is not None:
# Ensure pipeline in multi mode before returning to caller (if not set before)
if not pipeline.explicit_transaction:
pipeline.multi()
return job
def enqueue_call(
self,
func: 'FunctionReferenceType',
args: Union[tuple, list, None] = None,
kwargs: Optional[dict] = None,
timeout: Optional[int] = None,
result_ttl: Optional[int] = None,
ttl: Optional[int] = None,
failure_ttl: Optional[int] = None,
description: Optional[str] = None,
depends_on: Optional['JobDependencyType'] = None,
job_id: Optional[str] = None,
at_front: bool = False,
meta: Optional[dict] = None,
retry: Optional['Retry'] = None,
repeat: Optional['Repeat'] = None,
on_success: Optional[Union[Callback, Callable[..., Any]]] = None,
on_failure: Optional[Union[Callback, Callable[..., Any]]] = None,
on_stopped: Optional[Union[Callback, Callable[..., Any]]] = None,
pipeline: Optional['Pipeline'] = None,
) -> Job:
"""Creates a job to represent the delayed function call and enqueues it.
It is much like `.enqueue()`, except that it takes the function's args
and kwargs as explicit arguments. Any kwargs passed to this function
contain options for RQ itself.
Args:
func (FunctionReferenceType): The reference to the function
args (Union[Tuple, List, None], optional): The `*args` to pass to the function. Defaults to None.
kwargs (Optional[Dict], optional): The `**kwargs` to pass to the function. Defaults to None.
timeout (Optional[int], optional): Function timeout. Defaults to None.
result_ttl (Optional[int], optional): Result time to live. Defaults to None.
ttl (Optional[int], optional): Time to live. Defaults to None.
failure_ttl (Optional[int], optional): Failure time to live. Defaults to None.
description (Optional[str], optional): The job description. Defaults to None.
depends_on (Optional[JobDependencyType], optional): The job dependencies. Defaults to None.
job_id (Optional[str], optional): The job ID. Defaults to None.
at_front (bool, optional): Whether to enqueue the job at the front. Defaults to False.
meta (Optional[Dict], optional): Metadata to attach to the job. Defaults to None.
retry (Optional[Retry], optional): Retry object. Defaults to None.
on_success (Optional[Union[Callback, Callable[..., Any]]], optional): Callback for on success. Defaults to
None. Callable is deprecated.
on_failure (Optional[Union[Callback, Callable[..., Any]]], optional): Callback for on failure. Defaults to
None. Callable is deprecated.
on_stopped (Optional[Union[Callback, Callable[..., Any]]], optional): Callback for on stopped. Defaults to
None. Callable is deprecated.
pipeline (Optional[Pipeline], optional): The Redis Pipeline. Defaults to None.
Returns:
Job: The enqueued Job
"""
job = self.create_job(
func,
args=args,
kwargs=kwargs,
result_ttl=result_ttl,
ttl=ttl,
failure_ttl=failure_ttl,
description=description,
depends_on=depends_on,
job_id=job_id,
meta=meta,
status=JobStatus.QUEUED,
timeout=timeout,
retry=retry,
repeat=repeat,
on_success=on_success,
on_failure=on_failure,
on_stopped=on_stopped,
)
return self.enqueue_job(job, pipeline=pipeline, at_front=at_front)
@staticmethod
def prepare_data(
func: 'FunctionReferenceType',
args: Union[tuple, list, None] = None,
kwargs: Optional[dict] = None,
timeout: Optional[int] = None,
result_ttl: Optional[int] = None,
ttl: Optional[int] = None,
failure_ttl: Optional[int] = None,
description: Optional[str] = None,
depends_on: Optional['JobDependencyType'] = None,
job_id: Optional[str] = None,
at_front: bool = False,
meta: Optional[dict] = None,
retry: Optional['Retry'] = None,
on_success: Optional[Union[Callback, Callable]] = None,
on_failure: Optional[Union[Callback, Callable]] = None,
on_stopped: Optional[Union[Callback, Callable]] = None,
repeat: Optional['Repeat'] = None,
) -> EnqueueData:
"""Need this till support dropped for python_version < 3.7, where defaults can be specified for named tuples
And can keep this logic within EnqueueData
Args:
func (FunctionReferenceType): The reference to the function
args (Union[Tuple, List, None], optional): The `*args` to pass to the function. Defaults to None.
kwargs (Optional[Dict], optional): The `**kwargs` to pass to the function. Defaults to None.
timeout (Optional[int], optional): Function timeout. Defaults to None.
result_ttl (Optional[int], optional): Result time to live. Defaults to None.
ttl (Optional[int], optional): Time to live. Defaults to None.
failure_ttl (Optional[int], optional): Failure time to live. Defaults to None.
description (Optional[str], optional): The job description. Defaults to None.
depends_on (Optional[JobDependencyType], optional): The job dependencies. Defaults to None.
job_id (Optional[str], optional): The job ID. Defaults to None.
at_front (bool, optional): Whether to enqueue the job at the front. Defaults to False.
meta (Optional[Dict], optional): Metadata to attach to the job. Defaults to None.
retry (Optional[Retry], optional): Retry object. Defaults to None.
on_success (Optional[Union[Callback, Callable[..., Any]]], optional): Callback for on success. Defaults to
None. Callable is deprecated.
on_failure (Optional[Union[Callback, Callable[..., Any]]], optional): Callback for on failure. Defaults to
None. Callable is deprecated.
on_stopped (Optional[Union[Callback, Callable[..., Any]]], optional): Callback for on stopped. Defaults to
None. Callable is deprecated.
repeat (Optional[Repeat], optional): Repeat object. Defaults to None.
Returns:
EnqueueData: The EnqueueData
"""
return EnqueueData(
func,
args,
kwargs,
timeout,
result_ttl,
ttl,
failure_ttl,
description,
depends_on,
job_id,
at_front,
meta,
retry,
on_success,
on_failure,
on_stopped,
repeat,
)
def enqueue_many(
self, job_datas: Iterable['EnqueueData'], pipeline: Optional['Pipeline'] = None, group_id: Optional[str] = None
) -> list[Job]:
"""Creates multiple jobs (created via `Queue.prepare_data` calls)
to represent the delayed function calls and enqueues them.
Args:
job_datas (List['EnqueueData']): A List of job data
pipeline (Optional[Pipeline], optional): The Redis Pipeline. Defaults to None.
Returns:
List[Job]: A list of enqueued jobs
"""
pipe = pipeline if pipeline is not None else self.connection.pipeline()
# Add Queue key set
pipe.sadd(self.redis_queues_keys, self.key)
jobs_without_dependencies = []
jobs_with_unmet_dependencies = []
jobs_with_met_dependencies = []
def get_job_kwargs(job_data, initial_status):
return {
'func': job_data.func,
'args': job_data.args,
'kwargs': job_data.kwargs,
'result_ttl': job_data.result_ttl,
'ttl': job_data.ttl,
'failure_ttl': job_data.failure_ttl,
'description': job_data.description,
'depends_on': job_data.depends_on,
'job_id': job_data.job_id,
'meta': job_data.meta,
'status': initial_status,
'timeout': job_data.timeout,
'retry': job_data.retry,
'on_success': job_data.on_success,
'on_failure': job_data.on_failure,
'on_stopped': job_data.on_stopped,
'group_id': group_id,
'repeat': job_data.repeat,
}
# Enqueue jobs without dependencies
job_datas_without_dependencies = [job_data for job_data in job_datas if not job_data.depends_on]
if job_datas_without_dependencies:
jobs_without_dependencies = [
self._enqueue_job(
self.create_job(**get_job_kwargs(job_data, JobStatus.QUEUED)),
pipeline=pipe,
at_front=job_data.at_front,
)
for job_data in job_datas_without_dependencies
]
if pipeline is None:
pipe.execute()
job_datas_with_dependencies = [job_data for job_data in job_datas if job_data.depends_on]
if job_datas_with_dependencies:
# Save all jobs with dependencies as deferred
jobs_with_dependencies = [
self.create_job(**get_job_kwargs(job_data, JobStatus.DEFERRED))
for job_data in job_datas_with_dependencies
]
for job in jobs_with_dependencies:
job.save(pipeline=pipe)
if pipeline is None:
pipe.execute()
# Enqueue the jobs whose dependencies have been met
jobs_with_met_dependencies, jobs_with_unmet_dependencies = Dependency.get_jobs_with_met_dependencies(
jobs_with_dependencies, pipeline=pipe
)
jobs_with_met_dependencies = [
self._enqueue_job(job, pipeline=pipe, at_front=job.enqueue_at_front)
for job in jobs_with_met_dependencies
]
if pipeline is None:
pipe.execute()
return jobs_without_dependencies + jobs_with_unmet_dependencies + jobs_with_met_dependencies
def run_job(self, job: 'Job') -> Job:
"""Run the job
Args:
job (Job): The job to run
Returns:
Job: _description_
"""
job.perform()
job.ended_at = now()
result_ttl = job.get_result_ttl(default_ttl=DEFAULT_RESULT_TTL)
with self.connection.pipeline() as pipeline:
job._handle_success(result_ttl=result_ttl, pipeline=pipeline, worker_name='')
job.cleanup(result_ttl, pipeline=pipeline)
pipeline.execute()
return job
@classmethod
def parse_args(cls, f: 'FunctionReferenceType', *args, **kwargs):
"""
Parses arguments passed to `queue.enqueue()` and `queue.enqueue_at()`
The function argument `f` may be any of the following:
* A reference to a function
* A reference to an object's instance method
* A string, representing the location of a function (must be
meaningful to the import context of the workers)
Args:
f (FunctionReferenceType): The function reference
args (*args): function args
kwargs (**kwargs): function kwargs
"""
if not isinstance(f, str) and f.__module__ == '__main__':
raise ValueError('Functions from the __main__ module cannot be processed by workers')
# Detect explicit invocations, i.e. of the form:
# q.enqueue(foo, args=(1, 2), kwargs={'a': 1}, job_timeout=30)
timeout = kwargs.pop('job_timeout', None)
description = kwargs.pop('description', None)
result_ttl = kwargs.pop('result_ttl', None)
ttl = kwargs.pop('ttl', None)
failure_ttl = kwargs.pop('failure_ttl', None)
depends_on = kwargs.pop('depends_on', None)
job_id = kwargs.pop('job_id', None)
at_front = kwargs.pop('at_front', False)
meta = kwargs.pop('meta', None)
retry = kwargs.pop('retry', None)
repeat = kwargs.pop('repeat', None)
on_success = kwargs.pop('on_success', None)
on_failure = kwargs.pop('on_failure', None)
on_stopped = kwargs.pop('on_stopped', None)
pipeline = kwargs.pop('pipeline', None)
if 'args' in kwargs or 'kwargs' in kwargs:
assert args == (), 'Extra positional arguments cannot be used when using explicit args and kwargs' # noqa
args = kwargs.pop('args', None)
kwargs = kwargs.pop('kwargs', None)
return (
f,
timeout,
description,
result_ttl,
ttl,
failure_ttl,
depends_on,
job_id,
at_front,
meta,
retry,
repeat,
on_success,
on_failure,
on_stopped,
pipeline,
args,
kwargs,
)
def enqueue(self, f: 'FunctionReferenceType', *args, **kwargs) -> 'Job':
"""Creates a job to represent the delayed function call and enqueues it.
Receives the same parameters accepted by the `enqueue_call` method.
Args:
f (FunctionReferenceType): The function reference
args (*args): function args
kwargs (**kwargs): function kwargs
Returns:
job (Job): The created Job
"""
(
f,
timeout,
description,
result_ttl,
ttl,
failure_ttl,
depends_on,
job_id,
at_front,
meta,
retry,
repeat,
on_success,
on_failure,
on_stopped,
pipeline,
args,
kwargs,
) = Queue.parse_args(f, *args, **kwargs)
return self.enqueue_call(
func=f,
args=args,
kwargs=kwargs,
timeout=timeout,
result_ttl=result_ttl,
ttl=ttl,
failure_ttl=failure_ttl,
description=description,
depends_on=depends_on,
job_id=job_id,
at_front=at_front,
meta=meta,
retry=retry,
repeat=repeat,
on_success=on_success,
on_failure=on_failure,
on_stopped=on_stopped,
pipeline=pipeline,
)
def enqueue_at(self, datetime: datetime, f, *args, **kwargs):
"""Schedules a job to be enqueued at specified time
Args:
datetime (datetime): _description_
f (_type_): _description_
Returns:
_type_: _description_
"""
(
f,
timeout,
description,
result_ttl,
ttl,
failure_ttl,
depends_on,
job_id,
at_front,
meta,
retry,
repeat,
on_success,
on_failure,
on_stopped,
pipeline,
args,
kwargs,
) = Queue.parse_args(f, *args, **kwargs)
job = self.create_job(
f,
status=JobStatus.SCHEDULED,
args=args,
kwargs=kwargs,
timeout=timeout,
result_ttl=result_ttl,
ttl=ttl,
failure_ttl=failure_ttl,
description=description,
depends_on=depends_on,
job_id=job_id,
meta=meta,
retry=retry,
repeat=repeat,
on_success=on_success,
on_failure=on_failure,
on_stopped=on_stopped,
)
if at_front:
job.enqueue_at_front = True
return self.schedule_job(job, datetime, pipeline=pipeline)
def schedule_job(self, job: 'Job', datetime: datetime, pipeline: Optional['Pipeline'] = None):
"""Puts job on ScheduledJobRegistry
Args:
job (Job): _description_
datetime (datetime): _description_
pipeline (Optional[Pipeline], optional): _description_. Defaults to None.
Returns:
_type_: _description_
"""
from .registry import ScheduledJobRegistry
registry = ScheduledJobRegistry(queue=self)
pipe = pipeline if pipeline is not None else self.connection.pipeline()
# Add Queue key set
pipe.sadd(self.redis_queues_keys, self.key)
job.save(pipeline=pipe)
registry.schedule(job, datetime, pipeline=pipe)
if pipeline is None:
pipe.execute()
return job
def enqueue_in(self, time_delta: timedelta, func: 'FunctionReferenceType', *args, **kwargs) -> 'Job':
"""Schedules a job to be executed in a given `timedelta` object
Args:
time_delta (timedelta): The timedelta object
func (FunctionReferenceType): The function reference
Returns:
job (Job): The enqueued Job
"""
return self.enqueue_at(now() + time_delta, func, *args, **kwargs)
def enqueue_job(self, job: 'Job', pipeline: Optional['Pipeline'] = None, at_front: bool = False) -> Job:
"""Enqueues a job for delayed execution checking dependencies.
Args:
job (Job): The job to enqueue
pipeline (Optional[Pipeline], optional): The Redis pipeline to use. Defaults to None.
at_front (bool, optional): Whether should enqueue at the front of the queue. Defaults to False.
Returns:
Job: The enqueued job
"""
job.origin = self.name
job = self.setup_dependencies(job, pipeline=pipeline)
# Add Queue key set
pipe = pipeline if pipeline is not None else self.connection.pipeline()
pipe.sadd(self.redis_queues_keys, self.key)
if pipeline is None:
pipe.execute()
# If we do not depend on an unfinished job, enqueue the job.
if job.get_status(refresh=False) != JobStatus.DEFERRED:
return self._enqueue_job(job, pipeline=pipeline, at_front=at_front)
return job
def _enqueue_job(self, job: 'Job', pipeline: Optional['Pipeline'] = None, at_front: bool = False) -> Job:
"""Enqueues a job for delayed execution without checking dependencies.
If Queue is instantiated with is_async=False, job is executed immediately.
Args:
job (Job): The job to enqueue
pipeline (Optional[Pipeline], optional): The Redis pipeline to use. Defaults to None.
at_front (bool, optional): Whether should enqueue at the front of the queue. Defaults to False.
Returns:
Job: The enqueued job
"""
self.log.debug('Enqueueing job %s to queue %s (at_front=%s)', job.id, self.name, at_front)
pipe = pipeline if pipeline is not None else self.connection.pipeline()
job.redis_server_version = self.get_redis_server_version()
job.set_status(JobStatus.QUEUED, pipeline=pipe)
job.origin = self.name
job.enqueued_at = now()
if job.timeout is None:
job.timeout = self._default_timeout
job.save(pipeline=pipe)
job.cleanup(ttl=job.ttl, pipeline=pipe)
if self._is_async:
self.push_job_id(job.id, pipeline=pipe, at_front=at_front)
if pipeline is None:
pipe.execute()
if not self._is_async:
job = self.run_sync(job)
return job
def run_sync(self, job: 'Job') -> 'Job':
"""Run a job synchronously, meaning on the same process the method was called.
Args:
job (Job): The job to run
Returns:
Job: The job instance
"""
with self.connection.pipeline() as pipeline:
job.prepare_for_execution('sync', pipeline)
try:
job = self.run_job(job)
except: # noqa
with self.connection.pipeline() as pipeline:
job.set_status(JobStatus.FAILED, pipeline=pipeline)
exc_string = ''.join(traceback.format_exception(*sys.exc_info()))
job._handle_failure(exc_string, pipeline, worker_name='')
pipeline.execute()
if job.failure_callback:
job.failure_callback(job, self.connection, *sys.exc_info())
else:
if job.success_callback:
job.success_callback(job, self.connection, job.return_value())
return job
def enqueue_dependents(
self,
job: 'Job',
pipeline: Optional['Pipeline'] = None,
exclude_job_id: Optional[str] = None,
refresh_job_status: bool = True,
):
"""Enqueues all jobs in the given job's dependents set and clears it.
When called without a pipeline, this method uses WATCH/MULTI/EXEC.
If you pass a pipeline, only MULTI is called. The rest is up to the
caller.
Args:
job (Job): The Job to enqueue the dependents
pipeline (Optional[Pipeline], optional): The Redis Pipeline. Defaults to None.
exclude_job_id (Optional[str], optional): Whether to exclude the job id. Defaults to None.
refresh_job_status (bool): whether to refresh job status when checking for dependencies. Defaults to True.
"""
from .registry import DeferredJobRegistry
pipe = pipeline if pipeline is not None else self.connection.pipeline()
dependents_key = job.dependents_key
while True:
try:
# if a pipeline is passed, the caller is responsible for calling WATCH
# to ensure all jobs are enqueued
if pipeline is None:
pipe.watch(dependents_key)
dependent_job_ids = {as_text(_id) for _id in pipe.smembers(dependents_key)} # type: ignore[attr-defined]
# There's no dependents
if not dependent_job_ids:
break
jobs_to_enqueue = [
dependent_job
for dependent_job in self.job_class.fetch_many(
dependent_job_ids, connection=self.connection, serializer=self.serializer
)
if dependent_job
and dependent_job.dependencies_are_met(
parent_job=job,
pipeline=pipe,
exclude_job_id=exclude_job_id,
refresh_job_status=refresh_job_status,
)
and dependent_job.get_status(refresh=False) != JobStatus.CANCELED
]
pipe.multi()
if not jobs_to_enqueue:
break
self.log.debug(
'Enqueueing %d dependent jobs for job %s: %s',
len(jobs_to_enqueue),
job.id,
[j.id for j in jobs_to_enqueue],
)
for dependent in jobs_to_enqueue:
enqueue_at_front = dependent.enqueue_at_front or False
registry = DeferredJobRegistry(
dependent.origin, self.connection, job_class=self.job_class, serializer=self.serializer
)
registry.remove(dependent, pipeline=pipe)
self.log.debug('Removed job %s from DeferredJobRegistry', dependent.id)
if dependent.origin == self.name:
self.log.debug(
'Enqueueing job %s to current queue %s (at_front=%s)',
dependent.id,
self.name,
enqueue_at_front,
)
self._enqueue_job(dependent, pipeline=pipe, at_front=enqueue_at_front)
else:
self.log.debug(
'Enqueueing job %s to different queue %s (at_front=%s)',
dependent.id,
dependent.origin,
enqueue_at_front,
)
queue = self.__class__(name=dependent.origin, connection=self.connection)
queue._enqueue_job(dependent, pipeline=pipe, at_front=enqueue_at_front)
# Only delete dependents_key if all dependents have been enqueued
if len(jobs_to_enqueue) == len(dependent_job_ids):
pipe.delete(dependents_key)
else:
enqueued_job_ids = [job.id for job in jobs_to_enqueue]
pipe.srem(dependents_key, *enqueued_job_ids)
if pipeline is None:
pipe.execute()
break
except WatchError:
if pipeline is None:
continue
else:
# if the pipeline comes from the caller, we re-raise the
# exception as it it the responsibility of the caller to
# handle it
raise
def pop_job_id(self) -> Optional[str]:
"""Pops a given job ID from this Redis queue.
Returns:
job_id (str): The job id
"""
return as_text(self.connection.lpop(self.key))
# The queue_keys type is Sequence[str] instead of Iterable[str]
# because we loop over it twice, and we don't want user to pass a generator.
@classmethod
def lpop(cls, queue_keys: Sequence[str], timeout: Optional[int], connection: Optional['Redis'] = None):
"""Helper method to abstract away from some Redis API details
where LPOP accepts only a single key, whereas BLPOP
accepts multiple. So if we want the non-blocking LPOP, we need to
iterate over all queues, do individual LPOPs, and return the result.
Until Redis receives a specific method for this, we'll have to wrap it
this way.
The timeout parameter is interpreted as follows:
None - non-blocking (return immediately)
> 0 - maximum number of seconds to block
Args:
queue_keys (Sequence[str]): _description_
timeout (Optional[int]): _description_
connection (Optional[Redis], optional): _description_. Defaults to None.
Raises:
ValueError: If timeout of 0 was passed
DequeueTimeout: BLPOP Timeout
Returns:
_type_: _description_
"""
if timeout is not None: # blocking variant
if timeout == 0:
raise ValueError('RQ does not support indefinite timeouts. Please pick a timeout value > 0')
colored_queues = ', '.join(map(str, [green(str(queue)) for queue in queue_keys]))
logger.debug('Starting BLPOP operation for queues %s with timeout of %d', colored_queues, timeout)
assert connection
result = connection.blpop(queue_keys, timeout)
if result is None:
logger.debug('BLPOP timeout, no jobs found on queues %s', colored_queues)
raise DequeueTimeout(timeout, queue_keys)
queue_key, job_id = result
return queue_key, job_id
else: # non-blocking variant
for queue_key in queue_keys:
assert connection
blob = connection.lpop(queue_key)
if blob is not None:
return queue_key, blob
return None
@classmethod
def lmove(cls, connection: 'Redis', queue_key: str, timeout: Optional[int]):
"""Similar to lpop, but accepts only a single queue key and immediately pushes
the result to an intermediate queue.
"""
intermediate_queue = IntermediateQueue(queue_key, connection)
if timeout is not None: # blocking variant
if timeout == 0:
raise ValueError('RQ does not support indefinite timeouts. Please pick a timeout value > 0')
colored_queue = green(queue_key)
logger.debug(f'Starting BLMOVE operation for {colored_queue} with timeout of {timeout}')
result: Optional[Any] = connection.blmove(queue_key, intermediate_queue.key, timeout)
if result is None:
logger.debug(f'BLMOVE timeout, no jobs found on {colored_queue}')
raise DequeueTimeout(timeout, queue_key)
return queue_key, result
else: # non-blocking variant
result = cast(Optional[Any], connection.lmove(queue_key, intermediate_queue.key))
if result is not None:
return queue_key, result
return None
@classmethod
def dequeue_any(
cls,
queues: Iterable['Queue'],
timeout: Optional[int],
connection: 'Redis',
job_class: Optional[type['Job']] = None,
serializer: Optional[Union[Serializer, str]] = None,
death_penalty_class: Optional[type[BaseDeathPenalty]] = None,
) -> Optional[tuple['Job', 'Queue']]:
"""Class method returning the job_class instance at the front of the given
set of Queues, where the order of the queues is important.
When all of the Queues are empty, depending on the `timeout` argument,
either blocks execution of this function for the duration of the
timeout or until new messages arrive on any of the queues, or returns
None.
See the documentation of cls.lpop for the interpretation of timeout.
Args:
queues (Iterable[Queue]): Iterable of queue objects
timeout (Optional[int]): Timeout for the LPOP
connection (Optional[Redis], optional): Redis Connection. Defaults to None.
job_class (Optional[Type[Job]], optional): The job class. Defaults to None.
serializer (Optional[Union[Serializer, str]], optional): Serializer to use. Defaults to None.
death_penalty_class (Optional[Type[BaseDeathPenalty]], optional): The death penalty class. Defaults to None.
Raises:
e: Any exception
Returns:
job, queue (Tuple[Job, Queue]): A tuple of Job, Queue
"""
job_cls: type[Job] = backend_class(cls, 'job_class', override=job_class)
while True:
queue_keys = [q.key for q in queues]
if len(queue_keys) == 1 and get_version(connection) >= (6, 2, 0):
result = cls.lmove(connection, queue_keys[0], timeout)
else:
result = cls.lpop(queue_keys, timeout, connection=connection)
if result is None:
return None
queue_key, job_id = map(as_text, result)
queue = cls.from_queue_key(
queue_key,
connection=connection,
job_class=job_cls,
serializer=serializer,
death_penalty_class=death_penalty_class,
)
try:
job = job_cls.fetch(job_id, connection=connection, serializer=serializer)
except NoSuchJobError:
# Silently pass on jobs that don't exist (anymore),
# and continue in the look
continue
except Exception as e:
# Attach queue information on the exception for improved error
# reporting
e.job_id = job_id # type: ignore[attr-defined]
e.queue = queue # type: ignore[attr-defined]
raise e
return job, queue
# Total ordering definition (the rest of the required Python methods are
# auto-generated by the @total_ordering decorator)
def __eq__(self, other): # noqa
if not isinstance(other, Queue):
raise TypeError('Cannot compare queues to other objects')
return self.name == other.name
def __lt__(self, other):
if not isinstance(other, Queue):
raise TypeError('Cannot compare queues to other objects')
return self.name < other.name
def __hash__(self): # pragma: no cover
return hash(self.name)
def __repr__(self): # noqa # pragma: no cover
return f'{self.__class__.__name__}({self.name!r})'
def __str__(self):
return f'<{self.__class__.__name__} {self.name}>'
|