mirror of
https://github.com/kennethreitz/requests3.git
synced 2026-06-05 23:10:16 +00:00
Kenneth Reitz
8d9bcefa9d
--- Ive completed the migration of the requests settings to the new `settings` module, but my attempt to facilitate for manipulating settings outside of the context manager (eg. `requests.settings.timeout = 5`) has been thwarted by the namespace collision of the context manager and the module. Im probably just being stupid. Youll figure it out. Conflicts: requests/api.py
119 lines
5.5 KiB
Python
119 lines
5.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 requests
|
|
import settings
|
|
from .models import Request, Response, AuthManager, AuthObject, auth_manager
|
|
|
|
|
|
__all__ = ('request', 'get', 'head', 'post', 'put', 'delete')
|
|
|
|
|
|
|
|
def request(method, url, **kwargs):
|
|
"""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 of GET/HEAD/DELETE Parameters to send with the :class:`Request`.
|
|
:param data: (optional) Bytes/Dictionary of PUT/POST Data to send with 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.
|
|
"""
|
|
data = kwargs.pop('data', dict()) or kwargs.pop('params', dict())
|
|
|
|
r = Request(method=method, url=url, data=data, headers=kwargs.pop('headers', {}),
|
|
cookiejar=kwargs.pop('cookies', None), files=kwargs.pop('files', None),
|
|
auth=kwargs.pop('auth', auth_manager.get_auth(url)),
|
|
timeout=kwargs.pop('timeout', settings.timeout))
|
|
|
|
r.send()
|
|
|
|
return r.response
|
|
|
|
|
|
def get(url, params={}, headers={}, cookies=None, auth=None, **kwargs):
|
|
"""Sends a GET request. Returns :class:`Response` object.
|
|
|
|
:param url: URL for the new :class:`Request` object.
|
|
:param params: (optional) Dictionary of GET Parameters to send with 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, **kwargs)
|
|
|
|
|
|
def head(url, params={}, headers={}, cookies=None, auth=None, **kwargs):
|
|
"""Sends a HEAD request. Returns :class:`Response` object.
|
|
|
|
:param url: URL for the new :class:`Request` object.
|
|
:param params: (optional) Dictionary of GET Parameters to send with 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, **kwargs)
|
|
|
|
|
|
def post(url, data={}, headers={}, files=None, cookies=None, auth=None, **kwargs):
|
|
"""Sends a POST request. Returns :class:`Response` object.
|
|
|
|
:param url: URL for the new :class:`Request` object.
|
|
:param data: (optional) Dictionary of POST data to send with 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.
|
|
"""
|
|
|
|
return request('POST', url, data=data, headers=headers, files=files, cookies=cookies, auth=auth, **kwargs)
|
|
|
|
|
|
def put(url, data='', headers={}, files={}, cookies=None, auth=None, **kwargs):
|
|
"""Sends a PUT request. Returns :class:`Response` object.
|
|
|
|
:param url: URL for the new :class:`Request` object.
|
|
:param params: (optional) Bytes of PUT Data to send with 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.
|
|
"""
|
|
|
|
return request('PUT', url, data=data, headers=headers, files=files, cookies=cookies, auth=auth, **kwargs)
|
|
|
|
|
|
def delete(url, params={}, headers={}, cookies=None, auth=None, **kwargs):
|
|
"""Sends a DELETE request. Returns :class:`Response` object.
|
|
|
|
:param url: URL for the new :class:`Request` object.
|
|
:param params: (optional) Dictionary of DELETE Parameters to send with 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('DELETE', url, params=params, headers=headers, cookies=cookies, auth=auth, **kwargs)
|