Inheritance diagram for pip._vendor.requests.sessions.Session:

Public Member Functions
def	__init__

def	__enter__

def	__exit__

def	prepare_request

def	request

def	get

def	options

def	head

def	post

def	put

def	patch

def	delete

def	send

def	get_adapter

def	close

def	mount

def	__getstate__

def	__setstate__

Public Member Functions inherited from pip._vendor.requests.sessions.SessionRedirectMixin
def	resolve_redirects

def	rebuild_auth

def	rebuild_proxies

Public Attributes
	headers

	auth

	proxies

	hooks

	params

	stream

	verify

	cert

	max_redirects

	trust_env

	cookies

	adapters

Static Private Attributes
list	__attrs__

Detailed Description

A Requests session.

Provides cookie persistence, connection-pooling, and configuration.

Basic Usage::

  >>> import requests
  >>> s = requests.Session()
  >>> s.get('http://httpbin.org/get')
  200

Constructor & Destructor Documentation

def pip._vendor.requests.sessions.Session.__init__ ( self )

Member Function Documentation

def pip._vendor.requests.sessions.Session.__enter__ ( self )

def pip._vendor.requests.sessions.Session.__exit__	(	self,
		args
	)

def pip._vendor.requests.sessions.Session.__getstate__ ( self )

def pip._vendor.requests.sessions.Session.__setstate__	(	self,
		state
	)

def pip._vendor.requests.sessions.Session.close ( self )

Closes all adapters and as such the session

def pip._vendor.requests.sessions.Session.delete	(	self,
		url,
		kwargs
	)

Sends a DELETE request. Returns :class:`Response` object.

:param url: URL for the new :class:`Request` object.
:param \*\*kwargs: Optional arguments that ``request`` takes.

def pip._vendor.requests.sessions.Session.get	(	self,
		url,
		kwargs
	)

Sends a GET request. Returns :class:`Response` object.

:param url: URL for the new :class:`Request` object.
:param \*\*kwargs: Optional arguments that ``request`` takes.

def pip._vendor.requests.sessions.Session.get_adapter	(	self,
		url
	)

Returns the appropriate connnection adapter for the given URL.

def pip._vendor.requests.sessions.Session.head	(	self,
		url,
		kwargs
	)

Sends a HEAD request. Returns :class:`Response` object.

:param url: URL for the new :class:`Request` object.
:param \*\*kwargs: Optional arguments that ``request`` takes.

def pip._vendor.requests.sessions.Session.mount	(	self,
		prefix,
		adapter
	)

Registers a connection adapter to a prefix.

Adapters are sorted in descending order by key length.

def pip._vendor.requests.sessions.Session.options	(	self,
		url,
		kwargs
	)

Sends a OPTIONS request. Returns :class:`Response` object.

:param url: URL for the new :class:`Request` object.
:param \*\*kwargs: Optional arguments that ``request`` takes.

def pip._vendor.requests.sessions.Session.patch	(	self,
		url,
		data = `None`,
		kwargs
	)

Sends a PATCH request. Returns :class:`Response` object.

:param url: URL for the new :class:`Request` object.
:param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`.
:param \*\*kwargs: Optional arguments that ``request`` takes.

def pip._vendor.requests.sessions.Session.post	(	self,
		url,
		data = `None`,
		kwargs
	)

Sends a POST request. Returns :class:`Response` object.

:param url: URL for the new :class:`Request` object.
:param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`.
:param \*\*kwargs: Optional arguments that ``request`` takes.

def pip._vendor.requests.sessions.Session.prepare_request	(	self,
		request
	)

Constructs a :class:`PreparedRequest <PreparedRequest>` for
transmission and returns it. The :class:`PreparedRequest` has settings
merged from the :class:`Request <Request>` instance and those of the
:class:`Session`.

:param request: :class:`Request` instance to prepare with this
    session's settings.

def pip._vendor.requests.sessions.Session.put	(	self,
		url,
		data = `None`,
		kwargs
	)

Sends a PUT request. Returns :class:`Response` object.

:param url: URL for the new :class:`Request` object.
:param data: (optional) Dictionary, bytes, or file-like object to send in the body of the :class:`Request`.
:param \*\*kwargs: Optional arguments that ``request`` takes.

def pip._vendor.requests.sessions.Session.request	(	self,
		method,
		url,
		params = `None`,
		data = `None`,
		headers = `None`,
		cookies = `None`,
		files = `None`,
		auth = `None`,
		timeout = `None`,
		allow_redirects = `True`,
		proxies = `None`,
		hooks = `None`,
		stream = `None`,
		verify = `None`,
		cert = `None`
	)

Constructs a :class:`Request <Request>`, prepares it and sends it.
Returns :class:`Response <Response>` object.

:param method: method for the new :class:`Request` object.
:param url: URL for the new :class:`Request` object.
:param params: (optional) Dictionary or bytes to be sent in the query
    string for the :class:`Request`.
:param data: (optional) Dictionary or bytes to send in the body of the
    :class:`Request`.
:param headers: (optional) Dictionary of HTTP Headers to send with the
    :class:`Request`.
:param cookies: (optional) Dict or CookieJar object to send with the
    :class:`Request`.
:param files: (optional) Dictionary of 'filename': file-like-objects
    for multipart encoding upload.
:param auth: (optional) Auth tuple or callable to enable
    Basic/Digest/Custom HTTP Auth.
:param timeout: (optional) Float describing the timeout of the
    request in seconds.
:param allow_redirects: (optional) Boolean. Set to True by default.
:param proxies: (optional) Dictionary mapping protocol to the URL of
    the proxy.
:param stream: (optional) whether to immediately download the response
    content. Defaults to ``False``.
:param verify: (optional) if ``True``, the SSL cert will be verified.
    A CA_BUNDLE path can also be provided.
:param cert: (optional) if String, path to ssl client cert file (.pem).
    If Tuple, ('cert', 'key') pair.

def pip._vendor.requests.sessions.Session.send	(	self,
		request,
		kwargs
	)

Send a given PreparedRequest.

Member Data Documentation

list pip._vendor.requests.sessions.Session.__attrs__

staticprivate

Initial value:

 = [
         'headers', 'cookies', 'auth', 'timeout', 'proxies', 'hooks',
         'params', 'verify', 'cert', 'prefetch', 'adapters', 'stream',
         'trust_env', 'max_redirects']

pip._vendor.requests.sessions.Session.adapters

pip._vendor.requests.sessions.Session.auth

pip._vendor.requests.sessions.Session.cert

pip._vendor.requests.sessions.Session.cookies

pip._vendor.requests.sessions.Session.headers

pip._vendor.requests.sessions.Session.hooks

pip._vendor.requests.sessions.Session.max_redirects

pip._vendor.requests.sessions.Session.params

pip._vendor.requests.sessions.Session.proxies

pip._vendor.requests.sessions.Session.stream

pip._vendor.requests.sessions.Session.trust_env

pip._vendor.requests.sessions.Session.verify

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

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

Public Member Functions

Public Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation