mirror of
https://github.com/kennethreitz/requests.git
synced 2026-06-05 22:50:18 +00:00
Luca De Vitis
d12eac8669
* Added hooks.setup_hooks to setup multiple and default hooks * Added hooks.response hooks to unicode encoding, and uncompress response. * Modified hooks.dispatch_hooks api: don't need a key any more.
147 lines
4.5 KiB
Python
147 lines
4.5 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
"""
|
|
requests.api
|
|
~~~~~~~~~~~~
|
|
|
|
This module impliments the Requests API.
|
|
|
|
:copyright: (c) 2011 by Kenneth Reitz.
|
|
:license: ISC, see LICENSE for more details.
|
|
|
|
"""
|
|
|
|
import config
|
|
from .models import Request, Response, AuthObject
|
|
from .status_codes import codes
|
|
from hooks import setup_hooks, dispatch_hooks
|
|
from .utils import cookiejar_from_dict
|
|
|
|
from urlparse import urlparse
|
|
|
|
__all__ = ('request', 'get', 'head', 'post', 'patch', 'put', 'delete')
|
|
|
|
def request(method, url,
|
|
params=None, data=None, headers=None, cookies=None, files=None, auth=None,
|
|
timeout=None, allow_redirects=False, proxies=None, hooks=None):
|
|
|
|
"""Constructs and sends a :class:`Request <Request>`.
|
|
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) AuthObject to enable Basic HTTP Auth.
|
|
:param timeout: (optional) Float describing the timeout of the request.
|
|
:param allow_redirects: (optional) Boolean. Set to True if POST/PUT/DELETE redirect following is allowed.
|
|
:param proxies: (optional) Dictionary mapping protocol to the URL of the proxy.
|
|
"""
|
|
|
|
method = str(method).upper()
|
|
|
|
cookies = cookiejar_from_dict(cookies or dict())
|
|
|
|
hooks = setup_hooks(hooks or dict())
|
|
|
|
args = dict(
|
|
method = method,
|
|
url = url,
|
|
data = data,
|
|
params = params,
|
|
headers = headers,
|
|
cookiejar = cookies,
|
|
files = files,
|
|
auth = auth,
|
|
timeout = timeout or config.settings.timeout,
|
|
allow_redirects = allow_redirects,
|
|
proxies = proxies or config.settings.proxies,
|
|
)
|
|
|
|
|
|
# Arguments manipulation hook.
|
|
args = dispatch_hooks(hooks.get('args', []), args)
|
|
|
|
r = Request(**args)
|
|
|
|
# Pre-request hook.
|
|
r = dispatch_hooks(hooks.get('pre_request', []), r)
|
|
|
|
# Send the HTTP Request.
|
|
r.send()
|
|
|
|
# Post-request hook.
|
|
r = dispatch_hooks(hooks.get('post_request', []), hooks, r)
|
|
|
|
# Response manipulation hook.
|
|
r.response = dispatch_hooks(hooks.get('response', []), r.response)
|
|
|
|
return r.response
|
|
|
|
|
|
def get(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.
|
|
"""
|
|
|
|
return request('get', url, **kwargs)
|
|
|
|
|
|
def head(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.
|
|
"""
|
|
|
|
return request('head', url, **kwargs)
|
|
|
|
|
|
def post(url, data='', **kwargs):
|
|
"""Sends a POST request. Returns :class:`Response` object.
|
|
|
|
:param url: URL for the new :class:`Request` object.
|
|
:param data: (optional) Dictionary or bytes to send in the body of the :class:`Request`.
|
|
:param **kwargs: Optional arguments that ``request`` takes.
|
|
"""
|
|
|
|
return request('post', url, data=data, **kwargs)
|
|
|
|
|
|
def put(url, data='', **kwargs):
|
|
"""Sends a PUT request. Returns :class:`Response` object.
|
|
|
|
:param url: URL for the new :class:`Request` object.
|
|
:param data: (optional) Dictionary or bytes to send in the body of the :class:`Request`.
|
|
:param **kwargs: Optional arguments that ``request`` takes.
|
|
"""
|
|
|
|
return request('put', url, data=data, **kwargs)
|
|
|
|
|
|
def patch(url, data='', **kwargs):
|
|
"""Sends a PATCH request. Returns :class:`Response` object.
|
|
|
|
:param url: URL for the new :class:`Request` object.
|
|
:param data: (optional) Dictionary or bytes to send in the body of the :class:`Request`.
|
|
:param **kwargs: Optional arguments that ``request`` takes.
|
|
"""
|
|
|
|
return request('patch', url, **kwargs)
|
|
|
|
|
|
def delete(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.
|
|
"""
|
|
|
|
return request('delete', url, **kwargs)
|