Inheritance diagram for pip._vendor.requests.models.PreparedRequest:

Collaboration diagram for pip._vendor.requests.models.PreparedRequest:

Public Member Functions
	__init__ (self)

	prepare (self, method=None, url=None, headers=None, files=None, data=None, params=None, auth=None, cookies=None, hooks=None, json=None)

	__repr__ (self)

	copy (self)

	prepare_method (self, method)

	prepare_url (self, url, params)

	prepare_headers (self, headers)

	prepare_body (self, data, files, json=None)

	prepare_content_length (self, body)

	prepare_auth (self, auth, url="")

	prepare_cookies (self, cookies)

	prepare_hooks (self, hooks)

Public Member Functions inherited from pip._vendor.requests.models.RequestEncodingMixin
	path_url (self)

Public Member Functions inherited from pip._vendor.requests.models.RequestHooksMixin
	register_hook (self, event, hook)

	deregister_hook (self, event, hook)

Public Attributes
	method

	url

	headers

	body

	hooks

Static Protected Member Functions
	_get_idna_encoded_host (host)

Static Protected Member Functions inherited from pip._vendor.requests.models.RequestEncodingMixin
	_encode_params (data)

	_encode_files (files, data)

Protected Attributes
	_cookies

	_body_position

Detailed Description

The fully mutable :class:`PreparedRequest <PreparedRequest>` object,
containing the exact bytes that will be sent to the server.

Instances are generated from a :class:`Request <Request>` object, and
should not be instantiated manually; doing so may produce undesirable
effects.

Usage::

  >>> import requests
  >>> req = requests.Request('GET', 'https://httpbin.org/get')
  >>> r = req.prepare()
  >>> r
  <PreparedRequest [GET]>

  >>> s = requests.Session()
  >>> s.send(r)
  <Response [200]>

Member Function Documentation

◆ prepare()

pip._vendor.requests.models.PreparedRequest.prepare	(	self,
		method = `None`,
		url = `None`,
		headers = `None`,
		files = `None`,
		data = `None`,
		params = `None`,
		auth = `None`,
		cookies = `None`,
		hooks = `None`,
		json = `None`
	)

Prepares the entire request with the given parameters.

◆ prepare_auth()

pip._vendor.requests.models.PreparedRequest.prepare_auth	(	self,
		auth,
		url = `""`
	)

Prepares the given HTTP auth data.

◆ prepare_body()

pip._vendor.requests.models.PreparedRequest.prepare_body	(	self,
		data,
		files,
		json = `None`
	)

Prepares the given HTTP body data.

◆ prepare_content_length()

pip._vendor.requests.models.PreparedRequest.prepare_content_length	(	self,
		body
	)

Prepare Content-Length header based on request method and body

◆ prepare_cookies()

pip._vendor.requests.models.PreparedRequest.prepare_cookies	(	self,
		cookies
	)

Prepares the given HTTP cookie data.

This function eventually generates a ``Cookie`` header from the
given cookies using cookielib. Due to cookielib's design, the header
will not be regenerated if it already exists, meaning this function
can only be called once for the life of the
:class:`PreparedRequest <PreparedRequest>` object. Any subsequent calls
to ``prepare_cookies`` will have no actual effect, unless the "Cookie"
header is removed beforehand.

◆ prepare_headers()

pip._vendor.requests.models.PreparedRequest.prepare_headers	(	self,
		headers
	)

Prepares the given HTTP headers.

◆ prepare_hooks()

pip._vendor.requests.models.PreparedRequest.prepare_hooks	(	self,
		hooks
	)

Prepares the given hooks.

◆ prepare_method()

pip._vendor.requests.models.PreparedRequest.prepare_method	(	self,
		method
	)

Prepares the given HTTP method.

◆ prepare_url()

pip._vendor.requests.models.PreparedRequest.prepare_url	(	self,
		url,
		params
	)

Prepares the given HTTP URL.

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

docs/help/help-venv/lib/python3.12/site-packages/pip/_vendor/requests/models.py

Public Member Functions

Public Attributes

Static Protected Member Functions

Protected Attributes