From 55d58180edce947b23559c5b650d0eb2bb554899 Mon Sep 17 00:00:00 2001 From: Joe Gregorio Date: Sun, 20 Feb 2011 01:42:07 -0500 Subject: [PATCH] Added httplib2 and uritemplate to generated docs --- docs/build.sh | 2 + docs/httplib2.html | 711 +++++++++++++++++++++++++++++++++++++ docs/httplib2.iri2uri.html | 9 + docs/httplib2.socks.html | 624 ++++++++++++++++++++++++++++++++ docs/uritemplate.html | 43 +++ 5 files changed, 1389 insertions(+) create mode 100644 docs/httplib2.html create mode 100644 docs/httplib2.iri2uri.html create mode 100644 docs/httplib2.socks.html create mode 100644 docs/uritemplate.html diff --git a/docs/build.sh b/docs/build.sh index e01c9e5..1c21da1 100755 --- a/docs/build.sh +++ b/docs/build.sh @@ -14,4 +14,6 @@ export DJANGO_SETTINGS_MODULE=fakesettings export PYTHONPATH=`pwd`/..:$GOOGLE_APPENGINE find ../apiclient/ -name "*.py" | sed "s/\/__init__.py//" | sed "s/\.py//" | sed "s/^\.\.\///" | sed "s#/#.#g" | xargs pydoc -w find ../oauth2client/ -name "*.py" | sed "s/\/__init__.py//" | sed "s/\.py//" | sed "s/^\.\.\///" | sed "s#/#.#g" | xargs pydoc -w +find ../httplib2/ -name "*.py" | sed "s/\/__init__.py//" | sed "s/\.py//" | sed "s/^\.\.\///" | sed "s#/#.#g" | xargs pydoc -w +find ../uritemplate/ -name "*.py" | sed "s/\/__init__.py//" | sed "s/\.py//" | sed "s/^\.\.\///" | sed "s#/#.#g" | xargs pydoc -w diff --git a/docs/httplib2.html b/docs/httplib2.html new file mode 100644 index 0000000..2f0d15a --- /dev/null +++ b/docs/httplib2.html @@ -0,0 +1,711 @@ + + +Python: package httplib2 + + + + +
 
+ 
httplib2 (version $Rev$)		index
/home/jcgregorio/projects/apiary/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)
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.
+ +
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__ = '$Rev$'
+debuglevel = 0

+ + + + + +
 
+Author
       Joe Gregorio (joe@bitworking.org)
+ \ No newline at end of file diff --git a/docs/httplib2.iri2uri.html b/docs/httplib2.iri2uri.html new file mode 100644 index 0000000..0f9a1f2 --- /dev/null +++ b/docs/httplib2.iri2uri.html @@ -0,0 +1,9 @@ + + +Python: function iri2uri + +

httplib2.iri2uri = iri2uri(uri)
Convert an IRI to a URI. Note that IRIs must be 
+passed in a unicode strings. That is, do not utf-8 encode
+the IRI before passing it into the function.
+ + \ No newline at end of file diff --git a/docs/httplib2.socks.html b/docs/httplib2.socks.html new file mode 100644 index 0000000..8851f4b --- /dev/null +++ b/docs/httplib2.socks.html @@ -0,0 +1,624 @@ + + +Python: module httplib2.socks + + + + +
 
+ 
httplib2.socks		index
/home/jcgregorio/projects/apiary/httplib2/socks.py
+

SocksiPy - Python SOCKS module.
+Version 1.00
+ 
+Copyright 2006 Dan-Haim. All rights reserved.
+ 
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+3. Neither the name of Dan Haim nor the names of his contributors may be used
+   to endorse or promote products derived from this software without specific
+   prior written permission.
+ 
+THIS SOFTWARE IS PROVIDED BY DAN HAIM "AS IS" AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL DAN HAIM OR HIS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA
+OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
+OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ 
+ 
+This module provides a standard socket-like interface for Python
+for tunneling connections through SOCKS proxies.

+

+ + + + + +
 
+Modules
       
socket
+		struct
+		sys
+

+ + + + + +
 
+Classes
       
+
exceptions.Exception(exceptions.BaseException) +
+
+
ProxyError +
+
+
GeneralProxyError +
HTTPError +
Socks4Error +
Socks5AuthError +
Socks5Error +
+
+
+
+
socket._socketobject(__builtin__.object) +
+
+
socksocket +
+
+
+

