pip._vendor.cachecontrol.adapter.CacheControlAdapter Class Reference

Inheritance diagram for pip._vendor.cachecontrol.adapter.CacheControlAdapter:

Collaboration diagram for pip._vendor.cachecontrol.adapter.CacheControlAdapter:

Public Member Functions
None	__init__ (self, BaseCache|None cache=None, bool cache_etags=True, type[CacheController]|None controller_class=None, Serializer|None serializer=None, BaseHeuristic|None heuristic=None, Collection[str]|None cacheable_methods=None, *Any args, **Any kw)
Response	send (self, PreparedRequest request, bool stream=False, None|float|tuple[float, float]|tuple[float, None] timeout=None, bool|str verify=True,(None|bytes|str|tuple[bytes|str, bytes|str]) cert=None, Mapping[str, str]|None proxies=None, Collection[str]|None cacheable_methods=None)
Response	build_response (self, PreparedRequest request, HTTPResponse response, bool from_cache=False, Collection[str]|None cacheable_methods=None)
None	close (self)
Public Member Functions inherited from pip._vendor.requests.adapters.HTTPAdapter
	__getstate__ (self)
	__setstate__ (self, state)
	init_poolmanager (self, connections, maxsize, block=DEFAULT_POOLBLOCK, **pool_kwargs)
	proxy_manager_for (self, proxy, **proxy_kwargs)
	cert_verify (self, conn, url, verify, cert)
	get_connection (self, url, proxies=None)
	request_url (self, request, proxies)
	add_headers (self, request, **kwargs)
	proxy_headers (self, proxy)

Public Attributes
	cache
	heuristic
	cacheable_methods
	controller
	chunk_left
Public Attributes inherited from pip._vendor.requests.adapters.HTTPAdapter
	max_retries
	config
	proxy_manager
	poolmanager

Static Public Attributes
dict	invalidating_methods = {"PUT", "PATCH", "DELETE"}

Additional Inherited Members
Protected Attributes inherited from pip._vendor.requests.adapters.HTTPAdapter
	_pool_connections
	_pool_maxsize
	_pool_block

Constructor & Destructor Documentation

__init__()

None pip._vendor.cachecontrol.adapter.CacheControlAdapter.__init__	(		self,
		BaseCache | None	cache = None,
		bool	cache_etags = True,
		type[CacheController] | None	controller_class = None,
		Serializer | None	serializer = None,
		BaseHeuristic | None	heuristic = None,
		Collection[str] | None	cacheable_methods = None,
		*Any	args,
		**Any	kw
	)

Reimplemented from pip._vendor.requests.adapters.HTTPAdapter.

Member Function Documentation

build_response()

Response pip._vendor.cachecontrol.adapter.CacheControlAdapter.build_response	(		self,
		PreparedRequest	request,
		HTTPResponse	response,
		bool	from_cache = False,
		Collection[str] | None	cacheable_methods = None
	)

Build a response by making a request or using the cache.

This will end up calling send and returning a potentially
cached response

Reimplemented from pip._vendor.requests.adapters.HTTPAdapter.

close()

None pip._vendor.cachecontrol.adapter.CacheControlAdapter.close

(

self

)

Disposes of any internal state.

Currently, this closes the PoolManager and any active ProxyManager,
which closes any pooled connections.

Reimplemented from pip._vendor.requests.adapters.HTTPAdapter.

send()

Response pip._vendor.cachecontrol.adapter.CacheControlAdapter.send	(		self,
		PreparedRequest	request,
		bool	stream = False,
		None | float | tuple[float, float] | tuple[float, None]	timeout = None,
		bool | str	verify = True,
		(None | bytes | str | tuple[bytes | str, bytes | str])	cert = None,
		Mapping[str, str] | None	proxies = None,
		Collection[str] | None	cacheable_methods = None
	)

Send a request. Use the request information to see if it
exists in the cache and cache the response if we need to and can.

Reimplemented from pip._vendor.requests.adapters.HTTPAdapter.

---

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

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