1 2<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 3<html><head><title>Python: module telemetry.internal.results.output_formatter</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.results.html"><font color="#ffffff">results</font></a>.output_formatter</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/results/output_formatter.py">telemetry/internal/results/output_formatter.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="#ee77aa"> 19<td colspan=3 valign=bottom> <br> 20<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr> 21 22<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td> 23<td width="100%"><dl> 24<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a> 25</font></dt><dd> 26<dl> 27<dt><font face="helvetica, arial"><a href="telemetry.internal.results.output_formatter.html#OutputFormatter">OutputFormatter</a> 28</font></dt></dl> 29</dd> 30</dl> 31 <p> 32<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> 33<tr bgcolor="#ffc8d8"> 34<td colspan=3 valign=bottom> <br> 35<font color="#000000" face="helvetica, arial"><a name="OutputFormatter">class <strong>OutputFormatter</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> 36 37<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> 38<td colspan=2><tt>A formatter for PageTestResults.<br> 39 <br> 40An <a href="#OutputFormatter">OutputFormatter</a> takes PageTestResults, formats the results<br> 41(telemetry.value.Value instances), and output the formatted results<br> 42in the given output stream.<br> 43 <br> 44Examples of output formatter: CsvOutputFormatter produces results in<br> 45CSV format.<br> </tt></td></tr> 46<tr><td> </td> 47<td width="100%">Methods defined here:<br> 48<dl><dt><a name="OutputFormatter-Format"><strong>Format</strong></a>(self, page_test_results)</dt><dd><tt>Formats the given PageTestResults into the output stream.<br> 49 <br> 50This will be called once at the end of a benchmark.<br> 51 <br> 52Args:<br> 53 page_test_results: A PageTestResults <a href="__builtin__.html#object">object</a> containing all results<br> 54 from the current benchmark run.</tt></dd></dl> 55 56<dl><dt><a name="OutputFormatter-__init__"><strong>__init__</strong></a>(self, output_stream)</dt><dd><tt>Constructs a new formatter that writes to the output_stream.<br> 57 <br> 58Args:<br> 59 output_stream: The stream to write the formatted output to.</tt></dd></dl> 60 61<hr> 62Data descriptors defined here:<br> 63<dl><dt><strong>__dict__</strong></dt> 64<dd><tt>dictionary for instance variables (if defined)</tt></dd> 65</dl> 66<dl><dt><strong>__weakref__</strong></dt> 67<dd><tt>list of weak references to the object (if defined)</tt></dd> 68</dl> 69<dl><dt><strong>output_stream</strong></dt> 70</dl> 71</td></tr></table></td></tr></table> 72</body></html>