forked from googleapis/google-cloud-python
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathkey.html
More file actions
515 lines (411 loc) · 45.3 KB
/
key.html
File metadata and controls
515 lines (411 loc) · 45.3 KB
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
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>gcloud.storage.key — gcloud 0.1 documentation</title>
<link rel="stylesheet" href="../../../_static/style.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/custom.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '0.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<script type="text/javascript" src="../../../_static/sidebar.js"></script>
<link rel="top" title="gcloud 0.1 documentation" href="../../../index.html" />
<link rel="up" title="Module code" href="../../index.html" />
</head>
<body role="document" class="two-column docs"><a href="https://github.com/GoogleCloudPlatform/gcloud-python"><img style="position: absolute; top: 0; right: 0; border: 0; z-index: 999;" src="_static/forkme.png" alt="Fork me on GitHub"></a>
<div id="sandbar">
<header id="gc-googlebar">
<a id="gc-logo" href="../../../index.html">
<img src="_static/cloudplatform-horizontal.png" alt="Google">
</a>
<form class="gc-search" action="search.html" method="GET">
<div class="searchbox" style="width: 429px;">
<span class="button button-blue mini">Google Cloud Python API</span>
<input type="hidden" name="check_keywords" value="yes">
<input type="hidden" name="area" value="default">
<input type="text" name="q" class="q" id="q" value=""
placeholder="Search" autocomplete="off" style="width: 263px;">
</div>
<button class="button button-blue" style="top: 0px; left: 444px;">
<img src="_static/search.png" alt="Search">
</button>
<input type="hidden" name="p" id="search_project" value="/compute">
</form>
</header>
</div>
<div id="gc-wrapper">
<div id="gc-appbar">
<h1><a href="../../../index.html">gcloud 0.1 documentation</a></h1>
</div>
<div id="gc-main" class="main">
<div id="gc-sidebar" class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3>All API Docs</h3>
<nav class="gc-toc">
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../datastore-api.html">Cloud Datastore</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../storage-api.html">Cloud Storage</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../common-api.html">Cloud Common</a></li>
</ul>
</nav>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main" id="gc-content">
<h1>Source code for gcloud.storage.key</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">errno</span>
<span class="kn">import</span> <span class="nn">json</span>
<span class="kn">import</span> <span class="nn">mimetypes</span>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">from</span> <span class="nn">StringIO</span> <span class="kn">import</span> <span class="n">StringIO</span>
<span class="kn">from</span> <span class="nn">gcloud.storage.acl</span> <span class="kn">import</span> <span class="n">ObjectACL</span>
<span class="kn">from</span> <span class="nn">gcloud.storage.iterator</span> <span class="kn">import</span> <span class="n">KeyDataIterator</span>
<div class="viewcode-block" id="Key"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key">[docs]</a><span class="k">class</span> <span class="nc">Key</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="sd">"""A wrapper around Cloud Storage's concept of an ``Object``."""</span>
<span class="n">CHUNK_SIZE</span> <span class="o">=</span> <span class="mi">1024</span> <span class="o">*</span> <span class="mi">1024</span> <span class="c"># 1 MB.</span>
<span class="sd">"""The size of a chunk of data whenever iterating (1 MB).</span>
<span class="sd"> This must be a multiple of 256 KB per the API specification.</span>
<span class="sd"> """</span>
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bucket</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""</span>
<span class="sd"> :type bucket: :class:`gcloud.storage.bucket.Bucket`</span>
<span class="sd"> :param bucket: The bucket to which this key belongs.</span>
<span class="sd"> :type name: string</span>
<span class="sd"> :param name: The name of the key.</span>
<span class="sd"> This corresponds to the unique path of the object</span>
<span class="sd"> in the bucket.</span>
<span class="sd"> :type metadata: dict</span>
<span class="sd"> :param metadata: All the other data provided by Cloud Storage.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">bucket</span> <span class="o">=</span> <span class="n">bucket</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span> <span class="ow">or</span> <span class="p">{}</span>
<span class="c"># Lazily get the ACL information.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">acl</span> <span class="o">=</span> <span class="bp">None</span>
<span class="nd">@classmethod</span>
<div class="viewcode-block" id="Key.from_dict"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.from_dict">[docs]</a> <span class="k">def</span> <span class="nf">from_dict</span><span class="p">(</span><span class="n">cls</span><span class="p">,</span> <span class="n">key_dict</span><span class="p">,</span> <span class="n">bucket</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""Instantiate a :class:`Key` from data returned by the JSON API.</span>
<span class="sd"> :type key_dict: dict</span>
<span class="sd"> :param key_dict: A dictionary of data returned from</span>
<span class="sd"> getting an Cloud Storage object.</span>
<span class="sd"> :type bucket: :class:`gcloud.storage.bucket.Bucket`</span>
<span class="sd"> :param bucket: The bucket to which this key belongs</span>
<span class="sd"> (and by proxy, which connection to use).</span>
<span class="sd"> :rtype: :class:`Key`</span>
<span class="sd"> :returns: A key based on the data provided.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">cls</span><span class="p">(</span><span class="n">bucket</span><span class="o">=</span><span class="n">bucket</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="n">key_dict</span><span class="p">[</span><span class="s">'name'</span><span class="p">],</span> <span class="n">metadata</span><span class="o">=</span><span class="n">key_dict</span><span class="p">)</span>
</div>
<span class="k">def</span> <span class="nf">__repr__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="p">:</span>
<span class="n">bucket_name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="o">.</span><span class="n">name</span>
<span class="k">else</span><span class="p">:</span>
<span class="n">bucket_name</span> <span class="o">=</span> <span class="bp">None</span>
<span class="k">return</span> <span class="s">'<Key: </span><span class="si">%s</span><span class="s">, </span><span class="si">%s</span><span class="s">>'</span> <span class="o">%</span> <span class="p">(</span><span class="n">bucket_name</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
<span class="nd">@property</span>
<div class="viewcode-block" id="Key.path"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.path">[docs]</a> <span class="k">def</span> <span class="nf">path</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Getter property for the URL path to this Key.</span>
<span class="sd"> :rtype: string</span>
<span class="sd"> :returns: The URL path to this Key.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">'Cannot determine path without a bucket defined.'</span><span class="p">)</span>
<span class="k">elif</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span><span class="s">'Cannot determine path without a key name.'</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="o">.</span><span class="n">path</span> <span class="o">+</span> <span class="s">'/o/'</span> <span class="o">+</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span>
</div>
<span class="nd">@property</span>
<div class="viewcode-block" id="Key.public_url"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.public_url">[docs]</a> <span class="k">def</span> <span class="nf">public_url</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">return</span> <span class="s">'{storage_base_url}/{self.bucket.name}/{self.name}'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="n">storage_base_url</span><span class="o">=</span><span class="s">'http://commondatastorage.googleapis.com'</span><span class="p">,</span> <span class="bp">self</span><span class="o">=</span><span class="bp">self</span><span class="p">)</span>
</div>
<span class="nd">@property</span>
<div class="viewcode-block" id="Key.connection"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.connection">[docs]</a> <span class="k">def</span> <span class="nf">connection</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Getter property for the connection to use with this Key.</span>
<span class="sd"> :rtype: :class:`gcloud.storage.connection.Connection` or None</span>
<span class="sd"> :returns: The connection to use, or None if no connection is set.</span>
<span class="sd"> """</span>
<span class="c"># TODO: If a bucket isn't defined, this is basically useless.</span>
<span class="c"># Where do we throw an error?</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="o">.</span><span class="n">connection</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="o">.</span><span class="n">connection</span>
</div>
<div class="viewcode-block" id="Key.exists"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.exists">[docs]</a> <span class="k">def</span> <span class="nf">exists</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Determines whether or not this key exists.</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> :returns: True if the key exists in Cloud Storage.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="o">.</span><span class="n">get_key</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span>
</div>
<div class="viewcode-block" id="Key.delete"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.delete">[docs]</a> <span class="k">def</span> <span class="nf">delete</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Deletes a key from Cloud Storage.</span>
<span class="sd"> :rtype: :class:`Key`</span>
<span class="sd"> :returns: The key that was just deleted.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="o">.</span><span class="n">delete_key</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="Key.get_contents_to_file"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.get_contents_to_file">[docs]</a> <span class="k">def</span> <span class="nf">get_contents_to_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fh</span><span class="p">):</span>
<span class="sd">"""Gets the contents of this key to a file-like object.</span>
<span class="sd"> :type fh: file</span>
<span class="sd"> :param fh: A file handle to which to write the key's data.</span>
<span class="sd"> :raises: :class:`gcloud.storage.exceptions.NotFoundError`</span>
<span class="sd"> """</span>
<span class="k">for</span> <span class="n">chunk</span> <span class="ow">in</span> <span class="n">KeyDataIterator</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">fh</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">chunk</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">IOError</span><span class="p">,</span> <span class="n">e</span><span class="p">:</span>
<span class="k">if</span> <span class="n">e</span><span class="o">.</span><span class="n">errno</span> <span class="o">==</span> <span class="n">errno</span><span class="o">.</span><span class="n">ENOSPC</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s">'No space left on device.'</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="Key.get_contents_to_filename"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.get_contents_to_filename">[docs]</a> <span class="k">def</span> <span class="nf">get_contents_to_filename</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
<span class="sd">"""Get the contents of this key to a file by name.</span>
<span class="sd"> :type filename: string</span>
<span class="sd"> :param filename: A filename to be passed to ``open``.</span>
<span class="sd"> :raises: :class:`gcloud.storage.exceptions.NotFoundError`</span>
<span class="sd"> """</span>
<span class="c"># TODO: Add good error checking.</span>
<span class="c"># TODO: Add good exception handling.</span>
<span class="c"># TODO: Set timestamp? Make optional, default being to set it if possible?</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s">'wb'</span><span class="p">)</span> <span class="k">as</span> <span class="n">fh</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_contents_to_file</span><span class="p">(</span><span class="n">fh</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="Key.get_contents_as_string"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.get_contents_as_string">[docs]</a> <span class="k">def</span> <span class="nf">get_contents_as_string</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Gets the data stored on this Key as a string.</span>
<span class="sd"> :rtype: string</span>
<span class="sd"> :returns: The data stored in this key.</span>
<span class="sd"> :raises: :class:`gcloud.storage.exceptions.NotFoundError`</span>
<span class="sd"> """</span>
<span class="n">string_buffer</span> <span class="o">=</span> <span class="n">StringIO</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_contents_to_file</span><span class="p">(</span><span class="n">string_buffer</span><span class="p">)</span>
<span class="k">return</span> <span class="n">string_buffer</span><span class="o">.</span><span class="n">getvalue</span><span class="p">()</span>
</div>
<div class="viewcode-block" id="Key.set_contents_from_file"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.set_contents_from_file">[docs]</a> <span class="k">def</span> <span class="nf">set_contents_from_file</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">fh</span><span class="p">,</span> <span class="n">rewind</span><span class="o">=</span><span class="bp">False</span><span class="p">,</span> <span class="n">size</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
<span class="n">content_type</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""Set the contents of this key to the contents of a file handle.</span>
<span class="sd"> :type fh: file</span>
<span class="sd"> :param fh: A file handle open for reading.</span>
<span class="sd"> :type rewind: bool</span>
<span class="sd"> :param rewind: If True, seek to the beginning of the file handle before</span>
<span class="sd"> writing the file to Cloud Storage.</span>
<span class="sd"> :type size: int</span>
<span class="sd"> :param size: The number of bytes to read from the file handle.</span>
<span class="sd"> If not provided, we'll try to guess the size using</span>
<span class="sd"> :func:`os.fstat`</span>
<span class="sd"> """</span>
<span class="c"># Rewind the file if desired.</span>
<span class="k">if</span> <span class="n">rewind</span><span class="p">:</span>
<span class="n">fh</span><span class="o">.</span><span class="n">seek</span><span class="p">(</span><span class="mi">0</span><span class="p">,</span> <span class="n">os</span><span class="o">.</span><span class="n">SEEK_SET</span><span class="p">)</span>
<span class="c"># Get the basic stats about the file.</span>
<span class="n">total_bytes</span> <span class="o">=</span> <span class="n">size</span> <span class="ow">or</span> <span class="n">os</span><span class="o">.</span><span class="n">fstat</span><span class="p">(</span><span class="n">fh</span><span class="o">.</span><span class="n">fileno</span><span class="p">())</span><span class="o">.</span><span class="n">st_size</span>
<span class="n">bytes_uploaded</span> <span class="o">=</span> <span class="mi">0</span>
<span class="c"># Set up a resumable upload session.</span>
<span class="n">headers</span> <span class="o">=</span> <span class="p">{</span>
<span class="s">'X-Upload-Content-Type'</span><span class="p">:</span> <span class="n">content_type</span> <span class="ow">or</span> <span class="s">'application/unknown'</span><span class="p">,</span>
<span class="s">'X-Upload-Content-Length'</span><span class="p">:</span> <span class="n">total_bytes</span>
<span class="p">}</span>
<span class="n">upload_url</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">build_api_url</span><span class="p">(</span>
<span class="n">path</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bucket</span><span class="o">.</span><span class="n">path</span> <span class="o">+</span> <span class="s">'/o'</span><span class="p">,</span>
<span class="n">query_params</span><span class="o">=</span><span class="p">{</span><span class="s">'uploadType'</span><span class="p">:</span> <span class="s">'resumable'</span><span class="p">,</span> <span class="s">'name'</span><span class="p">:</span> <span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">},</span>
<span class="n">api_base_url</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">API_BASE_URL</span> <span class="o">+</span> <span class="s">'/upload'</span><span class="p">)</span>
<span class="n">response</span><span class="p">,</span> <span class="n">content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">make_request</span><span class="p">(</span>
<span class="n">method</span><span class="o">=</span><span class="s">'POST'</span><span class="p">,</span> <span class="n">url</span><span class="o">=</span><span class="n">upload_url</span><span class="p">,</span>
<span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">)</span>
<span class="c"># Get the resumable upload URL.</span>
<span class="n">upload_url</span> <span class="o">=</span> <span class="n">response</span><span class="p">[</span><span class="s">'location'</span><span class="p">]</span>
<span class="k">while</span> <span class="n">bytes_uploaded</span> <span class="o"><</span> <span class="n">total_bytes</span><span class="p">:</span>
<span class="c"># Construct the range header.</span>
<span class="n">data</span> <span class="o">=</span> <span class="n">fh</span><span class="o">.</span><span class="n">read</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">CHUNK_SIZE</span><span class="p">)</span>
<span class="n">chunk_size</span> <span class="o">=</span> <span class="nb">len</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="n">start</span> <span class="o">=</span> <span class="n">bytes_uploaded</span>
<span class="n">end</span> <span class="o">=</span> <span class="n">bytes_uploaded</span> <span class="o">+</span> <span class="n">chunk_size</span> <span class="o">-</span> <span class="mi">1</span>
<span class="n">headers</span> <span class="o">=</span> <span class="p">{</span>
<span class="s">'Content-Range'</span><span class="p">:</span> <span class="s">'bytes </span><span class="si">%d</span><span class="s">-</span><span class="si">%d</span><span class="s">/</span><span class="si">%d</span><span class="s">'</span> <span class="o">%</span> <span class="p">(</span><span class="n">start</span><span class="p">,</span> <span class="n">end</span><span class="p">,</span> <span class="n">total_bytes</span><span class="p">),</span>
<span class="p">}</span>
<span class="c"># TODO: Error checking for response code.</span>
<span class="c"># TODO: Exponential backoff when errors come through.</span>
<span class="n">response</span><span class="p">,</span> <span class="n">content</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">make_request</span><span class="p">(</span><span class="n">content_type</span><span class="o">=</span><span class="s">'text/plain'</span><span class="p">,</span>
<span class="n">method</span><span class="o">=</span><span class="s">'POST'</span><span class="p">,</span> <span class="n">url</span><span class="o">=</span><span class="n">upload_url</span><span class="p">,</span> <span class="n">headers</span><span class="o">=</span><span class="n">headers</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">data</span><span class="p">)</span>
<span class="n">bytes_uploaded</span> <span class="o">+=</span> <span class="n">chunk_size</span>
</div>
<div class="viewcode-block" id="Key.set_contents_from_filename"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.set_contents_from_filename">[docs]</a> <span class="k">def</span> <span class="nf">set_contents_from_filename</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">filename</span><span class="p">):</span>
<span class="sd">"""Open a path and set this key's contents to the content of that file.</span>
<span class="sd"> :type filename: string</span>
<span class="sd"> :param filename: The path to the file.</span>
<span class="sd"> """</span>
<span class="n">content_type</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">mimetypes</span><span class="o">.</span><span class="n">guess_type</span><span class="p">(</span><span class="n">filename</span><span class="p">)</span>
<span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="n">filename</span><span class="p">,</span> <span class="s">'rb'</span><span class="p">)</span> <span class="k">as</span> <span class="n">fh</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_contents_from_file</span><span class="p">(</span><span class="n">fh</span><span class="p">,</span> <span class="n">content_type</span><span class="o">=</span><span class="n">content_type</span><span class="p">)</span>
</div>
<div class="viewcode-block" id="Key.set_contents_from_string"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.set_contents_from_string">[docs]</a> <span class="k">def</span> <span class="nf">set_contents_from_string</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="n">content_type</span><span class="o">=</span><span class="s">'text/plain'</span><span class="p">):</span>
<span class="sd">"""Sets the contents of this key to the provided string.</span>
<span class="sd"> You can use this method to quickly set the value of a key::</span>
<span class="sd"> >>> from gcloud import storage</span>
<span class="sd"> >>> connection = storage.get_connection(project_name, email, key_path)</span>
<span class="sd"> >>> bucket = connection.get_bucket(bucket_name)</span>
<span class="sd"> >>> key = bucket.new_key('my_text_file.txt')</span>
<span class="sd"> >>> key.set_contents_from_string('This is the contents of my file!')</span>
<span class="sd"> Under the hood this is using a string buffer</span>
<span class="sd"> and calling :func:`gcloud.storage.key.Key.set_contents_from_file`.</span>
<span class="sd"> :type data: string</span>
<span class="sd"> :param data: The data to store in this key.</span>
<span class="sd"> :rtype: :class:`Key`</span>
<span class="sd"> :returns: The updated Key object.</span>
<span class="sd"> """</span>
<span class="c"># TODO: How do we handle NotFoundErrors?</span>
<span class="n">string_buffer</span> <span class="o">=</span> <span class="n">StringIO</span><span class="p">()</span>
<span class="n">string_buffer</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">set_contents_from_file</span><span class="p">(</span><span class="n">fh</span><span class="o">=</span><span class="n">string_buffer</span><span class="p">,</span> <span class="n">rewind</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span>
<span class="n">size</span><span class="o">=</span><span class="n">string_buffer</span><span class="o">.</span><span class="n">len</span><span class="p">,</span>
<span class="n">content_type</span><span class="o">=</span><span class="n">content_type</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span>
</div>
<div class="viewcode-block" id="Key.has_metadata"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.has_metadata">[docs]</a> <span class="k">def</span> <span class="nf">has_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""Check if metadata is available locally.</span>
<span class="sd"> :type field: string</span>
<span class="sd"> :param field: (optional) the particular field to check for.</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> :returns: Whether metadata is available locally.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">elif</span> <span class="n">field</span> <span class="ow">and</span> <span class="n">field</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">False</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">True</span>
</div>
<div class="viewcode-block" id="Key.reload_metadata"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.reload_metadata">[docs]</a> <span class="k">def</span> <span class="nf">reload_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">full</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
<span class="sd">"""Reload metadata from Cloud Storage.</span>
<span class="sd"> :type full: bool</span>
<span class="sd"> :param full: If True, loads all data (include ACL data).</span>
<span class="sd"> :rtype: :class:`Key`</span>
<span class="sd"> :returns: The key you just reloaded data for.</span>
<span class="sd"> """</span>
<span class="n">projection</span> <span class="o">=</span> <span class="s">'full'</span> <span class="k">if</span> <span class="n">full</span> <span class="k">else</span> <span class="s">'noAcl'</span>
<span class="n">query_params</span> <span class="o">=</span> <span class="p">{</span><span class="s">'projection'</span><span class="p">:</span> <span class="n">projection</span><span class="p">}</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">api_request</span><span class="p">(</span>
<span class="n">method</span><span class="o">=</span><span class="s">'GET'</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="n">query_params</span><span class="o">=</span><span class="n">query_params</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span>
</div>
<div class="viewcode-block" id="Key.get_metadata"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.get_metadata">[docs]</a> <span class="k">def</span> <span class="nf">get_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">field</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">default</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""Get all metadata or a specific field.</span>
<span class="sd"> If you request a field that isn't available,</span>
<span class="sd"> and that field can be retrieved by refreshing data</span>
<span class="sd"> from Cloud Storage,</span>
<span class="sd"> this method will reload the data using</span>
<span class="sd"> :func:`Key.reload_metadata`.</span>
<span class="sd"> :type field: string</span>
<span class="sd"> :param field: (optional) A particular field to retrieve from metadata.</span>
<span class="sd"> :type default: anything</span>
<span class="sd"> :param default: The value to return if the field provided wasn't found.</span>
<span class="sd"> :rtype: dict or anything</span>
<span class="sd"> :returns: All metadata or the value of the specific field.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">has_metadata</span><span class="p">(</span><span class="n">field</span><span class="o">=</span><span class="n">field</span><span class="p">):</span>
<span class="n">full</span> <span class="o">=</span> <span class="p">(</span><span class="n">field</span> <span class="ow">and</span> <span class="n">field</span> <span class="o">==</span> <span class="s">'acl'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">reload_metadata</span><span class="p">(</span><span class="n">full</span><span class="o">=</span><span class="n">full</span><span class="p">)</span>
<span class="k">if</span> <span class="n">field</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">field</span><span class="p">,</span> <span class="n">default</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">metadata</span>
</div>
<div class="viewcode-block" id="Key.patch_metadata"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.patch_metadata">[docs]</a> <span class="k">def</span> <span class="nf">patch_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">metadata</span><span class="p">):</span>
<span class="sd">"""Update particular fields of this key's metadata.</span>
<span class="sd"> This method will only update the fields provided</span>
<span class="sd"> and will not touch the other fields.</span>
<span class="sd"> It will also reload the metadata locally</span>
<span class="sd"> based on the servers response.</span>
<span class="sd"> :type metadata: dict</span>
<span class="sd"> :param metadata: The dictionary of values to update.</span>
<span class="sd"> :rtype: :class:`Key`</span>
<span class="sd"> :returns: The current key.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">connection</span><span class="o">.</span><span class="n">api_request</span><span class="p">(</span>
<span class="n">method</span><span class="o">=</span><span class="s">'PATCH'</span><span class="p">,</span> <span class="n">path</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">path</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">metadata</span><span class="p">,</span>
<span class="n">query_params</span><span class="o">=</span><span class="p">{</span><span class="s">'projection'</span><span class="p">:</span> <span class="s">'full'</span><span class="p">})</span>
<span class="k">return</span> <span class="bp">self</span>
</div>
<div class="viewcode-block" id="Key.reload_acl"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.reload_acl">[docs]</a> <span class="k">def</span> <span class="nf">reload_acl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Reload the ACL data from Cloud Storage.</span>
<span class="sd"> :rtype: :class:`Key`</span>
<span class="sd"> :returns: The current key.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">acl</span> <span class="o">=</span> <span class="n">ObjectACL</span><span class="p">(</span><span class="n">key</span><span class="o">=</span><span class="bp">self</span><span class="p">)</span>
<span class="k">for</span> <span class="n">entry</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_metadata</span><span class="p">(</span><span class="s">'acl'</span><span class="p">,</span> <span class="p">[]):</span>
<span class="n">entity</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">acl</span><span class="o">.</span><span class="n">entity_from_dict</span><span class="p">(</span><span class="n">entry</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">acl</span><span class="o">.</span><span class="n">add_entity</span><span class="p">(</span><span class="n">entity</span><span class="p">)</span>
<span class="k">return</span> <span class="bp">self</span>
</div>
<div class="viewcode-block" id="Key.get_acl"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.get_acl">[docs]</a> <span class="k">def</span> <span class="nf">get_acl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c"># TODO: This might be a VERY long list. Use the specific API endpoint.</span>
<span class="sd">"""Get ACL metadata as a :class:`gcloud.storage.acl.ObjectACL` object.</span>
<span class="sd"> :rtype: :class:`gcloud.storage.acl.ObjectACL`</span>
<span class="sd"> :returns: An ACL object for the current key.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">acl</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">reload_acl</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">acl</span>
</div>
<div class="viewcode-block" id="Key.save_acl"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.save_acl">[docs]</a> <span class="k">def</span> <span class="nf">save_acl</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">acl</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
<span class="sd">"""Save the ACL data for this key.</span>
<span class="sd"> :type acl: :class:`gcloud.storage.acl.ACL`</span>
<span class="sd"> :param acl: The ACL object to save.</span>
<span class="sd"> If left blank, this will save the ACL</span>
<span class="sd"> set locally on the key.</span>
<span class="sd"> """</span>
<span class="c"># We do things in this weird way because [] and None</span>
<span class="c"># both evaluate to False, but mean very different things.</span>
<span class="k">if</span> <span class="n">acl</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="n">acl</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">acl</span>
<span class="k">if</span> <span class="n">acl</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span>
<span class="k">return</span> <span class="bp">self</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">patch_metadata</span><span class="p">({</span><span class="s">'acl'</span><span class="p">:</span> <span class="nb">list</span><span class="p">(</span><span class="n">acl</span><span class="p">)})</span>
</div>
<div class="viewcode-block" id="Key.clear_acl"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.clear_acl">[docs]</a> <span class="k">def</span> <span class="nf">clear_acl</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Remove all ACL rules from the key.</span>
<span class="sd"> Note that this won't actually remove *ALL* the rules,</span>
<span class="sd"> but it will remove all the non-default rules.</span>
<span class="sd"> In short,</span>
<span class="sd"> you'll still have access</span>
<span class="sd"> to a key that you created</span>
<span class="sd"> even after you clear ACL rules</span>
<span class="sd"> with this method.</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">save_acl</span><span class="p">(</span><span class="n">acl</span><span class="o">=</span><span class="p">[])</span>
</div>
<div class="viewcode-block" id="Key.make_public"><a class="viewcode-back" href="../../../storage-api.html#gcloud.storage.key.Key.make_public">[docs]</a> <span class="k">def</span> <span class="nf">make_public</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">"""Make this key public giving all users read access.</span>
<span class="sd"> :rtype: :class:`Key`</span>
<span class="sd"> :returns: The current key.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_acl</span><span class="p">()</span><span class="o">.</span><span class="n">all</span><span class="p">()</span><span class="o">.</span><span class="n">grant_read</span><span class="p">()</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_acl</span><span class="p">()</span>
<span class="k">return</span> <span class="bp">self</span></div></div>
</pre></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<footer id="gc-footer" class="footer" role="contentinfo">
<div id="gc-copyright">
© Copyright 2014, JJ Geewax.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.1.
</div>
</footer>
</body>
</html>