pip._vendor.requests.models.Request Class Reference

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

Public Member Functions
def	__init__
def	__repr__
def	prepare
Public Member Functions inherited from pip._vendor.requests.models.RequestHooksMixin
def	register_hook
def	deregister_hook

Public Attributes
	hooks
	method
	url
	headers
	files
	data
	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 the request. If a dictionary is provided, form-encoding will take place.
:param params: dictionary of URL parameters to append to the URL.
: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', 'http://httpbin.org/get')
  >>> req.prepare()
  <PreparedRequest [GET]>

Constructor & Destructor Documentation

def pip._vendor.requests.models.Request.__init__	(		self,
			method = None,
			url = None,
			headers = None,
			files = None,
			data = None,
			params = None,
			auth = None,
			cookies = None,
			hooks = None
	)

Member Function Documentation

def pip._vendor.requests.models.Request.__repr__

(

self

)

def pip._vendor.requests.models.Request.prepare

(

self

)

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

Member Data Documentation

pip._vendor.requests.models.Request.auth

pip._vendor.requests.models.Request.cookies

pip._vendor.requests.models.Request.data

pip._vendor.requests.models.Request.files

pip._vendor.requests.models.Request.headers

pip._vendor.requests.models.Request.hooks

pip._vendor.requests.models.Request.method

pip._vendor.requests.models.Request.params

pip._vendor.requests.models.Request.url

---

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

• orbits/lib/python2.7/site-packages/pip/_vendor/requests/models.py