View: src/requests/hooks.py

← requests / src/requests/hooks.py

"""
requests.hooks
~~~~~~~~~~~~~~

This module provides the capabilities for the Requests hooks system.

Available hooks:

``response``:
    The response generated from a Request.
"""

from __future__ import annotations

from collections.abc import Callable, Iterable
from typing import TYPE_CHECKING, Any

if TYPE_CHECKING:
    from . import _types as _t
    from .models import Response

HOOKS: list[str] = ["response"]


def default_hooks() -> dict[str, list[_t.HookType]]:
    return {event: [] for event in HOOKS}


# TODO: response is the only one


def dispatch_hook(
    key: str,
    hooks: _t.HooksInputType | None,
    hook_data: Response,
    **kwargs: Any,
) -> Response:
    """Dispatches a hook dictionary on a given piece of data."""
    hooks_dict = hooks or {}
    hook_list: Iterable[_t.HookType] | _t.HookType | None = hooks_dict.get(key)
    if hook_list:
        if isinstance(hook_list, Callable):
            hook_list = [hook_list]
        for hook in hook_list:
            _hook_data = hook(hook_data, **kwargs)
            if _hook_data is not None:
                hook_data = _hook_data
    return hook_data


1	"""
2	requests.hooks
3	~~~~~~~~~~~~~~
4
5	This module provides the capabilities for the Requests hooks system.
6
7	Available hooks:
8
9	``response``:
10	The response generated from a Request.
11	"""
12
13	from __future__ import annotations
14
15	from collections.abc import Callable, Iterable
16	from typing import TYPE_CHECKING, Any
17
18	if TYPE_CHECKING:
19	from . import _types as _t
20	from .models import Response
21
22	HOOKS: list[str] = ["response"]
23
24
25	def default_hooks() -> dict[str, list[_t.HookType]]:
26	return {event: [] for event in HOOKS}
27
28
29	# TODO: response is the only one
30
31
32	def dispatch_hook(
33	key: str,
34	hooks: _t.HooksInputType \| None,
35	hook_data: Response,
36	**kwargs: Any,
37	) -> Response:
38	"""Dispatches a hook dictionary on a given piece of data."""
39	hooks_dict = hooks or {}
40	hook_list: Iterable[_t.HookType] \| _t.HookType \| None = hooks_dict.get(key)
41	if hook_list:
42	if isinstance(hook_list, Callable):
43	hook_list = [hook_list]
44	for hook in hook_list:
45	_hook_data = hook(hook_data, **kwargs)
46	if _hook_data is not None:
47	hook_data = _hook_data
48	return hook_data
49