968 lines
65 KiB
HTML
968 lines
65 KiB
HTML
|
|
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
<html><head><title>Python: module oauth2client.client</title>
|
|
</head><body bgcolor="#f0f0f8">
|
|
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
|
<tr bgcolor="#7799ee">
|
|
<td valign=bottom> <br>
|
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="oauth2client.html"><font color="#ffffff">oauth2client</font></a>.client</strong></big></big></font></td
|
|
><td align=right valign=bottom
|
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiclient-release/oauth2client/client.py">/usr/local/google/home/jcgregorio/projects/apiclient-release/oauth2client/client.py</a></font></td></tr></table>
|
|
<p><tt>An OAuth 2.0 client.<br>
|
|
<br>
|
|
Tools for interacting with OAuth 2.0 protected resources.</tt></p>
|
|
<p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#aa55cc">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
|
|
|
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
|
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="oauth2client.clientsecrets.html">oauth2client.clientsecrets</a><br>
|
|
<a href="copy.html">copy</a><br>
|
|
<a href="datetime.html">datetime</a><br>
|
|
</td><td width="25%" valign=top><a href="httplib2.html">httplib2</a><br>
|
|
<a href="logging.html">logging</a><br>
|
|
<a href="simplejson.html">simplejson</a><br>
|
|
</td><td width="25%" valign=top><a href="sys.html">sys</a><br>
|
|
<a href="urllib.html">urllib</a><br>
|
|
<a href="urlparse.html">urlparse</a><br>
|
|
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ee77aa">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
|
|
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
|
<td width="100%"><dl>
|
|
<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
|
|
</font></dt><dd>
|
|
<dl>
|
|
<dt><font face="helvetica, arial"><a href="oauth2client.client.html#Credentials">Credentials</a>
|
|
</font></dt><dd>
|
|
<dl>
|
|
<dt><font face="helvetica, arial"><a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>
|
|
</font></dt><dd>
|
|
<dl>
|
|
<dt><font face="helvetica, arial"><a href="oauth2client.client.html#AccessTokenCredentials">AccessTokenCredentials</a>
|
|
</font></dt><dt><font face="helvetica, arial"><a href="oauth2client.client.html#AssertionCredentials">AssertionCredentials</a>
|
|
</font></dt></dl>
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
<dt><font face="helvetica, arial"><a href="oauth2client.client.html#Flow">Flow</a>
|
|
</font></dt><dd>
|
|
<dl>
|
|
<dt><font face="helvetica, arial"><a href="oauth2client.client.html#OAuth2WebServerFlow">OAuth2WebServerFlow</a>
|
|
</font></dt></dl>
|
|
</dd>
|
|
<dt><font face="helvetica, arial"><a href="oauth2client.client.html#Storage">Storage</a>
|
|
</font></dt></dl>
|
|
</dd>
|
|
<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
|
|
</font></dt><dd>
|
|
<dl>
|
|
<dt><font face="helvetica, arial"><a href="oauth2client.client.html#Error">Error</a>
|
|
</font></dt><dd>
|
|
<dl>
|
|
<dt><font face="helvetica, arial"><a href="oauth2client.client.html#AccessTokenCredentialsError">AccessTokenCredentialsError</a>
|
|
</font></dt><dt><font face="helvetica, arial"><a href="oauth2client.client.html#AccessTokenRefreshError">AccessTokenRefreshError</a>
|
|
</font></dt><dt><font face="helvetica, arial"><a href="oauth2client.client.html#FlowExchangeError">FlowExchangeError</a>
|
|
</font></dt><dt><font face="helvetica, arial"><a href="oauth2client.client.html#UnknownClientSecretsFlowError">UnknownClientSecretsFlowError</a>
|
|
</font></dt></dl>
|
|
</dd>
|
|
</dl>
|
|
</dd>
|
|
</dl>
|
|
<p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#000000" face="helvetica, arial"><a name="AccessTokenCredentials">class <strong>AccessTokenCredentials</strong></a>(<a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>)</font></td></tr>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> for OAuth 2.0.<br>
|
|
<br>
|
|
<a href="#Credentials">Credentials</a> can be applied to an httplib2.Http <a href="__builtin__.html#object">object</a> using the<br>
|
|
<a href="#AccessTokenCredentials-authorize">authorize</a>() method, which then signs each request from that <a href="__builtin__.html#object">object</a><br>
|
|
with the OAuth 2.0 access token. This set of credentials is for the<br>
|
|
use case where you have acquired an OAuth 2.0 access_token from<br>
|
|
another place such as a JavaScript client or another web<br>
|
|
application, and wish to use it from Python. Because only the<br>
|
|
access_token is present it can not be refreshed and will in time<br>
|
|
expire.<br>
|
|
<br>
|
|
<a href="#AccessTokenCredentials">AccessTokenCredentials</a> objects may be safely pickled and unpickled.<br>
|
|
<br>
|
|
Usage:<br>
|
|
credentials = <a href="#AccessTokenCredentials">AccessTokenCredentials</a>('<an access token>',<br>
|
|
'my-user-agent/1.0')<br>
|
|
http = httplib2.Http()<br>
|
|
http = credentials.<a href="#AccessTokenCredentials-authorize">authorize</a>(http)<br>
|
|
<br>
|
|
Exceptions:<br>
|
|
AccessTokenCredentialsExpired: raised when the access_token expires or is<br>
|
|
revoked.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="oauth2client.client.html#AccessTokenCredentials">AccessTokenCredentials</a></dd>
|
|
<dd><a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a></dd>
|
|
<dd><a href="oauth2client.client.html#Credentials">Credentials</a></dd>
|
|
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods defined here:<br>
|
|
<dl><dt><a name="AccessTokenCredentials-__init__"><strong>__init__</strong></a>(self, access_token, user_agent)</dt><dd><tt>Create an instance of <a href="#OAuth2Credentials">OAuth2Credentials</a><br>
|
|
<br>
|
|
This is one of the few types if <a href="#Credentials">Credentials</a> that you should contrust,<br>
|
|
<a href="#Credentials">Credentials</a> objects are usually instantiated by a <a href="#Flow">Flow</a>.<br>
|
|
<br>
|
|
Args:<br>
|
|
access_token: string, access token.<br>
|
|
user_agent: string, The HTTP User-Agent to provide for this application.<br>
|
|
<br>
|
|
Notes:<br>
|
|
store: callable, a callable that when passed a Credential<br>
|
|
will store the credential back to where it came from.</tt></dd></dl>
|
|
|
|
<hr>
|
|
Class methods defined here:<br>
|
|
<dl><dt><a name="AccessTokenCredentials-from_json"><strong>from_json</strong></a>(cls, s)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl>
|
|
|
|
<hr>
|
|
Methods inherited from <a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>:<br>
|
|
<dl><dt><a name="AccessTokenCredentials-__getstate__"><strong>__getstate__</strong></a>(self)</dt><dd><tt>Trim the state down to something that can be pickled.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AccessTokenCredentials-__setstate__"><strong>__setstate__</strong></a>(self, state)</dt><dd><tt>Reconstitute the state of the <a href="__builtin__.html#object">object</a> from being pickled.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AccessTokenCredentials-authorize"><strong>authorize</strong></a>(self, http)</dt><dd><tt>Authorize an httplib2.Http instance with these credentials.<br>
|
|
<br>
|
|
Args:<br>
|
|
http: An instance of httplib2.Http<br>
|
|
or something that acts like it.<br>
|
|
<br>
|
|
Returns:<br>
|
|
A modified instance of http that was passed in.<br>
|
|
<br>
|
|
Example:<br>
|
|
<br>
|
|
h = httplib2.Http()<br>
|
|
h = credentials.<a href="#AccessTokenCredentials-authorize">authorize</a>(h)<br>
|
|
<br>
|
|
You can't create a new OAuth subclass of httplib2.Authenication<br>
|
|
because it never gets passed the absolute URI, which is needed for<br>
|
|
signing. So instead we have to overload 'request' with a closure<br>
|
|
that adds in the Authorization header and then calls the original<br>
|
|
version of 'request()'.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AccessTokenCredentials-set_store"><strong>set_store</strong></a>(self, store)</dt><dd><tt>Set the <a href="#Storage">Storage</a> for the credential.<br>
|
|
<br>
|
|
Args:<br>
|
|
store: <a href="#Storage">Storage</a>, an implementation of Stroage <a href="__builtin__.html#object">object</a>.<br>
|
|
This is needed to store the latest access_token if it<br>
|
|
has expired and been refreshed. This implementation uses<br>
|
|
locking to check for updates before updating the<br>
|
|
access_token.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AccessTokenCredentials-to_json"><strong>to_json</strong></a>(self)</dt></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>:<br>
|
|
<dl><dt><strong>access_token_expired</strong></dt>
|
|
<dd><tt>True if the credential is expired or invalid.<br>
|
|
<br>
|
|
If the token_expiry isn't set, we assume the token doesn't expire.</tt></dd>
|
|
</dl>
|
|
<hr>
|
|
Class methods inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:<br>
|
|
<dl><dt><a name="AccessTokenCredentials-new_from_json"><strong>new_from_json</strong></a>(cls, s)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Utility class method to instantiate a <a href="#Credentials">Credentials</a> subclass from a JSON<br>
|
|
representation produced by <a href="#AccessTokenCredentials-to_json">to_json</a>().<br>
|
|
<br>
|
|
Args:<br>
|
|
s: string, JSON from <a href="#AccessTokenCredentials-to_json">to_json</a>().<br>
|
|
<br>
|
|
Returns:<br>
|
|
An instance of the subclass of <a href="#Credentials">Credentials</a> that was serialized with<br>
|
|
<a href="#AccessTokenCredentials-to_json">to_json</a>().</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<hr>
|
|
Data and other attributes inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:<br>
|
|
<dl><dt><strong>NON_SERIALIZED_MEMBERS</strong> = ['store']</dl>
|
|
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#000000" face="helvetica, arial"><a name="AccessTokenCredentialsError">class <strong>AccessTokenCredentialsError</strong></a>(<a href="oauth2client.client.html#Error">Error</a>)</font></td></tr>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt>Having only the access_token means no refresh is possible.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="oauth2client.client.html#AccessTokenCredentialsError">AccessTokenCredentialsError</a></dd>
|
|
<dd><a href="oauth2client.client.html#Error">Error</a></dd>
|
|
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
|
|
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
|
|
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Data descriptors inherited from <a href="oauth2client.client.html#Error">Error</a>:<br>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
|
<dl><dt><a name="AccessTokenCredentialsError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#AccessTokenCredentialsError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
|
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#AccessTokenCredentialsError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>
|
|
|
|
<hr>
|
|
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
|
<dl><dt><a name="AccessTokenCredentialsError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#AccessTokenCredentialsError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AccessTokenCredentialsError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#AccessTokenCredentialsError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AccessTokenCredentialsError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#AccessTokenCredentialsError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AccessTokenCredentialsError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#AccessTokenCredentialsError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
|
|
<br>
|
|
Use of negative indices is not supported.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AccessTokenCredentialsError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
|
|
|
|
<dl><dt><a name="AccessTokenCredentialsError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#AccessTokenCredentialsError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AccessTokenCredentialsError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#AccessTokenCredentialsError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AccessTokenCredentialsError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
|
|
|
|
<dl><dt><a name="AccessTokenCredentialsError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#AccessTokenCredentialsError-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AccessTokenCredentialsError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>args</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>message</strong></dt>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#000000" face="helvetica, arial"><a name="AccessTokenRefreshError">class <strong>AccessTokenRefreshError</strong></a>(<a href="oauth2client.client.html#Error">Error</a>)</font></td></tr>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#Error">Error</a> trying to refresh an expired access token.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="oauth2client.client.html#AccessTokenRefreshError">AccessTokenRefreshError</a></dd>
|
|
<dd><a href="oauth2client.client.html#Error">Error</a></dd>
|
|
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
|
|
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
|
|
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Data descriptors inherited from <a href="oauth2client.client.html#Error">Error</a>:<br>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
|
<dl><dt><a name="AccessTokenRefreshError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#AccessTokenRefreshError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
|
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#AccessTokenRefreshError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>
|
|
|
|
<hr>
|
|
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
|
<dl><dt><a name="AccessTokenRefreshError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#AccessTokenRefreshError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AccessTokenRefreshError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#AccessTokenRefreshError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AccessTokenRefreshError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#AccessTokenRefreshError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AccessTokenRefreshError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#AccessTokenRefreshError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
|
|
<br>
|
|
Use of negative indices is not supported.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AccessTokenRefreshError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
|
|
|
|
<dl><dt><a name="AccessTokenRefreshError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#AccessTokenRefreshError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AccessTokenRefreshError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#AccessTokenRefreshError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AccessTokenRefreshError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
|
|
|
|
<dl><dt><a name="AccessTokenRefreshError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#AccessTokenRefreshError-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AccessTokenRefreshError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>args</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>message</strong></dt>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#000000" face="helvetica, arial"><a name="AssertionCredentials">class <strong>AssertionCredentials</strong></a>(<a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>)</font></td></tr>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt>Abstract <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> used for OAuth 2.0 assertion grants.<br>
|
|
<br>
|
|
This credential does not require a flow to instantiate because it<br>
|
|
represents a two legged flow, and therefore has all of the required<br>
|
|
information to generate and refresh its own access tokens. It must<br>
|
|
be subclassed to generate the appropriate assertion string.<br>
|
|
<br>
|
|
<a href="#AssertionCredentials">AssertionCredentials</a> objects may be safely pickled and unpickled.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="oauth2client.client.html#AssertionCredentials">AssertionCredentials</a></dd>
|
|
<dd><a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a></dd>
|
|
<dd><a href="oauth2client.client.html#Credentials">Credentials</a></dd>
|
|
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods defined here:<br>
|
|
<dl><dt><a name="AssertionCredentials-__init__"><strong>__init__</strong></a>(self, assertion_type, user_agent, token_uri<font color="#909090">='https://accounts.google.com/o/oauth2/token'</font>, **unused_kwargs)</dt><dd><tt>Constructor for AssertionFlowCredentials.<br>
|
|
<br>
|
|
Args:<br>
|
|
assertion_type: string, assertion type that will be declared to the auth<br>
|
|
server<br>
|
|
user_agent: string, The HTTP User-Agent to provide for this application.<br>
|
|
token_uri: string, URI for token endpoint. For convenience<br>
|
|
defaults to Google's endpoints but any OAuth 2.0 provider can be used.</tt></dd></dl>
|
|
|
|
<hr>
|
|
Methods inherited from <a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>:<br>
|
|
<dl><dt><a name="AssertionCredentials-__getstate__"><strong>__getstate__</strong></a>(self)</dt><dd><tt>Trim the state down to something that can be pickled.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AssertionCredentials-__setstate__"><strong>__setstate__</strong></a>(self, state)</dt><dd><tt>Reconstitute the state of the <a href="__builtin__.html#object">object</a> from being pickled.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AssertionCredentials-authorize"><strong>authorize</strong></a>(self, http)</dt><dd><tt>Authorize an httplib2.Http instance with these credentials.<br>
|
|
<br>
|
|
Args:<br>
|
|
http: An instance of httplib2.Http<br>
|
|
or something that acts like it.<br>
|
|
<br>
|
|
Returns:<br>
|
|
A modified instance of http that was passed in.<br>
|
|
<br>
|
|
Example:<br>
|
|
<br>
|
|
h = httplib2.Http()<br>
|
|
h = credentials.<a href="#AssertionCredentials-authorize">authorize</a>(h)<br>
|
|
<br>
|
|
You can't create a new OAuth subclass of httplib2.Authenication<br>
|
|
because it never gets passed the absolute URI, which is needed for<br>
|
|
signing. So instead we have to overload 'request' with a closure<br>
|
|
that adds in the Authorization header and then calls the original<br>
|
|
version of 'request()'.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AssertionCredentials-set_store"><strong>set_store</strong></a>(self, store)</dt><dd><tt>Set the <a href="#Storage">Storage</a> for the credential.<br>
|
|
<br>
|
|
Args:<br>
|
|
store: <a href="#Storage">Storage</a>, an implementation of Stroage <a href="__builtin__.html#object">object</a>.<br>
|
|
This is needed to store the latest access_token if it<br>
|
|
has expired and been refreshed. This implementation uses<br>
|
|
locking to check for updates before updating the<br>
|
|
access_token.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="AssertionCredentials-to_json"><strong>to_json</strong></a>(self)</dt></dl>
|
|
|
|
<hr>
|
|
Class methods inherited from <a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>:<br>
|
|
<dl><dt><a name="AssertionCredentials-from_json"><strong>from_json</strong></a>(cls, s)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Instantiate a <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> from a JSON description of it. The JSON<br>
|
|
should have been produced by calling .<a href="#AssertionCredentials-to_json">to_json</a>() on the <a href="__builtin__.html#object">object</a>.<br>
|
|
<br>
|
|
Args:<br>
|
|
data: dict, A deserialized JSON <a href="__builtin__.html#object">object</a>.<br>
|
|
<br>
|
|
Returns:<br>
|
|
An instance of a <a href="#Credentials">Credentials</a> subclass.</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a>:<br>
|
|
<dl><dt><strong>access_token_expired</strong></dt>
|
|
<dd><tt>True if the credential is expired or invalid.<br>
|
|
<br>
|
|
If the token_expiry isn't set, we assume the token doesn't expire.</tt></dd>
|
|
</dl>
|
|
<hr>
|
|
Class methods inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:<br>
|
|
<dl><dt><a name="AssertionCredentials-new_from_json"><strong>new_from_json</strong></a>(cls, s)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Utility class method to instantiate a <a href="#Credentials">Credentials</a> subclass from a JSON<br>
|
|
representation produced by <a href="#AssertionCredentials-to_json">to_json</a>().<br>
|
|
<br>
|
|
Args:<br>
|
|
s: string, JSON from <a href="#AssertionCredentials-to_json">to_json</a>().<br>
|
|
<br>
|
|
Returns:<br>
|
|
An instance of the subclass of <a href="#Credentials">Credentials</a> that was serialized with<br>
|
|
<a href="#AssertionCredentials-to_json">to_json</a>().</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<hr>
|
|
Data and other attributes inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:<br>
|
|
<dl><dt><strong>NON_SERIALIZED_MEMBERS</strong> = ['store']</dl>
|
|
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#000000" face="helvetica, arial"><a name="Credentials">class <strong>Credentials</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt>Base class for all <a href="#Credentials">Credentials</a> objects.<br>
|
|
<br>
|
|
Subclasses must define an <a href="#Credentials-authorize">authorize</a>() method that applies the credentials to<br>
|
|
an HTTP transport.<br>
|
|
<br>
|
|
Subclasses must also specify a classmethod named 'from_json' that takes a JSON<br>
|
|
string as input and returns an instaniated Crentials <a href="__builtin__.html#object">object</a>.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%">Methods defined here:<br>
|
|
<dl><dt><a name="Credentials-authorize"><strong>authorize</strong></a>(self, http)</dt><dd><tt>Take an httplib2.Http instance (or equivalent) and<br>
|
|
authorizes it for the set of credentials, usually by<br>
|
|
replacing http.request() with a method that adds in<br>
|
|
the appropriate headers and then delegates to the original<br>
|
|
Http.request() method.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Credentials-to_json"><strong>to_json</strong></a>(self)</dt><dd><tt>Creating a JSON representation of an instance of <a href="#Credentials">Credentials</a>.<br>
|
|
<br>
|
|
Returns:<br>
|
|
string, a JSON representation of this instance, suitable to pass to<br>
|
|
from_json().</tt></dd></dl>
|
|
|
|
<hr>
|
|
Class methods defined here:<br>
|
|
<dl><dt><a name="Credentials-new_from_json"><strong>new_from_json</strong></a>(cls, s)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Utility class method to instantiate a <a href="#Credentials">Credentials</a> subclass from a JSON<br>
|
|
representation produced by <a href="#Credentials-to_json">to_json</a>().<br>
|
|
<br>
|
|
Args:<br>
|
|
s: string, JSON from <a href="#Credentials-to_json">to_json</a>().<br>
|
|
<br>
|
|
Returns:<br>
|
|
An instance of the subclass of <a href="#Credentials">Credentials</a> that was serialized with<br>
|
|
<a href="#Credentials-to_json">to_json</a>().</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors defined here:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<hr>
|
|
Data and other attributes defined here:<br>
|
|
<dl><dt><strong>NON_SERIALIZED_MEMBERS</strong> = ['store']</dl>
|
|
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#000000" face="helvetica, arial"><a name="Error">class <strong>Error</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt>Base error for this module.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="oauth2client.client.html#Error">Error</a></dd>
|
|
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
|
|
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
|
|
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Data descriptors defined here:<br>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
|
<dl><dt><a name="Error-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
|
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#Error-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>
|
|
|
|
<hr>
|
|
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
|
<dl><dt><a name="Error-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Error-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Error-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Error-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
|
|
<br>
|
|
Use of negative indices is not supported.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Error-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
|
|
|
|
<dl><dt><a name="Error-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Error-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Error-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
|
|
|
|
<dl><dt><a name="Error-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Error-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>args</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>message</strong></dt>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#000000" face="helvetica, arial"><a name="Flow">class <strong>Flow</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt>Base class for all <a href="#Flow">Flow</a> objects.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%">Data descriptors defined here:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#000000" face="helvetica, arial"><a name="FlowExchangeError">class <strong>FlowExchangeError</strong></a>(<a href="oauth2client.client.html#Error">Error</a>)</font></td></tr>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#Error">Error</a> trying to exchange an authorization grant for an access token.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="oauth2client.client.html#FlowExchangeError">FlowExchangeError</a></dd>
|
|
<dd><a href="oauth2client.client.html#Error">Error</a></dd>
|
|
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
|
|
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
|
|
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Data descriptors inherited from <a href="oauth2client.client.html#Error">Error</a>:<br>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
|
<dl><dt><a name="FlowExchangeError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#FlowExchangeError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
|
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#FlowExchangeError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>
|
|
|
|
<hr>
|
|
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
|
<dl><dt><a name="FlowExchangeError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#FlowExchangeError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
|
|
|
|
<dl><dt><a name="FlowExchangeError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#FlowExchangeError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
|
|
|
|
<dl><dt><a name="FlowExchangeError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#FlowExchangeError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
|
|
|
|
<dl><dt><a name="FlowExchangeError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#FlowExchangeError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
|
|
<br>
|
|
Use of negative indices is not supported.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="FlowExchangeError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
|
|
|
|
<dl><dt><a name="FlowExchangeError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#FlowExchangeError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="FlowExchangeError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#FlowExchangeError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
|
|
|
|
<dl><dt><a name="FlowExchangeError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
|
|
|
|
<dl><dt><a name="FlowExchangeError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#FlowExchangeError-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="FlowExchangeError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>args</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>message</strong></dt>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#000000" face="helvetica, arial"><a name="OAuth2Credentials">class <strong>OAuth2Credentials</strong></a>(<a href="oauth2client.client.html#Credentials">Credentials</a>)</font></td></tr>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt><a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> for OAuth 2.0.<br>
|
|
<br>
|
|
<a href="#Credentials">Credentials</a> can be applied to an httplib2.Http <a href="__builtin__.html#object">object</a> using the <a href="#OAuth2Credentials-authorize">authorize</a>()<br>
|
|
method, which then signs each request from that <a href="__builtin__.html#object">object</a> with the OAuth 2.0<br>
|
|
access token.<br>
|
|
<br>
|
|
<a href="#OAuth2Credentials">OAuth2Credentials</a> objects may be safely pickled and unpickled.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="oauth2client.client.html#OAuth2Credentials">OAuth2Credentials</a></dd>
|
|
<dd><a href="oauth2client.client.html#Credentials">Credentials</a></dd>
|
|
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods defined here:<br>
|
|
<dl><dt><a name="OAuth2Credentials-__getstate__"><strong>__getstate__</strong></a>(self)</dt><dd><tt>Trim the state down to something that can be pickled.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="OAuth2Credentials-__init__"><strong>__init__</strong></a>(self, access_token, client_id, client_secret, refresh_token, token_expiry, token_uri, user_agent)</dt><dd><tt>Create an instance of <a href="#OAuth2Credentials">OAuth2Credentials</a>.<br>
|
|
<br>
|
|
This constructor is not usually called by the user, instead<br>
|
|
<a href="#OAuth2Credentials">OAuth2Credentials</a> objects are instantiated by the <a href="#OAuth2WebServerFlow">OAuth2WebServerFlow</a>.<br>
|
|
<br>
|
|
Args:<br>
|
|
access_token: string, access token.<br>
|
|
client_id: string, client identifier.<br>
|
|
client_secret: string, client secret.<br>
|
|
refresh_token: string, refresh token.<br>
|
|
token_expiry: datetime, when the access_token expires.<br>
|
|
token_uri: string, URI of token endpoint.<br>
|
|
user_agent: string, The HTTP User-Agent to provide for this application.<br>
|
|
<br>
|
|
Notes:<br>
|
|
store: callable, a callable that when passed a Credential<br>
|
|
will store the credential back to where it came from.<br>
|
|
This is needed to store the latest access_token if it<br>
|
|
has expired and been refreshed.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="OAuth2Credentials-__setstate__"><strong>__setstate__</strong></a>(self, state)</dt><dd><tt>Reconstitute the state of the <a href="__builtin__.html#object">object</a> from being pickled.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="OAuth2Credentials-authorize"><strong>authorize</strong></a>(self, http)</dt><dd><tt>Authorize an httplib2.Http instance with these credentials.<br>
|
|
<br>
|
|
Args:<br>
|
|
http: An instance of httplib2.Http<br>
|
|
or something that acts like it.<br>
|
|
<br>
|
|
Returns:<br>
|
|
A modified instance of http that was passed in.<br>
|
|
<br>
|
|
Example:<br>
|
|
<br>
|
|
h = httplib2.Http()<br>
|
|
h = credentials.<a href="#OAuth2Credentials-authorize">authorize</a>(h)<br>
|
|
<br>
|
|
You can't create a new OAuth subclass of httplib2.Authenication<br>
|
|
because it never gets passed the absolute URI, which is needed for<br>
|
|
signing. So instead we have to overload 'request' with a closure<br>
|
|
that adds in the Authorization header and then calls the original<br>
|
|
version of 'request()'.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="OAuth2Credentials-set_store"><strong>set_store</strong></a>(self, store)</dt><dd><tt>Set the <a href="#Storage">Storage</a> for the credential.<br>
|
|
<br>
|
|
Args:<br>
|
|
store: <a href="#Storage">Storage</a>, an implementation of Stroage <a href="__builtin__.html#object">object</a>.<br>
|
|
This is needed to store the latest access_token if it<br>
|
|
has expired and been refreshed. This implementation uses<br>
|
|
locking to check for updates before updating the<br>
|
|
access_token.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="OAuth2Credentials-to_json"><strong>to_json</strong></a>(self)</dt></dl>
|
|
|
|
<hr>
|
|
Class methods defined here:<br>
|
|
<dl><dt><a name="OAuth2Credentials-from_json"><strong>from_json</strong></a>(cls, s)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Instantiate a <a href="#Credentials">Credentials</a> <a href="__builtin__.html#object">object</a> from a JSON description of it. The JSON<br>
|
|
should have been produced by calling .<a href="#OAuth2Credentials-to_json">to_json</a>() on the <a href="__builtin__.html#object">object</a>.<br>
|
|
<br>
|
|
Args:<br>
|
|
data: dict, A deserialized JSON <a href="__builtin__.html#object">object</a>.<br>
|
|
<br>
|
|
Returns:<br>
|
|
An instance of a <a href="#Credentials">Credentials</a> subclass.</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors defined here:<br>
|
|
<dl><dt><strong>access_token_expired</strong></dt>
|
|
<dd><tt>True if the credential is expired or invalid.<br>
|
|
<br>
|
|
If the token_expiry isn't set, we assume the token doesn't expire.</tt></dd>
|
|
</dl>
|
|
<hr>
|
|
Class methods inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:<br>
|
|
<dl><dt><a name="OAuth2Credentials-new_from_json"><strong>new_from_json</strong></a>(cls, s)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt><dd><tt>Utility class method to instantiate a <a href="#Credentials">Credentials</a> subclass from a JSON<br>
|
|
representation produced by <a href="#OAuth2Credentials-to_json">to_json</a>().<br>
|
|
<br>
|
|
Args:<br>
|
|
s: string, JSON from <a href="#OAuth2Credentials-to_json">to_json</a>().<br>
|
|
<br>
|
|
Returns:<br>
|
|
An instance of the subclass of <a href="#Credentials">Credentials</a> that was serialized with<br>
|
|
<a href="#OAuth2Credentials-to_json">to_json</a>().</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<hr>
|
|
Data and other attributes inherited from <a href="oauth2client.client.html#Credentials">Credentials</a>:<br>
|
|
<dl><dt><strong>NON_SERIALIZED_MEMBERS</strong> = ['store']</dl>
|
|
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#000000" face="helvetica, arial"><a name="OAuth2WebServerFlow">class <strong>OAuth2WebServerFlow</strong></a>(<a href="oauth2client.client.html#Flow">Flow</a>)</font></td></tr>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt>Does the Web Server <a href="#Flow">Flow</a> for OAuth 2.0.<br>
|
|
<br>
|
|
<a href="#OAuth2Credentials">OAuth2Credentials</a> objects may be safely pickled and unpickled.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="oauth2client.client.html#OAuth2WebServerFlow">OAuth2WebServerFlow</a></dd>
|
|
<dd><a href="oauth2client.client.html#Flow">Flow</a></dd>
|
|
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods defined here:<br>
|
|
<dl><dt><a name="OAuth2WebServerFlow-__init__"><strong>__init__</strong></a>(self, client_id, client_secret, scope, user_agent<font color="#909090">=None</font>, auth_uri<font color="#909090">='https://accounts.google.com/o/oauth2/auth'</font>, token_uri<font color="#909090">='https://accounts.google.com/o/oauth2/token'</font>, **kwargs)</dt><dd><tt>Constructor for <a href="#OAuth2WebServerFlow">OAuth2WebServerFlow</a>.<br>
|
|
<br>
|
|
Args:<br>
|
|
client_id: string, client identifier.<br>
|
|
client_secret: string client secret.<br>
|
|
scope: string or list of strings, scope(s) of the credentials being<br>
|
|
requested.<br>
|
|
user_agent: string, HTTP User-Agent to provide for this application.<br>
|
|
auth_uri: string, URI for authorization endpoint. For convenience<br>
|
|
defaults to Google's endpoints but any OAuth 2.0 provider can be used.<br>
|
|
token_uri: string, URI for token endpoint. For convenience<br>
|
|
defaults to Google's endpoints but any OAuth 2.0 provider can be used.<br>
|
|
**kwargs: dict, The keyword arguments are all optional and required<br>
|
|
parameters for the OAuth calls.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="OAuth2WebServerFlow-step1_get_authorize_url"><strong>step1_get_authorize_url</strong></a>(self, redirect_uri<font color="#909090">='oob'</font>)</dt><dd><tt>Returns a URI to redirect to the provider.<br>
|
|
<br>
|
|
Args:<br>
|
|
redirect_uri: string, Either the string 'oob' for a non-web-based<br>
|
|
application, or a URI that handles the callback from<br>
|
|
the authorization server.<br>
|
|
<br>
|
|
If redirect_uri is 'oob' then pass in the<br>
|
|
generated verification code to step2_exchange,<br>
|
|
otherwise pass in the query parameters received<br>
|
|
at the callback uri to step2_exchange.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="OAuth2WebServerFlow-step2_exchange"><strong>step2_exchange</strong></a>(self, code, http<font color="#909090">=None</font>)</dt><dd><tt>Exhanges a code for <a href="#OAuth2Credentials">OAuth2Credentials</a>.<br>
|
|
<br>
|
|
Args:<br>
|
|
code: string or dict, either the code as a string, or a dictionary<br>
|
|
of the query parameters to the redirect_uri, which contains<br>
|
|
the code.<br>
|
|
http: httplib2.Http, optional http instance to use to do the fetch</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="oauth2client.client.html#Flow">Flow</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#000000" face="helvetica, arial"><a name="Storage">class <strong>Storage</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt>Base class for all <a href="#Storage">Storage</a> objects.<br>
|
|
<br>
|
|
Store and retrieve a single credential. This class supports locking<br>
|
|
such that multiple processes and threads can operate on a single<br>
|
|
store.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%">Methods defined here:<br>
|
|
<dl><dt><a name="Storage-acquire_lock"><strong>acquire_lock</strong></a>(self)</dt><dd><tt>Acquires any lock necessary to access this <a href="#Storage">Storage</a>.<br>
|
|
<br>
|
|
This lock is not reentrant.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Storage-get"><strong>get</strong></a>(self)</dt><dd><tt>Retrieve credential.<br>
|
|
<br>
|
|
The <a href="#Storage">Storage</a> lock must *not* be held when this is called.<br>
|
|
<br>
|
|
Returns:<br>
|
|
oauth2client.client.<a href="#Credentials">Credentials</a></tt></dd></dl>
|
|
|
|
<dl><dt><a name="Storage-locked_get"><strong>locked_get</strong></a>(self)</dt><dd><tt>Retrieve credential.<br>
|
|
<br>
|
|
The <a href="#Storage">Storage</a> lock must be held when this is called.<br>
|
|
<br>
|
|
Returns:<br>
|
|
oauth2client.client.<a href="#Credentials">Credentials</a></tt></dd></dl>
|
|
|
|
<dl><dt><a name="Storage-locked_put"><strong>locked_put</strong></a>(self, credentials)</dt><dd><tt>Write a credential.<br>
|
|
<br>
|
|
The <a href="#Storage">Storage</a> lock must be held when this is called.<br>
|
|
<br>
|
|
Args:<br>
|
|
credentials: <a href="#Credentials">Credentials</a>, the credentials to store.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Storage-put"><strong>put</strong></a>(self, credentials)</dt><dd><tt>Write a credential.<br>
|
|
<br>
|
|
The <a href="#Storage">Storage</a> lock must be held when this is called.<br>
|
|
<br>
|
|
Args:<br>
|
|
credentials: <a href="#Credentials">Credentials</a>, the credentials to store.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="Storage-release_lock"><strong>release_lock</strong></a>(self)</dt><dd><tt>Release the <a href="#Storage">Storage</a> lock.<br>
|
|
<br>
|
|
Trying to release a lock that isn't held will result in a<br>
|
|
RuntimeError.</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data descriptors defined here:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
</dl>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
</td></tr></table> <p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#ffc8d8">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#000000" face="helvetica, arial"><a name="UnknownClientSecretsFlowError">class <strong>UnknownClientSecretsFlowError</strong></a>(<a href="oauth2client.client.html#Error">Error</a>)</font></td></tr>
|
|
|
|
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
<td colspan=2><tt>The client secrets file called for an unknown type of OAuth 2.0 flow.<br> </tt></td></tr>
|
|
<tr><td> </td>
|
|
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
<dd><a href="oauth2client.client.html#UnknownClientSecretsFlowError">UnknownClientSecretsFlowError</a></dd>
|
|
<dd><a href="oauth2client.client.html#Error">Error</a></dd>
|
|
<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
|
|
<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
|
|
<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
|
|
</dl>
|
|
<hr>
|
|
Data descriptors inherited from <a href="oauth2client.client.html#Error">Error</a>:<br>
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
</dl>
|
|
<hr>
|
|
Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
|
<dl><dt><a name="UnknownClientSecretsFlowError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownClientSecretsFlowError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>
|
|
|
|
<hr>
|
|
Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
|
|
<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#UnknownClientSecretsFlowError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>
|
|
|
|
<hr>
|
|
Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
|
<dl><dt><a name="UnknownClientSecretsFlowError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownClientSecretsFlowError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
|
|
|
|
<dl><dt><a name="UnknownClientSecretsFlowError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownClientSecretsFlowError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
|
|
|
|
<dl><dt><a name="UnknownClientSecretsFlowError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownClientSecretsFlowError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
|
|
|
|
<dl><dt><a name="UnknownClientSecretsFlowError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownClientSecretsFlowError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
|
|
<br>
|
|
Use of negative indices is not supported.</tt></dd></dl>
|
|
|
|
<dl><dt><a name="UnknownClientSecretsFlowError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
|
|
|
|
<dl><dt><a name="UnknownClientSecretsFlowError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownClientSecretsFlowError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="UnknownClientSecretsFlowError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownClientSecretsFlowError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>
|
|
|
|
<dl><dt><a name="UnknownClientSecretsFlowError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
|
|
|
|
<dl><dt><a name="UnknownClientSecretsFlowError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownClientSecretsFlowError-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
|
|
|
|
<dl><dt><a name="UnknownClientSecretsFlowError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
|
|
|
<hr>
|
|
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
|
<dl><dt><strong>__dict__</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>args</strong></dt>
|
|
</dl>
|
|
<dl><dt><strong>message</strong></dt>
|
|
</dl>
|
|
</td></tr></table></td></tr></table><p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#eeaa77">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
|
|
|
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
|
<td width="100%"><dl><dt><a name="-flow_from_clientsecrets"><strong>flow_from_clientsecrets</strong></a>(filename, scope, message<font color="#909090">=None</font>)</dt><dd><tt>Create a <a href="#Flow">Flow</a> from a clientsecrets file.<br>
|
|
<br>
|
|
Will create the right kind of <a href="#Flow">Flow</a> based on the contents of the clientsecrets<br>
|
|
file or will raise InvalidClientSecretsError for unknown types of Flows.<br>
|
|
<br>
|
|
Args:<br>
|
|
filename: string, File name of client secrets.<br>
|
|
scope: string or list of strings, scope(s) to request.<br>
|
|
message: string, A friendly string to display to the user if the<br>
|
|
clientsecrets file is missing or invalid. If message is provided then<br>
|
|
sys.exit will be called in the case of an error. If message in not<br>
|
|
provided then clientsecrets.InvalidClientSecretsError will be raised.<br>
|
|
<br>
|
|
Returns:<br>
|
|
A <a href="#Flow">Flow</a> <a href="__builtin__.html#object">object</a>.<br>
|
|
<br>
|
|
Raises:<br>
|
|
<a href="#UnknownClientSecretsFlowError">UnknownClientSecretsFlowError</a> if the file describes an unknown kind of <a href="#Flow">Flow</a>.<br>
|
|
clientsecrets.InvalidClientSecretsError if the clientsecrets file is<br>
|
|
invalid.</tt></dd></dl>
|
|
</td></tr></table><p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#55aa55">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
|
|
|
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
|
<td width="100%"><strong>EXPIRY_FORMAT</strong> = '%Y-%m-%dT%H:%M:%SZ'<br>
|
|
<strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'<br>
|
|
<strong>logger</strong> = <logging.Logger object></td></tr></table><p>
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
<tr bgcolor="#7799ee">
|
|
<td colspan=3 valign=bottom> <br>
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
|
|
|
|
<tr><td bgcolor="#7799ee"><tt> </tt></td><td> </td>
|
|
<td width="100%">jcgregorio@google.com (Joe Gregorio)</td></tr></table>
|
|
</body></html> |