pip._vendor.cachecontrol.heuristics.BaseHeuristic Class Reference

Inheritance diagram for pip._vendor.cachecontrol.heuristics.BaseHeuristic:

Public Member Functions
str|None	warning (self, HTTPResponse response)
dict[str, str]	update_headers (self, HTTPResponse response)
HTTPResponse	apply (self, HTTPResponse response)

Member Function Documentation

update_headers()

dict[str, str] pip._vendor.cachecontrol.heuristics.BaseHeuristic.update_headers	(		self,
		HTTPResponse	response
	)

Update the response headers with any new headers.

NOTE: This SHOULD always include some Warning header to
      signify that the response was cached by the client, not
      by way of the provided headers.

Reimplemented in pip._vendor.cachecontrol.heuristics.LastModified, pip._vendor.cachecontrol.heuristics.OneDayCache, and pip._vendor.cachecontrol.heuristics.ExpiresAfter.

warning()

str | None pip._vendor.cachecontrol.heuristics.BaseHeuristic.warning	(		self,
		HTTPResponse	response
	)

Return a valid 1xx warning header value describing the cache
adjustments.

The response is provided too allow warnings like 113
http://tools.ietf.org/html/rfc7234#section-5.5.4 where we need
to explicitly say response is over 24 hours old.

Reimplemented in pip._vendor.cachecontrol.heuristics.LastModified, and pip._vendor.cachecontrol.heuristics.ExpiresAfter.

---

The documentation for this class was generated from the following file:

• docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/cachecontrol/heuristics.py