mirror of
https://github.com/Garmelon/PFERD.git
synced 2023-12-21 10:23:01 +01:00
55678d7fee
Some python versions just can't handle it *despite the documentation stating they should*.
70 lines
2.2 KiB
Python
70 lines
2.2 KiB
Python
"""A helper for requests cookies."""
|
|
|
|
import logging
|
|
from http.cookiejar import LoadError, LWPCookieJar
|
|
from pathlib import Path
|
|
from typing import Optional
|
|
|
|
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()
|
|
else:
|
|
self._cookies = LWPCookieJar(str(cookie_file.resolve()))
|
|
|
|
@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
|
|
|
|
try:
|
|
LOGGER.info("Loading old cookies from %s", self._cookies.filename)
|
|
self._cookies.load(ignore_discard=True)
|
|
except (FileNotFoundError, LoadError):
|
|
LOGGER.warning(
|
|
"No valid cookie file found at %s, continuing with no cookies",
|
|
self._cookies.filename
|
|
)
|
|
|
|
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
|
|
|
|
if reason is None:
|
|
LOGGER.info("Saving cookies")
|
|
else:
|
|
LOGGER.info("Saving cookies (%s)", reason)
|
|
|
|
# TODO figure out why ignore_discard is set
|
|
# TODO possibly catch a few more exceptions
|
|
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
|
|
|
|
return sess
|