docs/epy/oauth2client.multistore_file-module.html - Issue 6305043: Switch to epydoc for documenting library.

Unified Diff: docs/epy/oauth2client.multistore_file-module.html

Issue 6305043: Switch to epydoc for documenting library. (Closed)

Patch Set: Revert old pydocs, they didn't really change. Created 12 years, 9 months ago

Use n/p to move between diff chunks; N/P to move between comments. Please Sign in to add in-line comments.

Jump to:

View side-by-side diff with in-line comments

Index: docs/epy/oauth2client.multistore_file-module.html

===================================================================

new file mode 100644

--- /dev/null

+++ b/docs/epy/oauth2client.multistore_file-module.html

@@ -0,0 +1,316 @@

+<?xml version="1.0" encoding="ascii"?>

+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"

+ "DTD/xhtml1-transitional.dtd">

+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">

+<head>

+ <title>oauth2client.multistore_file</title>

+ <link rel="stylesheet" href="epydoc.css" type="text/css" />

+ <script type="text/javascript" src="epydoc.js"></script>

+</head>

+<body bgcolor="white" text="black" link="blue" vlink="#204080"

+ alink="#204080">

+

+<table class="navbar" border="0" width="100%" cellpadding="0"

+ bgcolor="#a0c0ff" cellspacing="0">

+ <tr valign="middle">

+

+ <th>   <a

+ href="module-tree.html">Trees</a>   </th>

+

+ <th>   <a

+ href="identifier-index.html">Indices</a>   </th>

+

+ <th>   <a

+ href="help.html">Help</a>   </th>

+ <th class="navbar" width="100%"></th>

+ </tr>

+</table>

+<table width="100%" cellpadding="0" cellspacing="0">

+ <tr valign="top">

+ <td width="100%">

+ <span class="breadcrumbs">

+ <a href="oauth2client-module.html">Package oauth2client</a> ::

+ Module multistore_file

+ </span>

+ </td>

+ <td>

+ <table cellpadding="0" cellspacing="0">

+

+ <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"

+ onclick="toggle_private();">hide private</a>]</span></td></tr>

+ <tr><td align="right"><span class="options"

+ >[<a href="frames.html" target="_top">frames</a

+ >] | <a href="oauth2client.multistore_file-module.html"

+ target="_top">no frames</a>]</span></td></tr>

+ </table>

+ </td>

+ </tr>

+</table>

+

+<h1 class="epydoc">Module multistore_file</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.multistore_file-pysrc.html">source code</a></span></p>

+<pre class="literalblock">

+Multi-credential file store with lock support.

+This module implements a JSON credential store where multiple

+credentials can be stored in one file. That file supports locking

+both in a single process and across processes.

+The credential themselves are keyed off of:

+* client_id

+* user_agent

+* scope

+The format of the stored data is like so:

+ 'file_version': 1,

