Source code for requests_cache.models.request

from logging import getLogger

from attr import asdict, define, field, fields_dict
from requests import PreparedRequest
from requests.cookies import RequestsCookieJar
from requests.structures import CaseInsensitiveDict

from ..cache_keys import encode

logger = getLogger(__name__)


[docs]@define(auto_attribs=False) class CachedRequest: """A serializable dataclass that emulates :py:class:`requests.PreparedResponse`""" body: bytes = field(default=None, converter=encode) cookies: RequestsCookieJar = field(factory=RequestsCookieJar) headers: CaseInsensitiveDict = field(factory=CaseInsensitiveDict) method: str = field(default=None) url: str = field(default=None)
[docs] @classmethod def from_request(cls, original_request: PreparedRequest) -> 'CachedRequest': """Create a CachedRequest based on an original request object""" kwargs = {k: getattr(original_request, k, None) for k in fields_dict(cls).keys()} kwargs['cookies'] = getattr(original_request, '_cookies', None) return cls(**kwargs)
[docs] def copy(self) -> 'CachedRequest': """Return a copy of the CachedRequest""" return self.__class__(**asdict(self))
[docs] def prepare(self) -> PreparedRequest: """Convert the CachedRequest back into a PreparedRequest""" prepared_request = PreparedRequest() prepared_request.prepare( cookies=self.cookies, data=self.body, headers=self.headers, method=self.method, url=self.url, ) return prepared_request
@property def _cookies(self): """For compatibility with PreparedRequest, which has an attribute named '_cookies', and a keyword argument named 'cookies'. """ return self.cookies def __str__(self): return f'{self.method} {self.url}'