[Django] #36816: Allow **kwargs in @task decorator to support custom Task subclasses

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses
-------------------------------------+-------------------------------------
Reporter: sharingan-no- | Type: Bug
kakashi |
Status: new | Component: Tasks
Version: 6.0 | Severity: Normal
Keywords: task | Triage Stage:
| Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-------------------------------------+-------------------------------------
Currently, the @task decorator accepts a fixed set of parameters and
passes only those to task_class:


Problem: When using a custom backend with a custom task_class that accepts
additional parameters (e.g., max_retries, timeout), there's no way to pass
those through the decorator.

{{{
def task(
function=None,
*,
priority=DEFAULT_TASK_PRIORITY,
queue_name=DEFAULT_TASK_QUEUE_NAME,
backend=DEFAULT_TASK_BACKEND_ALIAS,
takes_context=False,
):
# ...
return task_backends[backend].task_class(
priority=priority,
func=f,
queue_name=queue_name,
backend=backend,
takes_context=takes_context,
run_after=None
)

}}}


Proposed solution: Add **kwargs to the decorator signature and pass it
through to task_class:
{{{
def task(
function=None,
*,
priority=DEFAULT_TASK_PRIORITY,
queue_name=DEFAULT_TASK_QUEUE_NAME,
backend=DEFAULT_TASK_BACKEND_ALIAS,
takes_context=False,
**kwargs,
):
def wrapper(f):
return task_backends[backend].task_class(
priority=priority,
func=f,
queue_name=queue_name,
backend=backend,
takes_context=takes_context,
run_after=None,
**kwargs,
)

}}}

Use case example:

{{{
class MyTask(Task):
def __init__(self, *, max_retries=3, timeout=300, **kwargs):
super().__init__(**kwargs)
self.max_retries = max_retries
self.timeout = timeout

# With the proposed change:
@task(backend="my_backend", max_retries=5, timeout=600)
def my_task():
pass
}}}

This change is backwards compatible and aligns with Django's common
extensibility patterns.
--
Ticket URL: <https://code.djangoproject.com/ticket/36816>
Django <https://code.djangoproject.com/>
The Web framework for perfectionists with deadlines.

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses

------------------------+--------------------------------------
Reporter: Pietro | Owner: Kshitij
Type: Bug | Status: assigned
Component: Tasks | Version: 6.0
Severity: Normal | Resolution:

Keywords: task | Triage Stage: Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0

------------------------+--------------------------------------
Changes (by Kshitij):

* owner: (none) => Kshitij
* status: new => assigned

--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:1>

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses

-----------------------------+--------------------------------------
Reporter: Pietro | Owner: Kshitij
Type: New feature | Status: assigned

Component: Tasks | Version: 6.0
Severity: Normal | Resolution:
Keywords: task | Triage Stage: Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0

-----------------------------+--------------------------------------
Changes (by Kshitij):

* type: Bug => New feature

--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:2>

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses
-----------------------------+--------------------------------------

Reporter: Pietro | Owner: (none)
Type: New feature | Status: new

Component: Tasks | Version: 6.0
Severity: Normal | Resolution:
Keywords: task | Triage Stage: Unreviewed
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------+--------------------------------------
Changes (by Kshitij):

* owner: Kshitij => (none)
* status: assigned => new

--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:3>

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses
-----------------------------+--------------------------------------
Reporter: Pietro | Owner: (none)
Type: New feature | Status: new
Component: Tasks | Version: 6.0
Severity: Normal | Resolution:
Keywords: task | Triage Stage: Unreviewed

Has patch: 0 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------+--------------------------------------

Changes (by JaeHyuckSa):

* has_patch: 1 => 0

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses
-----------------------------+--------------------------------------
Reporter: Pietro | Owner: (none)
Type: New feature | Status: new
Component: Tasks | Version: 6.0
Severity: Normal | Resolution:
Keywords: task | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------+--------------------------------------

Changes (by Nilesh Pahari):

* cc: Nilesh Pahari (added)

--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:4>

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses
-----------------------------+--------------------------------------
Reporter: Pietro | Owner: (none)
Type: New feature | Status: new
Component: Tasks | Version: 6.0
Severity: Normal | Resolution:
Keywords: task | Triage Stage: Unreviewed
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------+--------------------------------------

Changes (by Jacob Walls):

* cc: Jake Howard (added)

--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:5>

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses
-----------------------------+------------------------------------

Reporter: Pietro | Owner: (none)
Type: New feature | Status: new
Component: Tasks | Version: 6.0
Severity: Normal | Resolution:

Keywords: task | Triage Stage: Accepted

Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------+------------------------------------

Changes (by Jake Howard):

* stage: Unreviewed => Accepted

Comment:

This sounds like a reasonable change to me.

As for the solution, my suggestion would be to drop all explicit
arguments, and only accept `**kwargs` in the `@task` decorator - instead
moving the defaults to the `Task` class itself. That also means that, for
whatever reason, a custom `Task` can override defaults.
--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:6>

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses

-----------------------------+-----------------------------------------
Reporter: Pietro | Owner: Nilesh Pahari

Type: New feature | Status: assigned

Component: Tasks | Version: 6.0
Severity: Normal | Resolution:
Keywords: task | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0

-----------------------------+-----------------------------------------
Changes (by Nilesh Pahari):

* owner: (none) => Nilesh Pahari

* status: new => assigned

