requests-0.2.0.tar.gz

# -*- coding: utf-8 -*- """ requests.core ~~~~~~~~~~~~~ This module implements the main Requests system. :copyright: (c) 2011 by Kenneth Reitz. :license: ISC, see LICENSE for more details. """ import urllib import urllib2 __title__ = 'requests' __version__ = '0.2.0' __build__ = 0x000200 __author__ = 'Kenneth Reitz' __license__ = 'ISC' __copyright__ = 'Copyright 2011 Kenneth Reitz' AUTOAUTHS = [] class _Request(urllib2.Request): """Hidden wrapper around the urllib2.Request object. Allows for manual setting of HTTP methods. """ def __init__(self, url, data=None, headers={}, origin_req_host=None, unverifiable=False, method=None): urllib2.Request.__init__( self, url, data, headers, origin_req_host, unverifiable) self.method = method def get_method(self): if self.method: return self.method return urllib2.Request.get_method(self) class Request(object): """The :class:`Request` object. It carries out all functionality of Requests. Recommended interface is with the Requests functions. """ _METHODS = ('GET', 'HEAD', 'PUT', 'POST', 'DELETE') def __init__(self): self.url = None self.headers = dict() self.method = None self.params = {} self.data = {} self.response = Response() self.auth = None self.sent = False def __repr__(self): try: repr = '<Request [%s]>' % (self.method) except: repr = '<Request object>' return repr def __setattr__(self, name, value): if (name == 'method') and (value): if not value in self._METHODS: raise InvalidMethod() object.__setattr__(self, name, value) def _checks(self): """Deterministic checks for consistiency.""" if not self.url: raise URLRequired def _get_opener(self): """Creates appropriate opener object for urllib2.""" if self.auth: # create a password manager authr = urllib2.HTTPPasswordMgrWithDefaultRealm() authr.add_password(None, self.url, self.auth.username, self.auth.password) handler = urllib2.HTTPBasicAuthHandler(authr) opener = urllib2.build_opener(handler) # use the opener to fetch a URL return opener.open else: return urllib2.urlopen def send(self, anyway=False): """Sends the request. Returns True of successfull, false if not. If there was an HTTPError during transmission, self.response.status_code will contain the HTTPError code. Once a request is successfully sent, `sent` will equal True. :param anyway: If True, request will be sent, even if it has already been sent. """ self._checks() success = False if self.method in ('GET', 'HEAD', 'DELETE'): if (not self.sent) or anyway: # url encode GET params if it's a dict if isinstance(self.params, dict): params = urllib.urlencode(self.params) else: params = self.params req = _Request(("%s?%s" % (self.url, params)), method=self.method) if self.headers: req.headers = self.headers opener = self._get_opener() try: resp = opener(req) self.response.status_code = resp.code self.response.headers = resp.info().dict if self.method.lower() == 'get': self.response.content = resp.read() success = True except urllib2.HTTPError, why: self.response.status_code = why.code elif self.method == 'PUT': if (not self.sent) or anyway: req = _Request(self.url, method='PUT') if self.headers: req.headers = self.headers req.data = self.data try: opener = self._get_opener() resp = opener(req) self.response.status_code = resp.code self.response.headers = resp.info().dict self.response.content = resp.read() success = True except urllib2.HTTPError, why: self.response.status_code = why.code elif self.method == 'POST': if (not self.sent) or anyway: req = _Request(self.url, method='POST') if self.headers: req.headers = self.headers # url encode form data if it's a dict if isinstance(self.data, dict): req.data = urllib.urlencode(self.data) else: req.data = self.data try: opener = self._get_opener() resp = opener(req) self.response.status_code = resp.code self.response.headers = resp.info().dict self.response.content = resp.read() success = True except urllib2.HTTPError, why: self.response.status_code = why.code self.sent = True if success else False return success class Response(object): """The :class:`Request` object. All :class:`Request` objects contain a :class:`Request.response <response>` attribute, which is an instance of this class. """ def __init__(self): self.content = None self.status_code = None self.headers = dict() def __repr__(self): try: repr = '<Response [%s]>' % (self.status_code) except: repr = '<Response object>' return repr class AuthObject(object): """The :class:`AuthObject` is a simple HTTP Authentication token. When given to a Requests function, it enables Basic HTTP Authentication for that Request. You can also enable Authorization for domain realms with AutoAuth. See AutoAuth for more details. :param username: Username to authenticate with. :param password: Password for given username. """ def __init__(self, username, password): self.username = username self.password = password def get(url, params={}, headers={}, auth=None): """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 sent with the :class:`Request`. :param auth: (optional) AuthObject to enable Basic HTTP Auth. """ r = Request() r.method = 'GET' r.url = url r.params = params r.headers = headers r.auth = _detect_auth(url, auth) r.send() return r.response def head(url, params={}, headers={}, auth=None): """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 auth: (optional) AuthObject to enable Basic HTTP Auth. """ r = Request() r.method = 'HEAD' r.url = url # return response object r.params = params r.headers = headers r.auth = _detect_auth(url, auth) r.send() return r.response def post(url, data={}, headers={}, auth=None): """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 auth: (optional) AuthObject to enable Basic HTTP Auth. """ r = Request() r.url = url r.method = 'POST' r.data = data r.headers = headers r.auth = _detect_auth(url, auth) r.send() return r.response def put(url, data='', headers={}, auth=None): """Sends a PUT request. Returns :class:`Response` object. :param url: URL for the new :class:`Request` object. :param data: (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 auth: (optional) AuthObject to enable Basic HTTP Auth. """ r = Request() r.url = url r.method = 'PUT' r.data = data r.headers = headers r.auth = _detect_auth(url, auth) r.send() return r.response def delete(url, params={}, headers={}, auth=None): """Sends a DELETE request. Returns :class:`Response` object. :param url: URL for the new :class:`Request` object. :param params: (optional) Dictionary of GET Pa