FormRequestOptions

Options for the Request created from a form.

Mirrors RequestOptions without the URL, method and payload, which come from the form, without id and unique_key, which can't be shared by several forms, and without enqueue_strategy, which enqueuing sets.

Index

Properties

• always_enqueue
• headers
• keep_url_fragment
• label
• max_retries
• no_retry
• session_id
• use_extended_unique_key
• user_data

Properties

keyword-onlyoptionalalways_enqueue

always_enqueue: NotRequired[bool]

Whether to enqueue the request even if it's already in the queue.

keyword-onlyoptionalheaders

headers: NotRequired[(HttpHeaders | dict[str, str]) | None]

HTTP headers of the request, replacing those the form sets, like Content-Type or Referer.

keyword-onlyoptionalkeep_url_fragment

keep_url_fragment: NotRequired[bool]

Whether the URL fragment counts towards the unique key of the request.

keyword-onlyoptionallabel

label: NotRequired[str | None]

A label routing the request to a specific handler.

keyword-onlyoptionalmax_retries

max_retries: NotRequired[int | None]

The maximum number of retries of the request.

keyword-onlyoptionalno_retry

no_retry: NotRequired[bool]

Whether to skip retrying the request if it fails.

keyword-onlyoptionalsession_id

session_id: NotRequired[str | None]

ID of the Session the request is bound to.

keyword-onlyoptionaluse_extended_unique_key

use_extended_unique_key: NotRequired[bool]

Whether the method and payload count towards the unique key. Defaults to True for POST forms.

keyword-onlyoptionaluser_data

user_data: NotRequired[Mapping[str, JsonSerializable]]

Custom data stored with the request.