mirror of
https://github.com/kennethreitz/requests3.git
synced 2026-06-05 23:10:16 +00:00
Richard Boulton
f31ade335d
the request body or the query string, as appropriate. "GET parameters", "POST data", etc aren't the ideal terminology to use - they come from common usage with web browsers, rather than the HTTP specification, so are off-putting in other contexts.
132 lines
6.3 KiB
Python
132 lines
6.3 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 requests
|
|
import config
|
|
from .models import Request, Response, AuthManager, AuthObject, auth_manager
|
|
|
|
|
|
__all__ = ('request', 'get', 'head', 'post', 'put', 'delete')
|
|
|
|
def request(method, url, params=None, data=None, headers=None, cookies=None, files=None, auth=None,
|
|
timeout=None, allow_redirects=False):
|
|
"""Constructs and sends a :class:`Request <models.Request>`. Returns :class:`Response <models.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) 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.
|
|
"""
|
|
|
|
if params and data:
|
|
raise StandardError('You may provide either params or data to a request, but not both.')
|
|
|
|
r = Request(
|
|
method = method,
|
|
url = url,
|
|
data = params or data,
|
|
headers = headers,
|
|
cookiejar = cookies,
|
|
files = files,
|
|
auth = auth or auth_manager.get_auth(url),
|
|
timeout = timeout or config.settings.timeout,
|
|
allow_redirects = allow_redirects
|
|
)
|
|
|
|
r.send()
|
|
|
|
return r.response
|
|
|
|
def get(url, params=None, headers=None, cookies=None, auth=None, timeout=None):
|
|
"""Sends a GET request. Returns :class:`Response` object.
|
|
|
|
:param url: URL for the new :class:`Request` object.
|
|
:param params: (optional) Dictionary of parameters, or bytes, to be sent in the query string for the :class:`Request`.
|
|
:param headers: (optional) Dictionary of HTTP Headers to send with the :class:`Request`.
|
|
:param cookies: (optional) CookieJar object to send with the :class:`Request`.
|
|
:param auth: (optional) AuthObject to enable Basic HTTP Auth.
|
|
:param timeout: (optional) Float describing the timeout of the request.
|
|
"""
|
|
|
|
return request('GET', url, params=params, headers=headers, cookies=cookies, auth=auth, timeout=timeout)
|
|
|
|
|
|
def head(url, params=None, headers=None, cookies=None, auth=None, timeout=None):
|
|
"""Sends a HEAD request. Returns :class:`Response` object.
|
|
|
|
:param url: URL for the new :class:`Request` object.
|
|
:param params: (optional) Dictionary of parameters, or bytes, to be sent in the query string for the :class:`Request`.
|
|
:param headers: (optional) Dictionary of HTTP Headers to sent with the :class:`Request`.
|
|
:param cookies: (optional) CookieJar object to send with the :class:`Request`.
|
|
:param auth: (optional) AuthObject to enable Basic HTTP Auth.
|
|
:param timeout: (optional) Float describing the timeout of the request.
|
|
"""
|
|
|
|
return request('HEAD', url, params=params, headers=headers, cookies=cookies, auth=auth, timeout=timeout)
|
|
|
|
|
|
def post(url, data='', headers=None, files=None, cookies=None, auth=None, timeout=None, allow_redirects=False):
|
|
"""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 headers: (optional) Dictionary of HTTP Headers to sent with the :class:`Request`.
|
|
:param files: (optional) Dictionary of 'filename': file-like-objects for multipart encoding upload.
|
|
:param cookies: (optional) CookieJar object to send with the :class:`Request`.
|
|
: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 redirect following is allowed.
|
|
"""
|
|
|
|
return request('POST', url, data=data, headers=headers, files=files, cookies=cookies, auth=auth,
|
|
timeout=timeout, allow_redirects=allow_redirects)
|
|
|
|
|
|
def put(url, data='', headers=None, files=None, cookies=None, auth=None, timeout=None, allow_redirects=False):
|
|
"""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 headers: (optional) Dictionary of HTTP Headers to sent with the :class:`Request`.
|
|
:param files: (optional) Dictionary of 'filename': file-like-objects for multipart encoding upload.
|
|
:param cookies: (optional) CookieJar object to send with the :class:`Request`.
|
|
: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 redirect following is allowed.
|
|
"""
|
|
|
|
return request('PUT', url, data=data, headers=headers, files=files, cookies=cookies, auth=auth,
|
|
timeout=timeout, allow_redirects=allow_redirects)
|
|
|
|
|
|
def delete(url, params=None, headers=None, cookies=None, auth=None, timeout=None, allow_redirects=False):
|
|
"""Sends a DELETE request. Returns :class:`Response` object.
|
|
|
|
:param url: URL for the new :class:`Request` object.
|
|
:param params: (optional) Dictionary of parameters, or bytes, to be sent in the query string for the :class:`Request`.
|
|
:param headers: (optional) Dictionary of HTTP Headers to sent with the :class:`Request`.
|
|
:param cookies: (optional) CookieJar object to send with the :class:`Request`.
|
|
: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 redirect following is allowed.
|
|
"""
|
|
|
|
return request('DELETE', url, params=params, headers=headers, cookies=cookies, auth=auth,
|
|
timeout=timeout, allow_redirects=allow_redirects)
|