tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_page_test.html - Issue 1647513002: Delete tools/telemetry.

Unified Diff: tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_page_test.html

Issue 1647513002: Delete tools/telemetry. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master

Patch Set: Created 4 years, 11 months ago

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Jump to:

View side-by-side diff with in-line comments

Download patch

« no previous file with comments | « tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_measurement.html ('k') | tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_interaction_record.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_page_test.html

diff --git a/tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_page_test.html b/tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_page_test.html

deleted file mode 100644

index e3cbb383b4d323603abd3281748c32ee18a45637..0000000000000000000000000000000000000000

--- a/tools/telemetry/docs/pydoc/telemetry.web_perf.timeline_based_page_test.html

+++ /dev/null

@@ -1,136 +0,0 @@

-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

-<html><head><title>Python: module telemetry.web_perf.timeline_based_page_test</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>

-  <big><big><a href="telemetry.html">telemetry</a>.<a href="telemetry.web_perf.html">web_perf</a>.timeline_based_page_test</big></big></td

-><td align=right valign=bottom

-><a href=".">index</a> <a href="../telemetry/web_perf/timeline_based_page_test.py">telemetry/web_perf/timeline_based_page_test.py</a></td></tr></table>

- <tt># Copyright (c) 2015 The Chromium Authors. All rights reserved.

-# Use of this source code is governed by a BSD-style license that can be

-# found in the LICENSE file.</tt>

-

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#aa55cc">

-<td colspan=3 valign=bottom>

-<big>Modules</big></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="telemetry.page.page_test.html">telemetry.page.page_test</a>

-</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table>

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#ee77aa">

-<td colspan=3 valign=bottom>

-<big>Classes</big></td></tr>

-<tr><td bgcolor="#ee77aa"><tt>      </tt></td><td> </td>

-<td width="100%"><dl>

-<dt><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>(<a href="__builtin__.html#object">__builtin__.object</a>)

-</dt><dd>

-<dl>

-<dt><a href="telemetry.web_perf.timeline_based_page_test.html#TimelineBasedPageTest">TimelineBasedPageTest</a>

-</dt></dl>

-</dd>

-</dl>

-

-<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">

-<tr bgcolor="#ffc8d8">

-<td colspan=3 valign=bottom>

-<a name="TimelineBasedPageTest">class TimelineBasedPageTest</a>(<a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>)</td></tr>

-<tr bgcolor="#ffc8d8"><td rowspan=2><tt>   </tt></td>

-<td colspan=2><tt>Page test that collects metrics with TimelineBasedMeasurement.

-

-WillRunStory(), Measure() and DidRunStory() are all done in story_runner

-explicitly. We still need this wrapper around <a href="telemetry.page.page_test.html#PageTest">PageTest</a> because it executes

-some browser related functions in the parent class, which is needed by

-Timeline Based Measurement benchmarks. This class will be removed after

-page_test's hooks are fully removed.  </tt></td></tr>

-<tr><td> </td>

-<td width="100%"><dl><dt>Method resolution order:</dt>

-<dd><a href="telemetry.web_perf.timeline_based_page_test.html#TimelineBasedPageTest">TimelineBasedPageTest</a></dd>

-<dd><a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a></dd>

-<dd><a href="__builtin__.html#object">__builtin__.object</a></dd>

-</dl>

-<hr>

-Methods defined here:

-<dl><dt><a name="TimelineBasedPageTest-ValidateAndMeasurePage">ValidateAndMeasurePage</a>(self, page, tab, results)</dt><dd><tt>Collect all possible metrics and added them to results.</tt></dd></dl>

-<dl><dt><a name="TimelineBasedPageTest-__init__">__init__</a>(self, tbm)</dt></dl>

-<hr>

-Data descriptors defined here:

-<dl><dt>measurement</dt>

-</dl>

-<hr>

-Methods inherited from <a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>:

-<dl><dt><a name="TimelineBasedPageTest-CustomizeBrowserOptions">CustomizeBrowserOptions</a>(self, options)</dt><dd><tt>Override to add test-specific options to the BrowserOptions object</tt></dd></dl>