+ + + + + +
 
+class GeneralProxyError(ProxyError)
    
Method resolution order:
+
GeneralProxyError
+
ProxyError
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Methods defined here:
+
__init__(self, value)
+ +
__str__(self)
+ +
+Data descriptors inherited from ProxyError:
+
__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__(...)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + +
 
+class HTTPError(ProxyError)
    
Method resolution order:
+
HTTPError
+
ProxyError
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Methods defined here:
+
__init__(self, value)
+ +
__str__(self)
+ +
+Data descriptors inherited from ProxyError:
+
__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__(...)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + +
 
+class ProxyError(exceptions.Exception)
    
Method resolution order:
+
ProxyError
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Methods defined here:
+
__init__(self, value)
+ +
__str__(self)
+ +
+Data descriptors defined here:
+
__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__(...)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + +
 
+class Socks4Error(ProxyError)
    
Method resolution order:
+
Socks4Error
+
ProxyError
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Methods defined here:
+
__init__(self, value)
+ +
__str__(self)
+ +
+Data descriptors inherited from ProxyError:
+
__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__(...)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + +
 
+class Socks5AuthError(ProxyError)
    
Method resolution order:
+
Socks5AuthError
+
ProxyError
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Methods defined here:
+
__init__(self, value)
+ +
__str__(self)
+ +
+Data descriptors inherited from ProxyError:
+
__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__(...)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + +
 
+class Socks5Error(ProxyError)
    
Method resolution order:
+
Socks5Error
+
ProxyError
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Methods defined here:
+
__init__(self, value)
+ +
__str__(self)
+ +
+Data descriptors inherited from ProxyError:
+
__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__(...)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + + + +
 
+class socksocket(socket._socketobject)
   socksocket([family[, type[, proto]]]) -> socket object
