diff options
| author | Selwin Ong <selwin.ong@gmail.com> | 2019-04-14 18:31:28 +0700 |
|---|---|---|
| committer | Selwin Ong <selwin.ong@gmail.com> | 2019-04-14 18:31:28 +0700 |
| commit | 0d593f40e1efcf2bead67b8bade91d0f3477bf61 (patch) | |
| tree | 9a73f8c5479eb21e9d8cc4375e574bf4d4b0a24e | |
| parent | 2af3d829b09c6243148a561b0495965c95a27db0 (diff) | |
| download | rq-0d593f40e1efcf2bead67b8bade91d0f3477bf61.tar.gz | |
Clarify the use of "args" and "kwargs" in queue.enqueue()
| -rw-r--r-- | docs/docs/index.md | 19 |
1 files changed, 12 insertions, 7 deletions
diff --git a/docs/docs/index.md b/docs/docs/index.md index 1a77779..78661dd 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -74,17 +74,22 @@ results are kept. Expired jobs will be automatically deleted. Defaults to 500 se * `at_front` will place the job at the *front* of the queue, instead of the back * `description` to add additional description to enqueued jobs. -* `kwargs` and `args` lets you bypass the auto-pop of these arguments, ie: - specify a `description` argument for the underlying job function. +* `args` and `kwargs`: use these to explicitly pass arguments and keyword to the + underlying job function. This is useful if your function happens to have + conflicting argument names with RQ, for example `description` or `ttl`. -In the last case, it may be advantageous to instead use the explicit version of -`.enqueue()`, `.enqueue_call()`: +In the last case, if you want to pass `description` and `ttl` keyword arguments +to your job and not to RQ's enqueue function, this is what you do: ```python q = Queue('low', connection=redis_conn) -q.enqueue_call(func=count_words_at_url, - args=('http://nvie.com',), - job_timeout=30) +q.enqueue(func=count_words_at_url, + ttl=30, # This ttl will be used by RQ + args=('http://nvie.com',), + kwargs={ + 'description': 'Function description', # This is passed on to count_words_at_url + 'ttl': 15 # This is passed on to count_words_at_url function + }) ``` For cases where the web process doesn't have access to the source code running |
