1 2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 3<html><head><title>Python: module telemetry.wpr.archive_info</title> 4<meta charset="utf-8"> 5</head><body bgcolor="#f0f0f8"> 6 7<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading"> 8<tr bgcolor="#7799ee"> 9<td valign=bottom> <br> 10<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.wpr.html"><font color="#ffffff">wpr</font></a>.archive_info</strong></big></big></font></td 11><td align=right valign=bottom 12><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/wpr/archive_info.py">telemetry/wpr/archive_info.py</a></font></td></tr></table> 13 <p><tt># Copyright 2013 The Chromium Authors. All rights reserved.<br> 14# Use of this source code is governed by a BSD-style license that can be<br> 15# found in the LICENSE file.</tt></p> 16<p> 17<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 18<tr bgcolor="#aa55cc"> 19<td colspan=3 valign=bottom> <br> 20<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr> 21 22<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td> 23<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="catapult_base.cloud_storage.html">catapult_base.cloud_storage</a><br> 24<a href="json.html">json</a><br> 25</td><td width="25%" valign=top><a href="logging.html">logging</a><br> 26<a href="os.html">os</a><br> 27</td><td width="25%" valign=top><a href="re.html">re</a><br> 28<a href="shutil.html">shutil</a><br> 29</td><td width="25%" valign=top><a href="tempfile.html">tempfile</a><br> 30</td></tr></table></td></tr></table><p> 31<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 32<tr bgcolor="#ee77aa"> 33<td colspan=3 valign=bottom> <br> 34<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> 35 36<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> 37<td width="100%"><dl> 38<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> 39</font></dt><dd> 40<dl> 41<dt><font face="helvetica, arial"><a href="telemetry.wpr.archive_info.html#WprArchiveInfo">WprArchiveInfo</a> 42</font></dt></dl> 43</dd> 44<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>) 45</font></dt><dd> 46<dl> 47<dt><font face="helvetica, arial"><a href="telemetry.wpr.archive_info.html#ArchiveError">ArchiveError</a> 48</font></dt></dl> 49</dd> 50</dl> 51 <p> 52<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 53<tr bgcolor="#ffc8d8"> 54<td colspan=3 valign=bottom> <br> 55<font color="#000000" face="helvetica, arial"><a name="ArchiveError">class <strong>ArchiveError</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></td></tr> 56 57<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> 58<td width="100%"><dl><dt>Method resolution order:</dt> 59<dd><a href="telemetry.wpr.archive_info.html#ArchiveError">ArchiveError</a></dd> 60<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd> 61<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd> 62<dd><a href="__builtin__.html#object">__builtin__.object</a></dd> 63</dl> 64<hr> 65Data descriptors defined here:<br> 66<dl><dt><strong>__weakref__</strong></dt> 67<dd><tt>list of weak references to the object (if defined)</tt></dd> 68</dl> 69<hr> 70Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> 71<dl><dt><a name="ArchiveError-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#ArchiveError-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl> 72 73<hr> 74Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:<br> 75<dl><dt><strong>__new__</strong> = <built-in method __new__ of type object><dd><tt>T.<a href="#ArchiveError-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl> 76 77<hr> 78Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> 79<dl><dt><a name="ArchiveError-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ArchiveError-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl> 80 81<dl><dt><a name="ArchiveError-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#ArchiveError-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl> 82 83<dl><dt><a name="ArchiveError-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#ArchiveError-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl> 84 85<dl><dt><a name="ArchiveError-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#ArchiveError-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br> 86 <br> 87Use of negative indices is not supported.</tt></dd></dl> 88 89<dl><dt><a name="ArchiveError-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl> 90 91<dl><dt><a name="ArchiveError-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#ArchiveError-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl> 92 93<dl><dt><a name="ArchiveError-__setattr__"><strong>__setattr__</strong></a>(...)</dt><dd><tt>x.<a href="#ArchiveError-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl> 94 95<dl><dt><a name="ArchiveError-__setstate__"><strong>__setstate__</strong></a>(...)</dt></dl> 96 97<dl><dt><a name="ArchiveError-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#ArchiveError-__str__">__str__</a>() <==> str(x)</tt></dd></dl> 98 99<dl><dt><a name="ArchiveError-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl> 100 101<hr> 102Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br> 103<dl><dt><strong>__dict__</strong></dt> 104</dl> 105<dl><dt><strong>args</strong></dt> 106</dl> 107<dl><dt><strong>message</strong></dt> 108</dl> 109</td></tr></table> <p> 110<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 111<tr bgcolor="#ffc8d8"> 112<td colspan=3 valign=bottom> <br> 113<font color="#000000" face="helvetica, arial"><a name="WprArchiveInfo">class <strong>WprArchiveInfo</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> 114 115<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td> 116<td width="100%">Methods defined here:<br> 117<dl><dt><a name="WprArchiveInfo-AddNewTemporaryRecording"><strong>AddNewTemporaryRecording</strong></a>(self, temp_wpr_file_path<font color="#909090">=None</font>)</dt></dl> 118 119<dl><dt><a name="WprArchiveInfo-AddRecordedStories"><strong>AddRecordedStories</strong></a>(self, stories, upload_to_cloud_storage<font color="#909090">=False</font>)</dt></dl> 120 121<dl><dt><a name="WprArchiveInfo-DownloadArchivesIfNeeded"><strong>DownloadArchivesIfNeeded</strong></a>(self)</dt><dd><tt>Downloads archives iff the Archive has a bucket parameter and the user<br> 122has permission to access the bucket.<br> 123 <br> 124Raises cloud storage Permissions or Credentials error when there is no<br> 125local copy of the archive and the user doesn't have permission to access<br> 126the archive's bucket.<br> 127 <br> 128Warns when a bucket is not specified or when the user doesn't have<br> 129permission to access the archive's bucket but a local copy of the archive<br> 130exists.</tt></dd></dl> 131 132<dl><dt><a name="WprArchiveInfo-WprFilePathForStory"><strong>WprFilePathForStory</strong></a>(self, story)</dt></dl> 133 134<dl><dt><a name="WprArchiveInfo-__init__"><strong>__init__</strong></a>(self, file_path, data, bucket)</dt></dl> 135 136<hr> 137Class methods defined here:<br> 138<dl><dt><a name="WprArchiveInfo-FromFile"><strong>FromFile</strong></a>(cls, file_path, bucket)<font color="#909090"><font face="helvetica, arial"> from <a href="__builtin__.html#type">__builtin__.type</a></font></font></dt></dl> 139 140<hr> 141Data descriptors defined here:<br> 142<dl><dt><strong>__dict__</strong></dt> 143<dd><tt>dictionary for instance variables (if defined)</tt></dd> 144</dl> 145<dl><dt><strong>__weakref__</strong></dt> 146<dd><tt>list of weak references to the object (if defined)</tt></dd> 147</dl> 148</td></tr></table></td></tr></table><p> 149<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 150<tr bgcolor="#eeaa77"> 151<td colspan=3 valign=bottom> <br> 152<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> 153 154<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> 155<td width="100%"><dl><dt><a name="-AssertValidCloudStorageBucket"><strong>AssertValidCloudStorageBucket</strong></a>(bucket)</dt></dl> 156</td></tr></table> 157</body></html>