Context

Task request variables (Task.request).

Attributes

Attribute	Type	Description
args	tuple = null	Positional arguments passed to the task for execution.
callbacks	list = null	List of task signatures to be executed upon successful completion of the task.
called_directly	boolean = true	Flag indicating if the task was executed locally without a broker.
chain	list = null	List of task signatures forming a chain where this task is a member.
chord	dict = null	The chord callback signature if this task is part of a chord header.
correlation_id	string = null	Unique identifier used to correlate request and response messages.
delivery_info	dict = null	Dictionary containing message delivery metadata such as exchange and routing key.
errbacks	list = null	List of task signatures to be executed if the task fails.
eta	datetime = null	The scheduled estimated time of arrival for the task execution.
expires	datetime = null	The expiration time after which the task should be discarded.
group	string = null	The unique identifier of the group if the task is part of a group.
group_index	int = null	The zero-based index of the task within its group.
headers	dict = null	Mapping of custom message headers sent with the task.
hostname	string = null	The name of the worker node instance executing the task.
id	string = null	The unique UUID of the task instance.
ignore_result	boolean = false	Flag to disable storing the task return value in the result backend.
is_eager	boolean = false	Indicates if the task is being executed locally in the client process.
kwargs	dict = null	Keyword arguments passed to the task for execution.
logfile	string = null	The file path where task execution logs are written.
loglevel	int = null	The logging severity level used during task execution.
origin	string = null	The name of the node that sent the task.
parent_id	string = null	The unique identifier of the task that spawned this task.
properties	dict = null	Additional message properties provided by the broker.
retries	int = 0	The number of times the current task has been retried.
reply_to	string = null	The address of the queue where the result should be sent.
replaced_task_nesting	int = 0	Counter tracking the depth of task replacement nesting.
root_id	string = null	The unique identifier of the first task in the workflow chain.
shadow	string = null	An alternative name for the task to be used in logs and monitoring.
taskset	string = null	Compatibility alias for the group identifier.
timelimit	tuple = null	A tuple containing the hard and soft time limits for task execution.
time_limit	float = null	The maximum number of seconds the task can run before being terminated.
soft_time_limit	float = null	The number of seconds before a SoftTimeLimitExceeded exception is raised.
utc	boolean = null	Flag indicating if timestamps should use the UTC timezone.
stamped_headers	list = null	List of header keys that have been cryptographically stamped.
stamps	dict = null	Dictionary containing cryptographic stamps for message integrity.

---

Constructor

Signature

def Context(
    *args: tuple,
    **kwargs: dict
) - > null

Parameters

Name	Type	Description
*args	tuple	Variable length argument list used to update the context attributes.
**kwargs	dict	Arbitrary keyword arguments used to update the context attributes.

---

Signature

def Context(
    *args: any,
    **kwargs: any
) - > null

Parameters

Name	Type	Description
*args	any	Positional arguments used to populate the context dictionary.
**kwargs	any	Keyword arguments representing task request variables and metadata.

---

Methods

---

update()

@classmethod
def update(
    *args: any,
    **kwargs: any
) - > null

Updates the context state and synchronizes time limit attributes if the 'timelimit' key is modified.

Parameters

Name	Type	Description
*args	any	Mappings or iterables of pairs used to update the context attributes.
**kwargs	any	Attribute names and values to be merged into the context.

Returns

Type	Description
null	Nothing is returned.

---

clear()

@classmethod
def clear() - > null

Removes all attributes and data from the current context instance.

Returns

Type	Description
null	Nothing is returned.

---

get()

@classmethod
def get(
    key: str,
    default: any
) - > any

Retrieves a context attribute by name, falling back to a default value if the attribute does not exist.

Parameters

Name	Type	Description
key	str	The name of the context attribute to retrieve.
default	any	The value to return if the specified key is not found.

Returns

Type	Description
any	The value of the requested attribute or the specified default.

---

as_execution_options()

@classmethod
def as_execution_options() - > dict

Converts the current context into a dictionary of execution options suitable for task routing and execution.

Returns

Type	Description
dict	A dictionary containing task IDs, routing info, time limits, and filtered headers.

---

children()

@classmethod
def children() - > list

Provides access to the list of child tasks spawned within this context, initializing it if necessary.

Returns

Type	Description
list	A list of child task references.

---