cookiejar_from_dict() — requests Function Reference

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

Function python CoreAPI SessionLifecycle calls 2 called by 6

Entity Profile

CoreAPI→ SessionLifecycle→ cookiejar_from_dict() — requests Function Reference

Dependency Diagram

graph TD
  fad58eac_0316_2b83_52d3_1a1829c12c66["cookiejar_from_dict()"]
  270696ff_2a4f_ef5b_92e8_33a79e68a2d8["cookies.py"]
  fad58eac_0316_2b83_52d3_1a1829c12c66 -->|defined in| 270696ff_2a4f_ef5b_92e8_33a79e68a2d8
  b950528f_167e_7566_bbfa_f2e1929d1939["merge_cookies()"]
  b950528f_167e_7566_bbfa_f2e1929d1939 -->|calls| fad58eac_0316_2b83_52d3_1a1829c12c66
  f54e6687_0796_d413_58a1_971b32410667["prepare_cookies()"]
  f54e6687_0796_d413_58a1_971b32410667 -->|calls| fad58eac_0316_2b83_52d3_1a1829c12c66
  b47cdd7b_1bee_c465_e1f8_c3fa479afe6c["__init__()"]
  b47cdd7b_1bee_c465_e1f8_c3fa479afe6c -->|calls| fad58eac_0316_2b83_52d3_1a1829c12c66
  9e3b60ed_3668_f4e9_fa2a_9db7ae000c2e["__init__()"]
  9e3b60ed_3668_f4e9_fa2a_9db7ae000c2e -->|calls| fad58eac_0316_2b83_52d3_1a1829c12c66
  a4eb532d_c481_9e3e_ad07_8d203ffafd2d["prepare_request()"]
  a4eb532d_c481_9e3e_ad07_8d203ffafd2d -->|calls| fad58eac_0316_2b83_52d3_1a1829c12c66
  1d482234_4405_37b4_6d8e_56ee8d8badb3["add_dict_to_cookiejar()"]
  1d482234_4405_37b4_6d8e_56ee8d8badb3 -->|calls| fad58eac_0316_2b83_52d3_1a1829c12c66
  18b8e0d9_87b2_0c01_a9bc_40b6eb7e0054["set_cookie()"]
  fad58eac_0316_2b83_52d3_1a1829c12c66 -->|calls| 18b8e0d9_87b2_0c01_a9bc_40b6eb7e0054
  293b1fa1_bdd4_a38c_982e_5c92a646576d["create_cookie()"]
  fad58eac_0316_2b83_52d3_1a1829c12c66 -->|calls| 293b1fa1_bdd4_a38c_982e_5c92a646576d
  style fad58eac_0316_2b83_52d3_1a1829c12c66 fill:#6366f1,stroke:#818cf8,color:#fff

Relationship Graph

Source Code

src/requests/cookies.py lines 521–539

def cookiejar_from_dict(cookie_dict, cookiejar=None, overwrite=True):
    """Returns a CookieJar from a key/value dictionary.

    :param cookie_dict: Dict of key/values to insert into CookieJar.
    :param cookiejar: (optional) A cookiejar to add the cookies to.
    :param overwrite: (optional) If False, will not replace cookies
        already in the jar with new ones.
    :rtype: CookieJar
    """
    if cookiejar is None:
        cookiejar = RequestsCookieJar()

    if cookie_dict is not None:
        names_from_jar = [cookie.name for cookie in cookiejar]
        for name in cookie_dict:
            if overwrite or (name not in names_from_jar):
                cookiejar.set_cookie(create_cookie(name, cookie_dict[name]))

    return cookiejar