Blame - docs/oauth2client.multistore_file.html - platform/external/python/google-api-python-client

><a href=".">index</a> <a href="file:/home/jcgregorio/projects/google-api-python-client/oauth2client/multistore_file.py">/home/jcgregorio/projects/google-api-python-client/oauth2client/multistore_file.py</a></td></tr></table>

Joe Gregorio

a845167

2011-09-15 09:53:21 -0400

[diff] [blame]

12

<tt>Multi-credential file store with lock support.

13

14

This module implements a JSON credential store where multiple

15

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

16

both in a single process and across processes.

17

18

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>',

30

'userAgent': '<user agent>',

'scope': '<scope>'

},

'credential': {

# JSON serialized Credentials.

}

}

]

}</tt>

<big>Modules</big></td></tr>

Joe Gregorio

2012-02-21 10:11:19 -0500

[diff] [blame]

47

<a href="errno.html">errno</a>

48

</td><td width="25%" valign=top><a href="fcntl.html">fcntl</a>

49

<a href="logging.html">logging</a>

50

</td><td width="25%" valign=top><a href="os.html">os</a>

51

52

</td><td width="25%" valign=top><a href="threading.html">threading</a>

53

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

Joe Gregorio

a845167

2011-09-15 09:53:21 -0400

[diff] [blame]

<big>Classes</big></td></tr>

<dt><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)

62

</dt><dd>

63

<dl>

64

<dt><a href="oauth2client.multistore_file.html#Error">Error</a>

65

</dt><dd>

66

<dl>

67

<dt><a href="oauth2client.multistore_file.html#NewerCredentialStoreError">NewerCredentialStoreError</a>

</dt></dl>

</dd>

</dl>

</dd>

</dl>

<a name="Error">class Error</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</td></tr>

78

79

80

<td colspan=2><tt>Base error for this module.  </tt></td></tr>

81

82

<td width="100%"><dl><dt>Method resolution order:</dt>

83

<dd><a href="oauth2client.multistore_file.html#Error">Error</a></dd>

84

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

85

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

86

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

87

</dl>

88

<hr>

89

Data descriptors defined here:

90

<dl><dt>__weakref__</dt>

91

<dd><tt>list of weak references to the object (if defined)</tt></dd>

92

</dl>

93

<hr>

94

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

b417caf

2011-12-08 12:04:24 -0500

[diff] [blame]

95

<dl><dt><a name="Error-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#Error-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl>

Joe Gregorio

a845167

2011-09-15 09:53:21 -0400

[diff] [blame]

96

97

<hr>

98

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

99

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#Error-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>

100

101

<hr>

102

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

103

<dl><dt><a name="Error-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#Error-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

104

105

<dl><dt><a name="Error-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#Error-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

106

107

<dl><dt><a name="Error-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#Error-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

108

109

<dl><dt><a name="Error-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#Error-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

110

111

Use of negative indices is not supported.</tt></dd></dl>

112

113

<dl><dt><a name="Error-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="Error-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#Error-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

118

119

<dl><dt><a name="Error-__setstate__">__setstate__</a>(...)</dt></dl>

<dl><dt><a name="Error-__unicode__">__unicode__</a>(...)</dt></dl>

124

125

<hr>

126

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

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

<a name="NewerCredentialStoreError">class NewerCredentialStoreError</a>(<a href="oauth2client.multistore_file.html#Error">Error</a>)</td></tr>

138

139

140

<td colspan=2><tt>The credential store is a newer version that supported.  </tt></td></tr>

141

142

<td width="100%"><dl><dt>Method resolution order:</dt>

143

<dd><a href="oauth2client.multistore_file.html#NewerCredentialStoreError">NewerCredentialStoreError</a></dd>

144

<dd><a href="oauth2client.multistore_file.html#Error">Error</a></dd>

145

<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

146

<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

147

<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

148

</dl>

149

<hr>

150

Data descriptors inherited from <a href="oauth2client.multistore_file.html#Error">Error</a>:

151

<dl><dt>__weakref__</dt>

152

<dd><tt>list of weak references to the object (if defined)</tt></dd>

153

</dl>

154

<hr>

155

Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

Joe Gregorio

b417caf

2011-12-08 12:04:24 -0500

[diff] [blame]

156

<dl><dt><a name="NewerCredentialStoreError-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#NewerCredentialStoreError-__init__">__init__</a>(...) initializes x; see x.__class__.__doc__ for signature</tt></dd></dl>

Joe Gregorio

a845167

2011-09-15 09:53:21 -0400

[diff] [blame]

157

158

<hr>

159

Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

160

<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#NewerCredentialStoreError-__new__">__new__</a>(S, ...) -> a new object with type S, a subtype of T</tt></dl>

161

162

<hr>

163

Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

164

<dl><dt><a name="NewerCredentialStoreError-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#NewerCredentialStoreError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

165

166

<dl><dt><a name="NewerCredentialStoreError-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#NewerCredentialStoreError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

167

168

<dl><dt><a name="NewerCredentialStoreError-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#NewerCredentialStoreError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

169

170

<dl><dt><a name="NewerCredentialStoreError-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#NewerCredentialStoreError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

171

172

Use of negative indices is not supported.</tt></dd></dl>

173

174

<dl><dt><a name="NewerCredentialStoreError-__reduce__">__reduce__</a>(...)</dt></dl>

<dl><dt><a name="NewerCredentialStoreError-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#NewerCredentialStoreError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

179

180

<dl><dt><a name="NewerCredentialStoreError-__setstate__">__setstate__</a>(...)</dt></dl>

<dl><dt><a name="NewerCredentialStoreError-__unicode__">__unicode__</a>(...)</dt></dl>

185

186

<hr>

187

Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

</dl>

</dl>

<dl><dt>message</dt>

</dl>

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

<big>Functions</big></td></tr>

199

200

201

<td width="100%"><dl><dt><a name="-get_credential_storage">get_credential_storage</a>(filename, client_id, user_agent, scope, warn_on_readonly=True)</dt><dd><tt>Get a Storage instance for a credential.

202

203

Args:

204

filename: The JSON file storing a set of credentials

205

client_id: The client_id for the credential

206

user_agent: The user agent for the credential

Joe Gregorio

761c456

2011-10-28 14:36:24 -0400