From f3d3d6bb65ad14625654872fa4af27a4105df3b7 Mon Sep 17 00:00:00 2001 From: I-Al-Istannen Date: Mon, 20 Apr 2020 14:38:03 +0200 Subject: [PATCH] Add some docs to cookie_jar --- PFERD/cookie_jar.py | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/PFERD/cookie_jar.py b/PFERD/cookie_jar.py index 14590c7..e4b26d1 100644 --- a/PFERD/cookie_jar.py +++ b/PFERD/cookie_jar.py @@ -1,3 +1,5 @@ +"""A helper for requests cookies.""" + import logging from http.cookiejar import LoadError, LWPCookieJar from pathlib import Path @@ -7,9 +9,15 @@ import requests logger = logging.getLogger(__name__) + class CookieJar: + """A cookie jar that can be persisted.""" def __init__(self, cookie_file: Optional[Path] = None) -> None: + """Create a new cookie jar at the given path. + + If the path is None, the cookies will not be persisted. + """ self._cookies: LWPCookieJar if cookie_file is None: self._cookies = LWPCookieJar() @@ -18,9 +26,11 @@ class CookieJar: @property def cookies(self) -> LWPCookieJar: + """Return the requests cookie jar.""" return self._cookies def load_cookies(self) -> None: + """Load all cookies from the file given in the constructor.""" if self._cookies.filename is None: return @@ -34,6 +44,7 @@ class CookieJar: ) def save_cookies(self, reason: Optional[str] = None) -> None: + """Save the cookies in the file given in the constructor.""" if self._cookies.filename is None: return @@ -47,11 +58,12 @@ class CookieJar: self._cookies.save(ignore_discard=True) def create_session(self) -> requests.Session: + """Create a new session using the cookie jar.""" sess = requests.Session() # From the request docs: "All requests code should work out of the box # with externally provided instances of CookieJar, e.g. LWPCookieJar # and FileCookieJar." - sess.cookies = self.cookies # type: ignore + sess.cookies = self.cookies # type: ignore return sess