sdk/platform-tools/systrace/catapult/telemetry/docs/pydoc/telemetry.internal.util.file_handle.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
   3 <html><head><title>Python: module telemetry.internal.util.file_handle</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>&nbsp;<br>
  10 <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.internal.html"><font color="#ffffff">internal</font></a>.<a href="telemetry.internal.util.html"><font color="#ffffff">util</font></a>.file_handle</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/internal/util/file_handle.py">telemetry/internal/util/file_handle.py</a></font></td></tr></table>
  13     <p><tt>#&nbsp;Copyright&nbsp;2014&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
  14 #&nbsp;Use&nbsp;of&nbsp;this&nbsp;source&nbsp;code&nbsp;is&nbsp;governed&nbsp;by&nbsp;a&nbsp;BSD-style&nbsp;license&nbsp;that&nbsp;can&nbsp;be<br>
  15 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;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>&nbsp;<br>
  20 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
  21
  22 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  23 <td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="os.html">os</a><br>
  24 </td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
  25 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  26 <tr bgcolor="#ee77aa">
  27 <td colspan=3 valign=bottom>&nbsp;<br>
  28 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
  29
  30 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  31 <td width="100%"><dl>
  32 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
  33 </font></dt><dd>
  34 <dl>
  35 <dt><font face="helvetica, arial"><a href="telemetry.internal.util.file_handle.html#FileHandle">FileHandle</a>
  36 </font></dt></dl>
  37 </dd>
  38 </dl>
  39  <p>
  40 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  41 <tr bgcolor="#ffc8d8">
  42 <td colspan=3 valign=bottom>&nbsp;<br>
  43 <font color="#000000" face="helvetica, arial"><a name="FileHandle">class <strong>FileHandle</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
  44
  45 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  46 <td width="100%">Methods defined here:<br>
  47 <dl><dt><a name="FileHandle-GetAbsPath"><strong>GetAbsPath</strong></a>(self)</dt><dd><tt>Returns&nbsp;the&nbsp;path&nbsp;to&nbsp;the&nbsp;pointed-to&nbsp;file&nbsp;relative&nbsp;to&nbsp;the&nbsp;given&nbsp;start&nbsp;path.<br>
  48 &nbsp;<br>
  49 Args:<br>
  50 &nbsp;&nbsp;start:&nbsp;A&nbsp;string&nbsp;representing&nbsp;a&nbsp;starting&nbsp;path.<br>
  51 Returns:<br>
  52 &nbsp;&nbsp;A&nbsp;string&nbsp;giving&nbsp;the&nbsp;relative&nbsp;path&nbsp;from&nbsp;path&nbsp;to&nbsp;this&nbsp;file.</tt></dd></dl>
  53
  54 <dl><dt><a name="FileHandle-__init__"><strong>__init__</strong></a>(self, temp_file<font color="#909090">=None</font>, absolute_path<font color="#909090">=None</font>)</dt><dd><tt>Constructs&nbsp;a&nbsp;<a href="#FileHandle">FileHandle</a>&nbsp;<a href="__builtin__.html#object">object</a>.<br>
  55 &nbsp;<br>
  56 This&nbsp;constructor&nbsp;should&nbsp;not&nbsp;be&nbsp;used&nbsp;by&nbsp;the&nbsp;user;&nbsp;rather&nbsp;it&nbsp;is&nbsp;preferred&nbsp;to<br>
  57 use&nbsp;the&nbsp;module-level&nbsp;GetAbsPath&nbsp;and&nbsp;FromTempFile&nbsp;functions.<br>
  58 &nbsp;<br>
  59 Args:<br>
  60 &nbsp;&nbsp;temp_file:&nbsp;An&nbsp;instance&nbsp;of&nbsp;a&nbsp;temporary&nbsp;file&nbsp;<a href="__builtin__.html#object">object</a>.<br>
  61 &nbsp;&nbsp;absolute_path:&nbsp;A&nbsp;path;&nbsp;should&nbsp;not&nbsp;be&nbsp;passed&nbsp;if&nbsp;tempfile&nbsp;is&nbsp;and&nbsp;vice-versa.<br>
  62 &nbsp;&nbsp;extension:&nbsp;A&nbsp;string&nbsp;that&nbsp;specifies&nbsp;the&nbsp;file&nbsp;extension.&nbsp;It&nbsp;must&nbsp;starts&nbsp;with<br>
  63 &nbsp;&nbsp;&nbsp;&nbsp;".".</tt></dd></dl>
  64
  65 <hr>
  66 Data descriptors defined here:<br>
  67 <dl><dt><strong>__dict__</strong></dt>
  68 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
  69 </dl>
  70 <dl><dt><strong>__weakref__</strong></dt>
  71 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
  72 </dl>
  73 <dl><dt><strong>extension</strong></dt>
  74 </dl>
  75 <dl><dt><strong>id</strong></dt>
  76 </dl>
  77 </td></tr></table></td></tr></table><p>
  78 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  79 <tr bgcolor="#eeaa77">
  80 <td colspan=3 valign=bottom>&nbsp;<br>
  81 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
  82
  83 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  84 <td width="100%"><dl><dt><a name="-FromFilePath"><strong>FromFilePath</strong></a>(path)</dt><dd><tt>Constructs&nbsp;a&nbsp;<a href="#FileHandle">FileHandle</a>&nbsp;from&nbsp;an&nbsp;absolute&nbsp;file&nbsp;path.<br>
  85 &nbsp;<br>
  86 Args:<br>
  87 &nbsp;&nbsp;path:&nbsp;A&nbsp;string&nbsp;giving&nbsp;the&nbsp;absolute&nbsp;path&nbsp;to&nbsp;a&nbsp;file.<br>
  88 Returns:<br>
  89 &nbsp;&nbsp;A&nbsp;<a href="#FileHandle">FileHandle</a>&nbsp;referring&nbsp;to&nbsp;the&nbsp;file&nbsp;at&nbsp;the&nbsp;specified&nbsp;path.</tt></dd></dl>
  90  <dl><dt><a name="-FromTempFile"><strong>FromTempFile</strong></a>(temp_file)</dt><dd><tt>Constructs&nbsp;a&nbsp;<a href="#FileHandle">FileHandle</a>&nbsp;pointing&nbsp;to&nbsp;a&nbsp;temporary&nbsp;file.<br>
  91 &nbsp;<br>
  92 Returns:<br>
  93 &nbsp;&nbsp;A&nbsp;<a href="#FileHandle">FileHandle</a>&nbsp;referring&nbsp;to&nbsp;a&nbsp;named&nbsp;temporary&nbsp;file.</tt></dd></dl>
  94 </td></tr></table>
  95 </body></html>