-<dl><dt><a name="TimelineBasedPageTest-DidNavigateToPage">DidNavigateToPage</a>(self, page, tab)</dt><dd><tt>Override to do operations right after the page is navigated and after

-all waiting for completion has occurred.</tt></dd></dl>

-<dl><dt><a name="TimelineBasedPageTest-DidRunPage">DidRunPage</a>(self, platform)</dt><dd><tt>Called after the test run method was run, even if it failed.</tt></dd></dl>

-<dl><dt><a name="TimelineBasedPageTest-DidStartBrowser">DidStartBrowser</a>(self, browser)</dt><dd><tt>Override to customize the browser right after it has launched.</tt></dd></dl>

-<dl><dt><a name="TimelineBasedPageTest-RestartBrowserBeforeEachPage">RestartBrowserBeforeEachPage</a>(self)</dt><dd><tt>Should the browser be restarted for the page?

-

-This returns true if the test needs to unconditionally restart the

-browser for each page. It may be called before the browser is started.</tt></dd></dl>

-<dl><dt><a name="TimelineBasedPageTest-RunNavigateSteps">RunNavigateSteps</a>(self, page, tab)</dt><dd><tt>Navigates the tab to the page URL attribute.

-

-Runs the 'navigate_steps' page attribute as a compound action.</tt></dd></dl>

-<dl><dt><a name="TimelineBasedPageTest-SetOptions">SetOptions</a>(self, options)</dt><dd><tt>Sets the BrowserFinderOptions instance to use.</tt></dd></dl>

-<dl><dt><a name="TimelineBasedPageTest-StopBrowserAfterPage">StopBrowserAfterPage</a>(self, browser, page)</dt><dd><tt>Should the browser be stopped after the page is run?

-

-This is called after a page is run to decide whether the browser needs to

-be stopped to clean up its state. If it is stopped, then it will be

-restarted to run the next page.

-

-A test that overrides this can look at both the page and the browser to

-decide whether it needs to stop the browser.</tt></dd></dl>

-<dl><dt><a name="TimelineBasedPageTest-TabForPage">TabForPage</a>(self, page, browser)</dt><dd><tt>Override to select a different tab for the page.  For instance, to

-create a new tab for every page, return browser.tabs.New().</tt></dd></dl>

-<dl><dt><a name="TimelineBasedPageTest-WillNavigateToPage">WillNavigateToPage</a>(self, page, tab)</dt><dd><tt>Override to do operations before the page is navigated, notably Telemetry

-will already have performed the following operations on the browser before

-calling this function:

-* Ensure only one tab is open.

-* Call WaitForDocumentReadyStateToComplete on the tab.</tt></dd></dl>

-<dl><dt><a name="TimelineBasedPageTest-WillStartBrowser">WillStartBrowser</a>(self, platform)</dt><dd><tt>Override to manipulate the browser environment before it launches.</tt></dd></dl>

-<hr>

-Data descriptors inherited from <a href="telemetry.page.page_test.html#PageTest">telemetry.page.page_test.PageTest</a>:

-<dl><dt>__dict__</dt>

-<dd><tt>dictionary for instance variables (if defined)</tt></dd>

-</dl>

-<dl><dt>__weakref__</dt>

-<dd><tt>list of weak references to the object (if defined)</tt></dd>

-</dl>

-<dl><dt>clear_cache_before_each_run</dt>

-<dd><tt>When set to True, the browser's disk and memory cache will be cleared

-before each run.</tt></dd>

-</dl>

-<dl><dt>close_tabs_before_run</dt>

-<dd><tt>When set to True, all tabs are closed before running the test for the

-first time.</tt></dd>

-</dl>

-<dl><dt>is_multi_tab_test</dt>

-<dd><tt>Returns True if the test opens multiple tabs.

-

-If the test overrides TabForPage, it is deemed a multi-tab test.

-Multi-tab tests do not retry after tab or browser crashes, whereas,

-single-tab tests too. That is because the state of multi-tab tests

-(e.g., how many tabs are open, etc.) is unknown after crashes.</tt></dd>

-</dl>

-</td></tr></table></td></tr></table>

-</body></html>