head() — requests Function Reference

Architecture documentation for the head() function in api.py from the requests codebase.

Function python CoreAPI VerbHandlers calls 1

Entity Profile

CoreAPI→ VerbHandlers→ head() — requests Function Reference

Dependency Diagram

graph TD
  04dba529_ffe4_961c_ee46_0ed4acf6ab64["head()"]
  b9426d6e_b47d_565b_5251_7d3a1c1dfbd1["api.py"]
  04dba529_ffe4_961c_ee46_0ed4acf6ab64 -->|defined in| b9426d6e_b47d_565b_5251_7d3a1c1dfbd1
  8f0a1008_20a1_45d8_2ae7_96c1a7562216["request()"]
  04dba529_ffe4_961c_ee46_0ed4acf6ab64 -->|calls| 8f0a1008_20a1_45d8_2ae7_96c1a7562216
  style 04dba529_ffe4_961c_ee46_0ed4acf6ab64 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/requests/api.py lines 88–100

def head(url, **kwargs):
    r"""Sends a HEAD request.

    :param url: URL for the new :class:`Request` object.
    :param \*\*kwargs: Optional arguments that ``request`` takes. If
        `allow_redirects` is not provided, it will be set to `False` (as
        opposed to the default :meth:`request` behavior).
    :return: :class:`Response <Response>` object
    :rtype: requests.Response
    """

    kwargs.setdefault("allow_redirects", False)
    return request("head", url, **kwargs)