Home | History | Annotate | Download | only in pydoc
      1 
      2 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
      3 <html><head><title>Python: module telemetry.internal.results.json_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>&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.results.html"><font color="#ffffff">results</font></a>.json_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/json_output_formatter.py">telemetry/internal/results/json_output_formatter.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="json.html">json</a><br>
     24 </td><td width="25%" valign=top><a href="telemetry.internal.results.output_formatter.html">telemetry.internal.results.output_formatter</a><br>
     25 </td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
     26 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
     27 <tr bgcolor="#ee77aa">
     28 <td colspan=3 valign=bottom>&nbsp;<br>
     29 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
     30     
     31 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
     32 <td width="100%"><dl>
     33 <dt><font face="helvetica, arial"><a href="telemetry.internal.results.output_formatter.html#OutputFormatter">telemetry.internal.results.output_formatter.OutputFormatter</a>(<a href="__builtin__.html#object">__builtin__.object</a>)
     34 </font></dt><dd>
     35 <dl>
     36 <dt><font face="helvetica, arial"><a href="telemetry.internal.results.json_output_formatter.html#JsonOutputFormatter">JsonOutputFormatter</a>
     37 </font></dt></dl>
     38 </dd>
     39 </dl>
     40  <p>
     41 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
     42 <tr bgcolor="#ffc8d8">
     43 <td colspan=3 valign=bottom>&nbsp;<br>
     44 <font color="#000000" face="helvetica, arial"><a name="JsonOutputFormatter">class <strong>JsonOutputFormatter</strong></a>(<a href="telemetry.internal.results.output_formatter.html#OutputFormatter">telemetry.internal.results.output_formatter.OutputFormatter</a>)</font></td></tr>
     45     
     46 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
     47 <td width="100%"><dl><dt>Method resolution order:</dt>
     48 <dd><a href="telemetry.internal.results.json_output_formatter.html#JsonOutputFormatter">JsonOutputFormatter</a></dd>
     49 <dd><a href="telemetry.internal.results.output_formatter.html#OutputFormatter">telemetry.internal.results.output_formatter.OutputFormatter</a></dd>
     50 <dd><a href="__builtin__.html#object">__builtin__.object</a></dd>
     51 </dl>
     52 <hr>
     53 Methods defined here:<br>
     54 <dl><dt><a name="JsonOutputFormatter-Format"><strong>Format</strong></a>(self, page_test_results)</dt></dl>
     55 
     56 <dl><dt><a name="JsonOutputFormatter-__init__"><strong>__init__</strong></a>(self, output_stream, benchmark_metadata)</dt></dl>
     57 
     58 <hr>
     59 Data descriptors defined here:<br>
     60 <dl><dt><strong>benchmark_metadata</strong></dt>
     61 </dl>
     62 <hr>
     63 Data descriptors inherited from <a href="telemetry.internal.results.output_formatter.html#OutputFormatter">telemetry.internal.results.output_formatter.OutputFormatter</a>:<br>
     64 <dl><dt><strong>__dict__</strong></dt>
     65 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
     66 </dl>
     67 <dl><dt><strong>__weakref__</strong></dt>
     68 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
     69 </dl>
     70 <dl><dt><strong>output_stream</strong></dt>
     71 </dl>
     72 </td></tr></table></td></tr></table><p>
     73 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
     74 <tr bgcolor="#eeaa77">
     75 <td colspan=3 valign=bottom>&nbsp;<br>
     76 <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
     77     
     78 <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
     79 <td width="100%"><dl><dt><a name="-ResultsAsDict"><strong>ResultsAsDict</strong></a>(page_test_results, benchmark_metadata)</dt><dd><tt>Takes&nbsp;PageTestResults&nbsp;to&nbsp;a&nbsp;dict&nbsp;serializable&nbsp;to&nbsp;JSON.<br>
     80 &nbsp;<br>
     81 To&nbsp;serialize&nbsp;results&nbsp;as&nbsp;JSON&nbsp;we&nbsp;first&nbsp;convert&nbsp;them&nbsp;to&nbsp;a&nbsp;dict&nbsp;that&nbsp;can&nbsp;be<br>
     82 serialized&nbsp;by&nbsp;the&nbsp;json&nbsp;module.&nbsp;It&nbsp;also&nbsp;requires&nbsp;a&nbsp;benchmark_metadat&nbsp;object<br>
     83 for&nbsp;metadata&nbsp;to&nbsp;be&nbsp;integrated&nbsp;into&nbsp;the&nbsp;results&nbsp;(currently&nbsp;the&nbsp;benchmark<br>
     84 name).&nbsp;This&nbsp;function&nbsp;will&nbsp;also&nbsp;output&nbsp;trace&nbsp;files&nbsp;if&nbsp;they&nbsp;exist.<br>
     85 &nbsp;<br>
     86 Args:<br>
     87 &nbsp;&nbsp;page_test_results:&nbsp;a&nbsp;PageTestResults&nbsp;object<br>
     88 &nbsp;&nbsp;benchmark_metadata:&nbsp;a&nbsp;benchmark.BenchmarkMetadata&nbsp;object</tt></dd></dl>
     89 </td></tr></table>
     90 </body></html>