+ 
+Open a SOCKS enabled socket. The parameters are the same as
+those of the standard socket init. In order for SOCKS to work,
+you must specify family=AF_INET, type=SOCK_STREAM and proto=0.
 
 
Method resolution order:
+
socksocket
+
socket._socketobject
+
__builtin__.object
+
+
+Methods defined here:
+
__init__(self, family=2, type=1, proto=0, _sock=None)
+ +
connect(self, destpair)
connect(self,despair)
+Connects to the specified destination through a proxy.
+destpar - A tuple of the IP/DNS address and the port number.
+(identical to socket's connect).
+To select the proxy server use setproxy().
+ +
getpeername(self)
getpeername() -> address info
+Returns the IP address and port number of the destination
+machine (note: getproxypeername returns the proxy)
+ +
getproxypeername(self)
getproxypeername() -> address info
+Returns the IP and port number of the proxy.
+ +
getproxysockname(self)
getsockname() -> address info
+Returns the bound IP address and port number at the proxy.
+ +
sendall(self, bytes)
+ +
setproxy(self, proxytype=None, addr=None, port=None, rdns=True, username=None, password=None)
setproxy(proxytype, addr[, port[, rdns[, username[, password]]]])
+Sets the proxy to be used.
+proxytype -    The type of the proxy to be used. Three types
+        are supported: PROXY_TYPE_SOCKS4 (including socks4a),
+        PROXY_TYPE_SOCKS5 and PROXY_TYPE_HTTP
+addr -        The address of the server (IP or DNS).
+port -        The port of the server. Defaults to 1080 for SOCKS
+        servers and 8080 for HTTP proxy servers.
+rdns -        Should DNS queries be preformed on the remote side
+        (rather than the local side). The default is True.
+        Note: This has no effect with SOCKS4 servers.
+username -    Username to authenticate with to the server.
+        The default is no authentication.
+password -    Password to authenticate with to the server.
+        Only relevant when username is also provided.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
+Methods inherited from socket._socketobject:
+
accept(self)
accept() -> (socket object, address info)
+ 
+Wait for an incoming connection.  Return a new socket representing the
+connection, and the address of the client.  For IP sockets, the address
+info is a pair (hostaddr, port).
+ +
bind(self, *args)
bind(address)
+ 
+Bind the socket to a local address.  For IP sockets, the address is a
+pair (host, port); the host must refer to the local host. For raw packet
+sockets the address is a tuple (ifname, proto [,pkttype [,hatype]])
+ +
close(self)
close()
+ 
+Close the socket.  It cannot be used after this call.
+ +
connect_ex(self, *args)
connect_ex(address) -> errno
+ 
+This is like connect(address), but returns an error code (the errno value)
+instead of raising an exception when an error occurs.
+ +
dup(self)
dup() -> socket object
+ 
+Return a new socket object connected to the same system resource.
+ +
fileno(self, *args)
fileno() -> integer
+ 
+Return the integer file descriptor of the socket.
+ +
getsockname(self, *args)
getsockname() -> address info
+ 
+Return the address of the local endpoint.  For IP sockets, the address
+info is a pair (hostaddr, port).
+ +
getsockopt(self, *args)
getsockopt(level, option[, buffersize]) -> value
+ 
+Get a socket option.  See the Unix manual for level and option.
+If a nonzero buffersize argument is given, the return value is a
+string of that length; otherwise it is an integer.
+ +
gettimeout(self, *args)
gettimeout() -> timeout
+ 
+Returns the timeout in floating seconds associated with socket 
+operations. A timeout of None indicates that timeouts on socket 
+operations are disabled.
+ +
listen(self, *args)
listen(backlog)
+ 
+Enable a server to accept connections.  The backlog argument must be at
+least 1; it specifies the number of unaccepted connection that the system
+will allow before refusing new connections.
+ +
makefile(self, mode='r', bufsize=-1)
makefile([mode[, bufsize]]) -> file object
+ 
+Return a regular file object corresponding to the socket.  The mode
+and bufsize arguments are as for the built-in open() function.
+ +
setblocking(self, *args)
setblocking(flag)
+ 
+Set the socket to blocking (flag is true) or non-blocking (false).
+setblocking(True) is equivalent to settimeout(None);
+setblocking(False) is equivalent to settimeout(0.0).
+ +
setsockopt(self, *args)
setsockopt(level, option, value)
+ 
+Set a socket option.  See the Unix manual for level and option.
+The value argument can either be an integer or a string.
+ +
settimeout(self, *args)
settimeout(timeout)
+ 
+Set a timeout on socket operations.  'timeout' can be a float,
+giving in seconds, or None.  Setting a timeout of None disables
+the timeout feature and is equivalent to setblocking(1).
+Setting a timeout of zero is the same as setblocking(0).
+ +
shutdown(self, *args)
shutdown(flag)
+ 
+Shut down the reading side of the socket (flag == SHUT_RD), the writing side
+of the socket (flag == SHUT_WR), or both ends (flag == SHUT_RDWR).
+ +
+Data descriptors inherited from socket._socketobject:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
family
+
the socket family
+
+
proto
+
the socket protocol
+
+
recv
+
+
recv_into
+
+
recvfrom
+
+
recvfrom_into
+
+
send
+
+
sendto
+
+
type
+
the socket type
+
+

+ + + + + +
 
+Functions
       
bytes(obj, enc=None)
+
setdefaultproxy(proxytype=None, addr=None, port=None, rdns=True, username=None, password=None)
setdefaultproxy(proxytype, addr[, port[, rdns[, username[, password]]]])
+Sets a default proxy which all further socksocket objects will use,
+unless explicitly changed.
+

+ + + + + +
 
+Data
       PROXY_TYPE_HTTP = 3
+PROXY_TYPE_SOCKS4 = 1
+PROXY_TYPE_SOCKS5 = 2
+ \ No newline at end of file diff --git a/docs/uritemplate.html b/docs/uritemplate.html new file mode 100644 index 0000000..38598ae --- /dev/null +++ b/docs/uritemplate.html @@ -0,0 +1,43 @@ + + +Python: package uritemplate + + + + +
 
+ 
uritemplate		index
/home/jcgregorio/projects/apiary/uritemplate/__init__.py
+

# Early, and incomplete implementation of -04.
+#

+

+ + + + + +
 
+Package Contents
       

+ + + + + +
 
+Functions
       
expand(template, vars)
+

+ + + + + +
 
+Data
       EXPLODE = '*+'
+MODIFIER = ':^'
+OPERATOR = '+./;?|!@'
+RESERVED = ":/?#[]@!$&'()*+,;="
+TEMPLATE = <_sre.SRE_Pattern object>
+TOSTRING = {'': <function _tostring>, '+': <function _tostring>, '.': <function _tostring_path>, '/': <function _tostring_path>, ';': <function _tostring_query>, '?': <function _tostring_query>}
+VAR = <_sre.SRE_Pattern object>
+ \ No newline at end of file