diff options
author | lowercase00 <21188280+lowercase00@users.noreply.github.com> | 2023-01-30 01:42:04 -0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2023-01-30 11:42:04 +0700 |
commit | bd0731025377d5e8ebcbce78026698a57dea01df (patch) | |
tree | e3b365abc7a5b50483f94f3d742f141d9b2ee0bb /rq/defaults.py | |
parent | 398d5784db27ee7bc97fd2eb98aa5eb7d473d071 (diff) | |
download | rq-bd0731025377d5e8ebcbce78026698a57dea01df.tar.gz |
Job methods docstrings (#1772)
* Improve docstrings on `connections`
* Enhanced Job methods docstrings & Serialization Protocol
This adds docstrings to all Job methods in a standard format.
It also implements a `serializer` protocol.
* Excludes `Protocol` (keeping compatibility with < 3.8)
* Add docstrings & type annotation to the `job` decorator
* Docstrings for the `defaults` vars
* Add deprecation warning to Connection context manager
* Fix Types
Diffstat (limited to 'rq/defaults.py')
-rw-r--r-- | rq/defaults.py | 83 |
1 files changed, 80 insertions, 3 deletions
diff --git a/rq/defaults.py b/rq/defaults.py index bb7ec79..ef76678 100644 --- a/rq/defaults.py +++ b/rq/defaults.py @@ -1,14 +1,91 @@ DEFAULT_JOB_CLASS = 'rq.job.Job' +""" The path for the default Job class to use. +Defaults to the main `Job` class within the `rq.job` module +""" + + DEFAULT_QUEUE_CLASS = 'rq.Queue' +""" The path for the default Queue class to use. +Defaults to the main `Queue` class within the `rq.queue` module +""" + + DEFAULT_WORKER_CLASS = 'rq.Worker' +""" The path for the default Worker class to use. +Defaults to the main `Worker` class within the `rq.worker` module +""" + + DEFAULT_SERIALIZER_CLASS = 'rq.serializers.DefaultSerializer' +""" The path for the default Serializer class to use. +Defaults to the main `DefaultSerializer` class within the `rq.serializers` module +""" + + DEFAULT_CONNECTION_CLASS = 'redis.Redis' +""" The path for the default Redis client class to use. +Defaults to the main `Redis` class within the `redis` module +As imported like `from redis import Redis` +""" + + DEFAULT_WORKER_TTL = 420 +""" The default Time To Live (TTL) for the Worker in seconds +Defines the effective timeout period for a worker +""" + + DEFAULT_JOB_MONITORING_INTERVAL = 30 +""" The interval in seconds for Job monitoring +""" + + DEFAULT_RESULT_TTL = 500 -DEFAULT_FAILURE_TTL = 31536000 # 1 year in seconds -DEFAULT_LOGGING_DATE_FORMAT = '%H:%M:%S' +""" The Time To Live (TTL) in seconds to keep job results +Means that the results will be expired from Redis +after `DEFAULT_RESULT_TTL` seconds +""" + + +DEFAULT_FAILURE_TTL = 31536000 +""" The Time To Live (TTL) in seconds to keep job failure information +Means that the failure information will be expired from Redis +after `DEFAULT_FAILURE_TTL` seconds. +Defaults to 1 YEAR in seconds +""" + + DEFAULT_SCHEDULER_FALLBACK_PERIOD = 120 -DEFAULT_LOGGING_FORMAT = '%(asctime)s %(message)s' +""" The amount in seconds it will take for a new scheduler +to pickup tasks after a scheduler has died. +This is used as a safety net to avoid race conditions and duplicates +when using multiple schedulers +""" + + DEFAULT_MAINTENANCE_TASK_INTERVAL = 10 * 60 +""" The interval to run maintenance tasks +in seconds. Defaults to 10 minutes. +""" + + CALLBACK_TIMEOUT = 60 +""" The timeout period in seconds for Callback functions +Means that Functions used in `success_callback` and `failure_callback` +will timeout after N seconds +""" + + +DEFAULT_LOGGING_DATE_FORMAT = '%H:%M:%S' +""" The Date Format to use for RQ logging. +Defaults to Hour:Minute:Seconds on 24hour format +eg.: `15:45:23` +""" + + +DEFAULT_LOGGING_FORMAT = '%(asctime)s %(message)s' +""" The default Logging Format to use +Uses Python's default attributes as defined +https://docs.python.org/3/library/logging.html#logrecord-attributes +""" + |