RequestHandlerRunResult

Record of calls to storage-related context helpers.

Index

Methods

• __init__
• add_requests
• get_key_value_store
• push_data

Methods

__init__

• __init__(*, key_value_store_getter): None

• Parameters

  • optionalkeyword-onlykey_value_store_getter: GetKeyValueStoreFunction

  Returns None

add_requests

• async add_requests(*, requests, kwargs): None

• Track a call to the add_requests context helper.

  ---

  Parameters

  • optionalkeyword-onlyrequests: Sequence[str | BaseRequestData]

  • keyword-onlylimit: int

    Maximum number of requests to be enqueued.

  • keyword-onlybase_url: str

    Base URL to be used for relative URLs.

  • keyword-onlystrategy: EnqueueStrategy

    Enqueueing strategy, see the EnqueueStrategy enum for possible values and their meanings.

  • keyword-onlyinclude: list[re.Pattern | Glob]

    List of regular expressions or globs that URLs must match to be enqueued.

  • keyword-onlyexclude: list[re.Pattern | Glob]

    List of regular expressions or globs that URLs must not match to be enqueued.

  Returns None

get_key_value_store

• async get_key_value_store(*, id, name): KeyValueStoreInterface

• Parameters

  • optionalkeyword-onlyid: str | None = None

  • optionalkeyword-onlyname: str | None = None

  Returns KeyValueStoreInterface

push_data

• async push_data(*, data, dataset_id, dataset_name, kwargs): None

• Track a call to the push_data context helper.

  ---

  Parameters

  • optionalkeyword-onlydata: JsonSerializable

  • optionalkeyword-onlydataset_id: str | None = None

  • optionalkeyword-onlydataset_name: str | None = None

  Returns None