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> <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.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># Copyright 2014 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="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> <br> 28<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> 29 30<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </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> <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> </tt></td><td> </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 the path to the pointed-to file relative to the given start path.<br> 48 <br> 49Args:<br> 50 start: A string representing a starting path.<br> 51Returns:<br> 52 A string giving the relative path from path to this 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 a <a href="#FileHandle">FileHandle</a> <a href="__builtin__.html#object">object</a>.<br> 55 <br> 56This constructor should not be used by the user; rather it is preferred to<br> 57use the module-level GetAbsPath and FromTempFile functions.<br> 58 <br> 59Args:<br> 60 temp_file: An instance of a temporary file <a href="__builtin__.html#object">object</a>.<br> 61 absolute_path: A path; should not be passed if tempfile is and vice-versa.<br> 62 extension: A string that specifies the file extension. It must starts with<br> 63 ".".</tt></dd></dl> 64 65<hr> 66Data descriptors defined here:<br> 67<dl><dt><strong>__dict__</strong></dt> 68<dd><tt>dictionary for instance variables (if defined)</tt></dd> 69</dl> 70<dl><dt><strong>__weakref__</strong></dt> 71<dd><tt>list of weak references to the object (if 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> <br> 81<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr> 82 83<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td> 84<td width="100%"><dl><dt><a name="-FromFilePath"><strong>FromFilePath</strong></a>(path)</dt><dd><tt>Constructs a <a href="#FileHandle">FileHandle</a> from an absolute file path.<br> 85 <br> 86Args:<br> 87 path: A string giving the absolute path to a file.<br> 88Returns:<br> 89 A <a href="#FileHandle">FileHandle</a> referring to the file at the specified path.</tt></dd></dl> 90 <dl><dt><a name="-FromTempFile"><strong>FromTempFile</strong></a>(temp_file)</dt><dd><tt>Constructs a <a href="#FileHandle">FileHandle</a> pointing to a temporary file.<br> 91 <br> 92Returns:<br> 93 A <a href="#FileHandle">FileHandle</a> referring to a named temporary file.</tt></dd></dl> 94</td></tr></table> 95</body></html>