create_cookie() — requests Function Reference

Architecture documentation for the create_cookie() function in cookies.py from the requests codebase.

Function python CoreAPI SessionLifecycle calls 2 called by 3

Entity Profile

CoreAPI→ SessionLifecycle→ create_cookie() — requests Function Reference

Dependency Diagram

graph TD
  293b1fa1_bdd4_a38c_982e_5c92a646576d["create_cookie()"]
  270696ff_2a4f_ef5b_92e8_33a79e68a2d8["cookies.py"]
  293b1fa1_bdd4_a38c_982e_5c92a646576d -->|defined in| 270696ff_2a4f_ef5b_92e8_33a79e68a2d8
  fd64c32d_aaa4_5925_c2a7_12f040eb3704["set()"]
  fd64c32d_aaa4_5925_c2a7_12f040eb3704 -->|calls| 293b1fa1_bdd4_a38c_982e_5c92a646576d
  bdabf6b4_0fa2_b7d3_d69f_a30b72ada980["morsel_to_cookie()"]
  bdabf6b4_0fa2_b7d3_d69f_a30b72ada980 -->|calls| 293b1fa1_bdd4_a38c_982e_5c92a646576d
  fad58eac_0316_2b83_52d3_1a1829c12c66["cookiejar_from_dict()"]
  fad58eac_0316_2b83_52d3_1a1829c12c66 -->|calls| 293b1fa1_bdd4_a38c_982e_5c92a646576d
  fd64c32d_aaa4_5925_c2a7_12f040eb3704["set()"]
  293b1fa1_bdd4_a38c_982e_5c92a646576d -->|calls| fd64c32d_aaa4_5925_c2a7_12f040eb3704
  0aace64c_6424_62be_3052_5ea0e8ae90d3["update()"]
  293b1fa1_bdd4_a38c_982e_5c92a646576d -->|calls| 0aace64c_6424_62be_3052_5ea0e8ae90d3
  style 293b1fa1_bdd4_a38c_982e_5c92a646576d fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/requests/cookies.py lines 455–489

def create_cookie(name, value, **kwargs):
    """Make a cookie from underspecified parameters.

    By default, the pair of `name` and `value` will be set for the domain ''
    and sent on every request (this is sometimes called a "supercookie").
    """
    result = {
        "version": 0,
        "name": name,
        "value": value,
        "port": None,
        "domain": "",
        "path": "/",
        "secure": False,
        "expires": None,
        "discard": True,
        "comment": None,
        "comment_url": None,
        "rest": {"HttpOnly": None},
        "rfc2109": False,
    }

    badargs = set(kwargs) - set(result)
    if badargs:
        raise TypeError(
            f"create_cookie() got unexpected keyword arguments: {list(badargs)}"
        )

    result.update(kwargs)
    result["port_specified"] = bool(result["port"])
    result["domain_specified"] = bool(result["domain"])
    result["domain_initial_dot"] = result["domain"].startswith(".")
    result["path_specified"] = bool(result["path"])

    return cookielib.Cookie(**result)