blob: af69a5146d618fbba54f694bee6047537344ff35 [file] [log] [blame]
Joe Gregorio30dfdc32010-12-09 16:34:22 -05001
2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
3<html><head><title>Python: module apiclient.errors</title>
4</head><body bgcolor="#f0f0f8">
5
6<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
7<tr bgcolor="#7799ee">
8<td valign=bottom>&nbsp;<br>
9<font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="apiclient.html"><font color="#ffffff">apiclient</font></a>.errors</strong></big></big></font></td
10><td align=right valign=bottom
11><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/usr/local/google/home/jcgregorio/projects/apiary/apiclient/errors.py">/usr/local/google/home/jcgregorio/projects/apiary/apiclient/errors.py</a></font></td></tr></table>
12 <p><tt>Errors&nbsp;for&nbsp;the&nbsp;library.<br>
13&nbsp;<br>
14All&nbsp;exceptions&nbsp;defined&nbsp;by&nbsp;the&nbsp;library<br>
15should&nbsp;be&nbsp;defined&nbsp;in&nbsp;this&nbsp;file.</tt></p>
16<p>
17<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
18<tr bgcolor="#ee77aa">
19<td colspan=3 valign=bottom>&nbsp;<br>
20<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
21
22<tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
23<td width="100%"><dl>
24<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
25</font></dt><dd>
26<dl>
27<dt><font face="helvetica, arial"><a href="apiclient.errors.html#Error">Error</a>
28</font></dt><dd>
29<dl>
30<dt><font face="helvetica, arial"><a href="apiclient.errors.html#HttpError">HttpError</a>
31</font></dt><dt><font face="helvetica, arial"><a href="apiclient.errors.html#UnknownLinkType">UnknownLinkType</a>
32</font></dt></dl>
33</dd>
34</dl>
35</dd>
36</dl>
37 <p>
38<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
39<tr bgcolor="#ffc8d8">
40<td colspan=3 valign=bottom>&nbsp;<br>
41<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>
42
43<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
44<td colspan=2><tt>Base&nbsp;error&nbsp;for&nbsp;this&nbsp;module.<br>&nbsp;</tt></td></tr>
45<tr><td>&nbsp;</td>
46<td width="100%"><dl><dt>Method resolution order:</dt>
47<dd><a href="apiclient.errors.html#Error">Error</a></dd>
48<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
49<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
50<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
51</dl>
52<hr>
53Data descriptors defined here:<br>
54<dl><dt><strong>__weakref__</strong></dt>
55<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
56</dl>
57<hr>
58Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
59<dl><dt><a name="Error-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;x.__class__.__doc__&nbsp;for&nbsp;signature</tt></dd></dl>
60
61<hr>
62Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
63<dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#Error-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;object&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
64
65<hr>
66Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
67<dl><dt><a name="Error-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
68
69<dl><dt><a name="Error-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
70
71<dl><dt><a name="Error-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
72
73<dl><dt><a name="Error-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
74&nbsp;<br>
75Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
76
77<dl><dt><a name="Error-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
78
79<dl><dt><a name="Error-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
80
81<dl><dt><a name="Error-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
82
83<dl><dt><a name="Error-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
84
85<dl><dt><a name="Error-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#Error-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
86
87<dl><dt><a name="Error-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
88
89<hr>
90Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
91<dl><dt><strong>__dict__</strong></dt>
92</dl>
93<dl><dt><strong>args</strong></dt>
94</dl>
95<dl><dt><strong>message</strong></dt>
96</dl>
97</td></tr></table> <p>
98<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
99<tr bgcolor="#ffc8d8">
100<td colspan=3 valign=bottom>&nbsp;<br>
101<font color="#000000" face="helvetica, arial"><a name="HttpError">class <strong>HttpError</strong></a>(<a href="apiclient.errors.html#Error">Error</a>)</font></td></tr>
102
103<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
104<td colspan=2><tt>HTTP&nbsp;data&nbsp;was&nbsp;invalid&nbsp;or&nbsp;unexpected.<br>&nbsp;</tt></td></tr>
105<tr><td>&nbsp;</td>
106<td width="100%"><dl><dt>Method resolution order:</dt>
107<dd><a href="apiclient.errors.html#HttpError">HttpError</a></dd>
108<dd><a href="apiclient.errors.html#Error">Error</a></dd>
109<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
110<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
111<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
112</dl>
113<hr>
114Methods defined here:<br>
115<dl><dt><a name="HttpError-__init__"><strong>__init__</strong></a>(self, resp, detail)</dt></dl>
116
117<dl><dt><a name="HttpError-__str__"><strong>__str__</strong></a>(self)</dt></dl>
118
119<hr>
120Data descriptors inherited from <a href="apiclient.errors.html#Error">Error</a>:<br>
121<dl><dt><strong>__weakref__</strong></dt>
122<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
123</dl>
124<hr>
125Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
126<dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#HttpError-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;object&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
127
128<hr>
129Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
130<dl><dt><a name="HttpError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#HttpError-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
131
132<dl><dt><a name="HttpError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#HttpError-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
133
134<dl><dt><a name="HttpError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#HttpError-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
135
136<dl><dt><a name="HttpError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#HttpError-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
137&nbsp;<br>
138Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
139
140<dl><dt><a name="HttpError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
141
142<dl><dt><a name="HttpError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#HttpError-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
143
144<dl><dt><a name="HttpError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#HttpError-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
145
146<dl><dt><a name="HttpError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
147
148<dl><dt><a name="HttpError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
149
150<hr>
151Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
152<dl><dt><strong>__dict__</strong></dt>
153</dl>
154<dl><dt><strong>args</strong></dt>
155</dl>
156<dl><dt><strong>message</strong></dt>
157</dl>
158</td></tr></table> <p>
159<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
160<tr bgcolor="#ffc8d8">
161<td colspan=3 valign=bottom>&nbsp;<br>
162<font color="#000000" face="helvetica, arial"><a name="UnknownLinkType">class <strong>UnknownLinkType</strong></a>(<a href="apiclient.errors.html#Error">Error</a>)</font></td></tr>
163
164<tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
165<td colspan=2><tt>Link&nbsp;type&nbsp;unknown&nbsp;or&nbsp;unexpected.<br>&nbsp;</tt></td></tr>
166<tr><td>&nbsp;</td>
167<td width="100%"><dl><dt>Method resolution order:</dt>
168<dd><a href="apiclient.errors.html#UnknownLinkType">UnknownLinkType</a></dd>
169<dd><a href="apiclient.errors.html#Error">Error</a></dd>
170<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>
171<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>
172<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
173</dl>
174<hr>
175Data descriptors inherited from <a href="apiclient.errors.html#Error">Error</a>:<br>
176<dl><dt><strong>__weakref__</strong></dt>
177<dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
178</dl>
179<hr>
180Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
181<dl><dt><a name="UnknownLinkType-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownLinkType-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;x.__class__.__doc__&nbsp;for&nbsp;signature</tt></dd></dl>
182
183<hr>
184Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br>
185<dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object&gt;<dd><tt>T.<a href="#UnknownLinkType-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;object&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
186
187<hr>
188Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
189<dl><dt><a name="UnknownLinkType-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownLinkType-__delattr__">__delattr__</a>('name')&nbsp;&lt;==&gt;&nbsp;del&nbsp;x.name</tt></dd></dl>
190
191<dl><dt><a name="UnknownLinkType-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownLinkType-__getattribute__">__getattribute__</a>('name')&nbsp;&lt;==&gt;&nbsp;x.name</tt></dd></dl>
192
193<dl><dt><a name="UnknownLinkType-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownLinkType-__getitem__">__getitem__</a>(y)&nbsp;&lt;==&gt;&nbsp;x[y]</tt></dd></dl>
194
195<dl><dt><a name="UnknownLinkType-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownLinkType-__getslice__">__getslice__</a>(i,&nbsp;j)&nbsp;&lt;==&gt;&nbsp;x[i:j]<br>
196&nbsp;<br>
197Use&nbsp;of&nbsp;negative&nbsp;indices&nbsp;is&nbsp;not&nbsp;supported.</tt></dd></dl>
198
199<dl><dt><a name="UnknownLinkType-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
200
201<dl><dt><a name="UnknownLinkType-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownLinkType-__repr__">__repr__</a>()&nbsp;&lt;==&gt;&nbsp;repr(x)</tt></dd></dl>
202
203<dl><dt><a name="UnknownLinkType-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownLinkType-__setattr__">__setattr__</a>('name',&nbsp;value)&nbsp;&lt;==&gt;&nbsp;x.name&nbsp;=&nbsp;value</tt></dd></dl>
204
205<dl><dt><a name="UnknownLinkType-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl>
206
207<dl><dt><a name="UnknownLinkType-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#UnknownLinkType-__str__">__str__</a>()&nbsp;&lt;==&gt;&nbsp;str(x)</tt></dd></dl>
208
209<dl><dt><a name="UnknownLinkType-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
210
211<hr>
212Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
213<dl><dt><strong>__dict__</strong></dt>
214</dl>
215<dl><dt><strong>args</strong></dt>
216</dl>
217<dl><dt><strong>message</strong></dt>
218</dl>
219</td></tr></table></td></tr></table><p>
220<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
221<tr bgcolor="#55aa55">
222<td colspan=3 valign=bottom>&nbsp;<br>
223<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
224
225<tr><td bgcolor="#55aa55"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
226<td width="100%"><strong>__author__</strong> = 'jcgregorio@google.com (Joe Gregorio)'</td></tr></table><p>
227<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
228<tr bgcolor="#7799ee">
229<td colspan=3 valign=bottom>&nbsp;<br>
230<font color="#ffffff" face="helvetica, arial"><big><strong>Author</strong></big></font></td></tr>
231
232<tr><td bgcolor="#7799ee"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
233<td width="100%">jcgregorio@google.com&nbsp;(Joe&nbsp;Gregorio)</td></tr></table>
234</body></html>