tools/telemetry/docs/pydoc/telemetry.internal.results.page_test_results.html - chromium/src - Git at Google


 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <html><head><title>Python: module telemetry.internal.results.page_test_results</title>
 <meta charset="utf-8">
 </head><body bgcolor="#f0f0f8">

 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
 <tr bgcolor="#7799ee">
 <td valign=bottom>&nbsp;<br>
 <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>.page_test_results</strong></big></big></font></td
 ><td align=right valign=bottom
 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/internal/results/page_test_results.py">telemetry/internal/results/page_test_results.py</a></font></td></tr></table>
     <p><tt>#&nbsp;Copyright&nbsp;2014&nbsp;The&nbsp;Chromium&nbsp;Authors.&nbsp;All&nbsp;rights&nbsp;reserved.<br>
 #&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>
 #&nbsp;found&nbsp;in&nbsp;the&nbsp;LICENSE&nbsp;file.</tt></p>
 <p>
 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 <tr bgcolor="#aa55cc">
 <td colspan=3 valign=bottom>&nbsp;<br>
 <font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>

 <tr><td bgcolor="#aa55cc"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 <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>
 <a href="collections.html">collections</a><br>
 <a href="copy.html">copy</a><br>
 <a href="datetime.html">datetime</a><br>
 </td><td width="25%" valign=top><a href="telemetry.value.failure.html">telemetry.value.failure</a><br>
 <a href="telemetry.internal.results.json_output_formatter.html">telemetry.internal.results.json_output_formatter</a><br>
 <a href="logging.html">logging</a><br>
 <a href="random.html">random</a><br>
 </td><td width="25%" valign=top><a href="telemetry.internal.results.progress_reporter.html">telemetry.internal.results.progress_reporter</a><br>
 <a href="telemetry.value.skip.html">telemetry.value.skip</a><br>
 <a href="telemetry.internal.results.story_run.html">telemetry.internal.results.story_run</a><br>
 <a href="sys.html">sys</a><br>
 </td><td width="25%" valign=top><a href="telemetry.value.trace.html">telemetry.value.trace</a><br>
 <a href="traceback.html">traceback</a><br>
 <a href="telemetry.value.html">telemetry.value</a><br>
 </td></tr></table></td></tr></table><p>
 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 <tr bgcolor="#ee77aa">
 <td colspan=3 valign=bottom>&nbsp;<br>
 <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>

 <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 <td width="100%"><dl>
 <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
 </font></dt><dd>
 <dl>
 <dt><font face="helvetica, arial"><a href="telemetry.internal.results.page_test_results.html#PageTestResults">PageTestResults</a>
 </font></dt></dl>
 </dd>
 </dl>
  <p>
 <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
 <tr bgcolor="#ffc8d8">
 <td colspan=3 valign=bottom>&nbsp;<br>
 <font color="#000000" face="helvetica, arial"><a name="PageTestResults">class <strong>PageTestResults</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>

 <tr><td bgcolor="#ffc8d8"><tt>&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
 <td width="100%">Methods defined here:<br>
 <dl><dt><a name="PageTestResults-AddProfilingFile"><strong>AddProfilingFile</strong></a>(self, page, file_handle)</dt></dl>

 <dl><dt><a name="PageTestResults-AddSummaryValue"><strong>AddSummaryValue</strong></a>(self, value)</dt></dl>

 <dl><dt><a name="PageTestResults-AddValue"><strong>AddValue</strong></a>(self, value)</dt></dl>

 <dl><dt><a name="PageTestResults-CleanUp"><strong>CleanUp</strong></a>(self)</dt><dd><tt>Clean&nbsp;up&nbsp;any&nbsp;TraceValues&nbsp;contained&nbsp;within&nbsp;this&nbsp;results&nbsp;<a href="__builtin__.html#object">object</a>.</tt></dd></dl>

 <dl><dt><a name="PageTestResults-DidRunPage"><strong>DidRunPage</strong></a>(self, page)</dt><dd><tt>Args:<br>
 &nbsp;&nbsp;page:&nbsp;The&nbsp;current&nbsp;page&nbsp;under&nbsp;test.</tt></dd></dl>

 <dl><dt><a name="PageTestResults-FindAllPageSpecificValuesFromIRNamed"><strong>FindAllPageSpecificValuesFromIRNamed</strong></a>(self, tir_label, value_name)</dt></dl>

 <dl><dt><a name="PageTestResults-FindAllPageSpecificValuesNamed"><strong>FindAllPageSpecificValuesNamed</strong></a>(self, value_name)</dt></dl>

 <dl><dt><a name="PageTestResults-FindAllTraceValues"><strong>FindAllTraceValues</strong></a>(self)</dt></dl>

 <dl><dt><a name="PageTestResults-FindPageSpecificValuesForPage"><strong>FindPageSpecificValuesForPage</strong></a>(self, page, value_name)</dt></dl>

 <dl><dt><a name="PageTestResults-FindValues"><strong>FindValues</strong></a>(self, predicate)</dt><dd><tt>Finds&nbsp;all&nbsp;values&nbsp;matching&nbsp;the&nbsp;specified&nbsp;predicate.<br>
 &nbsp;<br>
 Args:<br>
 &nbsp;&nbsp;predicate:&nbsp;A&nbsp;function&nbsp;that&nbsp;takes&nbsp;a&nbsp;Value&nbsp;and&nbsp;returns&nbsp;a&nbsp;bool.<br>
 Returns:<br>
 &nbsp;&nbsp;A&nbsp;list&nbsp;of&nbsp;values&nbsp;matching&nbsp;|predicate|.</tt></dd></dl>

 <dl><dt><a name="PageTestResults-PrintSummary"><strong>PrintSummary</strong></a>(self)</dt></dl>

 <dl><dt><a name="PageTestResults-UploadProfilingFilesToCloud"><strong>UploadProfilingFilesToCloud</strong></a>(self, bucket)</dt></dl>

 <dl><dt><a name="PageTestResults-UploadTraceFilesToCloud"><strong>UploadTraceFilesToCloud</strong></a>(self, bucket)</dt></dl>

 <dl><dt><a name="PageTestResults-WillRunPage"><strong>WillRunPage</strong></a>(self, page)</dt></dl>

 <dl><dt><a name="PageTestResults-__copy__"><strong>__copy__</strong></a>(self)</dt></dl>

 <dl><dt><a name="PageTestResults-__enter__"><strong>__enter__</strong></a>(self)</dt></dl>

 <dl><dt><a name="PageTestResults-__exit__"><strong>__exit__</strong></a>(self, _, __, ___)</dt></dl>

 <dl><dt><a name="PageTestResults-__init__"><strong>__init__</strong></a>(self, output_formatters<font color="#909090">=None</font>, progress_reporter<font color="#909090">=None</font>, trace_tag<font color="#909090">=''</font>, output_dir<font color="#909090">=None</font>, value_can_be_added_predicate<font color="#909090">=&lt;function &lt;lambda&gt;&gt;</font>)</dt><dd><tt>Args:<br>
 &nbsp;&nbsp;output_formatters:&nbsp;A&nbsp;list&nbsp;of&nbsp;output&nbsp;formatters.&nbsp;The&nbsp;output<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;formatters&nbsp;are&nbsp;typically&nbsp;used&nbsp;to&nbsp;format&nbsp;the&nbsp;test&nbsp;results,&nbsp;such<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;as&nbsp;CsvPivotTableOutputFormatter,&nbsp;which&nbsp;output&nbsp;the&nbsp;test&nbsp;results&nbsp;as&nbsp;CSV.<br>
 &nbsp;&nbsp;progress_reporter:&nbsp;An&nbsp;instance&nbsp;of&nbsp;progress_reporter.ProgressReporter,<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;to&nbsp;be&nbsp;used&nbsp;to&nbsp;output&nbsp;test&nbsp;status/results&nbsp;progressively.<br>
 &nbsp;&nbsp;trace_tag:&nbsp;A&nbsp;string&nbsp;to&nbsp;append&nbsp;to&nbsp;the&nbsp;buildbot&nbsp;trace&nbsp;name.&nbsp;Currently&nbsp;only<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;used&nbsp;for&nbsp;buildbot.<br>
 &nbsp;&nbsp;output_dir:&nbsp;A&nbsp;string&nbsp;specified&nbsp;the&nbsp;directory&nbsp;where&nbsp;to&nbsp;store&nbsp;the&nbsp;test<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;artifacts,&nbsp;e.g:&nbsp;trace,&nbsp;videos,...<br>
 &nbsp;&nbsp;value_can_be_added_predicate:&nbsp;A&nbsp;function&nbsp;that&nbsp;takes&nbsp;two&nbsp;arguments:<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;a&nbsp;value.Value&nbsp;instance&nbsp;(except&nbsp;failure.FailureValue,&nbsp;skip.SkipValue<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;or&nbsp;trace.TraceValue)&nbsp;and&nbsp;a&nbsp;boolean&nbsp;(True&nbsp;when&nbsp;the&nbsp;value&nbsp;is&nbsp;part&nbsp;of<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;the&nbsp;first&nbsp;result&nbsp;for&nbsp;the&nbsp;story).&nbsp;It&nbsp;returns&nbsp;True&nbsp;if&nbsp;the&nbsp;value<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;can&nbsp;be&nbsp;added&nbsp;to&nbsp;the&nbsp;test&nbsp;results&nbsp;and&nbsp;False&nbsp;otherwise.</tt></dd></dl>

 <hr>
 Data descriptors defined here:<br>
 <dl><dt><strong>__dict__</strong></dt>
 <dd><tt>dictionary&nbsp;for&nbsp;instance&nbsp;variables&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 <dl><dt><strong>__weakref__</strong></dt>
 <dd><tt>list&nbsp;of&nbsp;weak&nbsp;references&nbsp;to&nbsp;the&nbsp;object&nbsp;(if&nbsp;defined)</tt></dd>
 </dl>
 <dl><dt><strong>all_page_runs</strong></dt>
 </dl>
 <dl><dt><strong>all_page_specific_values</strong></dt>
 </dl>
 <dl><dt><strong>all_summary_values</strong></dt>
 </dl>
 <dl><dt><strong>current_page</strong></dt>
 </dl>
 <dl><dt><strong>current_page_run</strong></dt>
 </dl>
 <dl><dt><strong>failures</strong></dt>
 </dl>
 <dl><dt><strong>pages_that_failed</strong></dt>
 <dd><tt>Returns&nbsp;the&nbsp;set&nbsp;of&nbsp;failed&nbsp;pages.</tt></dd>
 </dl>
 <dl><dt><strong>pages_that_succeeded</strong></dt>
 <dd><tt>Returns&nbsp;the&nbsp;set&nbsp;of&nbsp;pages&nbsp;that&nbsp;succeeded.</tt></dd>
 </dl>
 <dl><dt><strong>pages_to_profiling_files</strong></dt>
 </dl>
 <dl><dt><strong>pages_to_profiling_files_cloud_url</strong></dt>
 </dl>
 <dl><dt><strong>serialized_trace_file_ids_to_paths</strong></dt>
 </dl>
 <dl><dt><strong>skipped_values</strong></dt>
 </dl>
 </td></tr></table></td></tr></table>
 </body></html>

	<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
	<html><head><title>Python: module telemetry.internal.results.page_test_results</title>
	<meta charset="utf-8">
	</head><body bgcolor="#f0f0f8">

	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
	<tr bgcolor="#7799ee">
	<td valign=bottom> <br>
	<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>.page_test_results</strong></big></big></font></td
	><td align=right valign=bottom
	><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/internal/results/page_test_results.py">telemetry/internal/results/page_test_results.py</a></font></td></tr></table>
	<p><tt># Copyright 2014 The Chromium Authors. All rights reserved.<br>
	# Use of this source code is governed by a BSD-style license that can be<br>
	# found in the LICENSE file.</tt></p>
	<p>
	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
	<tr bgcolor="#aa55cc">
	<td colspan=3 valign=bottom> <br>
	<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>

	<tr><td bgcolor="#aa55cc"><tt>      </tt></td><td> </td>
	<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>
	<a href="collections.html">collections</a><br>
	<a href="copy.html">copy</a><br>
	<a href="datetime.html">datetime</a><br>
	</td><td width="25%" valign=top><a href="telemetry.value.failure.html">telemetry.value.failure</a><br>
	<a href="telemetry.internal.results.json_output_formatter.html">telemetry.internal.results.json_output_formatter</a><br>
	<a href="logging.html">logging</a><br>
	<a href="random.html">random</a><br>
	</td><td width="25%" valign=top><a href="telemetry.internal.results.progress_reporter.html">telemetry.internal.results.progress_reporter</a><br>
	<a href="telemetry.value.skip.html">telemetry.value.skip</a><br>
	<a href="telemetry.internal.results.story_run.html">telemetry.internal.results.story_run</a><br>
	<a href="sys.html">sys</a><br>
	</td><td width="25%" valign=top><a href="telemetry.value.trace.html">telemetry.value.trace</a><br>
	<a href="traceback.html">traceback</a><br>
	<a href="telemetry.value.html">telemetry.value</a><br>
	</td></tr></table></td></tr></table><p>
	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
	<tr bgcolor="#ee77aa">
	<td colspan=3 valign=bottom> <br>
	<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>

	<tr><td bgcolor="#ee77aa"><tt>      </tt></td><td> </td>
	<td width="100%"><dl>
	<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
	</font></dt><dd>
	<dl>
	<dt><font face="helvetica, arial"><a href="telemetry.internal.results.page_test_results.html#PageTestResults">PageTestResults</a>
	</font></dt></dl>
	</dd>
	</dl>
	<p>
	<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
	<tr bgcolor="#ffc8d8">
	<td colspan=3 valign=bottom> <br>
	<font color="#000000" face="helvetica, arial"><a name="PageTestResults">class <strong>PageTestResults</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>

	<tr><td bgcolor="#ffc8d8"><tt>   </tt></td><td> </td>
	<td width="100%">Methods defined here:<br>
	<dl><dt><a name="PageTestResults-AddProfilingFile"><strong>AddProfilingFile</strong></a>(self, page, file_handle)</dt></dl>

	<dl><dt><a name="PageTestResults-AddSummaryValue"><strong>AddSummaryValue</strong></a>(self, value)</dt></dl>

	<dl><dt><a name="PageTestResults-AddValue"><strong>AddValue</strong></a>(self, value)</dt></dl>

	<dl><dt><a name="PageTestResults-CleanUp"><strong>CleanUp</strong></a>(self)</dt><dd><tt>Clean up any TraceValues contained within this results <a href="__builtin__.html#object">object</a>.</tt></dd></dl>

	<dl><dt><a name="PageTestResults-DidRunPage"><strong>DidRunPage</strong></a>(self, page)</dt><dd><tt>Args:<br>
	page: The current page under test.</tt></dd></dl>

	<dl><dt><a name="PageTestResults-FindAllPageSpecificValuesFromIRNamed"><strong>FindAllPageSpecificValuesFromIRNamed</strong></a>(self, tir_label, value_name)</dt></dl>

	<dl><dt><a name="PageTestResults-FindAllPageSpecificValuesNamed"><strong>FindAllPageSpecificValuesNamed</strong></a>(self, value_name)</dt></dl>

	<dl><dt><a name="PageTestResults-FindAllTraceValues"><strong>FindAllTraceValues</strong></a>(self)</dt></dl>

	<dl><dt><a name="PageTestResults-FindPageSpecificValuesForPage"><strong>FindPageSpecificValuesForPage</strong></a>(self, page, value_name)</dt></dl>

	<dl><dt><a name="PageTestResults-FindValues"><strong>FindValues</strong></a>(self, predicate)</dt><dd><tt>Finds all values matching the specified predicate.<br>
	<br>
	Args:<br>
	predicate: A function that takes a Value and returns a bool.<br>
	Returns:<br>
	A list of values matching \|predicate\|.</tt></dd></dl>

	<dl><dt><a name="PageTestResults-PrintSummary"><strong>PrintSummary</strong></a>(self)</dt></dl>

	<dl><dt><a name="PageTestResults-UploadProfilingFilesToCloud"><strong>UploadProfilingFilesToCloud</strong></a>(self, bucket)</dt></dl>

	<dl><dt><a name="PageTestResults-UploadTraceFilesToCloud"><strong>UploadTraceFilesToCloud</strong></a>(self, bucket)</dt></dl>

	<dl><dt><a name="PageTestResults-WillRunPage"><strong>WillRunPage</strong></a>(self, page)</dt></dl>

	<dl><dt><a name="PageTestResults-__copy__"><strong>__copy__</strong></a>(self)</dt></dl>

	<dl><dt><a name="PageTestResults-__enter__"><strong>__enter__</strong></a>(self)</dt></dl>

	<dl><dt><a name="PageTestResults-__exit__"><strong>__exit__</strong></a>(self, _, __, ___)</dt></dl>

	<dl><dt><a name="PageTestResults-__init__"><strong>__init__</strong></a>(self, output_formatters<font color="#909090">=None</font>, progress_reporter<font color="#909090">=None</font>, trace_tag<font color="#909090">=''</font>, output_dir<font color="#909090">=None</font>, value_can_be_added_predicate<font color="#909090">=<function <lambda>></font>)</dt><dd><tt>Args:<br>
	output_formatters: A list of output formatters. The output<br>
	formatters are typically used to format the test results, such<br>
	as CsvPivotTableOutputFormatter, which output the test results as CSV.<br>
	progress_reporter: An instance of progress_reporter.ProgressReporter,<br>
	to be used to output test status/results progressively.<br>
	trace_tag: A string to append to the buildbot trace name. Currently only<br>
	used for buildbot.<br>
	output_dir: A string specified the directory where to store the test<br>
	artifacts, e.g: trace, videos,...<br>
	value_can_be_added_predicate: A function that takes two arguments:<br>
	a value.Value instance (except failure.FailureValue, skip.SkipValue<br>
	or trace.TraceValue) and a boolean (True when the value is part of<br>
	the first result for the story). It returns True if the value<br>
	can be added to the test results and False otherwise.</tt></dd></dl>

	<hr>
	Data descriptors defined here:<br>
	<dl><dt><strong>__dict__</strong></dt>
	<dd><tt>dictionary for instance variables (if defined)</tt></dd>
	</dl>
	<dl><dt><strong>__weakref__</strong></dt>
	<dd><tt>list of weak references to the object (if defined)</tt></dd>
	</dl>
	<dl><dt><strong>all_page_runs</strong></dt>
	</dl>
	<dl><dt><strong>all_page_specific_values</strong></dt>
	</dl>
	<dl><dt><strong>all_summary_values</strong></dt>
	</dl>
	<dl><dt><strong>current_page</strong></dt>
	</dl>
	<dl><dt><strong>current_page_run</strong></dt>
	</dl>
	<dl><dt><strong>failures</strong></dt>
	</dl>
	<dl><dt><strong>pages_that_failed</strong></dt>
	<dd><tt>Returns the set of failed pages.</tt></dd>
	</dl>
	<dl><dt><strong>pages_that_succeeded</strong></dt>
	<dd><tt>Returns the set of pages that succeeded.</tt></dd>
	</dl>
	<dl><dt><strong>pages_to_profiling_files</strong></dt>
	</dl>
	<dl><dt><strong>pages_to_profiling_files_cloud_url</strong></dt>
	</dl>
	<dl><dt><strong>serialized_trace_file_ids_to_paths</strong></dt>
	</dl>
	<dl><dt><strong>skipped_values</strong></dt>
	</dl>
	</td></tr></table></td></tr></table>
	</body></html>