Documentation: Persistent cookies

[supervirus]

Hi, I saw multiple questions like #895 or #1056 about persisting cookies in a file.

Maybe it would be helpful to add a small section to the documentation, as there is a quite easy way offered by Python 3 itself....

Persistent cookies can be achieved by passing an LWPCookieJar or MozillaCookieJar instance as parameter cookies to HTTPX, as it not only accepts a dict, but another CookieJar instance, as well.

Both are implementations of FileCookieJar, which offers load an save functions on top of the normal CookieJar interface.

from http.cookiejar import LWPCookieJar
import httpx

cookiejar = LWPCookieJar(filename='lwp_cookies.dat')
try:
    cookiejar.load()
except FileNotFoundError:
    pass

session = httpx.Client(cookies=cookiejar)
r = httpx.get('https://httpbin.org/cookies/set?chocolate=chip')

cookiejar.save()

from http.cookiejar import MozillaCookieJar
import httpx

cookiejar = MozillaCookieJar(filename='my_cookies.txt')
try:
    cookiejar.load()
except FileNotFoundError:
    pass

session = httpx.Client(cookies=cookiejar)
r = httpx.get('https://httpbin.org/cookies/set?chocolate=chip')

cookiejar.save()

[la-gruge]

Hi, for your code to work with the LWPCookieJar or MozillaCookieJar, you must use the previously created session to make your GET requests.

from :

r = httpx.get('https://httpbin.org/cookies/set?chocolate=chip')

to :

r = session.get('https://httpbin.org/cookies/set?chocolate=chip')