Merge branch 'release/0.2.2'

Building of internal request object refactor

AUTHORS

@@ -0,0 +1,13 @@
+Requests is written and maintained by Kenneth Reitz and
+various contributors:
+
+Development Lead
+````````````````
+
+- Kenneth Reitz <me@kennethreitz.com>
+
+
+Patches and Suggestions
+```````````````````````
+
+- Various Pocoo Members

HISTORY.rst

@@ -1,6 +1,21 @@
 History
 -------
 
+0.2.2 (2011-02-14)
+++++++++++++++++++
+
+* Still handles request in the event of an HTTPError. (Issue #2)
+* Eventlet and Gevent Monkeypatch support.
+* Cookie Support (Issue #1)
+
+
+0.2.1 (2011-02-14)
+++++++++++++++++++
+
+* Added file attribute to POST and PUT requests for multipart-encode file uploads.
+* Added Request.url attribute for context and redirects
+
+
 0.2.0 (2011-02-14)
 ++++++++++++++++++
 

MANIFEST.in

@@ -0,0 +1 @@
+include README.rst LICENSE HISTORY.rst 

NOTICE

@@ -0,0 +1,12 @@
+Request includes some vendorized python libraries to ease installation.
+
+Poster License
+==============
+
+Copyright (c) 2010 Chris AtLee
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.rst

@@ -13,6 +13,9 @@ Features
 - Extremely simple GET, HEAD, POST, PUT, DELETE Requests
     + Simple HTTP Header Request Attachment
     + Simple Data/Params Request Attachment
+    + Simple Multipart File Uploads
+    + CookieJar Support
+    
 - Simple Basic HTTP Authentication
     + Simple URL + HTTP Auth Registry
 
@@ -55,25 +58,28 @@ API
 **Requests:**
 
 All request functions return a Response object (see below).
+
+If a {filename: fileobject} dictionary is passed in (files=...), a multipart_encode upload will be performed.
+If CookieJar object is is passed in (cookies=...), the cookies will be sent with the request.
     
   GET Requests
-    >>> request.get(url, params={}, headers={} auth=None)
+    >>> request.get(url, params={}, headers={}, cookies=None, auth=None)
     <request object>
     
   HEAD Requests
-    >>> request.head(url, params={}, headers={} auth=None)
+    >>> request.head(url, params={}, headers={}, cookies=None, auth=None)
     <request object>
     
   PUT Requests
-    >>> request.put(url, data='', headers={}, auth=None)
+    >>> request.put(url, data='', headers={}, files={}, cookies=None, auth=None)
     <request object>
     
   POST Requests
-    >>> request.post(url, data={}, headers={}, auth=None)
+    >>> request.post(url, data={}, headers={}, files={}, cookies=None, auth=None)
     <request object>
     
   DELETE Requests
-    >>> request.delete(url, params={}, headers={}, auth=None)
+    >>> request.delete(url, params={}, headers={}, cookies=None, auth=None)
     <request object>
     
 
@@ -88,6 +94,9 @@ All request functions return a Response object (see below).
     Request.content:
         (Bytes) Received Content
 
+    Request.url
+        (String) URL of response. Useful for detecting redirects. 
+
 
 **HTTP Authentication Registry:**
 

requests/__init__.py

@@ -1,3 +1,4 @@
 # -*- coding: utf-8 -*-
 
-from .core import *
+from . import packages
+from .core import *

requests/core.py

@@ -14,9 +14,27 @@ import urllib
 import urllib2
 
 
+try:
+	import eventlet
+	eventlet.monkey_patch()
+except ImportError:
+	pass
+
+if not 'eventlet' in locals():
+	try:
+		from gevent import monkey
+		monkey.patch_all()
+	except ImportError:
+		pass
+
+
+from .packages.poster.encode import multipart_encode
+from .packages.poster.streaminghttp import register_openers
+
+
 __title__ = 'requests'
-__version__ = '0.2.0'
-__build__ = 0x000200
+__version__ = '0.2.2'
+__build__ = 0x000202
 __author__ = 'Kenneth Reitz'
 __license__ = 'ISC'
 __copyright__ = 'Copyright 2011 Kenneth Reitz'
@@ -27,15 +45,12 @@ AUTOAUTHS = []
 
 class _Request(urllib2.Request):
 	"""Hidden wrapper around the urllib2.Request object. Allows for manual
-	setting of HTTP methods.
-	"""
+    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 __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:
@@ -46,28 +61,28 @@ class _Request(urllib2.Request):
 
 class Request(object):
 	"""The :class:`Request` object. It carries out all functionality of
-	Requests. Recommended interface is with the Requests functions.
-	
-	"""
+    Requests. Recommended interface is with the Requests functions.
+    """
 	
 	_METHODS = ('GET', 'HEAD', 'PUT', 'POST', 'DELETE')
 	
 	def __init__(self):
 		self.url = None
 		self.headers = dict()
+		self.files = None
 		self.method = None
 		self.params = {}
 		self.data = {}
 		self.response = Response()
+		
 		self.auth = None
+		self.cookiejar = None
 		self.sent = False
 		
+		
 	def __repr__(self):
-		try:
-			repr = '<Request [%s]>' % (self.method)
-		except:
-			repr = '<Request object>'
-		return repr
+		return '<Request [%s]>' % (self.method)
+	
 	
 	def __setattr__(self, name, value):
 		if (name == 'method') and (value):
@@ -78,45 +93,65 @@ class Request(object):
 	
 	
 	def _checks(self):
-		"""Deterministic checks for consistiency."""
+		"""Deterministic checks for consistency."""
 
 		if not self.url:
 			raise URLRequired
 
 		
 	def _get_opener(self):
-		""" Creates appropriate opener object for urllib2.
-		"""
-		
-		if self.auth:
+		"""Creates appropriate opener object for urllib2."""
 
-			# create a password manager
-			authr = urllib2.HTTPPasswordMgrWithDefaultRealm()
+		_handlers = []
 
-			authr.add_password(None, self.url, self.auth.username, self.auth.password)
-			handler = urllib2.HTTPBasicAuthHandler(authr)
-			opener = urllib2.build_opener(handler)
+		if self.auth or self.cookiejar:
 
-			# use the opener to fetch a URL
+			if self.auth:
+
+				authr = urllib2.HTTPPasswordMgrWithDefaultRealm()
+
+				authr.add_password(None, self.url, self.auth.username, self.auth.password)
+				auth_handler = urllib2.HTTPBasicAuthHandler(authr)
+
+				_handlers.append(auth_handler)
+
+			if self.cookiejar:
+
+				cookie_handler = urllib2.HTTPCookieProcessor(cookiejar)
+				_handlers.append(cookie_handler)
+
+			opener = urllib2.build_opener(*_handlers)
 			return opener.open
+
 		else:
 			return urllib2.urlopen
 
+
+	def _build_response(self, resp):
+		"""Build internal Response object from given response."""
+		
+		self.response.status_code = resp.code
+		self.response.headers = resp.info().dict
+		self.response.content = resp.read()
+		self.response.url = resp.url
+
 	
 	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.
+		"""Sends the request. Returns True of successful, 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.
+        """
 
-		    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:
 
@@ -136,69 +171,78 @@ class Request(object):
 
 				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()
-
+					self._build_response(resp)
 					success = True
-				except urllib2.HTTPError, why:
-					self.response.status_code = why.code
+
+				except urllib2.HTTPError as why:
+					self._build_response(why)
+					success = False
 
 
 		elif self.method == 'PUT':
 			if (not self.sent) or anyway:
 
-				req = _Request(self.url, method='PUT')
+				if self.files:
+					register_openers()
+					datagen, headers = multipart_encode(self.files)
+					req = _Request(self.url, data=datagen, headers=headers, method='PUT')
 
-				if self.headers:
-					req.headers = self.headers
+					if self.headers:
+						req.headers.update(self.headers)
 
-				req.data = self.data
+				else:
+
+					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()
-
+					self._build_response(resp)
 					success = True
 
-				except urllib2.HTTPError, why:
-					self.response.status_code = why.code
-
-
+				except urllib2.HTTPError as why:
+					self._build_response(why)
+					success = False
 
 
 		elif self.method == 'POST':
 			if (not self.sent) or anyway:
 
-				req = _Request(self.url, method='POST')
+				if self.files:
+					register_openers()
+					datagen, headers = multipart_encode(self.files)
+					req = _Request(self.url, data=datagen, headers=headers, method='POST')
 
-				if self.headers:
+					if self.headers:
+						req.headers.update(self.headers)
+				
+				else:
+					req = _Request(self.url, method='POST')
 					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
+					# 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()
-
+					self._build_response(resp)
 					success = True
 
-				except urllib2.HTTPError, why:
-					self.response.status_code = why.code
+				except urllib2.HTTPError as why:
+					self._build_response(why)
+					success = False
 
 		
 		self.sent = True if success else False
@@ -208,32 +252,30 @@ class Request(object):
 
 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.
-	"""
+    :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()
+		self.url = None
 		
 	def __repr__(self):
-		try:
-			repr = '<Response [%s]>' % (self.status_code)
-		except:
-			repr = '<Response object>'
-		return repr
+		return '<Response [%s]>' % (self.status_code)
+
 
 	
 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.s
-	
-	:param username: Username to authenticate with.
+    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
@@ -241,14 +283,15 @@ class AuthObject(object):
 
 
 
-def get(url, params={}, headers={}, auth=None):
+def get(url, params={}, headers={}, cookies=None, 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.
-	"""
+    :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.
+    """
 	
 	r = Request()
 	
@@ -256,6 +299,7 @@ def get(url, params={}, headers={}, auth=None):
 	r.url = url
 	r.params = params
 	r.headers = headers
+	r.cookiejar = cookies
 	r.auth = _detect_auth(url, auth)
 	
 	r.send()
@@ -263,14 +307,15 @@ def get(url, params={}, headers={}, auth=None):
 	return r.response
 
 
-def head(url, params={}, headers={}, auth=None):
+def head(url, params={}, headers={}, cookies=None, 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.
-	"""
+    :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.
+    """
 	
 	r = Request()
 	
@@ -279,6 +324,7 @@ def head(url, params={}, headers={}, auth=None):
 	# return response object
 	r.params = params
 	r.headers = headers
+	r.cookiejar = cookies
 	r.auth = _detect_auth(url, auth)
 	
 	r.send()
@@ -286,22 +332,28 @@ def head(url, params={}, headers={}, auth=None):
 	return r.response
 
 
-def post(url, data={}, headers={}, auth=None):
+def post(url, data={}, headers={}, files=None, cookies=None, 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.
-	"""
+    :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.
+    """
 	
 	r = Request()
-
+	
 	r.url = url
 	r.method = 'POST'
 	r.data = data
 	
+	if files:
+		r.files = files
+	
 	r.headers = headers
+	r.cookiejar = cookies
 	r.auth = _detect_auth(url, auth)
 	
 	r.send()
@@ -309,22 +361,25 @@ def post(url, data={}, headers={}, auth=None):
 	return r.response
 	
 	
-def put(url, data='', headers={}, auth=None):
+def put(url, data='', headers={}, files={}, cookies=None, 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.
-	"""
+    :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 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.
+    """
 	
 	r = Request()
 
 	r.url = url
 	r.method = 'PUT'
 	r.data = data
-	
+	r.files = files
 	r.headers = headers
+	r.cookiejar = cookies
 	r.auth = _detect_auth(url, auth)
 	
 	r.send()
@@ -332,22 +387,23 @@ def put(url, data='', headers={}, auth=None):
 	return r.response
 
 	
-def delete(url, params={}, headers={}, auth=None):
+def delete(url, params={}, headers={}, cookies=None, 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 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.
-	"""
+    :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.
+    """
 	
 	r = Request()
 
 	r.url = url
 	r.method = 'DELETE'
-	# return response object
 	
 	r.headers = headers
+	r.cookiejar = cookies
 	r.auth = _detect_auth(url, auth)
 	
 	r.send()
@@ -357,19 +413,20 @@ def delete(url, params={}, headers={}, auth=None):
 
 def add_autoauth(url, authobject):
 	"""Registers given AuthObject to given URL domain. for auto-activation.
-	Once a URL is registered with an AuthObject, the configured HTTP
-	Authentication will be used for all requests with URLS containing the given
-	URL string.
+    Once a URL is registered with an AuthObject, the configured HTTP
+    Authentication will be used for all requests with URLS containing the given
+    URL string.
 
-	Example: ::
-	    >>> c_auth = requests.AuthObject('kennethreitz', 'xxxxxxx')
-	    >>> requests.add_autoauth('https://convore.com/api/', c_auth)
-	    >>> r = requests.get('https://convore.com/api/account/verify.json')
-	    # Automatically HTTP Authenticated! Wh00t!
+    Example: ::
+        >>> c_auth = requests.AuthObject('kennethreitz', 'xxxxxxx')
+        >>> requests.add_autoauth('https://convore.com/api/', c_auth)
+        >>> r = requests.get('https://convore.com/api/account/verify.json')
+        # Automatically HTTP Authenticated! Wh00t!
+
+    :param url: Base URL for given AuthObject to auto-activate for.
+    :param authobject: AuthObject to auto-activate.
+    """
 
-	:param url: Base URL for given AuthObject to auto-activate for.
-	:param authobject: AuthObject to auto-activate.
-	"""
 	global AUTOAUTHS
 	
 	AUTOAUTHS.append((url, authobject))
@@ -377,14 +434,14 @@ def add_autoauth(url, authobject):
 
 def _detect_auth(url, auth):
 	"""Returns registered AuthObject for given url if available, defaulting to
-	given AuthObject."""
+    given AuthObject.
+    """
 
 	return _get_autoauth(url) if not auth else auth
 
 	
 def _get_autoauth(url):
-	"""Returns registered AuthObject for given url if available.
-	"""
+	"""Returns registered AuthObject for given url if available."""
 	
 	for (autoauth_url, auth) in AUTOAUTHS:
 		if autoauth_url in url: 
@@ -392,6 +449,7 @@ def _get_autoauth(url):
 			
 	return None
 
+
 class RequestException(Exception):
 	"""There was an ambiguous exception that occured while handling your request."""
 

requests/packages/__init__.py

@@ -0,0 +1 @@
+from . import poster

requests/packages/poster/__init__.py

@@ -0,0 +1,32 @@
+# Copyright (c) 2010 Chris AtLee
+# 
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+# 
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+"""poster module
+
+Support for streaming HTTP uploads, and multipart/form-data encoding
+
+```poster.version``` is a 3-tuple of integers representing the version number.
+New releases of poster will always have a version number that compares greater
+than an older version of poster.
+New in version 0.6."""
+
+from . import streaminghttp
+from . import encode
+
+version = (0, 8, 0) # Thanks JP!

requests/packages/poster/encode.py

@@ -0,0 +1,414 @@
+"""multipart/form-data encoding module
+
+This module provides functions that faciliate encoding name/value pairs
+as multipart/form-data suitable for a HTTP POST or PUT request.
+
+multipart/form-data is the standard way to upload files over HTTP"""
+
+__all__ = ['gen_boundary', 'encode_and_quote', 'MultipartParam',
+        'encode_string', 'encode_file_header', 'get_body_size', 'get_headers',
+        'multipart_encode']
+
+try:
+    import uuid
+    def gen_boundary():
+        """Returns a random string to use as the boundary for a message"""
+        return uuid.uuid4().hex
+except ImportError:
+    import random, sha
+    def gen_boundary():
+        """Returns a random string to use as the boundary for a message"""
+        bits = random.getrandbits(160)
+        return sha.new(str(bits)).hexdigest()
+
+import urllib, re, os, mimetypes
+try:
+    from email.header import Header
+except ImportError:
+    # Python 2.4
+    from email.Header import Header
+
+def encode_and_quote(data):
+    """If ``data`` is unicode, return urllib.quote_plus(data.encode("utf-8"))
+    otherwise return urllib.quote_plus(data)"""
+    if data is None:
+        return None
+
+    if isinstance(data, unicode):
+        data = data.encode("utf-8")
+    return urllib.quote_plus(data)
+
+def _strify(s):
+    """If s is a unicode string, encode it to UTF-8 and return the results,
+    otherwise return str(s), or None if s is None"""
+    if s is None:
+        return None
+    if isinstance(s, unicode):
+        return s.encode("utf-8")
+    return str(s)
+
+class MultipartParam(object):
+    """Represents a single parameter in a multipart/form-data request
+
+    ``name`` is the name of this parameter.
+
+    If ``value`` is set, it must be a string or unicode object to use as the
+    data for this parameter.
+
+    If ``filename`` is set, it is what to say that this parameter's filename
+    is.  Note that this does not have to be the actual filename any local file.
+
+    If ``filetype`` is set, it is used as the Content-Type for this parameter.
+    If unset it defaults to "text/plain; charset=utf8"
+
+    If ``filesize`` is set, it specifies the length of the file ``fileobj``
+
+    If ``fileobj`` is set, it must be a file-like object that supports
+    .read().
+
+    Both ``value`` and ``fileobj`` must not be set, doing so will
+    raise a ValueError assertion.
+
+    If ``fileobj`` is set, and ``filesize`` is not specified, then
+    the file's size will be determined first by stat'ing ``fileobj``'s
+    file descriptor, and if that fails, by seeking to the end of the file,
+    recording the current position as the size, and then by seeking back to the
+    beginning of the file.
+
+    ``cb`` is a callable which will be called from iter_encode with (self,
+    current, total), representing the current parameter, current amount
+    transferred, and the total size.
+    """
+    def __init__(self, name, value=None, filename=None, filetype=None,
+                        filesize=None, fileobj=None, cb=None):
+        self.name = Header(name).encode()
+        self.value = _strify(value)
+        if filename is None:
+            self.filename = None
+        else:
+            if isinstance(filename, unicode):
+                # Encode with XML entities
+                self.filename = filename.encode("ascii", "xmlcharrefreplace")
+            else:
+                self.filename = str(filename)
+            self.filename = self.filename.encode("string_escape").\
+                    replace('"', '\\"')
+        self.filetype = _strify(filetype)
+
+        self.filesize = filesize
+        self.fileobj = fileobj
+        self.cb = cb
+
+        if self.value is not None and self.fileobj is not None:
+            raise ValueError("Only one of value or fileobj may be specified")
+
+        if fileobj is not None and filesize is None:
+            # Try and determine the file size
+            try:
+                self.filesize = os.fstat(fileobj.fileno()).st_size
+            except (OSError, AttributeError):
+                try:
+                    fileobj.seek(0, 2)
+                    self.filesize = fileobj.tell()
+                    fileobj.seek(0)
+                except:
+                    raise ValueError("Could not determine filesize")
+
+    def __cmp__(self, other):
+        attrs = ['name', 'value', 'filename', 'filetype', 'filesize', 'fileobj']
+        myattrs = [getattr(self, a) for a in attrs]
+        oattrs = [getattr(other, a) for a in attrs]
+        return cmp(myattrs, oattrs)
+
+    def reset(self):
+        if self.fileobj is not None:
+            self.fileobj.seek(0)
+        elif self.value is None:
+            raise ValueError("Don't know how to reset this parameter")
+
+    @classmethod
+    def from_file(cls, paramname, filename):
+        """Returns a new MultipartParam object constructed from the local
+        file at ``filename``.
+
+        ``filesize`` is determined by os.path.getsize(``filename``)
+
+        ``filetype`` is determined by mimetypes.guess_type(``filename``)[0]
+
+        ``filename`` is set to os.path.basename(``filename``)
+        """
+
+        return cls(paramname, filename=os.path.basename(filename),
+                filetype=mimetypes.guess_type(filename)[0],
+                filesize=os.path.getsize(filename),
+                fileobj=open(filename, "rb"))
+
+    @classmethod
+    def from_params(cls, params):
+        """Returns a list of MultipartParam objects from a sequence of
+        name, value pairs, MultipartParam instances,
+        or from a mapping of names to values
+
+        The values may be strings or file objects, or MultipartParam objects.
+        MultipartParam object names must match the given names in the
+        name,value pairs or mapping, if applicable."""
+        if hasattr(params, 'items'):
+            params = params.items()
+
+        retval = []
+        for item in params:
+            if isinstance(item, cls):
+                retval.append(item)
+                continue
+            name, value = item
+            if isinstance(value, cls):
+                assert value.name == name
+                retval.append(value)
+                continue
+            if hasattr(value, 'read'):
+                # Looks like a file object
+                filename = getattr(value, 'name', None)
+                if filename is not None:
+                    filetype = mimetypes.guess_type(filename)[0]
+                else:
+                    filetype = None
+
+                retval.append(cls(name=name, filename=filename,
+                    filetype=filetype, fileobj=value))
+            else:
+                retval.append(cls(name, value))
+        return retval
+
+    def encode_hdr(self, boundary):
+        """Returns the header of the encoding of this parameter"""
+        boundary = encode_and_quote(boundary)
+
+        headers = ["--%s" % boundary]
+
+        if self.filename:
+            disposition = 'form-data; name="%s"; filename="%s"' % (self.name,
+                    self.filename)
+        else:
+            disposition = 'form-data; name="%s"' % self.name
+
+        headers.append("Content-Disposition: %s" % disposition)
+
+        if self.filetype:
+            filetype = self.filetype
+        else:
+            filetype = "text/plain; charset=utf-8"
+
+        headers.append("Content-Type: %s" % filetype)
+
+        headers.append("")
+        headers.append("")
+
+        return "\r\n".join(headers)
+
+    def encode(self, boundary):
+        """Returns the string encoding of this parameter"""
+        if self.value is None:
+            value = self.fileobj.read()
+        else:
+            value = self.value
+
+        if re.search("^--%s$" % re.escape(boundary), value, re.M):
+            raise ValueError("boundary found in encoded string")
+
+        return "%s%s\r\n" % (self.encode_hdr(boundary), value)
+
+    def iter_encode(self, boundary, blocksize=4096):
+        """Yields the encoding of this parameter
+        If self.fileobj is set, then blocks of ``blocksize`` bytes are read and
+        yielded."""
+        total = self.get_size(boundary)
+        current = 0
+        if self.value is not None:
+            block = self.encode(boundary)
+            current += len(block)
+            yield block
+            if self.cb:
+                self.cb(self, current, total)
+        else:
+            block = self.encode_hdr(boundary)
+            current += len(block)
+            yield block
+            if self.cb:
+                self.cb(self, current, total)
+            last_block = ""
+            encoded_boundary = "--%s" % encode_and_quote(boundary)
+            boundary_exp = re.compile("^%s$" % re.escape(encoded_boundary),
+                    re.M)
+            while True:
+                block = self.fileobj.read(blocksize)
+                if not block:
+                    current += 2
+                    yield "\r\n"
+                    if self.cb:
+                        self.cb(self, current, total)
+                    break
+                last_block += block
+                if boundary_exp.search(last_block):
+                    raise ValueError("boundary found in file data")
+                last_block = last_block[-len(encoded_boundary)-2:]
+                current += len(block)
+                yield block
+                if self.cb:
+                    self.cb(self, current, total)
+
+    def get_size(self, boundary):
+        """Returns the size in bytes that this param will be when encoded
+        with the given boundary."""
+        if self.filesize is not None:
+            valuesize = self.filesize
+        else:
+            valuesize = len(self.value)
+
+        return len(self.encode_hdr(boundary)) + 2 + valuesize
+
+def encode_string(boundary, name, value):
+    """Returns ``name`` and ``value`` encoded as a multipart/form-data
+    variable.  ``boundary`` is the boundary string used throughout
+    a single request to separate variables."""
+
+    return MultipartParam(name, value).encode(boundary)
+
+def encode_file_header(boundary, paramname, filesize, filename=None,
+        filetype=None):
+    """Returns the leading data for a multipart/form-data field that contains
+    file data.
+
+    ``boundary`` is the boundary string used throughout a single request to
+    separate variables.
+
+    ``paramname`` is the name of the variable in this request.
+
+    ``filesize`` is the size of the file data.
+
+    ``filename`` if specified is the filename to give to this field.  This
+    field is only useful to the server for determining the original filename.
+
+    ``filetype`` if specified is the MIME type of this file.
+
+    The actual file data should be sent after this header has been sent.
+    """
+
+    return MultipartParam(paramname, filesize=filesize, filename=filename,
+            filetype=filetype).encode_hdr(boundary)
+
+def get_body_size(params, boundary):
+    """Returns the number of bytes that the multipart/form-data encoding
+    of ``params`` will be."""
+    size = sum(p.get_size(boundary) for p in MultipartParam.from_params(params))
+    return size + len(boundary) + 6
+
+def get_headers(params, boundary):
+    """Returns a dictionary with Content-Type and Content-Length headers
+    for the multipart/form-data encoding of ``params``."""
+    headers = {}
+    boundary = urllib.quote_plus(boundary)
+    headers['Content-Type'] = "multipart/form-data; boundary=%s" % boundary
+    headers['Content-Length'] = str(get_body_size(params, boundary))
+    return headers
+
+class multipart_yielder:
+    def __init__(self, params, boundary, cb):
+        self.params = params
+        self.boundary = boundary
+        self.cb = cb
+
+        self.i = 0
+        self.p = None
+        self.param_iter = None
+        self.current = 0
+        self.total = get_body_size(params, boundary)
+
+    def __iter__(self):
+        return self
+
+    def next(self):
+        """generator function to yield multipart/form-data representation
+        of parameters"""
+        if self.param_iter is not None:
+            try:
+                block = self.param_iter.next()
+                self.current += len(block)
+                if self.cb:
+                    self.cb(self.p, self.current, self.total)
+                return block
+            except StopIteration:
+                self.p = None
+                self.param_iter = None
+
+        if self.i is None:
+            raise StopIteration
+        elif self.i >= len(self.params):
+            self.param_iter = None
+            self.p = None
+            self.i = None
+            block = "--%s--\r\n" % self.boundary
+            self.current += len(block)
+            if self.cb:
+                self.cb(self.p, self.current, self.total)
+            return block
+
+        self.p = self.params[self.i]
+        self.param_iter = self.p.iter_encode(self.boundary)
+        self.i += 1
+        return self.next()
+
+    def reset(self):
+        self.i = 0
+        self.current = 0
+        for param in self.params:
+            param.reset()
+
+def multipart_encode(params, boundary=None, cb=None):
+    """Encode ``params`` as multipart/form-data.
+
+    ``params`` should be a sequence of (name, value) pairs or MultipartParam
+    objects, or a mapping of names to values.
+    Values are either strings parameter values, or file-like objects to use as
+    the parameter value.  The file-like objects must support .read() and either
+    .fileno() or both .seek() and .tell().
+
+    If ``boundary`` is set, then it as used as the MIME boundary.  Otherwise
+    a randomly generated boundary will be used.  In either case, if the
+    boundary string appears in the parameter values a ValueError will be
+    raised.
+
+    If ``cb`` is set, it should be a callback which will get called as blocks
+    of data are encoded.  It will be called with (param, current, total),
+    indicating the current parameter being encoded, the current amount encoded,
+    and the total amount to encode.
+
+    Returns a tuple of `datagen`, `headers`, where `datagen` is a
+    generator that will yield blocks of data that make up the encoded
+    parameters, and `headers` is a dictionary with the assoicated
+    Content-Type and Content-Length headers.
+
+    Examples:
+
+    >>> datagen, headers = multipart_encode( [("key", "value1"), ("key", "value2")] )
+    >>> s = "".join(datagen)
+    >>> assert "value2" in s and "value1" in s
+
+    >>> p = MultipartParam("key", "value2")
+    >>> datagen, headers = multipart_encode( [("key", "value1"), p] )
+    >>> s = "".join(datagen)
+    >>> assert "value2" in s and "value1" in s
+
+    >>> datagen, headers = multipart_encode( {"key": "value1"} )
+    >>> s = "".join(datagen)
+    >>> assert "value2" not in s and "value1" in s
+
+    """
+    if boundary is None:
+        boundary = gen_boundary()
+    else:
+        boundary = urllib.quote_plus(boundary)
+
+    headers = get_headers(params, boundary)
+    params = MultipartParam.from_params(params)
+
+    return multipart_yielder(params, boundary, cb), headers

requests/packages/poster/streaminghttp.py

@@ -0,0 +1,197 @@
+"""Streaming HTTP uploads module.
+
+This module extends the standard httplib and urllib2 objects so that
+iterable objects can be used in the body of HTTP requests.
+
+In most cases all one should have to do is call :func:`register_openers()`
+to register the new streaming http handlers which will take priority over
+the default handlers, and then you can use iterable objects in the body
+of HTTP requests.
+
+**N.B.** You must specify a Content-Length header if using an iterable object
+since there is no way to determine in advance the total size that will be
+yielded, and there is no way to reset an interator.
+
+Example usage:
+
+>>> from StringIO import StringIO
+>>> import urllib2, poster.streaminghttp
+
+>>> opener = poster.streaminghttp.register_openers()
+
+>>> s = "Test file data"
+>>> f = StringIO(s)
+
+>>> req = urllib2.Request("http://localhost:5000", f,
+...                       {'Content-Length': str(len(s))})
+"""
+
+import httplib, urllib2, socket
+from httplib import NotConnected
+
+__all__ = ['StreamingHTTPConnection', 'StreamingHTTPRedirectHandler',
+        'StreamingHTTPHandler', 'register_openers']
+
+if hasattr(httplib, 'HTTPS'):
+    __all__.extend(['StreamingHTTPSHandler', 'StreamingHTTPSConnection'])
+
+class _StreamingHTTPMixin:
+    """Mixin class for HTTP and HTTPS connections that implements a streaming
+    send method."""
+    def send(self, value):
+        """Send ``value`` to the server.
+
+        ``value`` can be a string object, a file-like object that supports
+        a .read() method, or an iterable object that supports a .next()
+        method.
+        """
+        # Based on python 2.6's httplib.HTTPConnection.send()
+        if self.sock is None:
+            if self.auto_open:
+                self.connect()
+            else:
+                raise NotConnected()
+
+        # send the data to the server. if we get a broken pipe, then close
+        # the socket. we want to reconnect when somebody tries to send again.
+        #
+        # NOTE: we DO propagate the error, though, because we cannot simply
+        #       ignore the error... the caller will know if they can retry.
+        if self.debuglevel > 0:
+            print "send:", repr(value)
+        try:
+            blocksize = 8192
+            if hasattr(value, 'read') :
+                if hasattr(value, 'seek'):
+                    value.seek(0)
+                if self.debuglevel > 0:
+                    print "sendIng a read()able"
+                data = value.read(blocksize)
+                while data:
+                    self.sock.sendall(data)
+                    data = value.read(blocksize)
+            elif hasattr(value, 'next'):
+                if hasattr(value, 'reset'):
+                    value.reset()
+                if self.debuglevel > 0:
+                    print "sendIng an iterable"
+                for data in value:
+                    self.sock.sendall(data)
+            else:
+                self.sock.sendall(value)
+        except socket.error, v:
+            if v[0] == 32:      # Broken pipe
+                self.close()
+            raise
+
+class StreamingHTTPConnection(_StreamingHTTPMixin, httplib.HTTPConnection):
+    """Subclass of `httplib.HTTPConnection` that overrides the `send()` method
+    to support iterable body objects"""
+
+class StreamingHTTPRedirectHandler(urllib2.HTTPRedirectHandler):
+    """Subclass of `urllib2.HTTPRedirectHandler` that overrides the
+    `redirect_request` method to properly handle redirected POST requests
+
+    This class is required because python 2.5's HTTPRedirectHandler does
+    not remove the Content-Type or Content-Length headers when requesting
+    the new resource, but the body of the original request is not preserved.
+    """
+
+    handler_order = urllib2.HTTPRedirectHandler.handler_order - 1
+
+    # From python2.6 urllib2's HTTPRedirectHandler
+    def redirect_request(self, req, fp, code, msg, headers, newurl):
+        """Return a Request or None in response to a redirect.
+
+        This is called by the http_error_30x methods when a
+        redirection response is received.  If a redirection should
+        take place, return a new Request to allow http_error_30x to
+        perform the redirect.  Otherwise, raise HTTPError if no-one
+        else should try to handle this url.  Return None if you can't
+        but another Handler might.
+        """
+        m = req.get_method()
+        if (code in (301, 302, 303, 307) and m in ("GET", "HEAD")
+            or code in (301, 302, 303) and m == "POST"):
+            # Strictly (according to RFC 2616), 301 or 302 in response
+            # to a POST MUST NOT cause a redirection without confirmation
+            # from the user (of urllib2, in this case).  In practice,
+            # essentially all clients do redirect in this case, so we
+            # do the same.
+            # be conciliant with URIs containing a space
+            newurl = newurl.replace(' ', '%20')
+            newheaders = dict((k, v) for k, v in req.headers.items()
+                              if k.lower() not in (
+                                  "content-length", "content-type")
+                             )
+            return urllib2.Request(newurl,
+                           headers=newheaders,
+                           origin_req_host=req.get_origin_req_host(),
+                           unverifiable=True)
+        else:
+            raise urllib2.HTTPError(req.get_full_url(), code, msg, headers, fp)
+
+class StreamingHTTPHandler(urllib2.HTTPHandler):
+    """Subclass of `urllib2.HTTPHandler` that uses
+    StreamingHTTPConnection as its http connection class."""
+
+    handler_order = urllib2.HTTPHandler.handler_order - 1
+
+    def http_open(self, req):
+        """Open a StreamingHTTPConnection for the given request"""
+        return self.do_open(StreamingHTTPConnection, req)
+
+    def http_request(self, req):
+        """Handle a HTTP request.  Make sure that Content-Length is specified
+        if we're using an interable value"""
+        # Make sure that if we're using an iterable object as the request
+        # body, that we've also specified Content-Length
+        if req.has_data():
+            data = req.get_data()
+            if hasattr(data, 'read') or hasattr(data, 'next'):
+                if not req.has_header('Content-length'):
+                    raise ValueError(
+                            "No Content-Length specified for iterable body")
+        return urllib2.HTTPHandler.do_request_(self, req)
+
+if hasattr(httplib, 'HTTPS'):
+    class StreamingHTTPSConnection(_StreamingHTTPMixin,
+            httplib.HTTPSConnection):
+        """Subclass of `httplib.HTTSConnection` that overrides the `send()`
+        method to support iterable body objects"""
+
+    class StreamingHTTPSHandler(urllib2.HTTPSHandler):
+        """Subclass of `urllib2.HTTPSHandler` that uses
+        StreamingHTTPSConnection as its http connection class."""
+
+        handler_order = urllib2.HTTPSHandler.handler_order - 1
+
+        def https_open(self, req):
+            return self.do_open(StreamingHTTPSConnection, req)
+
+        def https_request(self, req):
+            # Make sure that if we're using an iterable object as the request
+            # body, that we've also specified Content-Length
+            if req.has_data():
+                data = req.get_data()
+                if hasattr(data, 'read') or hasattr(data, 'next'):
+                    if not req.has_header('Content-length'):
+                        raise ValueError(
+                                "No Content-Length specified for iterable body")
+            return urllib2.HTTPSHandler.do_request_(self, req)
+
+
+def register_openers():
+    """Register the streaming http handlers in the global urllib2 default
+    opener object.
+
+    Returns the created OpenerDirector object."""
+    handlers = [StreamingHTTPHandler, StreamingHTTPRedirectHandler]
+    if hasattr(httplib, "HTTPS"):
+        handlers.append(StreamingHTTPSHandler)
+
+    opener = urllib2.build_opener(*handlers)
+
+    urllib2.install_opener(opener)
+
+    return opener

setup.py

@@ -7,22 +7,23 @@ import sys
 from distutils.core import setup
 
 
-def publish():
-	"""Publish to PyPi"""
-	os.system("python setup.py sdist upload")
-
+	
 if sys.argv[-1] == "publish":
-	publish()
+	os.system("python setup.py sdist upload")
 	sys.exit()
 
+if sys.argv[-1] == "test":
+	os.system("python test_requests.py")
+	sys.exit()
+	
 required = []
 
 # if python > 2.6, require simplejson
 
 setup(
 	name='requests',
-	version='0.2.0',
-	description='Python HTTP Library that\'s actually usable.',
+	version='0.2.2',
+	description='Awesome Python HTTP Library that\'s actually usable.',
 	long_description=open('README.rst').read() + '\n\n' +
 	                 open('HISTORY.rst').read(),
 	author='Kenneth Reitz',
@@ -30,6 +31,8 @@ setup(
 	url='https://github.com/kennethreitz/requests',
 	packages= [
 		'requests',
+		'requests.packages',
+		'requests.packages.poster'
 	],
 	install_requires=required,
 	license='ISC',
@@ -37,7 +40,7 @@ setup(
 		# 'Development Status :: 5 - Production/Stable',
 		'Intended Audience :: Developers',
 		'Natural Language :: English',
-		'License :: OSI Approved :: MIT License',
+		'License :: OSI Approved :: ISC License (ISCL)',
 		'Programming Language :: Python',
         # 'Programming Language :: Python :: 2.5',
         'Programming Language :: Python :: 2.6',

test_requests.py

@@ -1,7 +1,9 @@
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 
+
 import unittest
+from cStringIO import StringIO
 
 import requests
 
@@ -42,6 +44,18 @@ class RequestsTestSuite(unittest.TestCase):
 
 		self.assertEqual(r.status_code, 200)
 
+	def test_POSTBIN_GET_POST_FILES(self):
+
+		bin = requests.post('http://www.postbin.org/')
+		self.assertEqual(bin.status_code, 200)
+
+		post = requests.post(bin.url, data={'some': 'data'})
+		self.assertEqual(post.status_code, 201)
+
+		post2 = requests.post(bin.url, files={'some': StringIO('data')})
+		self.assertEqual(post2.status_code, 201)
+
+
 
 if __name__ == '__main__':
 	unittest.main()