httplib2 (version 0.7.0)
index
/usr/local/google/home/jcgregorio/projects/apiclient/httplib2/__init__.py

 
Package Contents
       
iri2uri
socks

 
Classes
       
__builtin__.dict(__builtin__.object)
Response
__builtin__.object
Http
ProxyInfo
exceptions.Exception(exceptions.BaseException)
HttpLib2Error
ProxiesUnavailableError
HttpLib2ErrorWithResponse(HttpLib2Error)
FailedToDecompressContent
RedirectLimit
RedirectMissingLocation
UnimplementedDigestAuthOptionError
UnimplementedHmacDigestAuthOptionError

 
class FailedToDecompressContent(HttpLib2ErrorWithResponse)
    
Method resolution order:
FailedToDecompressContent
HttpLib2ErrorWithResponse
HttpLib2Error
exceptions.Exception
exceptions.BaseException
__builtin__.object

Methods inherited from HttpLib2ErrorWithResponse:
__init__(self, desc, response, content)

Data descriptors inherited from HttpLib2Error:
__weakref__
list of weak references to the object (if defined)

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)
__unicode__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message

 
class Http(__builtin__.object)
    An HTTP client that handles:
- all methods
- caching
- ETags
- compression,
- HTTPS
- Basic
- Digest
- WSSE
 
and more.
 
  Methods defined here:
__init__(self, cache=None, timeout=None, proxy_info=None, ca_certs=None, disable_ssl_certificate_validation=False)
The value of proxy_info is a ProxyInfo instance.
 
If 'cache' is a string then it is used as a directory name for
a disk cache. Otherwise it must be an object that supports the
same interface as FileCache.
 
All timeouts are in seconds. If None is passed for timeout
then Python's default timeout for sockets will be used. See
for example the docs of socket.setdefaulttimeout():
http://docs.python.org/library/socket.html#socket.setdefaulttimeout
 
ca_certs is the path of a file containing root CA certificates for SSL
server certificate validation.  By default, a CA cert file bundled with
httplib2 is used.
 
If disable_ssl_certificate_validation is true, SSL cert validation will
not be performed.
add_certificate(self, key, cert, domain)
Add a key and cert that will be used
any time a request requires authentication.
add_credentials(self, name, password, domain='')
Add a name and password that will be used
any time a request requires authentication.
clear_credentials(self)
Remove all the names and passwords
that are used for authentication
request(self, uri, method='GET', body=None, headers=None, redirections=5, connection_type=None)
Performs a single HTTP request.
The 'uri' is the URI of the HTTP resource and can begin
with either 'http' or 'https'. The value of 'uri' must be an absolute URI.
 
The 'method' is the HTTP method to perform, such as GET, POST, DELETE, etc.
There is no restriction on the methods allowed.
 
The 'body' is the entity body to be sent with the request. It is a string
object.
 
Any extra headers that are to be sent with the request should be provided in the
'headers' dictionary.
 
The maximum number of redirect to follow before raising an
exception is 'redirections. The default is 5.
 
The return value is a tuple of (response, content), the first
being and instance of the 'Response' class, the second being
a string that contains the response entity body.

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class HttpLib2Error(exceptions.Exception)
    # All exceptions raised here derive from HttpLib2Error
 
 
Method resolution order:
HttpLib2Error
exceptions.Exception
exceptions.BaseException
__builtin__.object

Data descriptors defined here:
__weakref__
list of weak references to the object (if defined)

Methods inherited from exceptions.Exception:
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)
__unicode__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message

 
class ProxiesUnavailableError(HttpLib2Error)
    
Method resolution order:
ProxiesUnavailableError
HttpLib2Error
exceptions.Exception
exceptions.BaseException
__builtin__.object

Data descriptors inherited from HttpLib2Error:
__weakref__
list of weak references to the object (if defined)

Methods inherited from exceptions.Exception:
__init__(...)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)
__unicode__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message

 
class ProxyInfo(__builtin__.object)
    Collect information required to use a proxy.
 
  Methods defined here:
__init__(self, proxy_type, proxy_host, proxy_port, proxy_rdns=None, proxy_user=None, proxy_pass=None)
The parameter proxy_type must be set to one of socks.PROXY_TYPE_XXX
      constants. For example:
 
p = ProxyInfo(proxy_type=socks.PROXY_TYPE_HTTP, proxy_host='localhost', proxy_port=8000)
astuple(self)
isgood(self)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

 
class RedirectLimit(HttpLib2ErrorWithResponse)
    
Method resolution order:
RedirectLimit
HttpLib2ErrorWithResponse
HttpLib2Error
exceptions.Exception
exceptions.BaseException
__builtin__.object

Methods inherited from HttpLib2ErrorWithResponse:
__init__(self, desc, response, content)

Data descriptors inherited from HttpLib2Error:
__weakref__
list of weak references to the object (if defined)

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)
__unicode__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message

 
class RedirectMissingLocation(HttpLib2ErrorWithResponse)
    
Method resolution order:
RedirectMissingLocation
HttpLib2ErrorWithResponse
HttpLib2Error
exceptions.Exception
exceptions.BaseException
__builtin__.object

Methods inherited from HttpLib2ErrorWithResponse:
__init__(self, desc, response, content)

Data descriptors inherited from HttpLib2Error:
__weakref__
list of weak references to the object (if defined)

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)
__unicode__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message

 
class Response(__builtin__.dict)
    An object more like email.Message than httplib.HTTPResponse.
 
 
