1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
|
<?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>Camelot.camelot.core.files.storage.Storage</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">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Camelot.camelot-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.python-camelot.com">Camelot</a></th>
</tr></table></th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<span class="breadcrumbs">
Package Camelot ::
<a href="Camelot.camelot-module.html">Package camelot</a> ::
<a href="Camelot.camelot.core-module.html">Package core</a> ::
<a href="Camelot.camelot.core.files-module.html">Package files</a> ::
<a href="Camelot.camelot.core.files.storage-module.html">Module storage</a> ::
Class Storage
</span>
</td>
<td>
<table cellpadding="0" cellspacing="0">
<!-- hide/show private -->
<tr><td align="right"><span class="options"
>[<a href="frames.html" target="_top">frames</a
>] | <a href="Camelot.camelot.core.files.storage.Storage-class.html"
target="_top">no frames</a>]</span></td></tr>
</table>
</td>
</tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class Storage</h1><p class="nomargin-top"><span class="codelink"><a href="Camelot.camelot.core.files.storage-pysrc.html#Storage">source code</a></span></p>
<center>
<center> <map id="uml_class_diagram_for_camelot__29" name="uml_class_diagram_for_camelot__29">
<area shape="rect" href="Camelot.camelot.core.files.storage.Storage-class.html#__init__" title="checking out files from the storage" alt="" coords="17,36,663,55"/>
<area shape="rect" href="Camelot.camelot.core.files.storage.Storage-class.html#available" title="Verify if the storage is available" alt="" coords="17,55,663,73"/>
<area shape="rect" href="Camelot.camelot.core.files.storage.Storage-class.html#exists" title="True if a file exists given some name" alt="" coords="17,73,663,92"/>
<area shape="rect" href="Camelot.camelot.core.files.storage.Storage-class.html#list" title="Lists all files with a given prefix and or suffix available in this storage :return: a iterator of StoredFile objects" alt="" coords="17,92,663,111"/>
<area shape="rect" href="Camelot.camelot.core.files.storage.Storage-class.html#path" title="The local filesystem path where the file can be opened using Python’s standard open" alt="" coords="17,111,663,129"/>
<area shape="rect" href="Camelot.camelot.core.files.storage.Storage-class.html#checkin" title="Check the file pointed to by local_path into the storage, and return a StoredFile" alt="" coords="17,129,663,148"/>
<area shape="rect" href="Camelot.camelot.core.files.storage.Storage-class.html#checkin_stream" title="Check the datastream in as a file into the storage :param prefix: the prefix to use for generating a file name :param suffix: the suffix to use for generating a filen name, eg '.png' :return: a StoredFile" alt="" coords="17,148,663,167"/>
<area shape="rect" href="Camelot.camelot.core.files.storage.Storage-class.html#checkout" title="Check the file pointed to by the local_path out of the storage and return a local filesystem path where the file can be opened" alt="" coords="17,167,663,185"/>
<area shape="rect" href="Camelot.camelot.core.files.storage.Storage-class.html#checkout_stream" title="Check the file stored_file out of the storage as a datastream :return: a file object" alt="" coords="17,185,663,204"/>
<area shape="rect" href="Camelot.camelot.core.files.storage.Storage-class.html#delete" title="Camelot.camelot.core.files.storage.Storage.delete" alt="" coords="17,204,663,223"/>
<area shape="rect" href="Camelot.camelot.core.files.storage.Storage-class.html" title="Helper class that opens and saves StoredFile objects The default implementation stores files in the settings.CAMELOT_MEDIA_ROOT directory. The storage object should only be used within the model thread, as all of it's methods might block." alt="" coords="16,11,664,224"/>
</map>
<img src="uml_class_diagram_for_camelot__29.gif" alt='' usemap="#uml_class_diagram_for_camelot__29" ismap="ismap" class="graph-without-title" />
</center>
</center>
<hr />
<p>Helper class that opens and saves StoredFile objects
The default implementation stores files in the settings.CAMELOT_MEDIA_ROOT
directory. The storage object should only be used within the model thread,
as all of it's methods might block.</p>
<p>The methods of this class don't verify if they are called on the model
thread, because these classes can be used on the server as well.</p>
<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Instance Methods</span></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="Camelot.camelot.core.files.storage.Storage-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">upload_to</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">stored_file_implementation</span>=<span class="summary-sig-default"><class 'Camelot.camelot.core.files.storage.StoredFile'></span>)</span><br />
checking out files from the storage</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.core.files.storage-pysrc.html#Storage.__init__">source code</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 name="available"></a><span class="summary-sig-name">available</span>(<span class="summary-sig-arg">self</span>)</span><br />
Verify if the storage is available</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.core.files.storage-pysrc.html#Storage.available">source code</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 name="exists"></a><span class="summary-sig-name">exists</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>)</span><br />
True if a file exists given some name</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.core.files.storage-pysrc.html#Storage.exists">source code</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 name="list"></a><span class="summary-sig-name">list</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">prefix</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">*</code><code class="variable-quote">'</code></span>,
<span class="summary-sig-arg">suffix</span>=<span class="summary-sig-default"><code class="variable-quote">'</code><code class="variable-string">*</code><code class="variable-quote">'</code></span>)</span><br />
Lists all files with a given prefix and or suffix available in this storage
:return: a iterator of StoredFile objects</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.core.files.storage-pysrc.html#Storage.list">source code</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 name="path"></a><span class="summary-sig-name">path</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>)</span><br />
The local filesystem path where the file can be opened using Python’s standard open</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.core.files.storage-pysrc.html#Storage.path">source code</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 name="checkin"></a><span class="summary-sig-name">checkin</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">local_path</span>)</span><br />
Check the file pointed to by local_path into the storage, and
return a StoredFile</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.core.files.storage-pysrc.html#Storage.checkin">source code</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 name="checkin_stream"></a><span class="summary-sig-name">checkin_stream</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">prefix</span>,
<span class="summary-sig-arg">suffix</span>,
<span class="summary-sig-arg">stream</span>)</span><br />
Check the datastream in as a file into the storage
:param prefix: the prefix to use for generating a file name
:param suffix: the suffix to use for generating a filen name, eg '.png'
:return: a StoredFile</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.core.files.storage-pysrc.html#Storage.checkin_stream">source code</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 name="checkout"></a><span class="summary-sig-name">checkout</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">stored_file</span>)</span><br />
Check the file pointed to by the local_path out of the storage and return
a local filesystem path where the file can be opened</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.core.files.storage-pysrc.html#Storage.checkout">source code</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 name="checkout_stream"></a><span class="summary-sig-name">checkout_stream</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">stored_file</span>)</span><br />
Check the file stored_file out of the storage as a datastream
:return: a file object</td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.core.files.storage-pysrc.html#Storage.checkout_stream">source code</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 name="delete"></a><span class="summary-sig-name">delete</span>(<span class="summary-sig-arg">self</span>,
<span class="summary-sig-arg">name</span>)</span></td>
<td align="right" valign="top">
<span class="codelink"><a href="Camelot.camelot.core.files.storage-pysrc.html#Storage.delete">source code</a></span>
</td>
</tr>
</table>
</td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__delattr__</code>,
<code>__format__</code>,
<code>__getattribute__</code>,
<code>__hash__</code>,
<code>__new__</code>,
<code>__reduce__</code>,
<code>__reduce_ex__</code>,
<code>__repr__</code>,
<code>__setattr__</code>,
<code>__sizeof__</code>,
<code>__str__</code>,
<code>__subclasshook__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Properties</span></td>
</tr>
<tr>
<td colspan="2" class="summary">
<p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
<code>__class__</code>
</p>
</td>
</tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
<td align="left" colspan="2" class="table-header">
<span class="table-header">Method Details</span></td>
</tr>
</table>
<a name="__init__"></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">__init__</span>(<span class="sig-arg">self</span>,
<span class="sig-arg">upload_to</span>=<span class="sig-default"><code class="variable-quote">'</code><code class="variable-string"></code><code class="variable-quote">'</code></span>,
<span class="sig-arg">stored_file_implementation</span>=<span class="sig-default"><class 'Camelot.camelot.core.files.storage.StoredFile'></span>)</span>
<br /><em class="fname">(Constructor)</em>
</h3>
</td><td align="right" valign="top"
><span class="codelink"><a href="Camelot.camelot.core.files.storage-pysrc.html#Storage.__init__">source code</a></span>
</td>
</tr></table>
checking out files from the storage
<dl class="fields">
<dt>Parameters:</dt>
<dd><ul class="nomargin-top">
<li><strong class="pname"><code>upload_to</code></strong> - the sub directory in which to put files</li>
<li><strong class="pname"><code>stored_file_implementation</code></strong> - the subclass of StoredFile to be used when</li>
</ul></dd>
<dt>Overrides:
object.__init__
</dt>
</dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
<tr valign="middle">
<!-- Home link -->
<th> <a
href="Camelot.camelot-module.html">Home</a> </th>
<!-- Tree link -->
<th> <a
href="module-tree.html">Trees</a> </th>
<!-- Index link -->
<th> <a
href="identifier-index.html">Indices</a> </th>
<!-- Help link -->
<th> <a
href="help.html">Help</a> </th>
<!-- Project homepage -->
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center"
><a class="navbar" target="_top" href="http://www.python-camelot.com">Camelot</a></th>
</tr></table></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 Sat Jun 12 15:41:32 2010
</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>
|