--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:7>

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses
-----------------------------+-----------------------------------------
Reporter: Pietro | Owner: Nilesh Pahari
Type: New feature | Status: assigned

Component: Tasks | Version: dev

Severity: Normal | Resolution:
Keywords: task | Triage Stage: Accepted
Has patch: 0 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------+-----------------------------------------

Changes (by Jacob Walls):

* version: 6.0 => dev

--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:8>

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses
-----------------------------+-----------------------------------------
Reporter: Pietro | Owner: Nilesh Pahari
Type: New feature | Status: assigned
Component: Tasks | Version: dev
Severity: Normal | Resolution:
Keywords: task | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------+-----------------------------------------

Changes (by Nilesh Pahari):

* has_patch: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:9>

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses
-----------------------------+-----------------------------------------
Reporter: Pietro | Owner: Nilesh Pahari
Type: New feature | Status: assigned
Component: Tasks | Version: dev
Severity: Normal | Resolution:
Keywords: task | Triage Stage: Accepted
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------+-----------------------------------------

Comment (by Nilesh Pahari):

PR: https://github.com/django/django/pull/20456
--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:10>

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses
-----------------------------+-----------------------------------------
Reporter: Pietro | Owner: Nilesh Pahari
Type: New feature | Status: assigned
Component: Tasks | Version: dev
Severity: Normal | Resolution:
Keywords: task | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 1

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------+-----------------------------------------

Changes (by Jacob Walls):

* needs_docs: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:11>

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses

-----------------------------+---------------------------------------------

Reporter: Pietro | Owner: Nilesh Pahari
Type: New feature | Status: assigned
Component: Tasks | Version: dev
Severity: Normal | Resolution:

Keywords: task | Triage Stage: Ready for checkin
Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0

-----------------------------+---------------------------------------------
Changes (by Kerollos Emad):

* needs_docs: 1 => 0
* stage: Accepted => Ready for checkin

Comment:

[https://github.com/django/django/pull/20917 PR]
--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:12>

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses
-----------------------------+-----------------------------------------

Reporter: Pietro | Owner: Nilesh Pahari
Type: New feature | Status: assigned
Component: Tasks | Version: dev
Severity: Normal | Resolution:

Keywords: task | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------+-----------------------------------------

Changes (by Kerollos Emad):

* stage: Ready for checkin => Accepted

--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:13>

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses
-----------------------------+-----------------------------------------
Reporter: Pietro | Owner: Nilesh Pahari
Type: New feature | Status: assigned
Component: Tasks | Version: dev
Severity: Normal | Resolution:
Keywords: task | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 1

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------+-----------------------------------------

Changes (by Jacob Walls):

* needs_docs: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:14>

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses
-----------------------------+-----------------------------------------
Reporter: Pietro | Owner: Nilesh Pahari
Type: New feature | Status: assigned
Component: Tasks | Version: dev
Severity: Normal | Resolution:
Keywords: task | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------+-----------------------------------------

Changes (by Nilesh Pahari):

* needs_docs: 1 => 0

--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:15>

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses
-----------------------------+-----------------------------------------
Reporter: Pietro | Owner: Nilesh Pahari
Type: New feature | Status: assigned
Component: Tasks | Version: dev
Severity: Normal | Resolution:
Keywords: task | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 1

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------+-----------------------------------------

Changes (by Jacob Walls):

* needs_docs: 0 => 1

--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:16>

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses
-----------------------------+-----------------------------------------
Reporter: Pietro | Owner: Nilesh Pahari
Type: New feature | Status: assigned
Component: Tasks | Version: dev
Severity: Normal | Resolution:
Keywords: task | Triage Stage: Accepted

Has patch: 1 | Needs documentation: 0

Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------+-----------------------------------------

Changes (by Nilesh Pahari):

* needs_docs: 1 => 0

--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:17>

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses

-----------------------------+---------------------------------------------

Reporter: Pietro | Owner: Nilesh Pahari
Type: New feature | Status: assigned
Component: Tasks | Version: dev
Severity: Normal | Resolution:

Keywords: task | Triage Stage: Ready for checkin

Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0

-----------------------------+---------------------------------------------
Changes (by Jacob Walls):

* stage: Accepted => Ready for checkin

--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:18>

[Django]

#36816: Allow **kwargs in @task decorator to support custom Task subclasses
-----------------------------+---------------------------------------------
Reporter: Pietro | Owner: Nilesh Pahari

Type: New feature | Status: closed
Component: Tasks | Version: dev
Severity: Normal | Resolution: fixed

Keywords: task | Triage Stage: Ready for checkin
Has patch: 1 | Needs documentation: 0
Needs tests: 0 | Patch needs improvement: 0
Easy pickings: 1 | UI/UX: 0
-----------------------------+---------------------------------------------

Changes (by Jacob Walls <jacobtylerwalls@…>):

* resolution: => fixed
* status: assigned => closed

Comment:

In [changeset:"e27f23b268c520957384054fb236cfc303f95f51" e27f23b]:
{{{#!CommitTicketReference repository=""
revision="e27f23b268c520957384054fb236cfc303f95f51"
Fixed #36816 -- Allowed **kwargs in @task decorator.

The decorator was updated to accept **kwargs and forward them to
task_class, allowing additional parameters to be passed to custom
Task subclasses.
}}}
--
Ticket URL: <https://code.djangoproject.com/ticket/36816#comment:19>