catapult/telemetry/docs/pydoc/telemetry.project_config.html - platform/external/chromium-trace - Git at Google


 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
 <html><head><title>Python: module telemetry.project_config</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>.project_config</strong></big></big></font></td
 ><td align=right valign=bottom
 ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/project_config.py">telemetry/project_config.py</a></font></td></tr></table>
     <p><tt>#&nbsp;Copyright&nbsp;2013&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="#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.project_config.html#ProjectConfig">ProjectConfig</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="ProjectConfig">class <strong>ProjectConfig</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>

 <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
 <td colspan=2><tt>Contains&nbsp;information&nbsp;about&nbsp;the&nbsp;benchmark&nbsp;runtime&nbsp;environment.<br>
 &nbsp;<br>
 Attributes:<br>
 &nbsp;&nbsp;top_level_dir:&nbsp;A&nbsp;dir&nbsp;that&nbsp;contains&nbsp;benchmark,&nbsp;page&nbsp;test,&nbsp;and/or&nbsp;story<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;set&nbsp;dirs&nbsp;and&nbsp;associated&nbsp;artifacts.<br>
 &nbsp;&nbsp;benchmark_dirs:&nbsp;A&nbsp;list&nbsp;of&nbsp;dirs&nbsp;containing&nbsp;benchmarks.<br>
 &nbsp;&nbsp;benchmark_aliases:&nbsp;A&nbsp;dict&nbsp;of&nbsp;name:alias&nbsp;string&nbsp;pairs&nbsp;to&nbsp;be&nbsp;matched&nbsp;against<br>
 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;exactly&nbsp;during&nbsp;benchmark&nbsp;selection.<br>
 &nbsp;&nbsp;client_config:&nbsp;A&nbsp;path&nbsp;to&nbsp;a&nbsp;ProjectDependencies&nbsp;json&nbsp;file.<br>
 &nbsp;&nbsp;default_chrome_root:&nbsp;A&nbsp;path&nbsp;to&nbsp;chromium&nbsp;source&nbsp;directory.&nbsp;Many&nbsp;telemetry<br>
 &nbsp;&nbsp;&nbsp;&nbsp;features&nbsp;depend&nbsp;on&nbsp;chromium&nbsp;source&nbsp;tree's&nbsp;presence&nbsp;and&nbsp;those&nbsp;won't&nbsp;work<br>
 &nbsp;&nbsp;&nbsp;&nbsp;in&nbsp;case&nbsp;this&nbsp;is&nbsp;not&nbsp;specified.<br>&nbsp;</tt></td></tr>
 <tr><td>&nbsp;</td>
 <td width="100%">Methods defined here:<br>
 <dl><dt><a name="ProjectConfig-__init__"><strong>__init__</strong></a>(self, top_level_dir, benchmark_dirs<font color="#909090">=None</font>, benchmark_aliases<font color="#909090">=None</font>, client_config<font color="#909090">=None</font>, default_chrome_root<font color="#909090">=None</font>)</dt></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>benchmark_aliases</strong></dt>
 </dl>
 <dl><dt><strong>benchmark_dirs</strong></dt>
 </dl>
 <dl><dt><strong>client_config</strong></dt>
 </dl>
 <dl><dt><strong>default_chrome_root</strong></dt>
 </dl>
 <dl><dt><strong>top_level_dir</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.project_config</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>.project_config</strong></big></big></font></td
	><td align=right valign=bottom
	><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/project_config.py">telemetry/project_config.py</a></font></td></tr></table>
	<p><tt># Copyright 2013 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="#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.project_config.html#ProjectConfig">ProjectConfig</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="ProjectConfig">class <strong>ProjectConfig</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>

	<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>
	<td colspan=2><tt>Contains information about the benchmark runtime environment.<br>
	<br>
	Attributes:<br>
	top_level_dir: A dir that contains benchmark, page test, and/or story<br>
	set dirs and associated artifacts.<br>
	benchmark_dirs: A list of dirs containing benchmarks.<br>
	benchmark_aliases: A dict of name:alias string pairs to be matched against<br>
	exactly during benchmark selection.<br>
	client_config: A path to a ProjectDependencies json file.<br>
	default_chrome_root: A path to chromium source directory. Many telemetry<br>
	features depend on chromium source tree's presence and those won't work<br>
	in case this is not specified.<br> </tt></td></tr>
	<tr><td> </td>
	<td width="100%">Methods defined here:<br>
	<dl><dt><a name="ProjectConfig-__init__"><strong>__init__</strong></a>(self, top_level_dir, benchmark_dirs<font color="#909090">=None</font>, benchmark_aliases<font color="#909090">=None</font>, client_config<font color="#909090">=None</font>, default_chrome_root<font color="#909090">=None</font>)</dt></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>benchmark_aliases</strong></dt>
	</dl>
	<dl><dt><strong>benchmark_dirs</strong></dt>
	</dl>
	<dl><dt><strong>client_config</strong></dt>
	</dl>
	<dl><dt><strong>default_chrome_root</strong></dt>
	</dl>
	<dl><dt><strong>top_level_dir</strong></dt>
	</dl>
	</td></tr></table></td></tr></table>
	</body></html>