+ 'data': [

+ {

+ 'key': {

+ 'clientId': '<client id>',

+ 'userAgent': '<user agent>',

+ 'scope': '<scope>'

+ },

+ 'credential': {

+ # JSON serialized Credentials.

+ }

+ ]

+</pre>

+<hr />

+<div class="fields"> <p><strong>Author:</strong>

+ jbeda@google.com (Joe Beda)

+ </p>

+</div>

+<a name="section-Classes"></a>

+<table class="summary" border="1" cellpadding="3"

+ cellspacing="0" width="100%" bgcolor="white">

+<tr bgcolor="#70b0f0" class="table-header">

+ <td colspan="2" class="table-header">

+ <table border="0" cellpadding="0" cellspacing="0" width="100%">

+ <tr valign="top">

+ <td align="left"><span class="table-header">Classes</span></td>

+ <td align="right" valign="top"

+ ><span class="options">[<a href="#section-Classes"

+ class="privatelink" onclick="toggle_private();"

+ >hide private</a>]</span></td>

+ </tr>

+ </table>

+ </td>

+</tr>

+<tr>

+ <td width="15%" align="right" valign="top" class="summary">

+ <span class="summary-type"> </span>

+ </td><td class="summary">

+ <a href="oauth2client.multistore_file.Error-class.html" class="summary-name">Error</a><br />

+ Base error for this module.

+ </td>

+ </tr>

+<tr>

+ <td width="15%" align="right" valign="top" class="summary">

+ <span class="summary-type"> </span>

+ </td><td class="summary">

+ <a href="oauth2client.multistore_file.NewerCredentialStoreError-class.html" class="summary-name">NewerCredentialStoreError</a><br />

+ The credential store is a newer version that supported.

+ </td>

+ </tr>

+<tr class="private">

+ <td width="15%" align="right" valign="top" class="summary">

+ <span class="summary-type"> </span>

+ </td><td class="summary">

+ <a href="oauth2client.multistore_file._MultiStore-class.html" class="summary-name" onclick="show_private();">_MultiStore</a><br />

+ A file backed store for multiple credentials.

+ </td>

+ </tr>

+</table>

+

+<a name="section-Functions"></a>

+<table class="summary" border="1" cellpadding="3"

+ cellspacing="0" width="100%" bgcolor="white">

+<tr bgcolor="#70b0f0" class="table-header">

+ <td colspan="2" class="table-header">

+ <table border="0" cellpadding="0" cellspacing="0" width="100%">

+ <tr valign="top">

+ <td align="left"><span class="table-header">Functions</span></td>

+ <td align="right" valign="top"

+ ><span class="options">[<a href="#section-Functions"

+ class="privatelink" onclick="toggle_private();"

+ >hide private</a>]</span></td>

+ </tr>

+ </table>

+ </td>

+</tr>

+<tr>

+ <td width="15%" align="right" valign="top" class="summary">

+ <span class="summary-type"> </span>

+ </td><td class="summary">

+ <table width="100%" cellpadding="0" cellspacing="0" border="0">

+ <tr>

+ <td><span class="summary-sig"><a href="oauth2client.multistore_file-module.html#get_credential_storage" class="summary-sig-name">get_credential_storage</a>(<span class="summary-sig-arg">filename</span>,

+ <span class="summary-sig-arg">client_id</span>,

+ <span class="summary-sig-arg">user_agent</span>,

+ <span class="summary-sig-arg">scope</span>,

+ <span class="summary-sig-arg">warn_on_readonly</span>=<span class="summary-sig-default">True</span>)</span><br />

+ Get a Storage instance for a credential.</td>

+ <td align="right" valign="top">

+ <span class="codelink"><a href="oauth2client.multistore_file-pysrc.html#get_credential_storage">source code</a></span>

+ </td>

+ </tr>

+ </table>

+ </td>

+ </tr>

+</table>

+

+<a name="section-Variables"></a>

+<table class="summary" border="1" cellpadding="3"

+ cellspacing="0" width="100%" bgcolor="white">

+<tr bgcolor="#70b0f0" class="table-header">

+ <td colspan="2" class="table-header">

+ <table border="0" cellpadding="0" cellspacing="0" width="100%">

+ <tr valign="top">

+ <td align="left"><span class="table-header">Variables</span></td>

+ <td align="right" valign="top"

+ ><span class="options">[<a href="#section-Variables"

+ class="privatelink" onclick="toggle_private();"

+ >hide private</a>]</span></td>

+ </tr>

+ </table>

+ </td>

+</tr>

+<tr>

+ <td width="15%" align="right" valign="top" class="summary">

+ <span class="summary-type"> </span>

+ </td><td class="summary">

+ <a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger(__name__)">logging.getLogger(__name__)</code>

+ </td>

+ </tr>

+<tr class="private">

+ <td width="15%" align="right" valign="top" class="summary">

+ <span class="summary-type"> </span>

+ </td><td class="summary">

+ <a name="_multistores"></a><span class="summary-name">_multistores</span> = <code title="{}"><code class="variable-group">{</code><code class="variable-group">}</code></code>

+ </td>

+ </tr>

+<tr class="private">

+ <td width="15%" align="right" valign="top" class="summary">

+ <span class="summary-type"> </span>

+ </td><td class="summary">

+ <a name="_multistores_lock"></a><span class="summary-name">_multistores_lock</span> = <code title="threading.Lock()">threading.Lock()</code>

+ </td>

+ </tr>

+<tr>

+ <td width="15%" align="right" valign="top" class="summary">

+ <span class="summary-type"> </span>

+ </td><td class="summary">

+ <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'oauth2client'"><code class="variable-quote">'</code><code class="variable-string">oauth2client</code><code class="variable-quote">'</code></code>

+ </td>

+ </tr>

+</table>

+

+<a name="section-FunctionDetails"></a>

+<table class="details" border="1" cellpadding="3"

+ cellspacing="0" width="100%" bgcolor="white">

+<tr bgcolor="#70b0f0" class="table-header">

+ <td colspan="2" class="table-header">

+ <table border="0" cellpadding="0" cellspacing="0" width="100%">

+ <tr valign="top">

+ <td align="left"><span class="table-header">Function Details</span></td>

+ <td align="right" valign="top"

+ ><span class="options">[<a href="#section-FunctionDetails"

+ class="privatelink" onclick="toggle_private();"

+ >hide private</a>]</span></td>

+ </tr>

+ </table>

+ </td>

+</tr>

+</table>

+<a name="get_credential_storage"></a>

+<div>

+<table class="details" border="1" cellpadding="3"

+ cellspacing="0" width="100%" bgcolor="white">

+<tr><td>

+ <table width="100%" cellpadding="0" cellspacing="0" border="0">

+ <tr valign="top"><td>

+ <h3 class="epydoc"><span class="sig"><span class="sig-name">get_credential_storage</span>(<span class="sig-arg">filename</span>,

+ <span class="sig-arg">client_id</span>,

+ <span class="sig-arg">user_agent</span>,

+ <span class="sig-arg">scope</span>,

+ <span class="sig-arg">warn_on_readonly</span>=<span class="sig-default">True</span>)</span>

+ </h3>

+ </td><td align="right" valign="top"

+ ><span class="codelink"><a href="oauth2client.multistore_file-pysrc.html#get_credential_storage">source code</a></span> 

+ </td>

+ </tr></table>

+ <pre class="literalblock">

+Get a Storage instance for a credential.

+Args:

+ filename: The JSON file storing a set of credentials

+ client_id: The client_id for the credential

+ user_agent: The user agent for the credential

+ scope: string or list of strings, Scope(s) being requested

+ warn_on_readonly: if True, log a warning if the store is readonly

+Returns:

+ An object derived from client.Storage for getting/setting the

+ credential.

+</pre>

+ <dl class="fields">

+ </dl>

+</td></tr></table>

+</div>

+<br />

+

+<table class="navbar" border="0" width="100%" cellpadding="0"

+ bgcolor="#a0c0ff" cellspacing="0">

+ <tr valign="middle">

+

+ <th>   <a

+ href="module-tree.html">Trees</a>   </th>

+

+ <th>   <a

+ href="identifier-index.html">Indices</a>   </th>

+

+ <th>   <a

+ href="help.html">Help</a>   </th>

+ <th class="navbar" width="100%"></th>

+ </tr>

+</table>

+<table border="0" cellpadding="0" cellspacing="0" width="100%%">

+ <tr>

+ <td align="left" class="footer">

+ Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:05 2012

+ </td>

+ <td align="right" class="footer">

+ <a target="mainFrame" href="http://epydoc.sourceforge.net"

+ >http://epydoc.sourceforge.net</a>

+ </td>

+ </tr>

+</table>

+<script type="text/javascript">

+ <!--

+ // Private objects are initially displayed (because if

+ // javascript is turned off then we want them to be

+ // visible); but by default, we want to hide them. So hide

+ // them unless we have a cookie that says to show them.

+ checkCookie();

+ // -->

+</script>

+</body>

+</html>

« no previous file with comments | « docs/epy/oauth2client.file.Storage-class.html ('k') | docs/epy/oauth2client.multistore_file-pysrc.html » ('j') | no next file with comments »