pip._vendor.requests.models.Request Class Reference

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

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

Public Member Functions
	__init__ (self, method=None, url=None, headers=None, files=None, data=None, params=None, auth=None, cookies=None, hooks=None, json=None)
	__repr__ (self)
	prepare (self)
Public Member Functions inherited from pip._vendor.requests.models.RequestHooksMixin
	register_hook (self, event, hook)
	deregister_hook (self, event, hook)

Public Attributes
	hooks
	method
	url
	headers
	files
	data
	json
	params
	auth
	cookies

Detailed Description

A user-created :class:`Request <Request>` object.

Used to prepare a :class:`PreparedRequest <PreparedRequest>`, which is sent to the server.

:param method: HTTP method to use.
:param url: URL to send.
:param headers: dictionary of headers to send.
:param files: dictionary of {filename: fileobject} files to multipart upload.
:param data: the body to attach to the request. If a dictionary or
    list of tuples ``[(key, value)]`` is provided, form-encoding will
    take place.
:param json: json for the body to attach to the request (if files or data is not specified).
:param params: URL parameters to append to the URL. If a dictionary or
    list of tuples ``[(key, value)]`` is provided, form-encoding will
    take place.
:param auth: Auth handler or (user, pass) tuple.
:param cookies: dictionary or CookieJar of cookies to attach to this request.
:param hooks: dictionary of callback hooks, for internal usage.

Usage::

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

Member Function Documentation

prepare()

pip._vendor.requests.models.Request.prepare

(

self

)

Constructs a :class:`PreparedRequest <PreparedRequest>` for transmission and returns it.

---

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