Method resolution order:
Response
__builtin__.dict
__builtin__.object

Methods defined here:
__getattr__(self, name)
__init__(self, info)

Data descriptors defined here:
__dict__
dictionary for instance variables (if defined)
__weakref__
list of weak references to the object (if defined)

Data and other attributes defined here:
fromcache = False
previous = None
reason = 'Ok'
status = 200
version = 11

Methods inherited from __builtin__.dict:
__cmp__(...)
x.__cmp__(y) <==> cmp(x,y)
__contains__(...)
D.__contains__(k) -> True if D has a key k, else False
__delitem__(...)
x.__delitem__(y) <==> del x[y]
__eq__(...)
x.__eq__(y) <==> x==y
__ge__(...)
x.__ge__(y) <==> x>=y
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__gt__(...)
x.__gt__(y) <==> x>y
__iter__(...)
x.__iter__() <==> iter(x)
__le__(...)
x.__le__(y) <==> x<=y
__len__(...)
x.__len__() <==> len(x)
__lt__(...)
x.__lt__(y) <==> x<y
__ne__(...)
x.__ne__(y) <==> x!=y
__repr__(...)
x.__repr__() <==> repr(x)
__setitem__(...)
x.__setitem__(i, y) <==> x[i]=y
__sizeof__(...)
D.__sizeof__() -> size of D in memory, in bytes
clear(...)
D.clear() -> None.  Remove all items from D.
copy(...)
D.copy() -> a shallow copy of D
get(...)
D.get(k[,d]) -> D[k] if k in D, else d.  d defaults to None.
has_key(...)
D.has_key(k) -> True if D has a key k, else False
items(...)
D.items() -> list of D's (key, value) pairs, as 2-tuples
iteritems(...)
D.iteritems() -> an iterator over the (key, value) items of D
iterkeys(...)
D.iterkeys() -> an iterator over the keys of D
itervalues(...)
D.itervalues() -> an iterator over the values of D
keys(...)
D.keys() -> list of D's keys
pop(...)
D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
If key is not found, d is returned if given, otherwise KeyError is raised
popitem(...)
D.popitem() -> (k, v), remove and return some (key, value) pair as a
2-tuple; but raise KeyError if D is empty.
setdefault(...)
D.setdefault(k[,d]) -> D.get(k,d), also set D[k]=d if k not in D
update(...)
D.update(E, **F) -> None.  Update D from dict/iterable E and F.
If E has a .keys() method, does:     for k in E: D[k] = E[k]
If E lacks .keys() method, does:     for (k, v) in E: D[k] = v
In either case, this is followed by: for k in F: D[k] = F[k]
values(...)
D.values() -> list of D's values

Data and other attributes inherited from __builtin__.dict:
__hash__ = None
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
fromkeys = <built-in method fromkeys of type object>
dict.fromkeys(S[,v]) -> New dict with keys from S and values equal to v.
v defaults to None.

 
class UnimplementedDigestAuthOptionError(HttpLib2ErrorWithResponse)
    
Method resolution order:
UnimplementedDigestAuthOptionError
HttpLib2ErrorWithResponse
HttpLib2Error
exceptions.Exception
exceptions.BaseException
__builtin__.object

Methods inherited from HttpLib2ErrorWithResponse:
__init__(self, desc, response, content)

Data descriptors inherited from HttpLib2Error:
__weakref__
list of weak references to the object (if defined)

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)
__unicode__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message

 
class UnimplementedHmacDigestAuthOptionError(HttpLib2ErrorWithResponse)
    
Method resolution order:
UnimplementedHmacDigestAuthOptionError
HttpLib2ErrorWithResponse
HttpLib2Error
exceptions.Exception
exceptions.BaseException
__builtin__.object

Methods inherited from HttpLib2ErrorWithResponse:
__init__(self, desc, response, content)

Data descriptors inherited from HttpLib2Error:
__weakref__
list of weak references to the object (if defined)

Data and other attributes inherited from exceptions.Exception:
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T

Methods inherited from exceptions.BaseException:
__delattr__(...)
x.__delattr__('name') <==> del x.name
__getattribute__(...)
x.__getattribute__('name') <==> x.name
__getitem__(...)
x.__getitem__(y) <==> x[y]
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
 
Use of negative indices is not supported.
__reduce__(...)
__repr__(...)
x.__repr__() <==> repr(x)
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
__setstate__(...)
__str__(...)
x.__str__() <==> str(x)
__unicode__(...)

Data descriptors inherited from exceptions.BaseException:
__dict__
args
message

 
Data
        __all__ = ['Http', 'Response', 'ProxyInfo', 'HttpLib2Error', 'RedirectMissingLocation', 'RedirectLimit', 'FailedToDecompressContent', 'UnimplementedDigestAuthOptionError', 'UnimplementedHmacDigestAuthOptionError', 'debuglevel', 'ProxiesUnavailableError']
__author__ = 'Joe Gregorio (joe@bitworking.org)'
__contributors__ = ['Thomas Broyer (t.broyer@ltgt.net)', 'James Antill', 'Xavier Verges Farrero', 'Jonathan Feinberg', 'Blair Zajac', 'Sam Ruby', 'Louis Nyffenegger']
__copyright__ = 'Copyright 2006, Joe Gregorio'
__license__ = 'MIT'
__version__ = '0.7.0'
debuglevel = 0

 
Author
        Joe Gregorio (joe@bitworking.org)