From f9a5c9e6e7f0959187f0a3f4cda6bdcfde0a3b9c Mon Sep 17 00:00:00 2001 From: "nduca@chromium.org" Date: Wed, 19 Jun 2013 03:31:53 +0000 Subject: [telemetry] Initial (autogenerated) documentation plus support scripts This makes help(telemetry) show the classes and methods we care most about. Then, it adds ./update_docs script that autogenerates a docs/ folder using pydoc.writedoc. Finally, it adds docs/ which contains HTML documentation on telemetry generated by update_docs. BUG=241616 Review URL: https://chromiumcodereview.appspot.com/17150002 git-svn-id: svn://svn.chromium.org/chrome/trunk/src@207156 0039d316-1c4b-4281-b951-d872f2087c98 --- tools/telemetry/build/__init__.py | 3 + tools/telemetry/build/update_docs.py | 64 +++ tools/telemetry/docs/telemetry.core.browser.html | 174 +++++++ .../docs/telemetry.core.browser_credentials.html | 78 +++ .../docs/telemetry.core.browser_finder.html | 179 +++++++ .../docs/telemetry.core.browser_options.html | 79 +++ .../docs/telemetry.core.chrome.adb_commands.html | 165 ++++++ ...emetry.core.chrome.android_browser_backend.html | 316 ++++++++++++ ...lemetry.core.chrome.android_browser_finder.html | 102 ++++ .../telemetry.core.chrome.browser_backend.html | 215 ++++++++ ...telemetry.core.chrome.cros_browser_backend.html | 174 +++++++ .../telemetry.core.chrome.cros_browser_finder.html | 96 ++++ .../docs/telemetry.core.chrome.cros_interface.html | 248 +++++++++ .../docs/telemetry.core.chrome.cros_util.html | 36 ++ .../docs/telemetry.core.chrome.crx_id.html | 41 ++ ...emetry.core.chrome.desktop_browser_backend.html | 140 ++++++ ...lemetry.core.chrome.desktop_browser_finder.html | 98 ++++ ...lemetry.core.chrome.extension_dict_backend.html | 133 +++++ ...y.core.chrome.facebook_credentials_backend.html | 88 ++++ ...core.chrome.form_based_credentials_backend.html | 79 +++ ...rm_based_credentials_backend_unittest_base.html | 343 +++++++++++++ ...try.core.chrome.google_credentials_backend.html | 88 ++++ tools/telemetry/docs/telemetry.core.chrome.html | 65 +++ .../telemetry.core.chrome.inspector_backend.html | 195 +++++++ .../telemetry.core.chrome.inspector_console.html | 60 +++ .../telemetry.core.chrome.inspector_memory.html | 133 +++++ .../docs/telemetry.core.chrome.inspector_page.html | 74 +++ .../telemetry.core.chrome.inspector_runtime.html | 72 +++ .../telemetry.core.chrome.inspector_timeline.html | 133 +++++ ...etry.core.chrome.misc_web_contents_backend.html | 68 +++ .../docs/telemetry.core.chrome.png_bitmap.html | 107 ++++ .../telemetry.core.chrome.tab_list_backend.html | 85 ++++ .../docs/telemetry.core.chrome.trace_result.html | 54 ++ .../telemetry.core.chrome.tracing_backend.html | 160 ++++++ .../docs/telemetry.core.chrome.websocket.html | 40 ++ tools/telemetry/docs/telemetry.core.discover.html | 59 +++ .../telemetry/docs/telemetry.core.exceptions.html | 338 +++++++++++++ .../docs/telemetry.core.extension_dict.html | 64 +++ .../docs/telemetry.core.extension_page.html | 103 ++++ .../docs/telemetry.core.extension_to_load.html | 194 +++++++ tools/telemetry/docs/telemetry.core.html | 57 +++ .../telemetry.core.memory_cache_http_server.html | 559 +++++++++++++++++++++ ...try.core.platform.android_platform_backend.html | 102 ++++ ...emetry.core.platform.cros_platform_backend.html | 101 ++++ tools/telemetry/docs/telemetry.core.platform.html | 108 ++++ ...metry.core.platform.linux_platform_backend.html | 97 ++++ ...lemetry.core.platform.mac_platform_backend.html | 98 ++++ .../telemetry.core.platform.platform_backend.html | 77 +++ ...metry.core.platform.posix_platform_backend.html | 94 ++++ .../docs/telemetry.core.platform.profiler.html | 72 +++ ....core.platform.profiler.iprofiler_profiler.html | 76 +++ ....core.platform.profiler.java_heap_profiler.html | 77 +++ ...metry.core.platform.profiler.perf_profiler.html | 75 +++ ...try.core.platform.profiler.profiler_finder.html | 37 ++ ...try.core.platform.profiler.sample_profiler.html | 76 +++ ...e.platform.profiler.tcmalloc_heap_profiler.html | 76 +++ ...lemetry.core.platform.win_platform_backend.html | 108 ++++ .../docs/telemetry.core.possible_browser.html | 63 +++ .../docs/telemetry.core.profile_creator.html | 53 ++ .../docs/telemetry.core.profile_types.html | 51 ++ tools/telemetry/docs/telemetry.core.tab.html | 166 ++++++ tools/telemetry/docs/telemetry.core.tab_list.html | 61 +++ .../docs/telemetry.core.temporary_http_server.html | 76 +++ .../docs/telemetry.core.timeline.event.html | 60 +++ tools/telemetry/docs/telemetry.core.timeline.html | 29 ++ .../docs/telemetry.core.timeline.importer.html | 61 +++ ...telemetry.core.timeline.inspector_importer.html | 74 +++ .../docs/telemetry.core.timeline.model.html | 68 +++ ...lemetry.core.timeline.trace_event_importer.html | 33 ++ .../telemetry/docs/telemetry.core.user_agent.html | 33 ++ tools/telemetry/docs/telemetry.core.util.html | 138 +++++ .../docs/telemetry.core.web_contents.html | 94 ++++ tools/telemetry/docs/telemetry.core.wpr_modes.html | 25 + .../telemetry/docs/telemetry.core.wpr_server.html | 74 +++ tools/telemetry/docs/telemetry.html | 481 ++++++++++++++++++ .../telemetry.page.actions.all_page_actions.html | 36 ++ .../docs/telemetry.page.actions.click_element.html | 99 ++++ tools/telemetry/docs/telemetry.page.actions.html | 31 ++ .../telemetry.page.actions.js_collect_garbage.html | 96 ++++ .../docs/telemetry.page.actions.page_action.html | 205 ++++++++ .../docs/telemetry.page.actions.reload.html | 97 ++++ .../docs/telemetry.page.actions.scroll.html | 86 ++++ .../docs/telemetry.page.actions.wait.html | 98 ++++ ...emetry.page.block_page_measurement_results.html | 144 ++++++ ...try.page.buildbot_page_measurement_results.html | 147 ++++++ ...elemetry.page.csv_page_measurement_results.html | 144 ++++++ .../docs/telemetry.page.gtest_test_results.html | 125 +++++ tools/telemetry/docs/telemetry.page.html | 54 ++ tools/telemetry/docs/telemetry.page.page.html | 79 +++ .../telemetry/docs/telemetry.page.page_filter.html | 66 +++ .../docs/telemetry.page.page_measurement.html | 244 +++++++++ .../telemetry.page.page_measurement_results.html | 177 +++++++ .../telemetry.page.page_measurement_runner.html | 107 ++++ ...emetry.page.page_measurement_unittest_base.html | 346 +++++++++++++ .../telemetry.page.page_measurement_value.html | 61 +++ .../telemetry/docs/telemetry.page.page_runner.html | 84 ++++ tools/telemetry/docs/telemetry.page.page_set.html | 82 +++ .../docs/telemetry.page.page_set_archive_info.html | 71 +++ tools/telemetry/docs/telemetry.page.page_test.html | 190 +++++++ .../docs/telemetry.page.page_test_results.html | 120 +++++ .../docs/telemetry.page.page_test_runner.html | 104 ++++ .../docs/telemetry.page.perf_tests_helper.html | 41 ++ .../telemetry/docs/telemetry.page.record_wpr.html | 137 +++++ .../docs/telemetry.unittest.gtest_testrunner.html | 121 +++++ tools/telemetry/docs/telemetry.unittest.html | 41 ++ .../telemetry.unittest.options_for_unittests.html | 31 ++ .../docs/telemetry.unittest.run_tests.html | 42 ++ .../docs/telemetry.unittest.simple_mock.html | 106 ++++ .../docs/telemetry.unittest.system_stub.html | 164 ++++++ .../docs/telemetry.unittest.tab_test_case.html | 334 ++++++++++++ tools/telemetry/telemetry/__init__.py | 29 +- tools/telemetry/update_docs | 11 + 112 files changed, 12621 insertions(+), 2 deletions(-) create mode 100644 tools/telemetry/build/__init__.py create mode 100644 tools/telemetry/build/update_docs.py create mode 100644 tools/telemetry/docs/telemetry.core.browser.html create mode 100644 tools/telemetry/docs/telemetry.core.browser_credentials.html create mode 100644 tools/telemetry/docs/telemetry.core.browser_finder.html create mode 100644 tools/telemetry/docs/telemetry.core.browser_options.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.adb_commands.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.android_browser_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.android_browser_finder.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.browser_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.cros_browser_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.cros_browser_finder.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.cros_interface.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.cros_util.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.crx_id.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.desktop_browser_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.desktop_browser_finder.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.extension_dict_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.facebook_credentials_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.form_based_credentials_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.form_based_credentials_backend_unittest_base.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.google_credentials_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.inspector_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.inspector_console.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.inspector_memory.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.inspector_page.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.inspector_runtime.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.inspector_timeline.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.misc_web_contents_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.png_bitmap.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.tab_list_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.trace_result.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.tracing_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.chrome.websocket.html create mode 100644 tools/telemetry/docs/telemetry.core.discover.html create mode 100644 tools/telemetry/docs/telemetry.core.exceptions.html create mode 100644 tools/telemetry/docs/telemetry.core.extension_dict.html create mode 100644 tools/telemetry/docs/telemetry.core.extension_page.html create mode 100644 tools/telemetry/docs/telemetry.core.extension_to_load.html create mode 100644 tools/telemetry/docs/telemetry.core.html create mode 100644 tools/telemetry/docs/telemetry.core.memory_cache_http_server.html create mode 100644 tools/telemetry/docs/telemetry.core.platform.android_platform_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.platform.cros_platform_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.platform.html create mode 100644 tools/telemetry/docs/telemetry.core.platform.linux_platform_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.platform.mac_platform_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.platform.platform_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.platform.posix_platform_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.platform.profiler.html create mode 100644 tools/telemetry/docs/telemetry.core.platform.profiler.iprofiler_profiler.html create mode 100644 tools/telemetry/docs/telemetry.core.platform.profiler.java_heap_profiler.html create mode 100644 tools/telemetry/docs/telemetry.core.platform.profiler.perf_profiler.html create mode 100644 tools/telemetry/docs/telemetry.core.platform.profiler.profiler_finder.html create mode 100644 tools/telemetry/docs/telemetry.core.platform.profiler.sample_profiler.html create mode 100644 tools/telemetry/docs/telemetry.core.platform.profiler.tcmalloc_heap_profiler.html create mode 100644 tools/telemetry/docs/telemetry.core.platform.win_platform_backend.html create mode 100644 tools/telemetry/docs/telemetry.core.possible_browser.html create mode 100644 tools/telemetry/docs/telemetry.core.profile_creator.html create mode 100644 tools/telemetry/docs/telemetry.core.profile_types.html create mode 100644 tools/telemetry/docs/telemetry.core.tab.html create mode 100644 tools/telemetry/docs/telemetry.core.tab_list.html create mode 100644 tools/telemetry/docs/telemetry.core.temporary_http_server.html create mode 100644 tools/telemetry/docs/telemetry.core.timeline.event.html create mode 100644 tools/telemetry/docs/telemetry.core.timeline.html create mode 100644 tools/telemetry/docs/telemetry.core.timeline.importer.html create mode 100644 tools/telemetry/docs/telemetry.core.timeline.inspector_importer.html create mode 100644 tools/telemetry/docs/telemetry.core.timeline.model.html create mode 100644 tools/telemetry/docs/telemetry.core.timeline.trace_event_importer.html create mode 100644 tools/telemetry/docs/telemetry.core.user_agent.html create mode 100644 tools/telemetry/docs/telemetry.core.util.html create mode 100644 tools/telemetry/docs/telemetry.core.web_contents.html create mode 100644 tools/telemetry/docs/telemetry.core.wpr_modes.html create mode 100644 tools/telemetry/docs/telemetry.core.wpr_server.html create mode 100644 tools/telemetry/docs/telemetry.html create mode 100644 tools/telemetry/docs/telemetry.page.actions.all_page_actions.html create mode 100644 tools/telemetry/docs/telemetry.page.actions.click_element.html create mode 100644 tools/telemetry/docs/telemetry.page.actions.html create mode 100644 tools/telemetry/docs/telemetry.page.actions.js_collect_garbage.html create mode 100644 tools/telemetry/docs/telemetry.page.actions.page_action.html create mode 100644 tools/telemetry/docs/telemetry.page.actions.reload.html create mode 100644 tools/telemetry/docs/telemetry.page.actions.scroll.html create mode 100644 tools/telemetry/docs/telemetry.page.actions.wait.html create mode 100644 tools/telemetry/docs/telemetry.page.block_page_measurement_results.html create mode 100644 tools/telemetry/docs/telemetry.page.buildbot_page_measurement_results.html create mode 100644 tools/telemetry/docs/telemetry.page.csv_page_measurement_results.html create mode 100644 tools/telemetry/docs/telemetry.page.gtest_test_results.html create mode 100644 tools/telemetry/docs/telemetry.page.html create mode 100644 tools/telemetry/docs/telemetry.page.page.html create mode 100644 tools/telemetry/docs/telemetry.page.page_filter.html create mode 100644 tools/telemetry/docs/telemetry.page.page_measurement.html create mode 100644 tools/telemetry/docs/telemetry.page.page_measurement_results.html create mode 100644 tools/telemetry/docs/telemetry.page.page_measurement_runner.html create mode 100644 tools/telemetry/docs/telemetry.page.page_measurement_unittest_base.html create mode 100644 tools/telemetry/docs/telemetry.page.page_measurement_value.html create mode 100644 tools/telemetry/docs/telemetry.page.page_runner.html create mode 100644 tools/telemetry/docs/telemetry.page.page_set.html create mode 100644 tools/telemetry/docs/telemetry.page.page_set_archive_info.html create mode 100644 tools/telemetry/docs/telemetry.page.page_test.html create mode 100644 tools/telemetry/docs/telemetry.page.page_test_results.html create mode 100644 tools/telemetry/docs/telemetry.page.page_test_runner.html create mode 100644 tools/telemetry/docs/telemetry.page.perf_tests_helper.html create mode 100644 tools/telemetry/docs/telemetry.page.record_wpr.html create mode 100644 tools/telemetry/docs/telemetry.unittest.gtest_testrunner.html create mode 100644 tools/telemetry/docs/telemetry.unittest.html create mode 100644 tools/telemetry/docs/telemetry.unittest.options_for_unittests.html create mode 100644 tools/telemetry/docs/telemetry.unittest.run_tests.html create mode 100644 tools/telemetry/docs/telemetry.unittest.simple_mock.html create mode 100644 tools/telemetry/docs/telemetry.unittest.system_stub.html create mode 100644 tools/telemetry/docs/telemetry.unittest.tab_test_case.html create mode 100755 tools/telemetry/update_docs (limited to 'tools/telemetry') diff --git a/tools/telemetry/build/__init__.py b/tools/telemetry/build/__init__.py new file mode 100644 index 0000000..9228df8 --- /dev/null +++ b/tools/telemetry/build/__init__.py @@ -0,0 +1,3 @@ +# Copyright 2013 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. diff --git a/tools/telemetry/build/update_docs.py b/tools/telemetry/build/update_docs.py new file mode 100644 index 0000000..019ad55 --- /dev/null +++ b/tools/telemetry/build/update_docs.py @@ -0,0 +1,64 @@ +# Copyright 2013 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. +import logging +import optparse +import os +import pkgutil +import pydoc +import sys + +from telemetry.core import util + +def RemoveAllDocs(docs_dir): + for dirname, _, filenames in os.walk(docs_dir): + for filename in filenames: + os.remove(os.path.join(dirname, filename)) + +def WriteDocsFor(module): + pydoc.writedoc(module) + for _, modname, _ in pkgutil.walk_packages( + module.__path__, module.__name__ + '.'): + if modname.endswith('_unittest'): + logging.info("skipping %s due to being a unittest", modname) + continue + + module = __import__(modname, fromlist=[""]) + name, _ = os.path.splitext(module.__file__) + if not os.path.exists(name + '.py'): + logging.info("skipping %s due to being an orphan .pyc", module.__file__) + continue + + pydoc.writedoc(module) + +def Main(args): + parser = optparse.OptionParser() + parser.add_option( + '-v', '--verbose', action='count', default=0, + help='Increase verbosity level (repeat as needed)') + options, args = parser.parse_args(args) + if options.verbose >= 2: + logging.basicConfig(level=logging.DEBUG) + elif options.verbose: + logging.basicConfig(level=logging.INFO) + else: + logging.basicConfig(level=logging.WARNING) + + + telemetry_dir = util.GetTelemetryDir() + docs_dir = os.path.join(telemetry_dir, 'docs') + + assert os.path.isdir(docs_dir) + + RemoveAllDocs(docs_dir) + + if telemetry_dir not in sys.path: + sys.path.append(telemetry_dir) + import telemetry + + old_cwd = os.getcwd() + try: + os.chdir(docs_dir) + WriteDocsFor(telemetry) + finally: + os.chdir(old_cwd) diff --git a/tools/telemetry/docs/telemetry.core.browser.html b/tools/telemetry/docs/telemetry.core.browser.html new file mode 100644 index 0000000..4c7f8b1 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.browser.html @@ -0,0 +1,174 @@ + + +Python: module telemetry.core.browser + + + + +
 
+ 
telemetry.core.browser		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/browser.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.chrome.browser_backend
+telemetry.core.browser_credentials
+telemetry.core.extension_dict
+		os
+telemetry.core.platform
+telemetry.core.platform.profiler.profiler_finder
+		telemetry.core.tab_list
+telemetry.core.temporary_http_server
+telemetry.core.wpr_modes
+		telemetry.core.wpr_server
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
Browser +
+
+
+

+ + + + + + + +
 
+class Browser(__builtin__.object)
   A running browser instance that can be controlled in a limited way.
+ 
+To create a browser instance, use browser_finder.FindBrowser.
+ 
+Be sure to clean up after yourself by calling Close() when you are done with
+the browser. Or better yet:
+  browser_to_create = FindBrowser(options)
+  with browser_to_create.Create() as browser:
+    ... do all your operations on browser here
 
 Methods defined here:
+
Close(self)
Closes this browser.
+ +
GetStandardOutput(self)
+ +
GetTraceResultAndReset(self)
Returns the result of the trace, as TraceResult object.
+ +
SetHTTPServerDirectories(self, paths)
Returns True if the HTTP server was started, False otherwise.
+ +
SetReplayArchivePath(self, archive_path, append_to_existing_wpr=False)
+ +
StartProfiling(self, options, base_output_file)
Starts profiling using |options|.profiler_tool. Results are saved to
+|base_output_file|.<process_name>.
+ +
StartTracing(self, custom_categories=None)
+ +
StopProfiling(self)
Stops all active profilers and saves their results.
+ +
StopTracing(self)
+ +
__enter__(self)
+ +
__exit__(self, *args)
+ +
__init__(self, backend, platform_backend)
+ +
is_profiler_active(self, profiler_name)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
browser_type
+
+
extensions
+
Returns the extension dictionary if it exists.
+
+
http_server
+
+
io_stats
+
Returns a dict of IO statistics for the browser:
+{ 'Browser': {
+    'ReadOperationCount': W,
+    'WriteOperationCount': X,
+    'ReadTransferCount': Y,
+    'WriteTransferCount': Z
+  },
+  'Gpu': {
+    'ReadOperationCount': W,
+    'WriteOperationCount': X,
+    'ReadTransferCount': Y,
+    'WriteTransferCount': Z
+  },
+  'Renderer': {
+    'ReadOperationCount': W,
+    'WriteOperationCount': X,
+    'ReadTransferCount': Y,
+    'WriteTransferCount': Z
+  }
+}
+
+
is_content_shell
+
Returns whether this browser is a content shell, only.
+
+
memory_stats
+
Returns a dict of memory statistics for the browser:
+{ 'Browser': {
+    'VM': S,
+    'VMPeak': T,
+    'WorkingSetSize': U,
+    'WorkingSetSizePeak': V,
+    'ProportionalSetSize': W,
+    'PrivateDirty': X
+  },
+  'Gpu': {
+    'VM': S,
+    'VMPeak': T,
+    'WorkingSetSize': U,
+    'WorkingSetSizePeak': V,
+    'ProportionalSetSize': W,
+    'PrivateDirty': X
+  },
+  'Renderer': {
+    'VM': S,
+    'VMPeak': T,
+    'WorkingSetSize': U,
+    'WorkingSetSizePeak': V,
+    'ProportionalSetSize': W,
+    'PrivateDirty': X
+  },
+  'SystemCommitCharge': Y,
+  'ProcessCount': Z,
+}
+Any of the above keys may be missing on a per-platform basis.
+
+
platform
+
+
supports_extensions
+
+
supports_tab_control
+
+
supports_tracing
+
+
tabs
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.browser_credentials.html b/tools/telemetry/docs/telemetry.core.browser_credentials.html new file mode 100644 index 0000000..dd73f11 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.browser_credentials.html @@ -0,0 +1,78 @@ + + +Python: module telemetry.core.browser_credentials + + + + +
 
+ 
telemetry.core.browser_credentials		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/browser_credentials.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.chrome.facebook_credentials_backend
+telemetry.core.chrome.google_credentials_backend
+		json
+logging
+		telemetry.unittest.options_for_unittests
+os
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
BrowserCredentials +
+
+
+

+ + + + + +
 
+class BrowserCredentials(__builtin__.object)
    Methods defined here:
+
Add(self, credentials_type, data)
+ +
AddBackend(self, backend)
+ +
CanLogin(self, credentials_type)
+ +
IsLoggedIn(self, credentials_type)
+ +
LoginNeeded(self, tab, credentials_type)
+ +
LoginNoLongerNeeded(self, tab, credentials_type)
+ +
WarnIfMissingCredentials(self, page_set)
+ +
__init__(self, backends=None)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
credentials_path
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.browser_finder.html b/tools/telemetry/docs/telemetry.core.browser_finder.html new file mode 100644 index 0000000..5e60c35 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.browser_finder.html @@ -0,0 +1,179 @@ + + +Python: module telemetry.core.browser_finder + + + + +
 
+ 
telemetry.core.browser_finder		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/browser_finder.py
+

Finds browsers that can be controlled by telemetry.

+

+ + + + + +
 
+Modules
       
telemetry.core.chrome.android_browser_finder
+		telemetry.core.chrome.cros_browser_finder
+		telemetry.core.chrome.desktop_browser_finder
+		logging
+

+ + + + + +
 
+Classes
       
+
exceptions.Exception(exceptions.BaseException) +
+
+
BrowserFinderException +
BrowserTypeRequiredException +
+
+
+

+ + + + + +
 
+class BrowserFinderException(exceptions.Exception)
    
Method resolution order:
+
BrowserFinderException
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + +
 
+class BrowserTypeRequiredException(exceptions.Exception)
    
Method resolution order:
+
BrowserTypeRequiredException
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + +
 
+Functions
       
FindBrowser(options)
Finds the best PossibleBrowser object to run given the provided
+BrowserOptions object. The returned possiblity object can then be used to
+connect to and control the located browser. A BrowserFinderException will
+be raised if the BrowserOptions argument is improperly set or if an error
+occurs when finding a browser.
+
GetAllAvailableBrowserTypes(options)
Returns an array of browser types supported on this system.
+A BrowserFinderException will be raised if the BrowserOptions argument is
+improperly set or if an error occurs when finding a browser.
+

+ + + + + +
 
+Data
       ALL_BROWSER_TYPES = 'exact,release,debug,canary,content-shell-debug,c...chrome,cros-chrome,cros-chrome-guest,system-guest'
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.browser_options.html b/tools/telemetry/docs/telemetry.core.browser_options.html new file mode 100644 index 0000000..8e0d963 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.browser_options.html @@ -0,0 +1,79 @@ + + +Python: module telemetry.core.browser_options + + + + +
 
+ 
telemetry.core.browser_options		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/browser_options.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.browser_finder
+copy
+logging
+		optparse
+telemetry.core.profile_types
+telemetry.core.platform.profiler.profiler_finder
+		shlex
+sys
+telemetry.core.wpr_modes
+

+ + + + + +
 
+Classes
       
+
optparse.Values +
+
+
BrowserOptions +
+
+
+

+ + + + + + + +
 
+class BrowserOptions(optparse.Values)
   Options to be used for discovering and launching a browser.
 
 Methods defined here:
+
AppendExtraBrowserArg(self, arg)
+ +
Copy(self)
+ +
CreateParser(self, *args, **kwargs)
+ +
__init__(self, browser_type=None)
+ +
+Methods inherited from optparse.Values:
+
__cmp__(self, other)
+ +
__repr__ = _repr(self)
+ +
__str__(self)
+ +
ensure_value(self, attr, value)
+ +
read_file(self, filename, mode='careful')
+ +
read_module(self, modname, mode='careful')
+ +

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.adb_commands.html b/tools/telemetry/docs/telemetry.core.chrome.adb_commands.html new file mode 100644 index 0000000..7aa7d88 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.adb_commands.html @@ -0,0 +1,165 @@ + + +Python: module telemetry.core.chrome.adb_commands + + + + +
 
+ 
telemetry.core.chrome.adb_commands		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/adb_commands.py
+

Brings in Chrome Android's android_commands module, which itself is a
+thin(ish) wrapper around adb.

+

+ + + + + +
 
+Modules
       
pylib.android_commands
+pylib.cmd_helper
+		pylib.forwarder
+os
+		pylib.ports
+sys
+		pylib.valgrind_tools
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
AdbCommands +
Forwarder +
+
+
+

+ + + + + + + +
 
+class AdbCommands(__builtin__.object)
   A thin wrapper around ADB
 
 Methods defined here:
+
Adb(self)
+ +
CloseApplication(self, package)
Attempt to close down the application, using increasing violence.
+ 
+Args:
+  package: Name of the process to kill off, e.g.
+  com.google.android.apps.chrome
+ +
ExtractPid(self, process_name)
Extracts Process Ids for a given process name from Android Shell.
+ 
+Args:
+  process_name: name of the process on the device.
+ 
+Returns:
+  List of all the process ids (as strings) that match the given name.
+  If the name of a process exactly matches the given name, the pid of
+  that process will be inserted to the front of the pid list.
+ +
FileExistsOnDevice(self, file_name)
+ +
Forward(self, local, remote)
+ +
IsRootEnabled(self)
+ +
KillAll(self, process)
Android version of killall, connected via adb.
+ 
+Args:
+  process: name of the process to kill off
+ 
+Returns:
+  the number of processess killed
+ +
Pull(self, remote, local)
+ +
Push(self, local, remote)
+ +
RunShellCommand(self, command, timeout_time=20, log_result=False)
Send a command to the adb shell and return the result.
+ 
+Args:
+  command: String containing the shell command to send. Must not include
+           the single quotes as we use them to escape the whole command.
+  timeout_time: Number of seconds to wait for command to respond before
+    retrying, used by AdbInterface.SendShellCommand.
+  log_result: Boolean to indicate whether we should log the result of the
+              shell command.
+ 
+Returns:
+  list containing the lines of output received from running the command
+ +
StartActivity(self, package, activity, wait_for_completion=False, action='android.intent.action.VIEW', category=None, data=None, extras=None, trace_file_name=None)
Starts |package|'s activity on the device.
+ 
+Args:
+  package: Name of package to start (e.g. 'com.google.android.apps.chrome').
+  activity: Name of activity (e.g. '.Main' or
+    'com.google.android.apps.chrome.Main').
+  wait_for_completion: wait for the activity to finish launching (-W flag).
+  action: string (e.g. 'android.intent.action.MAIN'). Default is VIEW.
+  category: string (e.g. 'android.intent.category.HOME')
+  data: Data string to pass to activity (e.g. 'http://www.example.com/').
+  extras: Dict of extras to pass to activity. Values are significant.
+  trace_file_name: If used, turns on and saves the trace to this file name.
+ +
__init__(self, device)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+class Forwarder(__builtin__.object)
    Methods defined here:
+
Close(self)
+ +
__init__(self, adb, *port_pairs)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
url
+
+

+ + + + + +
 
+Functions
       
AllocateTestServerPort()
+
GetAttachedDevices()
Returns a list of attached, online android devices.
+ 
+If a preferred device has been set with ANDROID_SERIAL, it will be first in
+the returned list.
+
GetOutDirectory()
+
HasForwarder(buildtype=None)
+
IsAndroidSupported()
+
ResetTestServerPortAllocation()
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.android_browser_backend.html b/tools/telemetry/docs/telemetry.core.chrome.android_browser_backend.html new file mode 100644 index 0000000..61d74ef --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.android_browser_backend.html @@ -0,0 +1,316 @@ + + +Python: module telemetry.core.chrome.android_browser_backend + + + + +
 
+ 
telemetry.core.chrome.android_browser_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/android_browser_backend.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.chrome.adb_commands
+telemetry.core.chrome.browser_backend
+telemetry.core.exceptions
+		logging
+os
+subprocess
+		sys
+tempfile
+time
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
AndroidBrowserBackendSettings +
+
+
ChromeBackendSettings +
ChromiumTestShellBackendSettings +
ContentShellBackendSettings +
WebviewBackendSettings +
+
+
+
+
telemetry.core.chrome.browser_backend.BrowserBackend(__builtin__.object) +
+
+
AndroidBrowserBackend +
+
+
+

+ + + + + + + +
 
+class AndroidBrowserBackend(telemetry.core.chrome.browser_backend.BrowserBackend)
   The backend for controlling a browser instance running on Android.
 
 
Method resolution order:
+
AndroidBrowserBackend
+
telemetry.core.chrome.browser_backend.BrowserBackend
+
__builtin__.object
+
+
+Methods defined here:
+
Close(self)
+ +
CreateForwarder(self, *port_pairs)
+ +
GetBrowserStartupArgs(self)
+ +
GetRemotePort(self, local_port)
+ +
GetStandardOutput(self)
+ +
IsBrowserRunning(self)
+ +
__del__(self)
+ +
__init__(self, options, backend_settings)
+ +
+Data descriptors defined here:
+
adb
+
+
pid
+
+
+Methods inherited from telemetry.core.chrome.browser_backend.BrowserBackend:
+
GetProcessName(self, cmd_line)
Returns a user-friendly name for the process of the given |cmd_line|.
+ +
GetTraceResultAndReset(self)
+ +
Request(self, path, timeout=None)
+ +
SetBrowser(self, browser)
+ +
StartTracing(self, custom_categories=None)
custom_categories is an optional string containing a list of
+comma separated categories that will be traced instead of the
+default category set.  Example: use
+"webkit,cc,disabled-by-default-cc.debug" to trace only those three
+event categories.
+ +
StopTracing(self)
+ +
+Data descriptors inherited from telemetry.core.chrome.browser_backend.BrowserBackend:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
browser
+
+
chrome_branch_number
+
+
extension_dict_backend
+
+
misc_web_contents_backend
+
Access to chrome://oobe/login page which is neither a tab nor an
+extension.
+
+
supports_extensions
+
True if this browser backend supports extensions.
+
+
supports_tab_control
+
+
supports_tracing
+
+
tab_list_backend
+
+
wpr_mode
+
+
+Data and other attributes inherited from telemetry.core.chrome.browser_backend.BrowserBackend:
+
WEBPAGEREPLAY_HOST = '127.0.0.1'
+ +

+ + + + + +
 
+class AndroidBrowserBackendSettings(__builtin__.object)
    Methods defined here:
+
GetDevtoolsRemotePort(self)
+ +
PushProfile(self, _)
+ +
RemoveProfile(self)
+ +
__init__(self, adb, activity, cmdline_file, package, pseudo_exec_name)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
is_content_shell
+
+

+ + + + + +
 
+class ChromeBackendSettings(AndroidBrowserBackendSettings)
    
Method resolution order:
+
ChromeBackendSettings
+
AndroidBrowserBackendSettings
+
__builtin__.object
+
+
+Methods defined here:
+
GetDevtoolsRemotePort(self)
+ +
PushProfile(self, new_profile_dir)
+ +
__init__(self, adb, package)
+ +
+Methods inherited from AndroidBrowserBackendSettings:
+
RemoveProfile(self)
+ +
+Data descriptors inherited from AndroidBrowserBackendSettings:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
is_content_shell
+
+

+ + + + + +
 
+class ChromiumTestShellBackendSettings(AndroidBrowserBackendSettings)
    
Method resolution order:
+
ChromiumTestShellBackendSettings
+
AndroidBrowserBackendSettings
+
__builtin__.object
+
+
+Methods defined here:
+
GetDevtoolsRemotePort(self)
+ +
__init__(self, adb, package)
+ +
+Data descriptors defined here:
+
is_content_shell
+
+
+Methods inherited from AndroidBrowserBackendSettings:
+
PushProfile(self, _)
+ +
RemoveProfile(self)
+ +
+Data descriptors inherited from AndroidBrowserBackendSettings:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+class ContentShellBackendSettings(AndroidBrowserBackendSettings)
    
Method resolution order:
+
ContentShellBackendSettings
+
AndroidBrowserBackendSettings
+
__builtin__.object
+
+
+Methods defined here:
+
GetDevtoolsRemotePort(self)
+ +
__init__(self, adb, package)
+ +
+Data descriptors defined here:
+
is_content_shell
+
+
+Methods inherited from AndroidBrowserBackendSettings:
+
PushProfile(self, _)
+ +
RemoveProfile(self)
+ +
+Data descriptors inherited from AndroidBrowserBackendSettings:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+class WebviewBackendSettings(AndroidBrowserBackendSettings)
    
Method resolution order:
+
WebviewBackendSettings
+
AndroidBrowserBackendSettings
+
__builtin__.object
+
+
+Methods defined here:
+
GetDevtoolsRemotePort(self)
+ +
__init__(self, adb, package)
+ +
+Methods inherited from AndroidBrowserBackendSettings:
+
PushProfile(self, _)
+ +
RemoveProfile(self)
+ +
+Data descriptors inherited from AndroidBrowserBackendSettings:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
is_content_shell
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.android_browser_finder.html b/tools/telemetry/docs/telemetry.core.chrome.android_browser_finder.html new file mode 100644 index 0000000..d5a4b60 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.android_browser_finder.html @@ -0,0 +1,102 @@ + + +Python: module telemetry.core.chrome.android_browser_finder + + + + +
 
+ 
telemetry.core.chrome.android_browser_finder		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/android_browser_finder.py
+

Finds android browsers that can be controlled by telemetry.

+

+ + + + + +
 
+Modules
       
telemetry.core.chrome.adb_commands
+telemetry.core.chrome.android_browser_backend
+telemetry.core.platform.android_platform_backend
+		telemetry.core.browser
+os
+telemetry.core.possible_browser
+		telemetry.core.profile_types
+re
+logging
+		subprocess
+sys
+

+ + + + + +
 
+Classes
       
+
telemetry.core.possible_browser.PossibleBrowser(__builtin__.object) +
+
+
PossibleAndroidBrowser +
+
+
+

+ + + + + + + +
 
+class PossibleAndroidBrowser(telemetry.core.possible_browser.PossibleBrowser)
   A launchable android browser instance.
 
 
Method resolution order:
+
PossibleAndroidBrowser
+
telemetry.core.possible_browser.PossibleBrowser
+
__builtin__.object
+
+
+Methods defined here:
+
Create(self)
+ +
SupportsOptions(self, options)
+ +
__init__(self, browser_type, options, backend_settings)
+ +
__repr__(self)
+ +
+Data descriptors inherited from telemetry.core.possible_browser.PossibleBrowser:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
browser_type
+
+
options
+
+

+ + + + + +
 
+Functions
       
FindAllAvailableBrowsers(options, logging=<module 'logging' from '/System/Library/Framewor...Versions/2.7/lib/python2.7/logging/__init__.pyc'>)
Finds all the desktop browsers available on this machine.
+

+ + + + + +
 
+Data
       ALL_BROWSER_TYPES = 'android-chromium-testshell,android-content-shell...hrome,android-chrome-dev,android-jb-system-chrome'
+CHROME_PACKAGE_NAMES = {'android-chrome': 'com.google.android.apps.chrome', 'android-chrome-beta': 'com.chrome.beta', 'android-chrome-dev': 'com.google.android.apps.chrome_dev', 'android-jb-system-chrome': 'com.android.chrome'}
+CHROMIUM_TESTSHELL_PACKAGE = 'org.chromium.chrome.testshell'
+CONTENT_SHELL_PACKAGE = 'org.chromium.content_shell_apk'
+WEBVIEW_PACKAGE = 'com.android.webview.chromium.shell'
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.browser_backend.html b/tools/telemetry/docs/telemetry.core.chrome.browser_backend.html new file mode 100644 index 0000000..2259eff --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.browser_backend.html @@ -0,0 +1,215 @@ + + +Python: module telemetry.core.chrome.browser_backend + + + + +
 
+ 
telemetry.core.chrome.browser_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/browser_backend.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.exceptions
+telemetry.core.chrome.extension_dict_backend
+httplib
+json
+		telemetry.core.chrome.misc_web_contents_backend
+telemetry.unittest.options_for_unittests
+re
+socket
+		sys
+telemetry.core.chrome.tab_list_backend
+telemetry.core.chrome.tracing_backend
+urllib2
+		telemetry.core.user_agent
+telemetry.core.util
+telemetry.core.wpr_modes
+telemetry.core.wpr_server
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
BrowserBackend +
DoNothingForwarder +
+
+
exceptions.Exception(exceptions.BaseException) +
+
+
ExtensionsNotSupportedException +
+
+
+

+ + + + + + + +
 
+class BrowserBackend(__builtin__.object)
   A base class for browser backends. Provides basic functionality
+once a remote-debugger port has been established.
 
 Methods defined here:
+
Close(self)
+ +
CreateForwarder(self, *port_pairs)
+ +
GetBrowserStartupArgs(self)
+ +
GetProcessName(self, cmd_line)
Returns a user-friendly name for the process of the given |cmd_line|.
+ +
GetRemotePort(self, _)
+ +
GetStandardOutput(self)
+ +
GetTraceResultAndReset(self)
+ +
IsBrowserRunning(self)
+ +
Request(self, path, timeout=None)
+ +
SetBrowser(self, browser)
+ +
StartTracing(self, custom_categories=None)
custom_categories is an optional string containing a list of
+comma separated categories that will be traced instead of the
+default category set.  Example: use
+"webkit,cc,disabled-by-default-cc.debug" to trace only those three
+event categories.
+ +
StopTracing(self)
+ +
__init__(self, is_content_shell, supports_extensions, options)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
browser
+
+
chrome_branch_number
+
+
extension_dict_backend
+
+
misc_web_contents_backend
+
Access to chrome://oobe/login page which is neither a tab nor an
+extension.
+
+
supports_extensions
+
True if this browser backend supports extensions.
+
+
supports_tab_control
+
+
supports_tracing
+
+
tab_list_backend
+
+
wpr_mode
+
+
+Data and other attributes defined here:
+
WEBPAGEREPLAY_HOST = '127.0.0.1'
+ +

+ + + + + +
 
+class DoNothingForwarder(__builtin__.object)
    Methods defined here:
+
Close(self)
+ +
__init__(self, *port_pairs)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
url
+
+

+ + + + + +
 
+class ExtensionsNotSupportedException(exceptions.Exception)
    
Method resolution order:
+
ExtensionsNotSupportedException
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.cros_browser_backend.html b/tools/telemetry/docs/telemetry.core.chrome.cros_browser_backend.html new file mode 100644 index 0000000..0e1a682 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.cros_browser_backend.html @@ -0,0 +1,174 @@ + + +Python: module telemetry.core.chrome.cros_browser_backend + + + + +
 
+ 
telemetry.core.chrome.cros_browser_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/cros_browser_backend.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.chrome.browser_backend
+telemetry.core.chrome.cros_util
+		telemetry.core.exceptions
+logging
+		os
+subprocess
+		telemetry.core.util
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
SSHForwarder +
+
+
telemetry.core.chrome.browser_backend.BrowserBackend(__builtin__.object) +
+
+
CrOSBrowserBackend +
+
+
+

+ + + + + +
 
+class CrOSBrowserBackend(telemetry.core.chrome.browser_backend.BrowserBackend)
    
Method resolution order:
+
CrOSBrowserBackend
+
telemetry.core.chrome.browser_backend.BrowserBackend
+
__builtin__.object
+
+
+Methods defined here:
+
Close(self)
+ +
CreateForwarder(self, *port_pairs)
+ +
GetBrowserStartupArgs(self)
+ +
GetRemotePort(self, _)
+ +
GetStandardOutput(self)
+ +
IsBrowserRunning(self)
+ +
__del__(self)
+ +
__init__(self, browser_type, options, cri, is_guest)
+ +
+Data descriptors defined here:
+
hwid
+
+
pid
+
Locates the pid of the main chrome browser process.
+ 
+Chrome on cros is usually in /opt/google/chrome, but could be in
+/usr/local/ for developer workflows - debug chrome is too large to fit on
+rootfs.
+ 
+Chrome spawns multiple processes for renderers. pids wrap around after they
+are exhausted so looking for the smallest pid is not always correct. We
+locate the session_manager's pid, and look for the chrome process that's an
+immediate child. This is the main browser process.
+
+
+Data and other attributes defined here:
+
CHROME_PATHS = ['/opt/google/chrome/chrome ', '/usr/local/opt/google/chrome/chrome ']
+ +
+Methods inherited from telemetry.core.chrome.browser_backend.BrowserBackend:
+
GetProcessName(self, cmd_line)
Returns a user-friendly name for the process of the given |cmd_line|.
+ +
GetTraceResultAndReset(self)
+ +
Request(self, path, timeout=None)
+ +
SetBrowser(self, browser)
+ +
StartTracing(self, custom_categories=None)
custom_categories is an optional string containing a list of
+comma separated categories that will be traced instead of the
+default category set.  Example: use
+"webkit,cc,disabled-by-default-cc.debug" to trace only those three
+event categories.
+ +
StopTracing(self)
+ +
+Data descriptors inherited from telemetry.core.chrome.browser_backend.BrowserBackend:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
browser
+
+
chrome_branch_number
+
+
extension_dict_backend
+
+
misc_web_contents_backend
+
Access to chrome://oobe/login page which is neither a tab nor an
+extension.
+
+
supports_extensions
+
True if this browser backend supports extensions.
+
+
supports_tab_control
+
+
supports_tracing
+
+
tab_list_backend
+
+
wpr_mode
+
+
+Data and other attributes inherited from telemetry.core.chrome.browser_backend.BrowserBackend:
+
WEBPAGEREPLAY_HOST = '127.0.0.1'
+ +

+ + + + + +
 
+class SSHForwarder(__builtin__.object)
    Methods defined here:
+
Close(self)
+ +
__init__(self, cri, forwarding_flag, *port_pairs)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
url
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.cros_browser_finder.html b/tools/telemetry/docs/telemetry.core.chrome.cros_browser_finder.html new file mode 100644 index 0000000..6d75c26 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.cros_browser_finder.html @@ -0,0 +1,96 @@ + + +Python: module telemetry.core.chrome.cros_browser_finder + + + + +
 
+ 
telemetry.core.chrome.cros_browser_finder		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/cros_browser_finder.py
+

Finds CrOS browsers that can be controlled by telemetry.

+

+ + + + + +
 
+Modules
       
telemetry.core.browser
+telemetry.core.chrome.cros_browser_backend
+telemetry.core.chrome.cros_interface
+		telemetry.core.platform.cros_platform_backend
+logging
+os
+		telemetry.core.possible_browser
+telemetry.core.profile_types
+sys
+

+ + + + + +
 
+Classes
       
+
telemetry.core.possible_browser.PossibleBrowser(__builtin__.object) +
+
+
PossibleCrOSBrowser +
+
+
+

+ + + + + + + +
 
+class PossibleCrOSBrowser(telemetry.core.possible_browser.PossibleBrowser)
   A launchable chromeos browser instance.
 
 
Method resolution order:
+
PossibleCrOSBrowser
+
telemetry.core.possible_browser.PossibleBrowser
+
__builtin__.object
+
+
+Methods defined here:
+
Create(self)
+ +
SupportsOptions(self, options)
+ +
__init__(self, browser_type, options, cri, is_guest)
+ +
__repr__(self)
+ +
+Data descriptors inherited from telemetry.core.possible_browser.PossibleBrowser:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
browser_type
+
+
options
+
+

+ + + + + +
 
+Functions
       
FindAllAvailableBrowsers(options)
Finds all available chromeos browsers, locally and remotely.
+

+ + + + + +
 
+Data
       ALL_BROWSER_TYPES = 'cros-chrome,cros-chrome-guest,system-guest'
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.cros_interface.html b/tools/telemetry/docs/telemetry.core.chrome.cros_interface.html new file mode 100644 index 0000000..e82de40 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.cros_interface.html @@ -0,0 +1,248 @@ + + +Python: module telemetry.core.chrome.cros_interface + + + + +
 
+ 
telemetry.core.chrome.cros_interface		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/cros_interface.py
+

A wrapper around ssh for common operations on a CrOS-based device

+

+ + + + + +
 
+Modules
       
logging
+os
+		re
+subprocess
+		tempfile
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
CrOSInterface +
+
+
exceptions.Exception(exceptions.BaseException) +
+
+
LoginException +
+
+
KeylessLoginRequiredException +
+
+
+
+
+

+ + + + + +
 
+class CrOSInterface(__builtin__.object)
    Methods defined here:
+
FileExistsOnDevice(self, file_name, quiet=False)
+ +
FilesystemMountedAt(self, path)
Returns the filesystem mounted at |path|
+ +
FormSSHCommandLine(self, args, extra_ssh_args=None)
+ +
GetFileContents(self, filename)
+ +
GetRemotePort(self)
+ +
IsHTTPServerRunningOnPort(self, port)
+ +
IsServiceRunning(self, service_name)
+ +
KillAllMatching(self, predicate)
+ +
ListProcesses(self)
Returns a tuple (pid, cmd, ppid) of all processes on the device.
+ +
PushContents(self, text, remote_filename)
+ +
PushFile(self, filename, remote_filename)
+ +
RmRF(self, filename)
+ +
RunCmdOnDevice(self, args, cwd=None, quiet=False)
+ +
TryLogin(self)
+ +
__init__(self, hostname=None, ssh_identity=None)
# pylint: disable=R0923
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
hostname
+
+
local
+
+

+ + + + + +
 
+class KeylessLoginRequiredException(LoginException)
    
Method resolution order:
+
KeylessLoginRequiredException
+
LoginException
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors inherited from LoginException:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + +
 
+class LoginException(exceptions.Exception)
    
Method resolution order:
+
LoginException
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + +
 
+Functions
       
GetAllCmdOutput(args, cwd=None, quiet=False)
Open a subprocess to execute a program and returns its output.
+ 
+Args:
+  args: A string or a sequence of program arguments. The program to execute is
+    the string or the first item in the args sequence.
+  cwd: If not None, the subprocess's current directory will be changed to
+    |cwd| before it's executed.
+ 
+Returns:
+  Captures and returns the command's stdout.
+  Prints the command's stderr to logger (which defaults to stdout).
+
HasSSH()
+
RunCmd(args, cwd=None, quiet=False)
Opens a subprocess to execute a program and returns its return value.
+ 
+Args:
+  args: A string or a sequence of program arguments. The program to execute is
+    the string or the first item in the args sequence.
+  cwd: If not None, the subprocess's current directory will be changed to
+    |cwd| before it's executed.
+ 
+Returns:
+  Return code from the command execution.
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.cros_util.html b/tools/telemetry/docs/telemetry.core.chrome.cros_util.html new file mode 100644 index 0000000..e7994cc --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.cros_util.html @@ -0,0 +1,36 @@ + + +Python: module telemetry.core.chrome.cros_util + + + + +
 
+ 
telemetry.core.chrome.cros_util		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/cros_util.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.exceptions
+		telemetry.core.util
+

+ + + + + +
 
+Functions
       
NavigateGuestLogin(browser_backend, cri)
Navigates through oobe login screen as guest
+
NavigateLogin(browser_backend, cri)
Navigates through oobe login screen
+
WaitForAccountPicker(oobe)
Waits for the oobe screen to be in the account picker state.
+
WaitForGuestFsMounted(cri)
Waits for /home/chronos/user to be mounted as guestfs
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.crx_id.html b/tools/telemetry/docs/telemetry.core.chrome.crx_id.html new file mode 100644 index 0000000..cf6c52a --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.crx_id.html @@ -0,0 +1,41 @@ + + +Python: module telemetry.core.chrome.crx_id + + + + +
 
+ 
telemetry.core.chrome.crx_id		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/crx_id.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
crx_id.crx_id
+		os
+		sys
+

+ + + + + +
 
+Functions
       
__init__()
+

+ + + + + +
 
+Data
       absolute_import = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.desktop_browser_backend.html b/tools/telemetry/docs/telemetry.core.chrome.desktop_browser_backend.html new file mode 100644 index 0000000..040b317 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.desktop_browser_backend.html @@ -0,0 +1,140 @@ + + +Python: module telemetry.core.chrome.desktop_browser_backend + + + + +
 
+ 
telemetry.core.chrome.desktop_browser_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/desktop_browser_backend.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.chrome.browser_backend
+telemetry.core.chrome.cros_interface
+telemetry.core.chrome.cros_util
+		logging
+os
+shutil
+		subprocess
+sys
+tempfile
+		telemetry.core.util
+

+ + + + + +
 
+Classes
       
+
telemetry.core.chrome.browser_backend.BrowserBackend(__builtin__.object) +
+
+
DesktopBrowserBackend +
+
+
+

+ + + + + + + +
 
+class DesktopBrowserBackend(telemetry.core.chrome.browser_backend.BrowserBackend)
   The backend for controlling a locally-executed browser instance, on Linux,
+Mac or Windows.
 
 
Method resolution order:
+
DesktopBrowserBackend
+
telemetry.core.chrome.browser_backend.BrowserBackend
+
__builtin__.object
+
+
+Methods defined here:
+
Close(self)
+ +
CreateForwarder(self, *port_pairs)
+ +
GetBrowserStartupArgs(self)
+ +
GetStandardOutput(self)
+ +
IsBrowserRunning(self)
+ +
SetProfileDirectory(self, profile_dir)
+ +
__del__(self)
+ +
__init__(self, options, executable, is_content_shell, use_login, delete_profile_dir_after_run=True)
+ +
+Data descriptors defined here:
+
pid
+
+
profile_directory
+
+
+Methods inherited from telemetry.core.chrome.browser_backend.BrowserBackend:
+
GetProcessName(self, cmd_line)
Returns a user-friendly name for the process of the given |cmd_line|.
+ +
GetRemotePort(self, _)
+ +
GetTraceResultAndReset(self)
+ +
Request(self, path, timeout=None)
+ +
SetBrowser(self, browser)
+ +
StartTracing(self, custom_categories=None)
custom_categories is an optional string containing a list of
+comma separated categories that will be traced instead of the
+default category set.  Example: use
+"webkit,cc,disabled-by-default-cc.debug" to trace only those three
+event categories.
+ +
StopTracing(self)
+ +
+Data descriptors inherited from telemetry.core.chrome.browser_backend.BrowserBackend:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
browser
+
+
chrome_branch_number
+
+
extension_dict_backend
+
+
misc_web_contents_backend
+
Access to chrome://oobe/login page which is neither a tab nor an
+extension.
+
+
supports_extensions
+
True if this browser backend supports extensions.
+
+
supports_tab_control
+
+
supports_tracing
+
+
tab_list_backend
+
+
wpr_mode
+
+
+Data and other attributes inherited from telemetry.core.chrome.browser_backend.BrowserBackend:
+
WEBPAGEREPLAY_HOST = '127.0.0.1'
+ +

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.desktop_browser_finder.html b/tools/telemetry/docs/telemetry.core.chrome.desktop_browser_finder.html new file mode 100644 index 0000000..687b078 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.desktop_browser_finder.html @@ -0,0 +1,98 @@ + + +Python: module telemetry.core.chrome.desktop_browser_finder + + + + +
 
+ 
telemetry.core.chrome.desktop_browser_finder		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/desktop_browser_finder.py
+

Finds desktop browsers that can be controlled by telemetry.

+

+ + + + + +
 
+Modules
       
telemetry.core.browser
+telemetry.core.chrome.desktop_browser_backend
+telemetry.core.platform.linux_platform_backend
+		logging
+telemetry.core.platform.mac_platform_backend
+os
+		telemetry.core.possible_browser
+telemetry.core.profile_types
+subprocess
+		sys
+telemetry.core.platform.win_platform_backend
+

+ + + + + +
 
+Classes
       
+
telemetry.core.possible_browser.PossibleBrowser(__builtin__.object) +
+
+
PossibleDesktopBrowser +
+
+
+

+ + + + + + + +
 
+class PossibleDesktopBrowser(telemetry.core.possible_browser.PossibleBrowser)
   A desktop browser that can be controlled.
 
 
Method resolution order:
+
PossibleDesktopBrowser
+
telemetry.core.possible_browser.PossibleBrowser
+
__builtin__.object
+
+
+Methods defined here:
+
Create(self)
+ +
SupportsOptions(self, options)
+ +
__init__(self, browser_type, options, executable, is_content_shell, use_login=False)
+ +
__repr__(self)
+ +
+Data descriptors inherited from telemetry.core.possible_browser.PossibleBrowser:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
browser_type
+
+
options
+
+

+ + + + + +
 
+Functions
       
FindAllAvailableBrowsers(options)
Finds all the desktop browsers available on this machine.
+

+ + + + + +
 
+Data
       ALL_BROWSER_TYPES = 'exact,release,debug,canary,content-shell-debug,content-shell-release,debug-cros,release-cros,system'
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.extension_dict_backend.html b/tools/telemetry/docs/telemetry.core.chrome.extension_dict_backend.html new file mode 100644 index 0000000..53aac52 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.extension_dict_backend.html @@ -0,0 +1,133 @@ + + +Python: module telemetry.core.chrome.extension_dict_backend + + + + +
 
+ 
telemetry.core.chrome.extension_dict_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/extension_dict_backend.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.exceptions
+telemetry.core.extension_page
+httplib
+		telemetry.core.chrome.inspector_backend
+json
+re
+		socket
+urllib2
+weakref
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
ExtensionDictBackend +
+
+
exceptions.Exception(exceptions.BaseException) +
+
+
ExtensionNotFoundException +
+
+
+

+ + + + + +
 
+class ExtensionDictBackend(__builtin__.object)
    Methods defined here:
+
__contains__(self, extension_id)
+ +
__getitem__(self, extension_id)
+ +
__init__(self, browser_backend)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+class ExtensionNotFoundException(exceptions.Exception)
    
Method resolution order:
+
ExtensionNotFoundException
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.facebook_credentials_backend.html b/tools/telemetry/docs/telemetry.core.chrome.facebook_credentials_backend.html new file mode 100644 index 0000000..82100dc --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.facebook_credentials_backend.html @@ -0,0 +1,88 @@ + + +Python: module telemetry.core.chrome.facebook_credentials_backend + + + + +
 
+ 
telemetry.core.chrome.facebook_credentials_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/facebook_credentials_backend.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.chrome.form_based_credentials_backend
+

+ + + + + +
 
+Classes
       
+
telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend(__builtin__.object) +
+
+
FacebookCredentialsBackend +
+
+
+

+ + + + + +
 
+class FacebookCredentialsBackend(telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend)
    
Method resolution order:
+
FacebookCredentialsBackend
+
telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend
+
__builtin__.object
+
+
+Methods defined here:
+
IsAlreadyLoggedIn(self, tab)
+ +
+Data descriptors defined here:
+
credentials_type
+
+
login_form_id
+
+
login_input_id
+
+
password_input_id
+
+
url
+
+
+Methods inherited from telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend:
+
IsLoggedIn(self)
+ +
LoginNeeded(self, tab, config)
Logs in to a test account.
+ 
+Raises:
+  RuntimeError: if could not get credential information.
+ +
LoginNoLongerNeeded(self, tab)
+ +
__init__(self)
+ +
+Data descriptors inherited from telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.form_based_credentials_backend.html b/tools/telemetry/docs/telemetry.core.chrome.form_based_credentials_backend.html new file mode 100644 index 0000000..c473d59 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.form_based_credentials_backend.html @@ -0,0 +1,79 @@ + + +Python: module telemetry.core.chrome.form_based_credentials_backend + + + + +
 
+ 
telemetry.core.chrome.form_based_credentials_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/form_based_credentials_backend.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
logging
+		telemetry.core.util
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
FormBasedCredentialsBackend +
+
+
+

+ + + + + +
 
+class FormBasedCredentialsBackend(__builtin__.object)
    Methods defined here:
+
IsAlreadyLoggedIn(self, tab)
+ +
IsLoggedIn(self)
+ +
LoginNeeded(self, tab, config)
Logs in to a test account.
+ 
+Raises:
+  RuntimeError: if could not get credential information.
+ +
LoginNoLongerNeeded(self, tab)
+ +
__init__(self)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
credentials_type
+
+
login_form_id
+
+
login_input_id
+
+
password_input_id
+
+
url
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.form_based_credentials_backend_unittest_base.html b/tools/telemetry/docs/telemetry.core.chrome.form_based_credentials_backend_unittest_base.html new file mode 100644 index 0000000..514dc6c --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.form_based_credentials_backend_unittest_base.html @@ -0,0 +1,343 @@ + + +Python: module telemetry.core.chrome.form_based_credentials_backend_unittest_base + + + + +
 
+ 
telemetry.core.chrome.form_based_credentials_backend_unittest_base		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/form_based_credentials_backend_unittest_base.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.browser_finder
+logging
+		telemetry.unittest.options_for_unittests
+os
+		telemetry.unittest.simple_mock
+unittest
+

+ + + + + +
 
+Classes
       
+
unittest.case.TestCase(__builtin__.object) +
+
+
FormBasedCredentialsBackendUnitTestBase +
+
+
+

+ + + + + +
 
+class FormBasedCredentialsBackendUnitTestBase(unittest.case.TestCase)
    
Method resolution order:
+
FormBasedCredentialsBackendUnitTestBase
+
unittest.case.TestCase
+
__builtin__.object
+
+
+Methods defined here:
+
setUp(self)
+ +
testLoginUsingMock(self)
+ +
testRealLoginIfPossible(self)
+ +
testRealLoginWithDontOverrideProfileIfPossible(self)
+ +
+Methods inherited from unittest.case.TestCase:
+
__call__(self, *args, **kwds)
+ +
__eq__(self, other)
+ +
__hash__(self)
+ +
__init__(self, methodName='runTest')
Create an instance of the class that will use the named test
+method when executed. Raises a ValueError if the instance does
+not have a method with the specified name.
+ +
__ne__(self, other)
+ +
__repr__(self)
+ +
__str__(self)
+ +
addCleanup(self, function, *args, **kwargs)
Add a function, with arguments, to be called when the test is
+completed. Functions added are called on a LIFO basis and are
+called after tearDown on test failure or success.
+ 
+Cleanup items are called even if setUp fails (unlike tearDown).
+ +
addTypeEqualityFunc(self, typeobj, function)
Add a type specific assertEqual style function to compare a type.
+ 
+This method is for use by TestCase subclasses that need to register
+their own type equality functions to provide nicer error messages.
+ 
+Args:
+    typeobj: The data type to call this function on when both values
+            are of the same type in assertEqual().
+    function: The callable taking two arguments and an optional
+            msg= argument that raises self.failureException with a
+            useful error message when the two arguments are not equal.
+ +
assertAlmostEqual(self, first, second, places=None, msg=None, delta=None)
Fail if the two objects are unequal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero, or by comparing that the
+between the two objects is more than the given delta.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ 
+If the two objects compare equal then they will automatically
+compare almost equal.
+ +
assertAlmostEquals = assertAlmostEqual(self, first, second, places=None, msg=None, delta=None)
Fail if the two objects are unequal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero, or by comparing that the
+between the two objects is more than the given delta.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ 
+If the two objects compare equal then they will automatically
+compare almost equal.
+ +
assertDictContainsSubset(self, expected, actual, msg=None)
Checks whether actual is a superset of expected.
+ +
assertDictEqual(self, d1, d2, msg=None)
+ +
assertEqual(self, first, second, msg=None)
Fail if the two objects are unequal as determined by the '=='
+operator.
+ +
assertEquals = assertEqual(self, first, second, msg=None)
Fail if the two objects are unequal as determined by the '=='
+operator.
+ +
assertFalse(self, expr, msg=None)
Check that the expression is false.
+ +
assertGreater(self, a, b, msg=None)
Just like assertTrue(a > b), but with a nicer default message.
+ +
assertGreaterEqual(self, a, b, msg=None)
Just like assertTrue(a >= b), but with a nicer default message.
+ +
assertIn(self, member, container, msg=None)
Just like assertTrue(a in b), but with a nicer default message.
+ +
assertIs(self, expr1, expr2, msg=None)
Just like assertTrue(a is b), but with a nicer default message.
+ +
assertIsInstance(self, obj, cls, msg=None)
Same as assertTrue(isinstance(obj, cls)), with a nicer
+default message.
+ +
assertIsNone(self, obj, msg=None)
Same as assertTrue(obj is None), with a nicer default message.
+ +
assertIsNot(self, expr1, expr2, msg=None)
Just like assertTrue(a is not b), but with a nicer default message.
+ +
assertIsNotNone(self, obj, msg=None)
Included for symmetry with assertIsNone.
+ +
assertItemsEqual(self, expected_seq, actual_seq, msg=None)
An unordered sequence specific comparison. It asserts that
+actual_seq and expected_seq have the same element counts.
+Equivalent to::
+ 
+    assertEqual(Counter(iter(actual_seq)),
+                     Counter(iter(expected_seq)))
+ 
+Asserts that each element has the same count in both sequences.
+Example:
+    - [0, 1, 1] and [1, 0, 1] compare equal.
+    - [0, 0, 1] and [0, 1] compare unequal.
+ +
assertLess(self, a, b, msg=None)
Just like assertTrue(a < b), but with a nicer default message.
+ +
assertLessEqual(self, a, b, msg=None)
Just like assertTrue(a <= b), but with a nicer default message.
+ +
assertListEqual(self, list1, list2, msg=None)
A list-specific equality assertion.
+ 
+Args:
+    list1: The first list to compare.
+    list2: The second list to compare.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ +
assertMultiLineEqual(self, first, second, msg=None)
Assert that two multi-line strings are equal.
+ +
assertNotAlmostEqual(self, first, second, places=None, msg=None, delta=None)
Fail if the two objects are equal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero, or by comparing that the
+between the two objects is less than the given delta.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ 
+Objects that are equal automatically fail.
+ +
assertNotAlmostEquals = assertNotAlmostEqual(self, first, second, places=None, msg=None, delta=None)
Fail if the two objects are equal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero, or by comparing that the
+between the two objects is less than the given delta.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ 
+Objects that are equal automatically fail.
+ +
assertNotEqual(self, first, second, msg=None)
Fail if the two objects are equal as determined by the '=='
+operator.
+ +
assertNotEquals = assertNotEqual(self, first, second, msg=None)
Fail if the two objects are equal as determined by the '=='
+operator.
+ +
assertNotIn(self, member, container, msg=None)
Just like assertTrue(a not in b), but with a nicer default message.
+ +
assertNotIsInstance(self, obj, cls, msg=None)
Included for symmetry with assertIsInstance.
+ +
assertNotRegexpMatches(self, text, unexpected_regexp, msg=None)
Fail the test if the text matches the regular expression.
+ +
assertRaises(self, excClass, callableObj=None, *args, **kwargs)
Fail unless an exception of class excClass is thrown
+by callableObj when invoked with arguments args and keyword
+arguments kwargs. If a different type of exception is
+thrown, it will not be caught, and the test case will be
+deemed to have suffered an error, exactly as for an
+unexpected exception.
+ 
+If called with callableObj omitted or None, will return a
+context object used like this::
+ 
+     with assertRaises(SomeException):
+         do_something()
+ 
+The context manager keeps a reference to the exception as
+the 'exception' attribute. This allows you to inspect the
+exception after the assertion::
+ 
+    with assertRaises(SomeException) as cm:
+        do_something()
+    the_exception = cm.exception
+    assertEqual(the_exception.error_code, 3)
+ +
assertRaisesRegexp(self, expected_exception, expected_regexp, callable_obj=None, *args, **kwargs)
Asserts that the message in a raised exception matches a regexp.
+ 
+Args:
+    expected_exception: Exception class expected to be raised.
+    expected_regexp: Regexp (re pattern object or string) expected
+            to be found in error message.
+    callable_obj: Function to be called.
+    args: Extra args.
+    kwargs: Extra kwargs.
+ +
assertRegexpMatches(self, text, expected_regexp, msg=None)
Fail the test unless the text matches the regular expression.
+ +
assertSequenceEqual(self, seq1, seq2, msg=None, seq_type=None)
An equality assertion for ordered sequences (like lists and tuples).
+ 
+For the purposes of this function, a valid ordered sequence type is one
+which can be indexed, has a length, and has an equality operator.
+ 
+Args:
+    seq1: The first sequence to compare.
+    seq2: The second sequence to compare.
+    seq_type: The expected datatype of the sequences, or None if no
+            datatype should be enforced.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ +
assertSetEqual(self, set1, set2, msg=None)
A set-specific equality assertion.
+ 
+Args:
+    set1: The first set to compare.
+    set2: The second set to compare.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ 
+assertSetEqual uses ducktyping to support different types of sets, and
+is optimized for sets specifically (parameters must support a
+difference method).
+ +
assertTrue(self, expr, msg=None)
Check that the expression is true.
+ +
assertTupleEqual(self, tuple1, tuple2, msg=None)
A tuple-specific equality assertion.
+ 
+Args:
+    tuple1: The first tuple to compare.
+    tuple2: The second tuple to compare.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ +
assert_ = assertTrue(self, expr, msg=None)
Check that the expression is true.
+ +
countTestCases(self)
+ +
debug(self)
Run the test without collecting errors in a TestResult
+ +
defaultTestResult(self)
+ +
doCleanups(self)
Execute all cleanup functions. Normally called for you after
+tearDown.
+ +
fail(self, msg=None)
Fail immediately, with the given message.
+ +
failIf = deprecated_func(*args, **kwargs)
+ +
failIfAlmostEqual = deprecated_func(*args, **kwargs)
+ +
failIfEqual = deprecated_func(*args, **kwargs)
+ +
failUnless = deprecated_func(*args, **kwargs)
+ +
failUnlessAlmostEqual = deprecated_func(*args, **kwargs)
+ +
failUnlessEqual = deprecated_func(*args, **kwargs)
+ +
failUnlessRaises = deprecated_func(*args, **kwargs)
+ +
id(self)
+ +
run(self, result=None)
+ +
shortDescription(self)
Returns a one-line description of the test, or None if no
+description has been provided.
+ 
+The default implementation of this method returns the first line of
+the specified test method's docstring.
+ +
skipTest(self, reason)
Skip this test.
+ +
tearDown(self)
Hook method for deconstructing the test fixture after testing it.
+ +
+Class methods inherited from unittest.case.TestCase:
+
setUpClass(cls) from __builtin__.type
Hook method for setting up class fixture before running tests in the class.
+ +
tearDownClass(cls) from __builtin__.type
Hook method for deconstructing the class fixture after running all tests in the class.
+ +
+Data descriptors inherited from unittest.case.TestCase:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes inherited from unittest.case.TestCase:
+
failureException = <type 'exceptions.AssertionError'>
Assertion failed.
+ +
longMessage = False
+ +
maxDiff = 640
+ +

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.google_credentials_backend.html b/tools/telemetry/docs/telemetry.core.chrome.google_credentials_backend.html new file mode 100644 index 0000000..7745b4f --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.google_credentials_backend.html @@ -0,0 +1,88 @@ + + +Python: module telemetry.core.chrome.google_credentials_backend + + + + +
 
+ 
telemetry.core.chrome.google_credentials_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/google_credentials_backend.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.chrome.form_based_credentials_backend
+

+ + + + + +
 
+Classes
       
+
telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend(__builtin__.object) +
+
+
GoogleCredentialsBackend +
+
+
+

+ + + + + +
 
+class GoogleCredentialsBackend(telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend)
    
Method resolution order:
+
GoogleCredentialsBackend
+
telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend
+
__builtin__.object
+
+
+Methods defined here:
+
IsAlreadyLoggedIn(self, tab)
+ +
+Data descriptors defined here:
+
credentials_type
+
+
login_form_id
+
+
login_input_id
+
+
password_input_id
+
+
url
+
+
+Methods inherited from telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend:
+
IsLoggedIn(self)
+ +
LoginNeeded(self, tab, config)
Logs in to a test account.
+ 
+Raises:
+  RuntimeError: if could not get credential information.
+ +
LoginNoLongerNeeded(self, tab)
+ +
__init__(self)
+ +
+Data descriptors inherited from telemetry.core.chrome.form_based_credentials_backend.FormBasedCredentialsBackend:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.html b/tools/telemetry/docs/telemetry.core.chrome.html new file mode 100644 index 0000000..6110b0b --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.html @@ -0,0 +1,65 @@ + + +Python: package telemetry.core.chrome + + + + +
 
+ 
telemetry.core.chrome		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/__init__.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Package Contents
       
adb_commands
+android_browser_backend
+android_browser_finder
+android_browser_finder_unittest
+browser_backend
+cros_browser_backend
+cros_browser_finder
+cros_browser_finder_unittest
+cros_interface
+cros_interface_unittest
+cros_util
+		crx_id
+desktop_browser_backend
+desktop_browser_finder
+desktop_browser_finder_unittest
+extension_dict_backend
+facebook_credentials_backend
+facebook_credentials_backend_unittest
+form_based_credentials_backend
+form_based_credentials_backend_unittest_base
+google_credentials_backend
+google_credentials_backend_unittest
+		inspector_backend
+inspector_console
+inspector_console_unittest
+inspector_memory
+inspector_memory_unittest
+inspector_page
+inspector_page_unittest
+inspector_runtime
+inspector_runtime_unittest
+inspector_timeline
+inspector_timeline_unittest
+		misc_web_contents_backend
+png_bitmap
+png_bitmap_unittest
+tab_list_backend
+trace_result
+tracing_backend
+tracing_backend_unittest
+websocket
+websocket_unittest
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.inspector_backend.html b/tools/telemetry/docs/telemetry.core.chrome.inspector_backend.html new file mode 100644 index 0000000..5c565fb --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.inspector_backend.html @@ -0,0 +1,195 @@ + + +Python: module telemetry.core.chrome.inspector_backend + + + + +
 
+ 
telemetry.core.chrome.inspector_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/inspector_backend.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.exceptions
+telemetry.core.chrome.inspector_console
+telemetry.core.chrome.inspector_memory
+telemetry.core.chrome.inspector_page
+		telemetry.core.chrome.inspector_runtime
+telemetry.core.chrome.inspector_timeline
+json
+logging
+		telemetry.core.chrome.png_bitmap
+socket
+sys
+telemetry.core.util
+		telemetry.core.chrome.websocket
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
InspectorBackend +
+
+
exceptions.Exception(exceptions.BaseException) +
+
+
InspectorException +
+
+
+

+ + + + + +
 
+class InspectorBackend(__builtin__.object)
    Methods defined here:
+
Activate(self)
+ +
Close(self)
+ +
CollectGarbage(self)
+ +
Disconnect(self)
+ +
DispatchNotifications(self, timeout=10)
+ +
EvaluateJavaScript(self, expr, timeout)
+ +
ExecuteJavaScript(self, expr, timeout)
+ +
GetCookieByName(self, name, timeout)
+ +
GetDOMStats(self, timeout)
+ +
Navigate(self, url, script_to_evaluate_on_commit, timeout)
+ +
PerformActionAndWaitForNavigate(self, action_function, timeout)
+ +
RegisterDomain(self, domain_name, notification_handler, will_close_handler)
Registers a given domain for handling notification methods.
+ 
+For example, given inspector_backend:
+   def OnConsoleNotification(msg):
+      if msg['method'] == 'Console.messageAdded':
+         print msg['params']['message']
+      return
+   def OnConsoleClose(self):
+      pass
+   inspector_backend.RegisterDomain('Console',
+                                    OnConsoleNotification, OnConsoleClose)
+ +
Screenshot(self, timeout)
+ +
SendAndIgnoreResponse(self, req)
+ +
StartTimelineRecording(self)
+ +
StopTimelineRecording(self)
+ +
SyncRequest(self, req, timeout=10)
+ +
UnregisterDomain(self, domain_name)
Unregisters a previously registered domain.
+ +
WaitForDocumentReadyStateToBeComplete(self, timeout)
+ +
WaitForDocumentReadyStateToBeInteractiveOrBetter(self, timeout)
+ +
__del__(self)
+ +
__init__(self, browser, browser_backend, debugger_url)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
browser
+
+
message_output_stream
+
+
screenshot_supported
+
+
timeline_model
+
+
url
+
+

+ + + + + +
 
+class InspectorException(exceptions.Exception)
    
Method resolution order:
+
InspectorException
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.inspector_console.html b/tools/telemetry/docs/telemetry.core.chrome.inspector_console.html new file mode 100644 index 0000000..39ea04c --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.inspector_console.html @@ -0,0 +1,60 @@ + + +Python: module telemetry.core.chrome.inspector_console + + + + +
 
+ 
telemetry.core.chrome.inspector_console		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/inspector_console.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
json
+		logging
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
InspectorConsole +
+
+
+

+ + + + + +
 
+class InspectorConsole(__builtin__.object)
    Methods defined here:
+
__init__(self, inspector_backend)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
message_output_stream
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.inspector_memory.html b/tools/telemetry/docs/telemetry.core.chrome.inspector_memory.html new file mode 100644 index 0000000..076975f --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.inspector_memory.html @@ -0,0 +1,133 @@ + + +Python: module telemetry.core.chrome.inspector_memory + + + + +
 
+ 
telemetry.core.chrome.inspector_memory		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/inspector_memory.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
json
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
InspectorMemory +
+
+
exceptions.Exception(exceptions.BaseException) +
+
+
InspectorMemoryException +
+
+
+

+ + + + + + + +
 
+class InspectorMemory(__builtin__.object)
   Communicates with the remote inspector's Memory domain.
 
 Methods defined here:
+
GetDOMCounters(self, timeout)
Retrieves DOM element counts.
+ 
+Args:
+  timeout: The number of seconds to wait for the inspector backend to
+      service the request before timing out.
+ 
+Returns:
+  A dictionary containing the counts associated with "nodes", "documents",
+  and "jsEventListeners".
+ +
__init__(self, inspector_backend)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+class InspectorMemoryException(exceptions.Exception)
    
Method resolution order:
+
InspectorMemoryException
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.inspector_page.html b/tools/telemetry/docs/telemetry.core.chrome.inspector_page.html new file mode 100644 index 0000000..d7693f2 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.inspector_page.html @@ -0,0 +1,74 @@ + + +Python: module telemetry.core.chrome.inspector_page + + + + +
 
+ 
telemetry.core.chrome.inspector_page		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/inspector_page.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
json
+		logging
+		telemetry.core.util
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
InspectorPage +
+
+
+

+ + + + + +
 
+class InspectorPage(__builtin__.object)
    Methods defined here:
+
CollectGarbage(self, timeout=60)
+ +
GetCookieByName(self, name, timeout=60)
Returns the value of the cookie by the given |name|.
+ +
Navigate(self, url, script_to_evaluate_on_commit=None, timeout=60)
Navigates to |url|.
+ 
+If |script_to_evaluate_on_commit| is given, the script source string will be
+evaluated when the navigation is committed. This is after the context of
+the page exists, but before any script on the page itself has executed.
+ +
PerformActionAndWaitForNavigate(self, action_function, timeout=60)
Executes action_function, and waits for the navigation to complete.
+ 
+action_function is expect to result in a navigation. This function returns
+when the navigation is complete or when the timeout has been exceeded.
+ +
__init__(self, inspector_backend)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.inspector_runtime.html b/tools/telemetry/docs/telemetry.core.chrome.inspector_runtime.html new file mode 100644 index 0000000..90aca69 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.inspector_runtime.html @@ -0,0 +1,72 @@ + + +Python: module telemetry.core.chrome.inspector_runtime + + + + +
 
+ 
telemetry.core.chrome.inspector_runtime		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/inspector_runtime.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.exceptions
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
InspectorRuntime +
+
+
+

+ + + + + +
 
+class InspectorRuntime(__builtin__.object)
    Methods defined here:
+
Evaluate(self, expr, timeout=60)
Evalutes expr in javascript and returns the JSONized result.
+ 
+Consider using Execute for cases where the result of the expression is not
+needed.
+ 
+If evaluation throws in javascript, a python EvaluateException will
+be raised.
+ 
+If the result of the evaluation cannot be JSONized, then an
+EvaluationException will be raised.
+ +
Execute(self, expr, timeout=60)
Executes expr in javascript. Does not return the result.
+ 
+If the expression failed to evaluate, EvaluateException will be raised.
+ +
__init__(self, inspector_backend)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.inspector_timeline.html b/tools/telemetry/docs/telemetry.core.chrome.inspector_timeline.html new file mode 100644 index 0000000..cdcfb73 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.inspector_timeline.html @@ -0,0 +1,133 @@ + + +Python: module telemetry.core.chrome.inspector_timeline + + + + +
 
+ 
telemetry.core.chrome.inspector_timeline		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/inspector_timeline.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.timeline.model
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
InspectorTimeline +
+
+
exceptions.Exception(exceptions.BaseException) +
+
+
TabBackendException +
+
+
+

+ + + + + + + +
 
+class InspectorTimeline(__builtin__.object)
   Implementation of dev tools timeline.
 
 Methods defined here:
+
Start(self)
+ +
Stop(self)
+ +
__init__(self, inspector_backend)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
timeline_model
+
+
+Data and other attributes defined here:
+
Recorder = <class 'telemetry.core.chrome.inspector_timeline.Recorder'>
Utility class to Start / Stop recording timeline.
+ +

+ + + + + +
 
+class TabBackendException(exceptions.Exception)
    
Method resolution order:
+
TabBackendException
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.misc_web_contents_backend.html b/tools/telemetry/docs/telemetry.core.chrome.misc_web_contents_backend.html new file mode 100644 index 0000000..8b89a5e --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.misc_web_contents_backend.html @@ -0,0 +1,68 @@ + + +Python: module telemetry.core.chrome.misc_web_contents_backend + + + + +
 
+ 
telemetry.core.chrome.misc_web_contents_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/misc_web_contents_backend.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.exceptions
+httplib
+		telemetry.core.chrome.inspector_backend
+json
+		socket
+urllib2
+		telemetry.core.web_contents
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
MiscWebContentsBackend +
+
+
+

+ + + + + + + +
 
+class MiscWebContentsBackend(__builtin__.object)
   Provides acccess to chrome://oobe/login page, which is neither an extension
+nor a tab.
 
 Methods defined here:
+
GetOobe(self)
+ +
__init__(self, browser_backend)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.png_bitmap.html b/tools/telemetry/docs/telemetry.core.chrome.png_bitmap.html new file mode 100644 index 0000000..d311c93 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.png_bitmap.html @@ -0,0 +1,107 @@ + + +Python: module telemetry.core.chrome.png_bitmap + + + + +
 
+ 
telemetry.core.chrome.png_bitmap		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/png_bitmap.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
base64
+		os
+		png
+		sys
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
PngBitmap +
PngColor +
+
+
+

+ + + + + + + +
 
+class PngBitmap(__builtin__.object)
   Utilities for parsing and inspecting inspecting a PNG
 
 Methods defined here:
+
GetPixelColor(self, x, y)
Returns a PngColor for the pixel at (x, y)
+ +
WriteFile(self, path)
+ +
__init__(self, base64_png)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
height
+
Height of the snapshot
+
+
width
+
Width of the snapshot
+
+

+ + + + + + + +
 
+class PngColor(__builtin__.object)
   Encapsulates an RGB color retreived from a PngBitmap
 
 Methods defined here:
+
AssertIsRGB(self, r, g, b, tolerance=0)
+ +
AssertIsRGBA(self, r, g, b, a, tolerance=0)
+ +
IsEqual(self, expected_color, tolerance=0)
Verifies that the color is within a given tolerance of
+the expected color
+ +
__init__(self, r, g, b, a=255)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+Data
       PNG_PATH = '/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/../../../third_party/png'
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.tab_list_backend.html b/tools/telemetry/docs/telemetry.core.chrome.tab_list_backend.html new file mode 100644 index 0000000..5a7ca5c --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.tab_list_backend.html @@ -0,0 +1,85 @@ + + +Python: module telemetry.core.chrome.tab_list_backend + + + + +
 
+ 
telemetry.core.chrome.tab_list_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/tab_list_backend.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.exceptions
+httplib
+telemetry.core.chrome.inspector_backend
+		json
+socket
+telemetry.core.tab
+		urllib2
+telemetry.core.util
+weakref
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
TabListBackend +
+
+
+

+ + + + + +
 
+class TabListBackend(__builtin__.object)
    Methods defined here:
+
ActivateTab(self, debugger_url, timeout=None)
+ +
CloseTab(self, debugger_url, timeout=None)
+ +
DoesDebuggerUrlExist(self, url)
+ +
Get(self, index, ret)
Returns self[index] if it exists, or ret if index is out of bounds.
+ +
GetTabUrl(self, debugger_url)
+ +
Init(self)
+ +
New(self, timeout)
+ +
__getitem__(self, index)
+ +
__init__(self, browser_backend)
+ +
__iter__(self)
+ +
__len__(self)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.trace_result.html b/tools/telemetry/docs/telemetry.core.chrome.trace_result.html new file mode 100644 index 0000000..e080fe9 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.trace_result.html @@ -0,0 +1,54 @@ + + +Python: module telemetry.core.chrome.trace_result + + + + +
 
+ 
telemetry.core.chrome.trace_result		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/trace_result.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
TraceResult +
+
+
+

+ + + + + +
 
+class TraceResult(__builtin__.object)
    Methods defined here:
+
AsTimelineModel(self)
Parses the trace result into a timeline model for in-memory
+manipulation.
+ +
Serialize(self, f)
Serializes the trace result to a file-like object
+ +
__init__(self, impl)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.tracing_backend.html b/tools/telemetry/docs/telemetry.core.chrome.tracing_backend.html new file mode 100644 index 0000000..c9da2ea --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.tracing_backend.html @@ -0,0 +1,160 @@ + + +Python: module telemetry.core.chrome.tracing_backend + + + + +
 
+ 
telemetry.core.chrome.tracing_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/tracing_backend.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
cStringIO
+json
+logging
+		socket
+threading
+telemetry.core.timeline.trace_event_importer
+		telemetry.core.chrome.trace_result
+telemetry.core.util
+telemetry.core.chrome.websocket
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
TraceResultImpl +
TracingBackend +
+
+
exceptions.Exception(exceptions.BaseException) +
+
+
TracingUnsupportedException +
+
+
+

+ + + + + +
 
+class TraceResultImpl(__builtin__.object)
    Methods defined here:
+
AsTimelineModel(self)
+ +
Serialize(self, f)
+ +
__init__(self, tracing_data)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+class TracingBackend(__builtin__.object)
    Methods defined here:
+
BeginTracing(self, custom_categories=None)
+ +
Close(self)
+ +
EndTracing(self)
+ +
GetTraceResultAndReset(self)
+ +
__init__(self, devtools_port)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+class TracingUnsupportedException(exceptions.Exception)
    
Method resolution order:
+
TracingUnsupportedException
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.chrome.websocket.html b/tools/telemetry/docs/telemetry.core.chrome.websocket.html new file mode 100644 index 0000000..7c3fe54 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.chrome.websocket.html @@ -0,0 +1,40 @@ + + +Python: module telemetry.core.chrome.websocket + + + + +
 
+ 
telemetry.core.chrome.websocket		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/websocket.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
os
+		sys
+

+ + + + + +
 
+Functions
       
__init__()
+

+ + + + + +
 
+Data
       absolute_import = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.discover.html b/tools/telemetry/docs/telemetry.core.discover.html new file mode 100644 index 0000000..b78fb91 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.discover.html @@ -0,0 +1,59 @@ + + +Python: module telemetry.core.discover + + + + +
 
+ 
telemetry.core.discover		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/discover.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
fnmatch
+inspect
+		logging
+os
+		re
+traceback
+

+ + + + + +
 
+Functions
       
DiscoverClasses(start_dir, top_level_dir, base_class, pattern='*', import_error_should_raise=True)
Discover all classes in |start_dir| which subclass |base_class|.
+ 
+Args:
+  start_dir: The directory to recursively search.
+  top_level_dir: The top level of the package, for importing.
+  base_class: The base class to search for.
+  pattern: Unix shell-style pattern for filtering the filenames to import.
+  import_error_should_raise: If false, then import errors are logged but do
+    not stop discovery.
+ 
+Returns:
+  dict of {module_name: class}.
+
DiscoverModules(start_dir, top_level_dir, pattern='*', import_error_should_raise=True)
Discover all modules in |start_dir| which match |pattern|.
+ 
+Args:
+  start_dir: The directory to recursively search.
+  top_level_dir: The top level of the package, for importing.
+  pattern: Unix shell-style pattern for filtering the filenames to import.
+  import_error_should_raise: If false, then import errors are logged but do
+    not stop discovery.
+ 
+Returns:
+  list of modules.
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.exceptions.html b/tools/telemetry/docs/telemetry.core.exceptions.html new file mode 100644 index 0000000..92c4e1e --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.exceptions.html @@ -0,0 +1,338 @@ + + +Python: module telemetry.core.exceptions + + + + +
 
+ 
telemetry.core.exceptions		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/exceptions.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Classes
       
+
exceptions.Exception(exceptions.BaseException) +
+
+
BrowserGoneException +
+
+
BrowserConnectionGoneException +
+
+
EvaluateException +
LoginException +
TabCrashException +
+
+
+

+ + + + + +
 
+class BrowserConnectionGoneException(BrowserGoneException)
    
Method resolution order:
+
BrowserConnectionGoneException
+
BrowserGoneException
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors inherited from BrowserGoneException:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + + + +
 
+class BrowserGoneException(exceptions.Exception)
   Represents a crash of the entire browser.
+ 
+In this state, all bets are pretty much off.
 
 
Method resolution order:
+
BrowserGoneException
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + +
 
+class EvaluateException(exceptions.Exception)
    
Method resolution order:
+
EvaluateException
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + +
 
+class LoginException(exceptions.Exception)
    
Method resolution order:
+
LoginException
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + + + +
 
+class TabCrashException(exceptions.Exception)
   Represents a crash of the current tab, but not the overall browser.
+ 
+In this state, the tab is gone, but the underlying browser is still alive.
 
 
Method resolution order:
+
TabCrashException
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.extension_dict.html b/tools/telemetry/docs/telemetry.core.extension_dict.html new file mode 100644 index 0000000..162c184 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.extension_dict.html @@ -0,0 +1,64 @@ + + +Python: module telemetry.core.extension_dict + + + + +
 
+ 
telemetry.core.extension_dict		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/extension_dict.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.extension_to_load
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
ExtensionDict +
+
+
+

+ + + + + + + +
 
+class ExtensionDict(__builtin__.object)
   Dictionary of ExtensionPage instances, with extension_id as key
 
 Methods defined here:
+
__contains__(self, load_extension)
Checks if this ExtensionToLoad instance has been loaded
+ +
__getitem__(self, load_extension)
Given an ExtensionToLoad instance, returns the corresponding
+ExtensionPage instance.
+ +
__init__(self, extension_dict_backend)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.extension_page.html b/tools/telemetry/docs/telemetry.core.extension_page.html new file mode 100644 index 0000000..8891159 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.extension_page.html @@ -0,0 +1,103 @@ + + +Python: module telemetry.core.extension_page + + + + +
 
+ 
telemetry.core.extension_page		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/extension_page.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.web_contents
+

+ + + + + +
 
+Classes
       
+
telemetry.core.web_contents.WebContents(__builtin__.object) +
+
+
ExtensionPage +
+
+
+

+ + + + + + + +
 
+class ExtensionPage(telemetry.core.web_contents.WebContents)
   Represents a an extension page in the browser
 
 
Method resolution order:
+
ExtensionPage
+
telemetry.core.web_contents.WebContents
+
__builtin__.object
+
+
+Methods defined here:
+
__del__(self)
+ +
__init__(self, inspector_backend)
+ +
+Methods inherited from telemetry.core.web_contents.WebContents:
+
Close(self)
Closes this page.
+ 
+Not all browsers or browser versions support this method.
+Be sure to check browser.supports_tab_control.
+ +
Disconnect(self)
+ +
EvaluateJavaScript(self, expr, timeout=60)
Evalutes expr in JavaScript and returns the JSONized result.
+ 
+Consider using ExecuteJavaScript for cases where the result of the
+expression is not needed.
+ 
+If evaluation throws in JavaScript, a Python EvaluateException will
+be raised.
+ 
+If the result of the evaluation cannot be JSONized, then an
+EvaluationException will be raised.
+ +
ExecuteJavaScript(self, expr, timeout=60)
Executes expr in JavaScript. Does not return the result.
+ 
+If the expression failed to evaluate, EvaluateException will be raised.
+ +
StartTimelineRecording(self)
+ +
StopTimelineRecording(self)
+ +
WaitForDocumentReadyStateToBeComplete(self, timeout=60)
+ +
WaitForDocumentReadyStateToBeInteractiveOrBetter(self, timeout=60)
+ +
+Data descriptors inherited from telemetry.core.web_contents.WebContents:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
message_output_stream
+
+
timeline_model
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.extension_to_load.html b/tools/telemetry/docs/telemetry.core.extension_to_load.html new file mode 100644 index 0000000..8935b0a --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.extension_to_load.html @@ -0,0 +1,194 @@ + + +Python: module telemetry.core.extension_to_load + + + + +
 
+ 
telemetry.core.extension_to_load		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/extension_to_load.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.chrome.crx_id
+		os
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
ExtensionToLoad +
+
+
exceptions.Exception(exceptions.BaseException) +
+
+
ExtensionPathNonExistentException +
MissingPublicKeyException +
+
+
+

+ + + + + +
 
+class ExtensionPathNonExistentException(exceptions.Exception)
    
Method resolution order:
+
ExtensionPathNonExistentException
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + +
 
+class ExtensionToLoad(__builtin__.object)
    Methods defined here:
+
__init__(self, path, browser_type, is_component=False)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
extension_id
+
Unique extension id of this extension.
+
+
is_component
+
Whether this extension should be loaded as a component extension.
+
+
local_path
+
Path to extension destination directory, for remote instances of
+chrome
+
+
path
+
Path to extension source directory.
+
+

+ + + + + +
 
+class MissingPublicKeyException(exceptions.Exception)
    
Method resolution order:
+
MissingPublicKeyException
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.html b/tools/telemetry/docs/telemetry.core.html new file mode 100644 index 0000000..d2372ac --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.html @@ -0,0 +1,57 @@ + + +Python: package telemetry.core + + + + +
 
+ 
telemetry.core		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/__init__.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Package Contents
       
browser
+browser_credentials
+browser_credentials_unittest
+browser_finder
+browser_options
+browser_options_unittest
+browser_unittest
+chrome (package)
+discover
+		discover_unittest
+exceptions
+extension_dict
+extension_page
+extension_to_load
+extension_unittest
+memory_cache_http_server
+platform (package)
+possible_browser
+		profile_creator
+profile_types
+profile_types_unittest
+tab
+tab_list
+tab_unittest
+temporary_http_server
+temporary_http_server_unittest
+timeline (package)
+		user_agent
+user_agent_unittest
+util
+util_unittest
+web_contents
+wpr_modes
+wpr_server
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.memory_cache_http_server.html b/tools/telemetry/docs/telemetry.core.memory_cache_http_server.html new file mode 100644 index 0000000..a3d6ee6 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.memory_cache_http_server.html @@ -0,0 +1,559 @@ + + +Python: module telemetry.core.memory_cache_http_server + + + + +
 
+ 
telemetry.core.memory_cache_http_server		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/memory_cache_http_server.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
BaseHTTPServer
+SimpleHTTPServer
+		SocketServer
+mimetypes
+		os
+sys
+		zlib
+

+ + + + + +
 
+Classes
       
+
BaseHTTPServer.HTTPServer(SocketServer.TCPServer) +
+
+
MemoryCacheHTTPServer(SocketServer.ThreadingMixIn, BaseHTTPServer.HTTPServer) +
+
+
SimpleHTTPServer.SimpleHTTPRequestHandler(BaseHTTPServer.BaseHTTPRequestHandler) +
+
+
MemoryCacheHTTPRequestHandler +
+
+
SocketServer.ThreadingMixIn +
+
+
MemoryCacheHTTPServer(SocketServer.ThreadingMixIn, BaseHTTPServer.HTTPServer) +
+
+
__builtin__.tuple(__builtin__.object) +
+
+
ByteRange +
ResourceAndRange +
+
+
+

+ + + + + + + +
 
+class ByteRange(__builtin__.tuple)
   ByteRange(from_byte, to_byte)
 
 
Method resolution order:
+
ByteRange
+
__builtin__.tuple
+
__builtin__.object
+
+
+Methods defined here:
+
__getnewargs__(self)
Return self as a plain tuple.  Used by copy and pickle.
+ +
__repr__(self)
Return a nicely formatted representation string
+ +
_asdict(self)
Return a new OrderedDict which maps field names to their values
+ +
_replace(_self, **kwds)
Return a new ByteRange object replacing specified fields with new values
+ +
+Class methods defined here:
+
_make(cls, iterable, new=<built-in method __new__ of type object>, len=<built-in function len>) from __builtin__.type
Make a new ByteRange object from a sequence or iterable
+ +
+Static methods defined here:
+
__new__(_cls, from_byte, to_byte)
Create new instance of ByteRange(from_byte, to_byte)
+ +
+Data descriptors defined here:
+
from_byte
+
Alias for field number 0
+
+
to_byte
+
Alias for field number 1
+
+
+Data and other attributes defined here:
+
_fields = ('from_byte', 'to_byte')
+ +
+Methods inherited from __builtin__.tuple:
+
__add__(...)
x.__add__(y) <==> x+y
+ +
__contains__(...)
x.__contains__(y) <==> y in x
+ +
__eq__(...)
x.__eq__(y) <==> x==y
+ +
__ge__(...)
x.__ge__(y) <==> x>=y
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__gt__(...)
x.__gt__(y) <==> x>y
+ +
__hash__(...)
x.__hash__() <==> hash(x)
+ +
__iter__(...)
x.__iter__() <==> iter(x)
+ +
__le__(...)
x.__le__(y) <==> x<=y
+ +
__len__(...)
x.__len__() <==> len(x)
+ +
__lt__(...)
x.__lt__(y) <==> x<y
+ +
__mul__(...)
x.__mul__(n) <==> x*n
+ +
__ne__(...)
x.__ne__(y) <==> x!=y
+ +
__rmul__(...)
x.__rmul__(n) <==> n*x
+ +
__sizeof__(...)
T.__sizeof__() -- size of T in memory, in bytes
+ +
count(...)
T.count(value) -> integer -- return number of occurrences of value
+ +
index(...)
T.index(value, [start, [stop]]) -> integer -- return first index of value.
+Raises ValueError if the value is not present.
+ +

+ + + + + +
 
+class MemoryCacheHTTPRequestHandler(SimpleHTTPServer.SimpleHTTPRequestHandler)
    
Method resolution order:
+
MemoryCacheHTTPRequestHandler
+
SimpleHTTPServer.SimpleHTTPRequestHandler
+
BaseHTTPServer.BaseHTTPRequestHandler
+
SocketServer.StreamRequestHandler
+
SocketServer.BaseRequestHandler
+
+
+Methods defined here:
+
GetByteRange(self, total_num_of_bytes)
Parse the header and get the range values specified.
+ 
+Args:
+  total_num_of_bytes: Total # of bytes in requested resource,
+  used to calculate upper range limit.
+Returns:
+  A ByteRange namedtuple object with the requested byte-range values.
+  If no Range is explicitly requested or there is a failure parsing,
+  return None.
+  Special case: If range specified is in the format "N-", return N-N.
+  If upper range limit is greater than total # of bytes, return upper index.
+ +
SendHead(self)
+ +
do_GET(self)
Serve a GET request.
+ +
do_HEAD(self)
Serve a HEAD request.
+ +
+Methods inherited from SimpleHTTPServer.SimpleHTTPRequestHandler:
+
copyfile(self, source, outputfile)
Copy all data between two file objects.
+ 
+The SOURCE argument is a file object open for reading
+(or anything with a read() method) and the DESTINATION
+argument is a file object open for writing (or
+anything with a write() method).
+ 
+The only reason for overriding this would be to change
+the block size or perhaps to replace newlines by CRLF
+-- note however that this the default server uses this
+to copy binary data as well.
+ +
guess_type(self, path)
Guess the type of a file.
+ 
+Argument is a PATH (a filename).
+ 
+Return value is a string of the form type/subtype,
+usable for a MIME Content-type header.
+ 
+The default implementation looks the file's extension
+up in the table self.extensions_map, using application/octet-stream
+as a default; however it would be permissible (if
+slow) to look inside the data to make a better guess.
+ +
list_directory(self, path)
Helper to produce a directory listing (absent index.html).
+ 
+Return value is either a file object, or None (indicating an
+error).  In either case, the headers are sent, making the
+interface the same as for send_head().
+ +
send_head(self)
Common code for GET and HEAD commands.
+ 
+This sends the response code and MIME headers.
+ 
+Return value is either a file object (which has to be copied
+to the outputfile by the caller unless the command was HEAD,
+and must be closed by the caller under all circumstances), or
+None, in which case the caller has nothing further to do.
+ +
translate_path(self, path)
Translate a /-separated PATH to the local filename syntax.
+ 
+Components that mean special things to the local file system
+(e.g. drive or directory names) are ignored.  (XXX They should
+probably be diagnosed.)
+ +
+Data and other attributes inherited from SimpleHTTPServer.SimpleHTTPRequestHandler:
+
extensions_map = {'': 'application/octet-stream', '.123': 'application/vnd.lotus-1-2-3', '.3dml': 'text/vnd.in3d.3dml', '.3g2': 'video/3gpp2', '.3gp': 'video/3gpp', '.7z': 'application/x-7z-compressed', '.a': 'application/octet-stream', '.aab': 'application/x-authorware-bin', '.aac': 'audio/x-aac', '.aam': 'application/x-authorware-map', ...}
+ +
server_version = 'SimpleHTTP/0.6'
+ +
+Methods inherited from BaseHTTPServer.BaseHTTPRequestHandler:
+
address_string(self)
Return the client address formatted for logging.
+ 
+This version looks up the full hostname using gethostbyaddr(),
+and tries to find a name that contains at least one dot.
+ +
date_time_string(self, timestamp=None)
Return the current date and time formatted for a message header.
+ +
end_headers(self)
Send the blank line ending the MIME headers.
+ +
handle(self)
Handle multiple requests if necessary.
+ +
handle_one_request(self)
Handle a single HTTP request.
+ 
+You normally don't need to override this method; see the class
+__doc__ string for information on how to handle specific HTTP
+commands such as GET and POST.
+ +
log_date_time_string(self)
Return the current time formatted for logging.
+ +
log_error(self, format, *args)
Log an error.
+ 
+This is called when a request cannot be fulfilled.  By
+default it passes the message on to log_message().
+ 
+Arguments are the same as for log_message().
+ 
+XXX This should go to the separate error log.
+ +
log_message(self, format, *args)
Log an arbitrary message.
+ 
+This is used by all other logging functions.  Override
+it if you have specific logging wishes.
+ 
+The first argument, FORMAT, is a format string for the
+message to be logged.  If the format string contains
+any % escapes requiring parameters, they should be
+specified as subsequent arguments (it's just like
+printf!).
+ 
+The client host and current date/time are prefixed to
+every message.
+ +
log_request(self, code='-', size='-')
Log an accepted request.
+ 
+This is called by send_response().
+ +
parse_request(self)
Parse a request (internal).
+ 
+The request should be stored in self.raw_requestline; the results
+are in self.command, self.path, self.request_version and
+self.headers.
+ 
+Return True for success, False for failure; on failure, an
+error is sent back.
+ +
send_error(self, code, message=None)
Send and log an error reply.
+ 
+Arguments are the error code, and a detailed message.
+The detailed message defaults to the short entry matching the
+response code.
+ 
+This sends an error response (so it must be called before any
+output has been generated), logs the error, and finally sends
+a piece of HTML explaining the error to the user.
+ +
send_header(self, keyword, value)
Send a MIME header.
+ +
send_response(self, code, message=None)
Send the response header and log the response code.
+ 
+Also send two standard headers with the server software
+version and the current date.
+ +
version_string(self)
Return the server software version string.
+ +
+Data and other attributes inherited from BaseHTTPServer.BaseHTTPRequestHandler:
+
MessageClass = <class mimetools.Message>
+ +
default_request_version = 'HTTP/0.9'
+ +
error_content_type = 'text/html'
+ +
error_message_format = '<head>\n<title>Error response</title>\n</head>\n<bo...ode explanation: %(code)s = %(explain)s.\n</body>\n'
+ +
monthname = [None, 'Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec']
+ +
protocol_version = 'HTTP/1.0'
+ +
responses = {100: ('Continue', 'Request received, please continue'), 101: ('Switching Protocols', 'Switching to new protocol; obey Upgrade header'), 200: ('OK', 'Request fulfilled, document follows'), 201: ('Created', 'Document created, URL follows'), 202: ('Accepted', 'Request accepted, processing continues off-line'), 203: ('Non-Authoritative Information', 'Request fulfilled from cache'), 204: ('No Content', 'Request fulfilled, nothing follows'), 205: ('Reset Content', 'Clear input form for further input.'), 206: ('Partial Content', 'Partial content follows.'), 300: ('Multiple Choices', 'Object has several resources -- see URI list'), ...}
+ +
sys_version = 'Python/2.7.2'
+ +
weekdayname = ['Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat', 'Sun']
+ +
+Methods inherited from SocketServer.StreamRequestHandler:
+
finish(self)
+ +
setup(self)
+ +
+Data and other attributes inherited from SocketServer.StreamRequestHandler:
+
disable_nagle_algorithm = False
+ +
rbufsize = -1
+ +
timeout = None
+ +
wbufsize = 0
+ +
+Methods inherited from SocketServer.BaseRequestHandler:
+
__init__(self, request, client_address, server)
+ +

+ + + + + +
 
+class MemoryCacheHTTPServer(SocketServer.ThreadingMixIn, BaseHTTPServer.HTTPServer)
    
Method resolution order:
+
MemoryCacheHTTPServer
+
SocketServer.ThreadingMixIn
+
BaseHTTPServer.HTTPServer
+
SocketServer.TCPServer
+
SocketServer.BaseServer
+
+
+Methods defined here:
+
AddDirectoryToResourceMap(self, cwd)
Loads all files in cwd into the in-memory resource map.
+ +
AddFileToResourceMap(self, file_path)
Loads file_path into the in-memory resource map.
+ +
__init__(self, host_port, handler, paths)
+ +
+Data and other attributes defined here:
+
request_queue_size = 128
+ +
+Methods inherited from SocketServer.ThreadingMixIn:
+
process_request(self, request, client_address)
Start a new thread to process the request.
+ +
process_request_thread(self, request, client_address)
Same as in BaseServer but as a thread.
+ 
+In addition, exception handling is done here.
+ +
+Data and other attributes inherited from SocketServer.ThreadingMixIn:
+
daemon_threads = False
+ +
+Methods inherited from BaseHTTPServer.HTTPServer:
+
server_bind(self)
Override server_bind to store the server name.
+ +
+Data and other attributes inherited from BaseHTTPServer.HTTPServer:
+
allow_reuse_address = 1
+ +
+Methods inherited from SocketServer.TCPServer:
+
close_request(self, request)
Called to clean up an individual request.
+ +
fileno(self)
Return socket file number.
+ 
+Interface required by select().
+ +
get_request(self)
Get the request and client address from the socket.
+ 
+May be overridden.
+ +
server_activate(self)
Called by constructor to activate the server.
+ 
+May be overridden.
+ +
server_close(self)
Called to clean-up the server.
+ 
+May be overridden.
+ +
shutdown_request(self, request)
Called to shutdown and close an individual request.
+ +
+Data and other attributes inherited from SocketServer.TCPServer:
+
address_family = 2
+ +
socket_type = 1
+ +
+Methods inherited from SocketServer.BaseServer:
+
finish_request(self, request, client_address)
Finish one request by instantiating RequestHandlerClass.
+ +
handle_error(self, request, client_address)
Handle an error gracefully.  May be overridden.
+ 
+The default is to print a traceback and continue.
+ +
handle_request(self)
Handle one request, possibly blocking.
+ 
+Respects self.timeout.
+ +
handle_timeout(self)
Called if no new request arrives within self.timeout.
+ 
+Overridden by ForkingMixIn.
+ +
serve_forever(self, poll_interval=0.5)
Handle one request at a time until shutdown.
+ 
+Polls for shutdown every poll_interval seconds. Ignores
+self.timeout. If you need to do periodic tasks, do them in
+another thread.
+ +
shutdown(self)
Stops the serve_forever loop.
+ 
+Blocks until the loop has finished. This must be called while
+serve_forever() is running in another thread, or it will
+deadlock.
+ +
verify_request(self, request, client_address)
Verify the request.  May be overridden.
+ 
+Return True if we should proceed with this request.
+ +
+Data and other attributes inherited from SocketServer.BaseServer:
+
timeout = None
+ +

+ + + + + + + +
 
+class ResourceAndRange(__builtin__.tuple)
   ResourceAndRange(resource, byte_range)
 
 
Method resolution order:
+
ResourceAndRange
+
__builtin__.tuple
+
__builtin__.object
+
+
+Methods defined here:
+
__getnewargs__(self)
Return self as a plain tuple.  Used by copy and pickle.
+ +
__repr__(self)
Return a nicely formatted representation string
+ +
_asdict(self)
Return a new OrderedDict which maps field names to their values
+ +
_replace(_self, **kwds)
Return a new ResourceAndRange object replacing specified fields with new values
+ +
+Class methods defined here:
+
_make(cls, iterable, new=<built-in method __new__ of type object>, len=<built-in function len>) from __builtin__.type
Make a new ResourceAndRange object from a sequence or iterable
+ +
+Static methods defined here:
+
__new__(_cls, resource, byte_range)
Create new instance of ResourceAndRange(resource, byte_range)
+ +
+Data descriptors defined here:
+
byte_range
+
Alias for field number 1
+
+
resource
+
Alias for field number 0
+
+
+Data and other attributes defined here:
+
_fields = ('resource', 'byte_range')
+ +
+Methods inherited from __builtin__.tuple:
+
__add__(...)
x.__add__(y) <==> x+y
+ +
__contains__(...)
x.__contains__(y) <==> y in x
+ +
__eq__(...)
x.__eq__(y) <==> x==y
+ +
__ge__(...)
x.__ge__(y) <==> x>=y
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__gt__(...)
x.__gt__(y) <==> x>y
+ +
__hash__(...)
x.__hash__() <==> hash(x)
+ +
__iter__(...)
x.__iter__() <==> iter(x)
+ +
__le__(...)
x.__le__(y) <==> x<=y
+ +
__len__(...)
x.__len__() <==> len(x)
+ +
__lt__(...)
x.__lt__(y) <==> x<y
+ +
__mul__(...)
x.__mul__(n) <==> x*n
+ +
__ne__(...)
x.__ne__(y) <==> x!=y
+ +
__rmul__(...)
x.__rmul__(n) <==> n*x
+ +
__sizeof__(...)
T.__sizeof__() -- size of T in memory, in bytes
+ +
count(...)
T.count(value) -> integer -- return number of occurrences of value
+ +
index(...)
T.index(value, [start, [stop]]) -> integer -- return first index of value.
+Raises ValueError if the value is not present.
+ +

+ + + + + +
 
+Functions
       
Main()
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.android_platform_backend.html b/tools/telemetry/docs/telemetry.core.platform.android_platform_backend.html new file mode 100644 index 0000000..7a857a9 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.android_platform_backend.html @@ -0,0 +1,102 @@ + + +Python: module telemetry.core.platform.android_platform_backend + + + + +
 
+ 
telemetry.core.platform.android_platform_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/android_platform_backend.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
logging
+os
+		pylib.perf_tests_helper
+telemetry.core.platform
+		telemetry.core.platform.platform_backend
+pylib.surface_stats_collector
+		sys
+pylib.thermal_throttle
+

+ + + + + +
 
+Classes
       
+
telemetry.core.platform.platform_backend.PlatformBackend(__builtin__.object) +
+
+
AndroidPlatformBackend +
+
+
+

+ + + + + +
 
+class AndroidPlatformBackend(telemetry.core.platform.platform_backend.PlatformBackend)
    
Method resolution order:
+
AndroidPlatformBackend
+
telemetry.core.platform.platform_backend.PlatformBackend
+
__builtin__.object
+
+
+Methods defined here:
+
CanMonitorThermalThrottling(self)
+ +
GetChildPids(self, pid)
+ +
GetCommandLine(self, pid)
+ +
GetIOStats(self, pid)
+ +
GetMemoryStats(self, pid)
+ +
GetOSName(self)
+ +
GetRawDisplayFrameRateMeasurements(self)
+ +
GetSystemCommitCharge(self)
+ +
HasBeenThermallyThrottled(self)
+ +
IsRawDisplayFrameRateSupported(self)
+ +
IsThermallyThrottled(self)
+ +
SetFullPerformanceModeEnabled(self, enabled)
+ +
StartRawDisplayFrameRateMeasurement(self)
+ +
StopRawDisplayFrameRateMeasurement(self)
+ +
__init__(self, adb, no_performance_mode)
+ +
+Methods inherited from telemetry.core.platform.platform_backend.PlatformBackend:
+
GetOSVersionName(self)
+ +
+Data descriptors inherited from telemetry.core.platform.platform_backend.PlatformBackend:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.cros_platform_backend.html b/tools/telemetry/docs/telemetry.core.platform.cros_platform_backend.html new file mode 100644 index 0000000..8c7959c --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.cros_platform_backend.html @@ -0,0 +1,101 @@ + + +Python: module telemetry.core.platform.cros_platform_backend + + + + +
 
+ 
telemetry.core.platform.cros_platform_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/cros_platform_backend.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.platform.linux_platform_backend
+

+ + + + + +
 
+Classes
       
+
telemetry.core.platform.linux_platform_backend.LinuxPlatformBackend(telemetry.core.platform.posix_platform_backend.PosixPlatformBackend) +
+
+
CrosPlatformBackend +
+
+
+

+ + + + + +
 
+class CrosPlatformBackend(telemetry.core.platform.linux_platform_backend.LinuxPlatformBackend)
    
Method resolution order:
+
CrosPlatformBackend
+
telemetry.core.platform.linux_platform_backend.LinuxPlatformBackend
+
telemetry.core.platform.posix_platform_backend.PosixPlatformBackend
+
telemetry.core.platform.platform_backend.PlatformBackend
+
__builtin__.object
+
+
+Methods defined here:
+
GetOSName(self)
+ +
GetRawDisplayFrameRateMeasurements(self)
+ +
HasBeenThermallyThrottled(self)
+ +
IsThermallyThrottled(self)
+ +
StartRawDisplayFrameRateMeasurement(self)
+ +
StopRawDisplayFrameRateMeasurement(self)
+ +
__init__(self, cri)
+ +
+Methods inherited from telemetry.core.platform.linux_platform_backend.LinuxPlatformBackend:
+
GetIOStats(self, pid)
+ +
GetMemoryStats(self, pid)
+ +
GetSystemCommitCharge(self)
+ +
+Methods inherited from telemetry.core.platform.posix_platform_backend.PosixPlatformBackend:
+
GetChildPids(self, pid)
Returns a list of child pids of |pid|.
+ +
GetCommandLine(self, pid)
+ +
+Methods inherited from telemetry.core.platform.platform_backend.PlatformBackend:
+
CanMonitorThermalThrottling(self)
+ +
GetOSVersionName(self)
+ +
IsRawDisplayFrameRateSupported(self)
+ +
SetFullPerformanceModeEnabled(self, enabled)
+ +
+Data descriptors inherited from telemetry.core.platform.platform_backend.PlatformBackend:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.html b/tools/telemetry/docs/telemetry.core.platform.html new file mode 100644 index 0000000..4a9d9b6 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.html @@ -0,0 +1,108 @@ + + +Python: package telemetry.core.platform + + + + +
 
+ 
telemetry.core.platform		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/__init__.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Package Contents
       
android_platform_backend
+cros_platform_backend
+linux_platform_backend
+		mac_platform_backend
+platform_backend
+posix_platform_backend
+		posix_platform_backend_unittest
+profiler (package)
+win_platform_backend
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
Platform +
+
+
+

+ + + + + + + +
 
+class Platform(__builtin__.object)
   The platform that the target browser is running on.
+ 
+Provides a limited interface to interact with the platform itself, where
+possible. It's important to note that platforms may not provide a specific
+API, so check with IsFooBar() for availability.
 
 Methods defined here:
+
CanMonitorThermalThrottling(self)
Platforms may be able to detect thermal throttling.
+ 
+Some fan-less computers go into a reduced performance mode when their heat
+exceeds a certain threshold. Performance tests in particular should use this
+API to detect if this has happened and interpret results accordingly.
+ +
GetOSName(self)
Returns a string description of the Platform OS.
+ 
+Examples: WIN, MAC, LINUX, CHROMEOS
+ +
GetOSVersionName(self)
Returns a string description of the Platform OS version.
+ 
+Examples: VISTA, WIN7, LION, MOUNTAINLION
+ +
GetRawDisplayFrameRateMeasurements(self)
Returns a list of RawDisplayFrameRateMeasurement.
+ +
HasBeenThermallyThrottled(self)
Returns True if the device has been thermally throttled.
+ +
IsRawDisplayFrameRateSupported(self)
Platforms may be able to collect GL surface stats.
+ +
IsThermallyThrottled(self)
Returns True if the device is currently thermally throttled.
+ +
SetFullPerformanceModeEnabled(self, enabled)
Platforms may tweak their CPU governor, system status, etc.
+ 
+Most platforms can operate in a battery saving mode. While good for battery
+life, this can cause confusing performance results and add noise. Turning
+full performance mode on disables these features, which is useful for
+performance testing.
+ +
StartRawDisplayFrameRateMeasurement(self)
Start measuring GL surface stats.
+ +
StopRawDisplayFrameRateMeasurement(self)
Stop measuring GL surface stats.
+ +
__init__(self, platform_backend)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes defined here:
+
RawDisplayFrameRateMeasurement = <class 'telemetry.core.platform.RawDisplayFrameRateMeasurement'>
+ +

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.linux_platform_backend.html b/tools/telemetry/docs/telemetry.core.platform.linux_platform_backend.html new file mode 100644 index 0000000..208e90e --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.linux_platform_backend.html @@ -0,0 +1,97 @@ + + +Python: module telemetry.core.platform.linux_platform_backend + + + + +
 
+ 
telemetry.core.platform.linux_platform_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/linux_platform_backend.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.platform.posix_platform_backend
+		resource
+

+ + + + + +
 
+Classes
       
+
telemetry.core.platform.posix_platform_backend.PosixPlatformBackend(telemetry.core.platform.platform_backend.PlatformBackend) +
+
+
LinuxPlatformBackend +
+
+
+

+ + + + + +
 
+class LinuxPlatformBackend(telemetry.core.platform.posix_platform_backend.PosixPlatformBackend)
    
Method resolution order:
+
LinuxPlatformBackend
+
telemetry.core.platform.posix_platform_backend.PosixPlatformBackend
+
telemetry.core.platform.platform_backend.PlatformBackend
+
__builtin__.object
+
+
+Methods defined here:
+
GetIOStats(self, pid)
+ +
GetMemoryStats(self, pid)
+ +
GetOSName(self)
+ +
GetRawDisplayFrameRateMeasurements(self)
+ +
GetSystemCommitCharge(self)
+ +
HasBeenThermallyThrottled(self)
+ +
IsThermallyThrottled(self)
+ +
StartRawDisplayFrameRateMeasurement(self)
+ +
StopRawDisplayFrameRateMeasurement(self)
+ +
+Methods inherited from telemetry.core.platform.posix_platform_backend.PosixPlatformBackend:
+
GetChildPids(self, pid)
Returns a list of child pids of |pid|.
+ +
GetCommandLine(self, pid)
+ +
+Methods inherited from telemetry.core.platform.platform_backend.PlatformBackend:
+
CanMonitorThermalThrottling(self)
+ +
GetOSVersionName(self)
+ +
IsRawDisplayFrameRateSupported(self)
+ +
SetFullPerformanceModeEnabled(self, enabled)
+ +
+Data descriptors inherited from telemetry.core.platform.platform_backend.PlatformBackend:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.mac_platform_backend.html b/tools/telemetry/docs/telemetry.core.platform.mac_platform_backend.html new file mode 100644 index 0000000..00a8064 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.mac_platform_backend.html @@ -0,0 +1,98 @@ + + +Python: module telemetry.core.platform.mac_platform_backend + + + + +
 
+ 
telemetry.core.platform.mac_platform_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/mac_platform_backend.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
os
+		telemetry.core.platform.posix_platform_backend
+		resource
+

+ + + + + +
 
+Classes
       
+
telemetry.core.platform.posix_platform_backend.PosixPlatformBackend(telemetry.core.platform.platform_backend.PlatformBackend) +
+
+
MacPlatformBackend +
+
+
+

+ + + + + +
 
+class MacPlatformBackend(telemetry.core.platform.posix_platform_backend.PosixPlatformBackend)
    
Method resolution order:
+
MacPlatformBackend
+
telemetry.core.platform.posix_platform_backend.PosixPlatformBackend
+
telemetry.core.platform.platform_backend.PlatformBackend
+
__builtin__.object
+
+
+Methods defined here:
+
GetMemoryStats(self, pid)
+ +
GetOSName(self)
+ +
GetOSVersionName(self)
+ +
GetRawDisplayFrameRateMeasurements(self)
+ +
GetSystemCommitCharge(self)
+ +
HasBeenThermallyThrottled(self)
+ +
IsThermallyThrottled(self)
+ +
StartRawDisplayFrameRateMeasurement(self)
+ +
StopRawDisplayFrameRateMeasurement(self)
+ +
+Methods inherited from telemetry.core.platform.posix_platform_backend.PosixPlatformBackend:
+
GetChildPids(self, pid)
Returns a list of child pids of |pid|.
+ +
GetCommandLine(self, pid)
+ +
+Methods inherited from telemetry.core.platform.platform_backend.PlatformBackend:
+
CanMonitorThermalThrottling(self)
+ +
GetIOStats(self, pid)
+ +
IsRawDisplayFrameRateSupported(self)
+ +
SetFullPerformanceModeEnabled(self, enabled)
+ +
+Data descriptors inherited from telemetry.core.platform.platform_backend.PlatformBackend:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.platform_backend.html b/tools/telemetry/docs/telemetry.core.platform.platform_backend.html new file mode 100644 index 0000000..410d5ff --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.platform_backend.html @@ -0,0 +1,77 @@ + + +Python: module telemetry.core.platform.platform_backend + + + + +
 
+ 
telemetry.core.platform.platform_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/platform_backend.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
PlatformBackend +
+
+
+

+ + + + + +
 
+class PlatformBackend(__builtin__.object)
    Methods defined here:
+
CanMonitorThermalThrottling(self)
+ +
GetChildPids(self, pid)
+ +
GetCommandLine(self, pid)
+ +
GetIOStats(self, pid)
+ +
GetMemoryStats(self, pid)
+ +
GetOSName(self)
+ +
GetOSVersionName(self)
+ +
GetRawDisplayFrameRateMeasurements(self)
+ +
GetSystemCommitCharge(self)
+ +
HasBeenThermallyThrottled(self)
+ +
IsRawDisplayFrameRateSupported(self)
+ +
IsThermallyThrottled(self)
+ +
SetFullPerformanceModeEnabled(self, enabled)
+ +
StartRawDisplayFrameRateMeasurement(self)
# pylint: disable=W0613
+ +
StopRawDisplayFrameRateMeasurement(self)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.posix_platform_backend.html b/tools/telemetry/docs/telemetry.core.platform.posix_platform_backend.html new file mode 100644 index 0000000..517dc8a --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.posix_platform_backend.html @@ -0,0 +1,94 @@ + + +Python: module telemetry.core.platform.posix_platform_backend + + + + +
 
+ 
telemetry.core.platform.posix_platform_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/posix_platform_backend.py
+

# Copyright 2013 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.platform.platform_backend
+		subprocess
+

+ + + + + +
 
+Classes
       
+
telemetry.core.platform.platform_backend.PlatformBackend(__builtin__.object) +
+
+
PosixPlatformBackend +
+
+
+

+ + + + + +
 
+class PosixPlatformBackend(telemetry.core.platform.platform_backend.PlatformBackend)
    
Method resolution order:
+
PosixPlatformBackend
+
telemetry.core.platform.platform_backend.PlatformBackend
+
__builtin__.object
+
+
+Methods defined here:
+
GetChildPids(self, pid)
Returns a list of child pids of |pid|.
+ +
GetCommandLine(self, pid)
+ +
+Methods inherited from telemetry.core.platform.platform_backend.PlatformBackend:
+
CanMonitorThermalThrottling(self)
+ +
GetIOStats(self, pid)
+ +
GetMemoryStats(self, pid)
+ +
GetOSName(self)
+ +
GetOSVersionName(self)
+ +
GetRawDisplayFrameRateMeasurements(self)
+ +
GetSystemCommitCharge(self)
+ +
HasBeenThermallyThrottled(self)
+ +
IsRawDisplayFrameRateSupported(self)
+ +
IsThermallyThrottled(self)
+ +
SetFullPerformanceModeEnabled(self, enabled)
+ +
StartRawDisplayFrameRateMeasurement(self)
# pylint: disable=W0613
+ +
StopRawDisplayFrameRateMeasurement(self)
+ +
+Data descriptors inherited from telemetry.core.platform.platform_backend.PlatformBackend:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.profiler.html b/tools/telemetry/docs/telemetry.core.platform.profiler.html new file mode 100644 index 0000000..4823462 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.profiler.html @@ -0,0 +1,72 @@ + + +Python: package telemetry.core.platform.profiler + + + + +
 
+ 
telemetry.core.platform.profiler		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/__init__.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Package Contents
       
iprofiler_profiler
+java_heap_profiler
+		perf_profiler
+profiler_finder
+		sample_profiler
+tcmalloc_heap_profiler
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
Profiler +
+
+
+

+ + + + + + + +
 
+class Profiler(__builtin__.object)
   A sampling profiler provided by the platform.
 
 Methods defined here:
+
CollectProfile(self)
Collect the profile from the profiler.
+ +
__init__(self, browser_backend, platform_backend, output_path)
+ +
+Class methods defined here:
+
is_supported(cls, options) from __builtin__.type
True iff this profiler is currently supported by the platform.
+ +
name(cls) from __builtin__.type
User-friendly name of this profiler.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.profiler.iprofiler_profiler.html b/tools/telemetry/docs/telemetry.core.platform.profiler.iprofiler_profiler.html new file mode 100644 index 0000000..adcdcd3 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.profiler.iprofiler_profiler.html @@ -0,0 +1,76 @@ + + +Python: module telemetry.core.platform.profiler.iprofiler_profiler + + + + +
 
+ 
telemetry.core.platform.profiler.iprofiler_profiler		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/iprofiler_profiler.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
os
+pexpect
+		telemetry.core.platform.profiler
+signal
+		sys
+telemetry.core.util
+

+ + + + + +
 
+Classes
       
+
telemetry.core.platform.profiler.Profiler(__builtin__.object) +
+
+
IprofilerProfiler +
+
+
+

+ + + + + +
 
+class IprofilerProfiler(telemetry.core.platform.profiler.Profiler)
    
Method resolution order:
+
IprofilerProfiler
+
telemetry.core.platform.profiler.Profiler
+
__builtin__.object
+
+
+Methods defined here:
+
CollectProfile(self)
+ +
__init__(self, browser_backend, platform_backend, output_path)
+ +
+Class methods defined here:
+
is_supported(cls, options) from __builtin__.type
+ +
name(cls) from __builtin__.type
+ +
+Data descriptors inherited from telemetry.core.platform.profiler.Profiler:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.profiler.java_heap_profiler.html b/tools/telemetry/docs/telemetry.core.platform.profiler.java_heap_profiler.html new file mode 100644 index 0000000..84fbdc0 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.profiler.java_heap_profiler.html @@ -0,0 +1,77 @@ + + +Python: module telemetry.core.platform.profiler.java_heap_profiler + + + + +
 
+ 
telemetry.core.platform.profiler.java_heap_profiler		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/java_heap_profiler.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
os
+telemetry.core.platform.profiler
+		subprocess
+threading
+		telemetry.core.util
+

+ + + + + +
 
+Classes
       
+
telemetry.core.platform.profiler.Profiler(__builtin__.object) +
+
+
JavaHeapProfiler +
+
+
+

+ + + + + + + +
 
+class JavaHeapProfiler(telemetry.core.platform.profiler.Profiler)
   Android-specific, trigger and fetch java heap dumps.
 
 
Method resolution order:
+
JavaHeapProfiler
+
telemetry.core.platform.profiler.Profiler
+
__builtin__.object
+
+
+Methods defined here:
+
CollectProfile(self)
+ +
__init__(self, browser_backend, platform_backend, output_path)
+ +
+Class methods defined here:
+
is_supported(cls, options) from __builtin__.type
+ +
name(cls) from __builtin__.type
+ +
+Data descriptors inherited from telemetry.core.platform.profiler.Profiler:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.profiler.perf_profiler.html b/tools/telemetry/docs/telemetry.core.platform.profiler.perf_profiler.html new file mode 100644 index 0000000..00d904c --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.profiler.perf_profiler.html @@ -0,0 +1,75 @@ + + +Python: module telemetry.core.platform.profiler.perf_profiler + + + + +
 
+ 
telemetry.core.platform.profiler.perf_profiler		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/perf_profiler.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.platform.profiler
+signal
+		subprocess
+sys
+		tempfile
+

+ + + + + +
 
+Classes
       
+
telemetry.core.platform.profiler.Profiler(__builtin__.object) +
+
+
PerfProfiler +
+
+
+

+ + + + + +
 
+class PerfProfiler(telemetry.core.platform.profiler.Profiler)
    
Method resolution order:
+
PerfProfiler
+
telemetry.core.platform.profiler.Profiler
+
__builtin__.object
+
+
+Methods defined here:
+
CollectProfile(self)
+ +
__init__(self, browser_backend, platform_backend, output_path)
+ +
+Class methods defined here:
+
is_supported(cls, options) from __builtin__.type
+ +
name(cls) from __builtin__.type
+ +
+Data descriptors inherited from telemetry.core.platform.profiler.Profiler:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.profiler.profiler_finder.html b/tools/telemetry/docs/telemetry.core.platform.profiler.profiler_finder.html new file mode 100644 index 0000000..23af808 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.profiler.profiler_finder.html @@ -0,0 +1,37 @@ + + +Python: module telemetry.core.platform.profiler.profiler_finder + + + + +
 
+ 
telemetry.core.platform.profiler.profiler_finder		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/profiler_finder.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.platform.profiler.iprofiler_profiler
+telemetry.core.platform.profiler.java_heap_profiler
+		telemetry.core.platform.profiler.perf_profiler
+telemetry.core.platform.profiler.sample_profiler
+		telemetry.core.platform.profiler.tcmalloc_heap_profiler
+

+ + + + + +
 
+Functions
       
FindProfiler(name)
+
GetAllAvailableProfilers()
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.profiler.sample_profiler.html b/tools/telemetry/docs/telemetry.core.platform.profiler.sample_profiler.html new file mode 100644 index 0000000..5323b00 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.profiler.sample_profiler.html @@ -0,0 +1,76 @@ + + +Python: module telemetry.core.platform.profiler.sample_profiler + + + + +
 
+ 
telemetry.core.platform.profiler.sample_profiler		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/sample_profiler.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.platform.profiler
+signal
+		subprocess
+sys
+		tempfile
+telemetry.core.util
+

+ + + + + +
 
+Classes
       
+
telemetry.core.platform.profiler.Profiler(__builtin__.object) +
+
+
SampleProfiler +
+
+
+

+ + + + + +
 
+class SampleProfiler(telemetry.core.platform.profiler.Profiler)
    
Method resolution order:
+
SampleProfiler
+
telemetry.core.platform.profiler.Profiler
+
__builtin__.object
+
+
+Methods defined here:
+
CollectProfile(self)
+ +
__init__(self, browser_backend, platform_backend, output_path)
+ +
+Class methods defined here:
+
is_supported(cls, options) from __builtin__.type
+ +
name(cls) from __builtin__.type
+ +
+Data descriptors inherited from telemetry.core.platform.profiler.Profiler:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.profiler.tcmalloc_heap_profiler.html b/tools/telemetry/docs/telemetry.core.platform.profiler.tcmalloc_heap_profiler.html new file mode 100644 index 0000000..b1f53a7 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.profiler.tcmalloc_heap_profiler.html @@ -0,0 +1,76 @@ + + +Python: module telemetry.core.platform.profiler.tcmalloc_heap_profiler + + + + +
 
+ 
telemetry.core.platform.profiler.tcmalloc_heap_profiler		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/profiler/tcmalloc_heap_profiler.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
logging
+		os
+		telemetry.core.platform.profiler
+		sys
+

+ + + + + +
 
+Classes
       
+
telemetry.core.platform.profiler.Profiler(__builtin__.object) +
+
+
TCMallocHeapProfiler +
+
+
+

+ + + + + + + +
 
+class TCMallocHeapProfiler(telemetry.core.platform.profiler.Profiler)
   A Factory to instantiate the platform-specific profiler.
 
 
Method resolution order:
+
TCMallocHeapProfiler
+
telemetry.core.platform.profiler.Profiler
+
__builtin__.object
+
+
+Methods defined here:
+
CollectProfile(self)
+ +
__init__(self, browser_backend, platform_backend, output_path)
+ +
+Class methods defined here:
+
is_supported(cls, options) from __builtin__.type
+ +
name(cls) from __builtin__.type
+ +
+Data descriptors inherited from telemetry.core.platform.profiler.Profiler:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.platform.win_platform_backend.html b/tools/telemetry/docs/telemetry.core.platform.win_platform_backend.html new file mode 100644 index 0000000..870229f --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.platform.win_platform_backend.html @@ -0,0 +1,108 @@ + + +Python: module telemetry.core.platform.win_platform_backend + + + + +
 
+ 
telemetry.core.platform.win_platform_backend		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/platform/win_platform_backend.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
collections
+ctypes
+		os
+telemetry.core.platform.platform_backend
+		re
+subprocess
+

+ + + + + +
 
+Classes
       
+
telemetry.core.platform.platform_backend.PlatformBackend(__builtin__.object) +
+
+
WinPlatformBackend +
+
+
+

+ + + + + +
 
+class WinPlatformBackend(telemetry.core.platform.platform_backend.PlatformBackend)
    
Method resolution order:
+
WinPlatformBackend
+
telemetry.core.platform.platform_backend.PlatformBackend
+
__builtin__.object
+
+
+Methods defined here:
+
GetChildPids(self, pid)
Retunds a list of child pids of |pid|.
+ +
GetCommandLine(self, pid)
+ +
GetIOStats(self, pid)
+ +
GetMemoryStats(self, pid)
+ +
GetOSName(self)
+ +
GetOSVersionName(self)
+ +
GetRawDisplayFrameRateMeasurements(self)
+ +
GetSystemCommitCharge(self)
+ +
HasBeenThermallyThrottled(self)
+ +
IsThermallyThrottled(self)
+ +
StartRawDisplayFrameRateMeasurement(self)
# pylint: disable=W0613
+ +
StopRawDisplayFrameRateMeasurement(self)
+ +
+Methods inherited from telemetry.core.platform.platform_backend.PlatformBackend:
+
CanMonitorThermalThrottling(self)
+ +
IsRawDisplayFrameRateSupported(self)
+ +
SetFullPerformanceModeEnabled(self, enabled)
+ +
+Data descriptors inherited from telemetry.core.platform.platform_backend.PlatformBackend:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+Data
       pywintypes = None
+win32api = None
+win32con = None
+win32process = None
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.possible_browser.html b/tools/telemetry/docs/telemetry.core.possible_browser.html new file mode 100644 index 0000000..8a3ed8bd --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.possible_browser.html @@ -0,0 +1,63 @@ + + +Python: module telemetry.core.possible_browser + + + + +
 
+ 
telemetry.core.possible_browser		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/possible_browser.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
PossibleBrowser +
+
+
+

+ + + + + + + +
 
+class PossibleBrowser(__builtin__.object)
   A browser that can be controlled.
+ 
+Call Create() to launch the browser and begin manipulating it..
 
 Methods defined here:
+
Create(self)
+ +
SupportsOptions(self, options)
Tests for extension support.
+ +
__init__(self, browser_type, options)
+ +
__repr__(self)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
browser_type
+
+
options
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.profile_creator.html b/tools/telemetry/docs/telemetry.core.profile_creator.html new file mode 100644 index 0000000..35386fc --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.profile_creator.html @@ -0,0 +1,53 @@ + + +Python: module telemetry.core.profile_creator + + + + +
 
+ 
telemetry.core.profile_creator		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/profile_creator.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
ProfileCreator +
+
+
+

+ + + + + + + +
 
+class ProfileCreator(__builtin__.object)
   Base class for an object that constructs a Chrome profile.
 
 Methods defined here:
+
CreateProfile(self)
Fill in the profile in question.
+ +
__init__(self, browser)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.profile_types.html b/tools/telemetry/docs/telemetry.core.profile_types.html new file mode 100644 index 0000000..fedff7b --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.profile_types.html @@ -0,0 +1,51 @@ + + +Python: module telemetry.core.profile_types + + + + +
 
+ 
telemetry.core.profile_types		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/profile_types.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.discover
+		os
+		telemetry.core.profile_creator
+

+ + + + + +
 
+Functions
       
ClearProfieCreatorsForTests()
Clears the discovered profile creator objects.  Used for unit tests.
+
FindProfileCreators(profile_creators_dir)
Discover all the ProfileCreator objects in |profile_creators_dir|.
+
GetProfileCreator(profile_type)
Returns the profile creator object corresponding to the |profile_type|
+string.
+
GetProfileDir(profile_type)
Given a |profile_type| (as returned by GetProfileTypes()), return the
+directory to use for that profile or None if the profile needs to be generated
+or doesn't need a profile directory (e.g. using the browser default profile).
+
GetProfileTypes()
Returns a list of all command line options that can be specified for
+profile type.
+

+ + + + + +
 
+Data
       BASE_PROFILE_TYPES = ['clean', 'default']
+PROFILE_CREATORS = {}
+PROFILE_TYPE_MAPPING = {'power_user': 'chrome/test/data/extensions/profiles/extension_webrequest', 'typical_user': 'chrome/test/data/extensions/profiles/content_scripts1'}
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.tab.html b/tools/telemetry/docs/telemetry.core.tab.html new file mode 100644 index 0000000..1fba4ac --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.tab.html @@ -0,0 +1,166 @@ + + +Python: module telemetry.core.tab + + + + +
 
+ 
telemetry.core.tab		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/tab.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.web_contents
+

+ + + + + +
 
+Classes
       
+
telemetry.core.web_contents.WebContents(__builtin__.object) +
+
+
Tab +
+
+
+

+ + + + + + + +
 
+class Tab(telemetry.core.web_contents.WebContents)
   Represents a tab in the browser
+ 
+The important parts of the Tab object are in the runtime and page objects.
+E.g.:
+    # Navigates the tab to a given url.
+    tab.Navigate('http://www.google.com/')
+ 
+    # Evaluates 1+1 in the tab's JavaScript context.
+    tab.Evaluate('1+1')
 
 
Method resolution order:
+
Tab
+
telemetry.core.web_contents.WebContents
+
__builtin__.object
+
+
+Methods defined here:
+
Activate(self)
Brings this tab to the foreground asynchronously.
+ 
+Not all browsers or browser versions support this method.
+Be sure to check browser.supports_tab_control.
+ 
+Please note: this is asynchronous. There is a delay between this call
+and the page's documentVisibilityState becoming 'visible', and yet more
+delay until the actual tab is visible to the user. None of these delays
+are included in this call.
+ +
CollectGarbage(self)
+ +
GetCookieByName(self, name, timeout=60)
Returns the value of the cookie by the given |name|.
+ +
Navigate(self, url, script_to_evaluate_on_commit=None, timeout=60)
Navigates to url.
+ 
+If |script_to_evaluate_on_commit| is given, the script source string will be
+evaluated when the navigation is committed. This is after the context of
+the page exists, but before any script on the page itself has executed.
+ +
PerformActionAndWaitForNavigate(self, action_function, timeout=60)
Executes action_function, and waits for the navigation to complete.
+ 
+action_function must be a Python function that results in a navigation.
+This function returns when the navigation is complete or when
+the timeout has been exceeded.
+ +
Screenshot(self, timeout=60)
Capture a screenshot of the window for rendering validation
+ +
__del__(self)
+ +
__init__(self, inspector_backend)
+ +
+Data descriptors defined here:
+
browser
+
The browser in which this tab resides.
+
+
dom_stats
+
A dictionary populated with measured DOM statistics.
+ 
+Currently this dictionary contains:
+{
+  'document_count': integer,
+  'node_count': integer,
+  'event_listener_count': integer
+}
+
+
screenshot_supported
+
True if the browser instance is capable of capturing screenshots
+
+
url
+
+
+Methods inherited from telemetry.core.web_contents.WebContents:
+
Close(self)
Closes this page.
+ 
+Not all browsers or browser versions support this method.
+Be sure to check browser.supports_tab_control.
+ +
Disconnect(self)
+ +
EvaluateJavaScript(self, expr, timeout=60)
Evalutes expr in JavaScript and returns the JSONized result.
+ 
+Consider using ExecuteJavaScript for cases where the result of the
+expression is not needed.
+ 
+If evaluation throws in JavaScript, a Python EvaluateException will
+be raised.
+ 
+If the result of the evaluation cannot be JSONized, then an
+EvaluationException will be raised.
+ +
ExecuteJavaScript(self, expr, timeout=60)
Executes expr in JavaScript. Does not return the result.
+ 
+If the expression failed to evaluate, EvaluateException will be raised.
+ +
StartTimelineRecording(self)
+ +
StopTimelineRecording(self)
+ +
WaitForDocumentReadyStateToBeComplete(self, timeout=60)
+ +
WaitForDocumentReadyStateToBeInteractiveOrBetter(self, timeout=60)
+ +
+Data descriptors inherited from telemetry.core.web_contents.WebContents:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
message_output_stream
+
+
timeline_model
+
+

+ + + + + +
 
+Data
       DEFAULT_TAB_TIMEOUT = 60
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.tab_list.html b/tools/telemetry/docs/telemetry.core.tab_list.html new file mode 100644 index 0000000..91bffab --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.tab_list.html @@ -0,0 +1,61 @@ + + +Python: module telemetry.core.tab_list + + + + +
 
+ 
telemetry.core.tab_list		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/tab_list.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
TabList +
+
+
+

+ + + + + + + +
 
+class TabList(__builtin__.object)
   # Copyright (c) 2012 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.
 
 Methods defined here:
+
New(self, timeout=None)
+ +
__getitem__(self, index)
+ +
__init__(self, tab_list_backend)
+ +
__iter__(self)
+ +
__len__(self)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.temporary_http_server.html b/tools/telemetry/docs/telemetry.core.temporary_http_server.html new file mode 100644 index 0000000..01e0aec --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.temporary_http_server.html @@ -0,0 +1,76 @@ + + +Python: module telemetry.core.temporary_http_server + + + + +
 
+ 
telemetry.core.temporary_http_server		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/temporary_http_server.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
os
+socket
+		subprocess
+sys
+		urlparse
+telemetry.core.util
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
TemporaryHTTPServer +
+
+
+

+ + + + + +
 
+class TemporaryHTTPServer(__builtin__.object)
    Methods defined here:
+
Close(self)
+ +
UrlOf(self, path)
+ +
__del__(self)
+ +
__enter__(self)
+ +
__exit__(self, *args)
+ +
__init__(self, browser_backend, paths)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
paths
+
+
url
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.timeline.event.html b/tools/telemetry/docs/telemetry.core.timeline.event.html new file mode 100644 index 0000000..9bd02cf --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.timeline.event.html @@ -0,0 +1,60 @@ + + +Python: module telemetry.core.timeline.event + + + + +
 
+ 
telemetry.core.timeline.event		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/timeline/event.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
TimelineEvent +
+
+
+

+ + + + + + + +
 
+class TimelineEvent(__builtin__.object)
   Represents a timeline event.
 
 Methods defined here:
+
GetAllChildrenRecursive(self, include_self=False)
+ +
__init__(self, name, start, duration, args=None)
+ +
__repr__(self)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
end
+
+
self_time
+
Time spent in this function less any time spent in child events.
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.timeline.html b/tools/telemetry/docs/telemetry.core.timeline.html new file mode 100644 index 0000000..dfa2405 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.timeline.html @@ -0,0 +1,29 @@ + + +Python: package telemetry.core.timeline + + + + +
 
+ 
telemetry.core.timeline		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/timeline/__init__.py
+

+

+ + + + + +
 
+Package Contents
       
event
+event_unittest
+		importer
+inspector_importer
+		inspector_importer_unittest
+model
+		model_unittest
+trace_event_importer
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.timeline.importer.html b/tools/telemetry/docs/telemetry.core.timeline.importer.html new file mode 100644 index 0000000..24bb405 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.timeline.importer.html @@ -0,0 +1,61 @@ + + +Python: module telemetry.core.timeline.importer + + + + +
 
+ 
telemetry.core.timeline.importer		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/timeline/importer.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
TimelineImporter +
+
+
+

+ + + + + + + +
 
+class TimelineImporter(__builtin__.object)
   Interface for classes that can add events to
+a timeline model from raw event data.
 
 Methods defined here:
+
FinalizeImport(self)
Called after all other importers for the model are run.
+ +
ImportEvents(self)
Processes the event data and creates and adds
+new timeline events to the model
+ +
__init__(self, model, event_data, import_priority=0)
+ +
+Static methods defined here:
+
CanImport(event_data)
Returns true if the importer can process the given event data.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.timeline.inspector_importer.html b/tools/telemetry/docs/telemetry.core.timeline.inspector_importer.html new file mode 100644 index 0000000..52f4b51 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.timeline.inspector_importer.html @@ -0,0 +1,74 @@ + + +Python: module telemetry.core.timeline.inspector_importer + + + + +
 
+ 
telemetry.core.timeline.inspector_importer		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/timeline/inspector_importer.py
+

Imports event data obtained from the inspector's timeline.

+

+ + + + + +
 
+Modules
       
telemetry.core.timeline.importer
+		telemetry.core.timeline.event
+

+ + + + + +
 
+Classes
       
+
telemetry.core.timeline.importer.TimelineImporter(__builtin__.object) +
+
+
InspectorTimelineImporter +
+
+
+

+ + + + + +
 
+class InspectorTimelineImporter(telemetry.core.timeline.importer.TimelineImporter)
    
Method resolution order:
+
InspectorTimelineImporter
+
telemetry.core.timeline.importer.TimelineImporter
+
__builtin__.object
+
+
+Methods defined here:
+
FinalizeImport(self)
+ +
ImportEvents(self)
+ +
__init__(self, model, event_data)
+ +
+Static methods defined here:
+
CanImport(event_data)
Checks if event_data is from the inspector timeline. We assume
+that if the first event is a valid inspector event, we can import the
+entire list.
+ +
RawEventToTimelineEvent(raw_inspector_event)
Converts raw_inspector_event to TimelineEvent.
+ +
+Data descriptors inherited from telemetry.core.timeline.importer.TimelineImporter:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.timeline.model.html b/tools/telemetry/docs/telemetry.core.timeline.model.html new file mode 100644 index 0000000..22e80ce --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.timeline.model.html @@ -0,0 +1,68 @@ + + +Python: module telemetry.core.timeline.model + + + + +
 
+ 
telemetry.core.timeline.model		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/timeline/model.py
+

A container for timeline-based events and traces and can handle importing
+raw event data from different sources. This model closely resembles that in the
+trace_viewer project:
+https://code.google.com/p/trace-viewer/

+

+ + + + + +
 
+Modules
       
telemetry.core.timeline.inspector_importer
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
TimelineModel +
+
+
+

+ + + + + +
 
+class TimelineModel(__builtin__.object)
    Methods defined here:
+
AddEvent(self, event)
+ +
DidFinishRecording(self)
+ +
GetAllEvents(self)
+ +
GetAllOfName(self, name)
+ +
ImportTraces(self, traces)
+ +
__init__(self)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.timeline.trace_event_importer.html b/tools/telemetry/docs/telemetry.core.timeline.trace_event_importer.html new file mode 100644 index 0000000..dcf8dfd --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.timeline.trace_event_importer.html @@ -0,0 +1,33 @@ + + +Python: module telemetry.core.timeline.trace_event_importer + + + + +
 
+ 
telemetry.core.timeline.trace_event_importer		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/timeline/trace_event_importer.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
json
+		telemetry.core.timeline.model
+

+ + + + + +
 
+Functions
       
Import(data)
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.user_agent.html b/tools/telemetry/docs/telemetry.core.user_agent.html new file mode 100644 index 0000000..eb69745 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.user_agent.html @@ -0,0 +1,33 @@ + + +Python: module telemetry.core.user_agent + + + + +
 
+ 
telemetry.core.user_agent		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/user_agent.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Functions
       
GetChromeUserAgentArgumentFromType(user_agent_type)
Returns a chrome user agent based on a user agent type.
+This is derived from:
+https://developers.google.com/chrome/mobile/docs/user-agent
+

+ + + + + +
 
+Data
       UA_TYPE_MAPPING = {'desktop': 'Mozilla/5.0 (Macintosh; Intel Mac OS X 10_7_3) A...TML, like Gecko) Chrome/25.0.1364.2 Safari/537.22', 'mobile': 'Mozilla/5.0 (Linux; Android 4.0.4; Galaxy Nexus ... Gecko) Chrome/18.0.1025.133 Mobile Safari/535.19', 'tablet': 'Mozilla/5.0 (Linux; Android 4.0.4; Galaxy Nexus ...L, like Gecko) Chrome/18.0.1025.133 Safari/535.19'}
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.util.html b/tools/telemetry/docs/telemetry.core.util.html new file mode 100644 index 0000000..a2537ce --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.util.html @@ -0,0 +1,138 @@ + + +Python: module telemetry.core.util + + + + +
 
+ 
telemetry.core.util		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/util.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
inspect
+		os
+		socket
+		time
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
PortPair +
+
+
exceptions.Exception(exceptions.BaseException) +
+
+
TimeoutException +
+
+
+

+ + + + + +
 
+class PortPair(__builtin__.object)
    Methods defined here:
+
__init__(self, local_port, remote_port)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+class TimeoutException(exceptions.Exception)
    
Method resolution order:
+
TimeoutException
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + +
 
+Functions
       
CloseConnections(tab)
Closes all TCP sockets held open by the browser.
+
FindElementAndPerformAction(tab, text, callback_code)
JavaScript snippet for finding an element with a given text on a page.
+
GetAvailableLocalPort()
+
GetChromiumSrcDir()
+
GetTelemetryDir()
+
GetUnittestDataDir()
+
WaitFor(condition, timeout, poll_interval=0.1, pass_time_left_to_func=False)
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.web_contents.html b/tools/telemetry/docs/telemetry.core.web_contents.html new file mode 100644 index 0000000..7bd421a --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.web_contents.html @@ -0,0 +1,94 @@ + + +Python: module telemetry.core.web_contents + + + + +
 
+ 
telemetry.core.web_contents		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/web_contents.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
WebContents +
+
+
+

+ + + + + + + +
 
+class WebContents(__builtin__.object)
   Represents web contents in the browser
 
 Methods defined here:
+
Close(self)
Closes this page.
+ 
+Not all browsers or browser versions support this method.
+Be sure to check browser.supports_tab_control.
+ +
Disconnect(self)
+ +
EvaluateJavaScript(self, expr, timeout=60)
Evalutes expr in JavaScript and returns the JSONized result.
+ 
+Consider using ExecuteJavaScript for cases where the result of the
+expression is not needed.
+ 
+If evaluation throws in JavaScript, a Python EvaluateException will
+be raised.
+ 
+If the result of the evaluation cannot be JSONized, then an
+EvaluationException will be raised.
+ +
ExecuteJavaScript(self, expr, timeout=60)
Executes expr in JavaScript. Does not return the result.
+ 
+If the expression failed to evaluate, EvaluateException will be raised.
+ +
StartTimelineRecording(self)
+ +
StopTimelineRecording(self)
+ +
WaitForDocumentReadyStateToBeComplete(self, timeout=60)
+ +
WaitForDocumentReadyStateToBeInteractiveOrBetter(self, timeout=60)
+ +
__del__(self)
+ +
__init__(self, inspector_backend)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
message_output_stream
+
+
timeline_model
+
+

+ + + + + +
 
+Data
       DEFAULT_WEB_CONTENTS_TIMEOUT = 60
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.wpr_modes.html b/tools/telemetry/docs/telemetry.core.wpr_modes.html new file mode 100644 index 0000000..dac4835 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.wpr_modes.html @@ -0,0 +1,25 @@ + + +Python: module telemetry.core.wpr_modes + + + + +
 
+ 
telemetry.core.wpr_modes		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/wpr_modes.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Data
       WPR_OFF = 'wpr-off'
+WPR_RECORD = 'wpr-record'
+WPR_REPLAY = 'wpr-replay'
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.core.wpr_server.html b/tools/telemetry/docs/telemetry.core.wpr_server.html new file mode 100644 index 0000000..7677b22 --- /dev/null +++ b/tools/telemetry/docs/telemetry.core.wpr_server.html @@ -0,0 +1,74 @@ + + +Python: module telemetry.core.wpr_server + + + + +
 
+ 
telemetry.core.wpr_server		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/wpr_server.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
os
+		sys
+		telemetry.core.util
+		webpagereplay
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
ReplayServer +
+
+
+

+ + + + + +
 
+class ReplayServer(__builtin__.object)
    Methods defined here:
+
Close(self)
+ +
__enter__(self)
+ +
__exit__(self, *args)
+ +
__init__(self, browser_backend, path, is_record_mode, is_append_mode, webpagereplay_host, webpagereplay_local_http_port, webpagereplay_local_https_port, webpagereplay_remote_http_port, webpagereplay_remote_https_port)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+Functions
       
GetChromeFlags(replay_host, http_port, https_port)
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.html b/tools/telemetry/docs/telemetry.html new file mode 100644 index 0000000..5f3b8f0 --- /dev/null +++ b/tools/telemetry/docs/telemetry.html @@ -0,0 +1,481 @@ + + +Python: package telemetry + + + + +
 
+ 
telemetry		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/__init__.py
+

A library for cross-platform browser tests.

+

+ + + + + +
 
+Package Contents
       
core (package)
+		page (package)
+		unittest (package)
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
telemetry.core.browser.Browser +
+
+
optparse.Values +
+
+
telemetry.core.browser_options.BrowserOptions +
+
+
telemetry.core.web_contents.WebContents(__builtin__.object) +
+
+
telemetry.core.tab.Tab +
+
+
telemetry.page.page_test.PageTest(__builtin__.object) +
+
+
telemetry.page.page_measurement.PageMeasurement +
+
+
+

+ + + + + + + +
 
+class Browser(__builtin__.object)
   A running browser instance that can be controlled in a limited way.
+ 
+To create a browser instance, use browser_finder.FindBrowser.
+ 
+Be sure to clean up after yourself by calling Close() when you are done with
+the browser. Or better yet:
+  browser_to_create = FindBrowser(options)
+  with browser_to_create.Create() as browser:
+    ... do all your operations on browser here
 
 Methods defined here:
+
Close(self)
Closes this browser.
+ +
GetStandardOutput(self)
+ +
GetTraceResultAndReset(self)
Returns the result of the trace, as TraceResult object.
+ +
SetHTTPServerDirectories(self, paths)
Returns True if the HTTP server was started, False otherwise.
+ +
SetReplayArchivePath(self, archive_path, append_to_existing_wpr=False)
+ +
StartProfiling(self, options, base_output_file)
Starts profiling using |options|.profiler_tool. Results are saved to
+|base_output_file|.<process_name>.
+ +
StartTracing(self, custom_categories=None)
+ +
StopProfiling(self)
Stops all active profilers and saves their results.
+ +
StopTracing(self)
+ +
__enter__(self)
+ +
__exit__(self, *args)
+ +
__init__(self, backend, platform_backend)
+ +
is_profiler_active(self, profiler_name)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
browser_type
+
+
extensions
+
Returns the extension dictionary if it exists.
+
+
http_server
+
+
io_stats
+
Returns a dict of IO statistics for the browser:
+{ 'Browser': {
+    'ReadOperationCount': W,
+    'WriteOperationCount': X,
+    'ReadTransferCount': Y,
+    'WriteTransferCount': Z
+  },
+  'Gpu': {
+    'ReadOperationCount': W,
+    'WriteOperationCount': X,
+    'ReadTransferCount': Y,
+    'WriteTransferCount': Z
+  },
+  'Renderer': {
+    'ReadOperationCount': W,
+    'WriteOperationCount': X,
+    'ReadTransferCount': Y,
+    'WriteTransferCount': Z
+  }
+}
+
+
is_content_shell
+
Returns whether this browser is a content shell, only.
+
+
memory_stats
+
Returns a dict of memory statistics for the browser:
+{ 'Browser': {
+    'VM': S,
+    'VMPeak': T,
+    'WorkingSetSize': U,
+    'WorkingSetSizePeak': V,
+    'ProportionalSetSize': W,
+    'PrivateDirty': X
+  },
+  'Gpu': {
+    'VM': S,
+    'VMPeak': T,
+    'WorkingSetSize': U,
+    'WorkingSetSizePeak': V,
+    'ProportionalSetSize': W,
+    'PrivateDirty': X
+  },
+  'Renderer': {
+    'VM': S,
+    'VMPeak': T,
+    'WorkingSetSize': U,
+    'WorkingSetSizePeak': V,
+    'ProportionalSetSize': W,
+    'PrivateDirty': X
+  },
+  'SystemCommitCharge': Y,
+  'ProcessCount': Z,
+}
+Any of the above keys may be missing on a per-platform basis.
+
+
platform
+
+
supports_extensions
+
+
supports_tab_control
+
+
supports_tracing
+
+
tabs
+
+

+ + + + + + + +
 
+class BrowserOptions(optparse.Values)
   Options to be used for discovering and launching a browser.
 
 Methods defined here:
+
AppendExtraBrowserArg(self, arg)
+ +
Copy(self)
+ +
CreateParser(self, *args, **kwargs)
+ +
__init__(self, browser_type=None)
+ +
+Methods inherited from optparse.Values:
+
__cmp__(self, other)
+ +
__repr__ = _repr(self)
+ +
__str__(self)
+ +
ensure_value(self, attr, value)
+ +
read_file(self, filename, mode='careful')
+ +
read_module(self, modname, mode='careful')
+ +

+ + + + + + + +
 
+class PageMeasurement(telemetry.page.page_test.PageTest)
   Glue code for running a measurement across a set of pages.
+ 
+To use this, subclass from the measurement and override MeasurePage. For
+example:
+ 
+   class BodyChildElementMeasurement(PageMeasurement):
+      def MeasurePage(self, page, tab, results):
+         body_child_count = tab.EvaluateJavaScript(
+             'document.body.children.length')
+         results.Add('body_children', 'count', body_child_count)
+ 
+   if __name__ == '__main__':
+       page_measurement.Main(BodyChildElementMeasurement())
+ 
+To add test-specific options:
+ 
+   class BodyChildElementMeasurement(PageMeasurement):
+      def AddCommandLineOptions(parser):
+         parser.add_option('--element', action='store', default='body')
+ 
+      def MeasurePage(self, page, tab, results):
+         body_child_count = tab.EvaluateJavaScript(
+            'document.querySelector('%s').children.length')
+         results.Add('children', 'count', child_count)
 
 
Method resolution order:
+
PageMeasurement
+
telemetry.page.page_test.PageTest
+
__builtin__.object
+
+
+Methods defined here:
+
AddOutputOptions(self, parser)
+ +
MeasurePage(self, page, tab, results)
Override to actually measure the page's performance.
+ 
+page is a page_set.Page
+tab is an instance of telemetry.core.Tab
+ 
+Should call results.Add(name, units, value) for each result, or raise an
+exception on failure. The name and units of each Add() call must be
+the same across all iterations. The name 'url' must not be used.
+ 
+Prefer field names that are in accordance with python variable style. E.g.
+field_name.
+ 
+Put together:
+ 
+   def MeasurePage(self, page, tab, results):
+     res = tab.EvaluateJavaScript('2+2')
+     if res != 4:
+       raise Exception('Oh, wow.')
+     results.Add('two_plus_two', 'count', res)
+ +
PrepareResults(self, options)
+ +
__init__(self, action_name_to_run='', needs_browser_restart_after_each_run=False, discard_first_result=False)
+ +
+Data descriptors defined here:
+
output_format_choices
+
+
results_are_the_same_on_every_page
+
By default, measurements are assumed to output the same values for every
+page. This allows incremental output, for example in CSV. If, however, the
+measurement discovers what values it can report as it goes, and those values
+may vary from page to page, you need to override this function and return
+False. Output will not appear in this mode until the entire pageset has
+run.
+
+
+Methods inherited from telemetry.page.page_test.PageTest:
+
AddCommandLineOptions(self, parser)
Override to expose command-line options for this test.
+ 
+The provided parser is an optparse.OptionParser instance and accepts all
+normal results. The parsed options are available in Run as
+self.options.
+ +
CanRunForPage(self, page)
Override to customize if the test can be ran for the given page.
+ +
CreatePageSet(self, args, options)
Override to make this test generate its own page set instead of
+allowing arbitrary page sets entered from the command-line.
+ +
CustomizeBrowserOptions(self, options)
Override to add test-specific options to the BrowserOptions object
+ +
CustomizeBrowserOptionsForPage(self, page, options)
Add options specific to the test and the given page.
+ +
DidNavigateToPage(self, page, tab)
Override to do operations right after the page is navigated, but before
+any waiting for completion has occurred.
+ +
DidRunAction(self, page, tab, action)
Override to do operations after running the action on the page.
+ +
DidRunPageSet(self, tab, results)
Override to do operations after page set is completed, but before browser
+is torn down.
+ +
DidStartHTTPServer(self, tab)
Override to do operations after the HTTP server is started.
+ +
NeedsBrowserRestartAfterEachRun(self, tab)
Override to specify browser restart after each run.
+ +
Run(self, options, page, tab, results)
+ +
SetUpBrowser(self, browser)
Override to customize the browser right after it has launched.
+ +
WillNavigateToPage(self, page, tab)
Override to do operations before the page is navigated.
+ +
WillRunAction(self, page, tab, action)
Override to do operations before running the action on the page.
+ +
WillRunPageSet(self, tab)
Override to do operations before the page set is navigated.
+ +
+Data descriptors inherited from telemetry.page.page_test.PageTest:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
action_name_to_run
+
+
discard_first_result
+
When set to True, the first run of the test is discarded.  This is
+useful for cases where it's desirable to have some test resource cached so
+the first run of the test can warm things up.
+
+

+ + + + + + + +
 
+class Tab(telemetry.core.web_contents.WebContents)
   Represents a tab in the browser
+ 
+The important parts of the Tab object are in the runtime and page objects.
+E.g.:
+    # Navigates the tab to a given url.
+    tab.Navigate('http://www.google.com/')
+ 
+    # Evaluates 1+1 in the tab's JavaScript context.
+    tab.Evaluate('1+1')
 
 
Method resolution order:
+
Tab
+
telemetry.core.web_contents.WebContents
+
__builtin__.object
+
+
+Methods defined here:
+
Activate(self)
Brings this tab to the foreground asynchronously.
+ 
+Not all browsers or browser versions support this method.
+Be sure to check browser.supports_tab_control.
+ 
+Please note: this is asynchronous. There is a delay between this call
+and the page's documentVisibilityState becoming 'visible', and yet more
+delay until the actual tab is visible to the user. None of these delays
+are included in this call.
+ +
CollectGarbage(self)
+ +
GetCookieByName(self, name, timeout=60)
Returns the value of the cookie by the given |name|.
+ +
Navigate(self, url, script_to_evaluate_on_commit=None, timeout=60)
Navigates to url.
+ 
+If |script_to_evaluate_on_commit| is given, the script source string will be
+evaluated when the navigation is committed. This is after the context of
+the page exists, but before any script on the page itself has executed.
+ +
PerformActionAndWaitForNavigate(self, action_function, timeout=60)
Executes action_function, and waits for the navigation to complete.
+ 
+action_function must be a Python function that results in a navigation.
+This function returns when the navigation is complete or when
+the timeout has been exceeded.
+ +
Screenshot(self, timeout=60)
Capture a screenshot of the window for rendering validation
+ +
__del__(self)
+ +
__init__(self, inspector_backend)
+ +
+Data descriptors defined here:
+
browser
+
The browser in which this tab resides.
+
+
dom_stats
+
A dictionary populated with measured DOM statistics.
+ 
+Currently this dictionary contains:
+{
+  'document_count': integer,
+  'node_count': integer,
+  'event_listener_count': integer
+}
+
+
screenshot_supported
+
True if the browser instance is capable of capturing screenshots
+
+
url
+
+
+Methods inherited from telemetry.core.web_contents.WebContents:
+
Close(self)
Closes this page.
+ 
+Not all browsers or browser versions support this method.
+Be sure to check browser.supports_tab_control.
+ +
Disconnect(self)
+ +
EvaluateJavaScript(self, expr, timeout=60)
Evalutes expr in JavaScript and returns the JSONized result.
+ 
+Consider using ExecuteJavaScript for cases where the result of the
+expression is not needed.
+ 
+If evaluation throws in JavaScript, a Python EvaluateException will
+be raised.
+ 
+If the result of the evaluation cannot be JSONized, then an
+EvaluationException will be raised.
+ +
ExecuteJavaScript(self, expr, timeout=60)
Executes expr in JavaScript. Does not return the result.
+ 
+If the expression failed to evaluate, EvaluateException will be raised.
+ +
StartTimelineRecording(self)
+ +
StopTimelineRecording(self)
+ +
WaitForDocumentReadyStateToBeComplete(self, timeout=60)
+ +
WaitForDocumentReadyStateToBeInteractiveOrBetter(self, timeout=60)
+ +
+Data descriptors inherited from telemetry.core.web_contents.WebContents:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
message_output_stream
+
+
timeline_model
+
+

+ + + + + +
 
+Functions
       
RunPage = Run(test, page_set, options)
Runs a given test against a given page_set with the given options.
+

+ + + + + +
 
+Data
       __all__ = ['Browser', 'BrowserOptions', 'PageMeasurement', 'RunPage', 'Tab']
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.actions.all_page_actions.html b/tools/telemetry/docs/telemetry.page.actions.all_page_actions.html new file mode 100644 index 0000000..2c94152 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.actions.all_page_actions.html @@ -0,0 +1,36 @@ + + +Python: module telemetry.page.actions.all_page_actions + + + + +
 
+ 
telemetry.page.actions.all_page_actions		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/all_page_actions.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.discover
+		os
+		telemetry.page.actions.page_action
+

+ + + + + +
 
+Functions
       
FindClassWithName(name)
+
GetAllClasses()
+
RegisterClassForTest(name, clazz)
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.actions.click_element.html b/tools/telemetry/docs/telemetry.page.actions.click_element.html new file mode 100644 index 0000000..b6b227c --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.actions.click_element.html @@ -0,0 +1,99 @@ + + +Python: module telemetry.page.actions.click_element + + + + +
 
+ 
telemetry.page.actions.click_element		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/click_element.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.exceptions
+		telemetry.page.actions.page_action
+		telemetry.page.page
+		telemetry.core.util
+

+ + + + + +
 
+Classes
       
+
telemetry.page.actions.page_action.PageAction(__builtin__.object) +
+
+
ClickElementAction +
+
+
+

+ + + + + +
 
+class ClickElementAction(telemetry.page.actions.page_action.PageAction)
    
Method resolution order:
+
ClickElementAction
+
telemetry.page.actions.page_action.PageAction
+
__builtin__.object
+
+
+Methods defined here:
+
RunAction(self, page, tab, previous_action)
+ +
__init__(self, attributes=None)
+ +
+Methods inherited from telemetry.page.actions.page_action.PageAction:
+
BindMeasurementJavaScript(self, tab, start_js, stop_js)
Let this action determine when measurements should start and stop.
+ 
+A measurement can call this method to provide the action
+with JavaScript code that starts and stops measurements. The action
+determines when to execute the provided JavaScript code, for more accurate
+timings.
+ 
+Args:
+  tab: The tab to do everything on.
+  start_js: JavaScript code that starts measurements.
+  stop_js: JavaScript code that stops measurements.
+ +
CanBeBound(self)
If this class implements BindMeasurementJavaScript, override CanBeBound
+to return True so that a test knows it can bind measurements.
+ +
CleanUp(self, page, tab)
+ +
CustomizeBrowserOptions(self, options)
Override to add action-specific options to the BrowserOptions
+object.
+ +
RunsPreviousAction(self)
Some actions require some initialization to be performed before the
+previous action. For example, wait for href change needs to record the old
+href before the previous action changes it. Therefore, we allow actions to
+run the previous action. An action that does this should override this to
+return True in order to prevent the previous action from being run twice.
+ +
WillRunAction(self, page, tab)
Override to do action-specific setup before
+Test.WillRunAction is called.
+ +
+Data descriptors inherited from telemetry.page.actions.page_action.PageAction:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.actions.html b/tools/telemetry/docs/telemetry.page.actions.html new file mode 100644 index 0000000..838387b --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.actions.html @@ -0,0 +1,31 @@ + + +Python: package telemetry.page.actions + + + + +
 
+ 
telemetry.page.actions		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/__init__.py
+

+

+ + + + + +
 
+Package Contents
       
all_page_actions
+click_element
+click_element_unittest
+		js_collect_garbage
+page_action
+reload
+		scroll
+scroll_unittest
+wait
+		wait_unittest
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.actions.js_collect_garbage.html b/tools/telemetry/docs/telemetry.page.actions.js_collect_garbage.html new file mode 100644 index 0000000..774a784 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.actions.js_collect_garbage.html @@ -0,0 +1,96 @@ + + +Python: module telemetry.page.actions.js_collect_garbage + + + + +
 
+ 
telemetry.page.actions.js_collect_garbage		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/js_collect_garbage.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
telemetry.page.actions.page_action
+

+ + + + + +
 
+Classes
       
+
telemetry.page.actions.page_action.PageAction(__builtin__.object) +
+
+
JsCollectGarbageAction +
+
+
+

+ + + + + +
 
+class JsCollectGarbageAction(telemetry.page.actions.page_action.PageAction)
    
Method resolution order:
+
JsCollectGarbageAction
+
telemetry.page.actions.page_action.PageAction
+
__builtin__.object
+
+
+Methods defined here:
+
RunAction(self, page, tab, previous_action)
+ +
__init__(self, attributes=None)
+ +
+Methods inherited from telemetry.page.actions.page_action.PageAction:
+
BindMeasurementJavaScript(self, tab, start_js, stop_js)
Let this action determine when measurements should start and stop.
+ 
+A measurement can call this method to provide the action
+with JavaScript code that starts and stops measurements. The action
+determines when to execute the provided JavaScript code, for more accurate
+timings.
+ 
+Args:
+  tab: The tab to do everything on.
+  start_js: JavaScript code that starts measurements.
+  stop_js: JavaScript code that stops measurements.
+ +
CanBeBound(self)
If this class implements BindMeasurementJavaScript, override CanBeBound
+to return True so that a test knows it can bind measurements.
+ +
CleanUp(self, page, tab)
+ +
CustomizeBrowserOptions(self, options)
Override to add action-specific options to the BrowserOptions
+object.
+ +
RunsPreviousAction(self)
Some actions require some initialization to be performed before the
+previous action. For example, wait for href change needs to record the old
+href before the previous action changes it. Therefore, we allow actions to
+run the previous action. An action that does this should override this to
+return True in order to prevent the previous action from being run twice.
+ +
WillRunAction(self, page, tab)
Override to do action-specific setup before
+Test.WillRunAction is called.
+ +
+Data descriptors inherited from telemetry.page.actions.page_action.PageAction:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.actions.page_action.html b/tools/telemetry/docs/telemetry.page.actions.page_action.html new file mode 100644 index 0000000..4ca1b52 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.actions.page_action.html @@ -0,0 +1,205 @@ + + +Python: module telemetry.page.actions.page_action + + + + +
 
+ 
telemetry.page.actions.page_action		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/page_action.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
PageAction +
+
+
exceptions.Exception(exceptions.BaseException) +
+
+
PageActionFailed +
PageActionNotSupported +
+
+
+

+ + + + + + + +
 
+class PageAction(__builtin__.object)
   Represents an action that a user might try to perform to a page.
 
 Methods defined here:
+
BindMeasurementJavaScript(self, tab, start_js, stop_js)
Let this action determine when measurements should start and stop.
+ 
+A measurement can call this method to provide the action
+with JavaScript code that starts and stops measurements. The action
+determines when to execute the provided JavaScript code, for more accurate
+timings.
+ 
+Args:
+  tab: The tab to do everything on.
+  start_js: JavaScript code that starts measurements.
+  stop_js: JavaScript code that stops measurements.
+ +
CanBeBound(self)
If this class implements BindMeasurementJavaScript, override CanBeBound
+to return True so that a test knows it can bind measurements.
+ +
CleanUp(self, page, tab)
+ +
CustomizeBrowserOptions(self, options)
Override to add action-specific options to the BrowserOptions
+object.
+ +
RunAction(self, page, tab, previous_action)
+ +
RunsPreviousAction(self)
Some actions require some initialization to be performed before the
+previous action. For example, wait for href change needs to record the old
+href before the previous action changes it. Therefore, we allow actions to
+run the previous action. An action that does this should override this to
+return True in order to prevent the previous action from being run twice.
+ +
WillRunAction(self, page, tab)
Override to do action-specific setup before
+Test.WillRunAction is called.
+ +
__init__(self, attributes=None)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+class PageActionFailed(exceptions.Exception)
    
Method resolution order:
+
PageActionFailed
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + +
 
+class PageActionNotSupported(exceptions.Exception)
    
Method resolution order:
+
PageActionNotSupported
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.actions.reload.html b/tools/telemetry/docs/telemetry.page.actions.reload.html new file mode 100644 index 0000000..64ee4fd --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.actions.reload.html @@ -0,0 +1,97 @@ + + +Python: module telemetry.page.actions.reload + + + + +
 
+ 
telemetry.page.actions.reload		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/reload.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
telemetry.page.actions.page_action
+		telemetry.page.page
+

+ + + + + +
 
+Classes
       
+
telemetry.page.actions.page_action.PageAction(__builtin__.object) +
+
+
ReloadAction +
+
+
+

+ + + + + +
 
+class ReloadAction(telemetry.page.actions.page_action.PageAction)
    
Method resolution order:
+
ReloadAction
+
telemetry.page.actions.page_action.PageAction
+
__builtin__.object
+
+
+Methods defined here:
+
RunAction(self, page, tab, previous_action)
+ +
__init__(self, attributes=None)
+ +
+Methods inherited from telemetry.page.actions.page_action.PageAction:
+
BindMeasurementJavaScript(self, tab, start_js, stop_js)
Let this action determine when measurements should start and stop.
+ 
+A measurement can call this method to provide the action
+with JavaScript code that starts and stops measurements. The action
+determines when to execute the provided JavaScript code, for more accurate
+timings.
+ 
+Args:
+  tab: The tab to do everything on.
+  start_js: JavaScript code that starts measurements.
+  stop_js: JavaScript code that stops measurements.
+ +
CanBeBound(self)
If this class implements BindMeasurementJavaScript, override CanBeBound
+to return True so that a test knows it can bind measurements.
+ +
CleanUp(self, page, tab)
+ +
CustomizeBrowserOptions(self, options)
Override to add action-specific options to the BrowserOptions
+object.
+ +
RunsPreviousAction(self)
Some actions require some initialization to be performed before the
+previous action. For example, wait for href change needs to record the old
+href before the previous action changes it. Therefore, we allow actions to
+run the previous action. An action that does this should override this to
+return True in order to prevent the previous action from being run twice.
+ +
WillRunAction(self, page, tab)
Override to do action-specific setup before
+Test.WillRunAction is called.
+ +
+Data descriptors inherited from telemetry.page.actions.page_action.PageAction:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.actions.scroll.html b/tools/telemetry/docs/telemetry.page.actions.scroll.html new file mode 100644 index 0000000..6f24a5a --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.actions.scroll.html @@ -0,0 +1,86 @@ + + +Python: module telemetry.page.actions.scroll + + + + +
 
+ 
telemetry.page.actions.scroll		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/scroll.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
os
+		telemetry.page.actions.page_action
+		telemetry.core.util
+

+ + + + + +
 
+Classes
       
+
telemetry.page.actions.page_action.PageAction(__builtin__.object) +
+
+
ScrollAction +
+
+
+

+ + + + + +
 
+class ScrollAction(telemetry.page.actions.page_action.PageAction)
    
Method resolution order:
+
ScrollAction
+
telemetry.page.actions.page_action.PageAction
+
__builtin__.object
+
+
+Methods defined here:
+
BindMeasurementJavaScript(self, tab, start_js, stop_js)
+ +
CanBeBound(self)
+ +
RunAction(self, page, tab, previous_action)
+ +
WillRunAction(self, page, tab)
+ +
__init__(self, attributes=None)
+ +
+Methods inherited from telemetry.page.actions.page_action.PageAction:
+
CleanUp(self, page, tab)
+ +
CustomizeBrowserOptions(self, options)
Override to add action-specific options to the BrowserOptions
+object.
+ +
RunsPreviousAction(self)
Some actions require some initialization to be performed before the
+previous action. For example, wait for href change needs to record the old
+href before the previous action changes it. Therefore, we allow actions to
+run the previous action. An action that does this should override this to
+return True in order to prevent the previous action from being run twice.
+ +
+Data descriptors inherited from telemetry.page.actions.page_action.PageAction:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.actions.wait.html b/tools/telemetry/docs/telemetry.page.actions.wait.html new file mode 100644 index 0000000..1219cca --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.actions.wait.html @@ -0,0 +1,98 @@ + + +Python: module telemetry.page.actions.wait + + + + +
 
+ 
telemetry.page.actions.wait		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/actions/wait.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.page.actions.page_action
+		time
+		telemetry.core.util
+

+ + + + + +
 
+Classes
       
+
telemetry.page.actions.page_action.PageAction(__builtin__.object) +
+
+
WaitAction +
+
+
+

+ + + + + +
 
+class WaitAction(telemetry.page.actions.page_action.PageAction)
    
Method resolution order:
+
WaitAction
+
telemetry.page.actions.page_action.PageAction
+
__builtin__.object
+
+
+Methods defined here:
+
RunAction(self, page, tab, previous_action)
+ +
RunsPreviousAction(self)
+ +
__init__(self, attributes=None)
+ +
+Data and other attributes defined here:
+
DEFAULT_TIMEOUT = 60
+ +
+Methods inherited from telemetry.page.actions.page_action.PageAction:
+
BindMeasurementJavaScript(self, tab, start_js, stop_js)
Let this action determine when measurements should start and stop.
+ 
+A measurement can call this method to provide the action
+with JavaScript code that starts and stops measurements. The action
+determines when to execute the provided JavaScript code, for more accurate
+timings.
+ 
+Args:
+  tab: The tab to do everything on.
+  start_js: JavaScript code that starts measurements.
+  stop_js: JavaScript code that stops measurements.
+ +
CanBeBound(self)
If this class implements BindMeasurementJavaScript, override CanBeBound
+to return True so that a test knows it can bind measurements.
+ +
CleanUp(self, page, tab)
+ +
CustomizeBrowserOptions(self, options)
Override to add action-specific options to the BrowserOptions
+object.
+ +
WillRunAction(self, page, tab)
Override to do action-specific setup before
+Test.WillRunAction is called.
+ +
+Data descriptors inherited from telemetry.page.actions.page_action.PageAction:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.block_page_measurement_results.html b/tools/telemetry/docs/telemetry.page.block_page_measurement_results.html new file mode 100644 index 0000000..1c5fe72 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.block_page_measurement_results.html @@ -0,0 +1,144 @@ + + +Python: module telemetry.page.block_page_measurement_results + + + + +
 
+ 
telemetry.page.block_page_measurement_results		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/block_page_measurement_results.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
os
+		telemetry.page.page_measurement_results
+

+ + + + + +
 
+Classes
       
+
telemetry.page.page_measurement_results.PageMeasurementResults(telemetry.page.page_test_results.PageTestResults) +
+
+
BlockPageMeasurementResults +
+
+
+

+ + + + + +
 
+class BlockPageMeasurementResults(telemetry.page.page_measurement_results.PageMeasurementResults)
    
Method resolution order:
+
BlockPageMeasurementResults
+
telemetry.page.page_measurement_results.PageMeasurementResults
+
telemetry.page.page_test_results.PageTestResults
+
unittest.result.TestResult
+
__builtin__.object
+
+
+Methods defined here:
+
DidMeasurePage(self)
+ +
__init__(self, output_file)
+ +
+Methods inherited from telemetry.page.page_measurement_results.PageMeasurementResults:
+
Add(self, trace_name, units, value, chart_name=None, data_type='default')
+ +
AddSummary(self, trace_name, units, value, chart_name=None, data_type='default')
+ +
WillMeasurePage(self, page)
+ +
__getitem__(self, i)
Shorthand for self.page_results[i]
+ +
__len__(self)
+ +
+Data descriptors inherited from telemetry.page.page_measurement_results.PageMeasurementResults:
+
all_measurements_that_have_been_seen
+
+
page_results
+
+
values_for_current_page
+
+
+Methods inherited from telemetry.page.page_test_results.PageTestResults:
+
AddError(self, page, err)
+ +
AddErrorMessage(self, page, message)
+ +
AddFailure(self, page, err)
+ +
AddFailureMessage(self, page, message)
+ +
AddSkip(self, page, reason)
+ +
AddSuccess(self, page)
+ +
PrintSummary(self)
+ +
StartTest(self, page)
+ +
StopTest(self, page)
+ +
addSkip(self, test, reason)
+ +
addSuccess(self, test)
+ +
+Methods inherited from unittest.result.TestResult:
+
__repr__(self)
+ +
addError(self, *args, **kw)
Called when an error has occurred. 'err' is a tuple of values as
+returned by sys.exc_info().
+ +
addExpectedFailure(self, test, err)
Called when an expected failure/error occured.
+ +
addFailure(self, *args, **kw)
Called when an error has occurred. 'err' is a tuple of values as
+returned by sys.exc_info().
+ +
addUnexpectedSuccess(self, *args, **kw)
Called when a test was expected to fail, but succeed.
+ +
printErrors(self)
Called by TestRunner after test run
+ +
startTest(self, test)
Called when the given test is about to be run
+ +
startTestRun(self)
Called once before any tests are executed.
+ 
+See startTest for a method called before each test.
+ +
stop(self)
Indicates that the tests should be aborted
+ +
stopTest(self, test)
Called when the given test has been run
+ +
stopTestRun(self)
Called once after all tests are executed.
+ 
+See stopTest for a method called after each test.
+ +
wasSuccessful(self)
Tells whether or not this result was a success
+ +
+Data descriptors inherited from unittest.result.TestResult:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.buildbot_page_measurement_results.html b/tools/telemetry/docs/telemetry.page.buildbot_page_measurement_results.html new file mode 100644 index 0000000..f112805 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.buildbot_page_measurement_results.html @@ -0,0 +1,147 @@ + + +Python: module telemetry.page.buildbot_page_measurement_results + + + + +
 
+ 
telemetry.page.buildbot_page_measurement_results		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/buildbot_page_measurement_results.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
telemetry.page.page_measurement_results
+		telemetry.page.perf_tests_helper
+

+ + + + + +
 
+Classes
       
+
telemetry.page.page_measurement_results.PageMeasurementResults(telemetry.page.page_test_results.PageTestResults) +
+
+
BuildbotPageMeasurementResults +
+
+
+

+ + + + + +
 
+class BuildbotPageMeasurementResults(telemetry.page.page_measurement_results.PageMeasurementResults)
    
Method resolution order:
+
BuildbotPageMeasurementResults
+
telemetry.page.page_measurement_results.PageMeasurementResults
+
telemetry.page.page_test_results.PageTestResults
+
unittest.result.TestResult
+
__builtin__.object
+
+
+Methods defined here:
+
PrintSummary(self)
Print summary data in a format expected by buildbot for perf dashboards.
+ 
+If any failed pages exist, only output individual page results for
+non-failing pages, and do not output any average data.
+ +
__init__(self, trace_tag='')
+ +
+Methods inherited from telemetry.page.page_measurement_results.PageMeasurementResults:
+
Add(self, trace_name, units, value, chart_name=None, data_type='default')
+ +
AddSummary(self, trace_name, units, value, chart_name=None, data_type='default')
+ +
DidMeasurePage(self)
+ +
WillMeasurePage(self, page)
+ +
__getitem__(self, i)
Shorthand for self.page_results[i]
+ +
__len__(self)
+ +
+Data descriptors inherited from telemetry.page.page_measurement_results.PageMeasurementResults:
+
all_measurements_that_have_been_seen
+
+
page_results
+
+
values_for_current_page
+
+
+Methods inherited from telemetry.page.page_test_results.PageTestResults:
+
AddError(self, page, err)
+ +
AddErrorMessage(self, page, message)
+ +
AddFailure(self, page, err)
+ +
AddFailureMessage(self, page, message)
+ +
AddSkip(self, page, reason)
+ +
AddSuccess(self, page)
+ +
StartTest(self, page)
+ +
StopTest(self, page)
+ +
addSkip(self, test, reason)
+ +
addSuccess(self, test)
+ +
+Methods inherited from unittest.result.TestResult:
+
__repr__(self)
+ +
addError(self, *args, **kw)
Called when an error has occurred. 'err' is a tuple of values as
+returned by sys.exc_info().
+ +
addExpectedFailure(self, test, err)
Called when an expected failure/error occured.
+ +
addFailure(self, *args, **kw)
Called when an error has occurred. 'err' is a tuple of values as
+returned by sys.exc_info().
+ +
addUnexpectedSuccess(self, *args, **kw)
Called when a test was expected to fail, but succeed.
+ +
printErrors(self)
Called by TestRunner after test run
+ +
startTest(self, test)
Called when the given test is about to be run
+ +
startTestRun(self)
Called once before any tests are executed.
+ 
+See startTest for a method called before each test.
+ +
stop(self)
Indicates that the tests should be aborted
+ +
stopTest(self, test)
Called when the given test has been run
+ +
stopTestRun(self)
Called once after all tests are executed.
+ 
+See stopTest for a method called after each test.
+ +
wasSuccessful(self)
Tells whether or not this result was a success
+ +
+Data descriptors inherited from unittest.result.TestResult:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.csv_page_measurement_results.html b/tools/telemetry/docs/telemetry.page.csv_page_measurement_results.html new file mode 100644 index 0000000..8036083 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.csv_page_measurement_results.html @@ -0,0 +1,144 @@ + + +Python: module telemetry.page.csv_page_measurement_results + + + + +
 
+ 
telemetry.page.csv_page_measurement_results		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/csv_page_measurement_results.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
csv
+		telemetry.page.page_measurement_results
+

+ + + + + +
 
+Classes
       
+
telemetry.page.page_measurement_results.PageMeasurementResults(telemetry.page.page_test_results.PageTestResults) +
+
+
CsvPageMeasurementResults +
+
+
+

+ + + + + +
 
+class CsvPageMeasurementResults(telemetry.page.page_measurement_results.PageMeasurementResults)
    
Method resolution order:
+
CsvPageMeasurementResults
+
telemetry.page.page_measurement_results.PageMeasurementResults
+
telemetry.page.page_test_results.PageTestResults
+
unittest.result.TestResult
+
__builtin__.object
+
+
+Methods defined here:
+
DidMeasurePage(self)
+ +
PrintSummary(self)
+ +
__init__(self, output_stream, output_after_every_page, trace_tag='')
+ +
+Methods inherited from telemetry.page.page_measurement_results.PageMeasurementResults:
+
Add(self, trace_name, units, value, chart_name=None, data_type='default')
+ +
AddSummary(self, trace_name, units, value, chart_name=None, data_type='default')
+ +
WillMeasurePage(self, page)
+ +
__getitem__(self, i)
Shorthand for self.page_results[i]
+ +
__len__(self)
+ +
+Data descriptors inherited from telemetry.page.page_measurement_results.PageMeasurementResults:
+
all_measurements_that_have_been_seen
+
+
page_results
+
+
values_for_current_page
+
+
+Methods inherited from telemetry.page.page_test_results.PageTestResults:
+
AddError(self, page, err)
+ +
AddErrorMessage(self, page, message)
+ +
AddFailure(self, page, err)
+ +
AddFailureMessage(self, page, message)
+ +
AddSkip(self, page, reason)
+ +
AddSuccess(self, page)
+ +
StartTest(self, page)
+ +
StopTest(self, page)
+ +
addSkip(self, test, reason)
+ +
addSuccess(self, test)
+ +
+Methods inherited from unittest.result.TestResult:
+
__repr__(self)
+ +
addError(self, *args, **kw)
Called when an error has occurred. 'err' is a tuple of values as
+returned by sys.exc_info().
+ +
addExpectedFailure(self, test, err)
Called when an expected failure/error occured.
+ +
addFailure(self, *args, **kw)
Called when an error has occurred. 'err' is a tuple of values as
+returned by sys.exc_info().
+ +
addUnexpectedSuccess(self, *args, **kw)
Called when a test was expected to fail, but succeed.
+ +
printErrors(self)
Called by TestRunner after test run
+ +
startTest(self, test)
Called when the given test is about to be run
+ +
startTestRun(self)
Called once before any tests are executed.
+ 
+See startTest for a method called before each test.
+ +
stop(self)
Indicates that the tests should be aborted
+ +
stopTest(self, test)
Called when the given test has been run
+ +
stopTestRun(self)
Called once after all tests are executed.
+ 
+See stopTest for a method called after each test.
+ +
wasSuccessful(self)
Tells whether or not this result was a success
+ +
+Data descriptors inherited from unittest.result.TestResult:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.gtest_test_results.html b/tools/telemetry/docs/telemetry.page.gtest_test_results.html new file mode 100644 index 0000000..5e4b69ec --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.gtest_test_results.html @@ -0,0 +1,125 @@ + + +Python: module telemetry.page.gtest_test_results + + + + +
 
+ 
telemetry.page.gtest_test_results		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/gtest_test_results.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
telemetry.page.page_test_results
+		sys
+		time
+		unittest
+

+ + + + + +
 
+Classes
       
+
telemetry.page.page_test_results.PageTestResults(unittest.result.TestResult) +
+
+
GTestTestResults +
+
+
+

+ + + + + +
 
+class GTestTestResults(telemetry.page.page_test_results.PageTestResults)
    
Method resolution order:
+
GTestTestResults
+
telemetry.page.page_test_results.PageTestResults
+
unittest.result.TestResult
+
__builtin__.object
+
+
+Methods defined here:
+
PrintSummary(self)
+ +
__init__(self)
+ +
addError(self, test, err)
+ +
addFailure(self, test, err)
+ +
addSuccess(self, test)
+ +
startTest(self, test)
+ +
+Data descriptors defined here:
+
num_errors
+
+
+Methods inherited from telemetry.page.page_test_results.PageTestResults:
+
AddError(self, page, err)
+ +
AddErrorMessage(self, page, message)
+ +
AddFailure(self, page, err)
+ +
AddFailureMessage(self, page, message)
+ +
AddSkip(self, page, reason)
+ +
AddSuccess(self, page)
+ +
StartTest(self, page)
+ +
StopTest(self, page)
+ +
addSkip(self, test, reason)
+ +
+Methods inherited from unittest.result.TestResult:
+
__repr__(self)
+ +
addExpectedFailure(self, test, err)
Called when an expected failure/error occured.
+ +
addUnexpectedSuccess(self, *args, **kw)
Called when a test was expected to fail, but succeed.
+ +
printErrors(self)
Called by TestRunner after test run
+ +
startTestRun(self)
Called once before any tests are executed.
+ 
+See startTest for a method called before each test.
+ +
stop(self)
Indicates that the tests should be aborted
+ +
stopTest(self, test)
Called when the given test has been run
+ +
stopTestRun(self)
Called once after all tests are executed.
+ 
+See stopTest for a method called after each test.
+ +
wasSuccessful(self)
Tells whether or not this result was a success
+ +
+Data descriptors inherited from unittest.result.TestResult:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.html b/tools/telemetry/docs/telemetry.page.html new file mode 100644 index 0000000..37a13ff --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.html @@ -0,0 +1,54 @@ + + +Python: package telemetry.page + + + + +
 
+ 
telemetry.page		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/__init__.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Package Contents
       
actions (package)
+block_page_measurement_results
+block_page_measurement_results_unittest
+buildbot_page_measurement_results
+buildbot_page_measurement_results_unittest
+csv_page_measurement_results
+csv_page_measurement_results_unittest
+failure
+		gtest_test_results
+page
+page_filter
+page_measurement
+page_measurement_results
+page_measurement_results_unittest
+page_measurement_runner
+page_measurement_unittest
+		page_measurement_unittest_base
+page_measurement_value
+page_runner
+page_runner_unittest
+page_set
+page_set_archive_info
+page_set_archive_info_unittest
+page_set_unittest
+		page_test
+page_test_results
+page_test_runner
+page_test_unittest
+page_unittest
+perf_tests_helper
+record_wpr
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page.html b/tools/telemetry/docs/telemetry.page.page.html new file mode 100644 index 0000000..4167e01 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page.html @@ -0,0 +1,79 @@ + + +Python: module telemetry.page.page + + + + +
 
+ 
telemetry.page.page		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
os
+re
+		time
+urlparse
+		telemetry.core.util
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
Page +
+
+
+

+ + + + + +
 
+class Page(__builtin__.object)
    Methods defined here:
+
WaitToLoad(self, tab, timeout, poll_interval=0.1)
+ +
__getattr__(self, name)
+ +
__init__(self, url, page_set, attributes=None, base_dir=None)
+ +
__str__(self)
+ +
+Static methods defined here:
+
WaitForPageToLoad(obj, tab, timeout, poll_interval=0.1)
Waits for various wait conditions present in obj.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
archive_path
+
+
display_url
+
+
serving_dirs_and_file
+
+
url_as_file_safe_name
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_filter.html b/tools/telemetry/docs/telemetry.page.page_filter.html new file mode 100644 index 0000000..aff8de7 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_filter.html @@ -0,0 +1,66 @@ + + +Python: module telemetry.page.page_filter + + + + +
 
+ 
telemetry.page.page_filter		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_filter.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
optparse
+		re
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
PageFilter +
+
+
+

+ + + + + + + +
 
+class PageFilter(__builtin__.object)
   Filters pages in the page set based on command line flags.
 
 Methods defined here:
+
IsSelected(self, page)
+ +
__init__(self, options)
+ +
+Static methods defined here:
+
AddCommandLineOptions(parser)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_measurement.html b/tools/telemetry/docs/telemetry.page.page_measurement.html new file mode 100644 index 0000000..e0ad33f --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_measurement.html @@ -0,0 +1,244 @@ + + +Python: module telemetry.page.page_measurement + + + + +
 
+ 
telemetry.page.page_measurement		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_measurement.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.page.block_page_measurement_results
+telemetry.page.buildbot_page_measurement_results
+		telemetry.page.csv_page_measurement_results
+os
+		telemetry.page.page_measurement_results
+telemetry.page.page_test
+		sys
+

+ + + + + +
 
+Classes
       
+
telemetry.page.page_test.Failure(exceptions.Exception) +
+
+
MeasurementFailure +
+
+
telemetry.page.page_test.PageTest(__builtin__.object) +
+
+
PageMeasurement +
+
+
+

+ + + + + + + +
 
+class MeasurementFailure(telemetry.page.page_test.Failure)
   Exception that can be thrown from MeasurePage to indicate an undesired but
+designed-for problem.
 
 
Method resolution order:
+
MeasurementFailure
+
telemetry.page.page_test.Failure
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors inherited from telemetry.page.page_test.Failure:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + + + +
 
+class PageMeasurement(telemetry.page.page_test.PageTest)
   Glue code for running a measurement across a set of pages.
+ 
+To use this, subclass from the measurement and override MeasurePage. For
+example:
+ 
+   class BodyChildElementMeasurement(PageMeasurement):
+      def MeasurePage(self, page, tab, results):
+         body_child_count = tab.EvaluateJavaScript(
+             'document.body.children.length')
+         results.Add('body_children', 'count', body_child_count)
+ 
+   if __name__ == '__main__':
+       page_measurement.Main(BodyChildElementMeasurement())
+ 
+To add test-specific options:
+ 
+   class BodyChildElementMeasurement(PageMeasurement):
+      def AddCommandLineOptions(parser):
+         parser.add_option('--element', action='store', default='body')
+ 
+      def MeasurePage(self, page, tab, results):
+         body_child_count = tab.EvaluateJavaScript(
+            'document.querySelector('%s').children.length')
+         results.Add('children', 'count', child_count)
 
 
Method resolution order:
+
PageMeasurement
+
telemetry.page.page_test.PageTest
+
__builtin__.object
+
+
+Methods defined here:
+
AddOutputOptions(self, parser)
+ +
MeasurePage(self, page, tab, results)
Override to actually measure the page's performance.
+ 
+page is a page_set.Page
+tab is an instance of telemetry.core.Tab
+ 
+Should call results.Add(name, units, value) for each result, or raise an
+exception on failure. The name and units of each Add() call must be
+the same across all iterations. The name 'url' must not be used.
+ 
+Prefer field names that are in accordance with python variable style. E.g.
+field_name.
+ 
+Put together:
+ 
+   def MeasurePage(self, page, tab, results):
+     res = tab.EvaluateJavaScript('2+2')
+     if res != 4:
+       raise Exception('Oh, wow.')
+     results.Add('two_plus_two', 'count', res)
+ +
PrepareResults(self, options)
+ +
__init__(self, action_name_to_run='', needs_browser_restart_after_each_run=False, discard_first_result=False)
+ +
+Data descriptors defined here:
+
output_format_choices
+
+
results_are_the_same_on_every_page
+
By default, measurements are assumed to output the same values for every
+page. This allows incremental output, for example in CSV. If, however, the
+measurement discovers what values it can report as it goes, and those values
+may vary from page to page, you need to override this function and return
+False. Output will not appear in this mode until the entire pageset has
+run.
+
+
+Methods inherited from telemetry.page.page_test.PageTest:
+
AddCommandLineOptions(self, parser)
Override to expose command-line options for this test.
+ 
+The provided parser is an optparse.OptionParser instance and accepts all
+normal results. The parsed options are available in Run as
+self.options.
+ +
CanRunForPage(self, page)
Override to customize if the test can be ran for the given page.
+ +
CreatePageSet(self, args, options)
Override to make this test generate its own page set instead of
+allowing arbitrary page sets entered from the command-line.
+ +
CustomizeBrowserOptions(self, options)
Override to add test-specific options to the BrowserOptions object
+ +
CustomizeBrowserOptionsForPage(self, page, options)
Add options specific to the test and the given page.
+ +
DidNavigateToPage(self, page, tab)
Override to do operations right after the page is navigated, but before
+any waiting for completion has occurred.
+ +
DidRunAction(self, page, tab, action)
Override to do operations after running the action on the page.
+ +
DidRunPageSet(self, tab, results)
Override to do operations after page set is completed, but before browser
+is torn down.
+ +
DidStartHTTPServer(self, tab)
Override to do operations after the HTTP server is started.
+ +
NeedsBrowserRestartAfterEachRun(self, tab)
Override to specify browser restart after each run.
+ +
Run(self, options, page, tab, results)
+ +
SetUpBrowser(self, browser)
Override to customize the browser right after it has launched.
+ +
WillNavigateToPage(self, page, tab)
Override to do operations before the page is navigated.
+ +
WillRunAction(self, page, tab, action)
Override to do operations before running the action on the page.
+ +
WillRunPageSet(self, tab)
Override to do operations before the page set is navigated.
+ +
+Data descriptors inherited from telemetry.page.page_test.PageTest:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
action_name_to_run
+
+
discard_first_result
+
When set to True, the first run of the test is discarded.  This is
+useful for cases where it's desirable to have some test resource cached so
+the first run of the test can warm things up.
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_measurement_results.html b/tools/telemetry/docs/telemetry.page.page_measurement_results.html new file mode 100644 index 0000000..e23749f --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_measurement_results.html @@ -0,0 +1,177 @@ + + +Python: module telemetry.page.page_measurement_results + + + + +
 
+ 
telemetry.page.page_measurement_results		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_measurement_results.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.page.page_measurement_value
+		telemetry.page.page_test_results
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
ValuesForSinglePage +
+
+
telemetry.page.page_test_results.PageTestResults(unittest.result.TestResult) +
+
+
PageMeasurementResults +
+
+
+

+ + + + + +
 
+class PageMeasurementResults(telemetry.page.page_test_results.PageTestResults)
    
Method resolution order:
+
PageMeasurementResults
+
telemetry.page.page_test_results.PageTestResults
+
unittest.result.TestResult
+
__builtin__.object
+
+
+Methods defined here:
+
Add(self, trace_name, units, value, chart_name=None, data_type='default')
+ +
AddSummary(self, trace_name, units, value, chart_name=None, data_type='default')
+ +
DidMeasurePage(self)
+ +
WillMeasurePage(self, page)
+ +
__getitem__(self, i)
Shorthand for self.page_results[i]
+ +
__init__(self, trace_tag='')
+ +
__len__(self)
+ +
+Data descriptors defined here:
+
all_measurements_that_have_been_seen
+
+
page_results
+
+
values_for_current_page
+
+
+Methods inherited from telemetry.page.page_test_results.PageTestResults:
+
AddError(self, page, err)
+ +
AddErrorMessage(self, page, message)
+ +
AddFailure(self, page, err)
+ +
AddFailureMessage(self, page, message)
+ +
AddSkip(self, page, reason)
+ +
AddSuccess(self, page)
+ +
PrintSummary(self)
+ +
StartTest(self, page)
+ +
StopTest(self, page)
+ +
addSkip(self, test, reason)
+ +
addSuccess(self, test)
+ +
+Methods inherited from unittest.result.TestResult:
+
__repr__(self)
+ +
addError(self, *args, **kw)
Called when an error has occurred. 'err' is a tuple of values as
+returned by sys.exc_info().
+ +
addExpectedFailure(self, test, err)
Called when an expected failure/error occured.
+ +
addFailure(self, *args, **kw)
Called when an error has occurred. 'err' is a tuple of values as
+returned by sys.exc_info().
+ +
addUnexpectedSuccess(self, *args, **kw)
Called when a test was expected to fail, but succeed.
+ +
printErrors(self)
Called by TestRunner after test run
+ +
startTest(self, test)
Called when the given test is about to be run
+ +
startTestRun(self)
Called once before any tests are executed.
+ 
+See startTest for a method called before each test.
+ +
stop(self)
Indicates that the tests should be aborted
+ +
stopTest(self, test)
Called when the given test has been run
+ +
stopTestRun(self)
Called once after all tests are executed.
+ 
+See stopTest for a method called after each test.
+ +
wasSuccessful(self)
Tells whether or not this result was a success
+ +
+Data descriptors inherited from unittest.result.TestResult:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+class ValuesForSinglePage(__builtin__.object)
    Methods defined here:
+
AddValue(self, value)
+ +
FindValueByMeasurementName(self, measurement_name)
+ +
FindValueByTraceName(self, trace_name)
+ +
__contains__(self, trace_name)
+ +
__getitem__(self, trace_name)
+ +
__init__(self, page)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
measurement_names
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_measurement_runner.html b/tools/telemetry/docs/telemetry.page.page_measurement_runner.html new file mode 100644 index 0000000..e0b8bb8 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_measurement_runner.html @@ -0,0 +1,107 @@ + + +Python: module telemetry.page.page_measurement_runner + + + + +
 
+ 
telemetry.page.page_measurement_runner		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_measurement_runner.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.page.page_measurement
+		telemetry.page.page_test_runner
+		sys
+

+ + + + + +
 
+Classes
       
+
telemetry.page.page_test_runner.PageTestRunner(__builtin__.object) +
+
+
PageMeasurementRunner +
+
+
+

+ + + + + +
 
+class PageMeasurementRunner(telemetry.page.page_test_runner.PageTestRunner)
    
Method resolution order:
+
PageMeasurementRunner
+
telemetry.page.page_test_runner.PageTestRunner
+
__builtin__.object
+
+
+Data descriptors defined here:
+
test_class
+
+
test_class_name
+
+
+Methods inherited from telemetry.page.page_test_runner.PageTestRunner:
+
FindTestConstructors(self, test_dir)
+ +
FindTestName(self, test_constructors, args)
Find the test name in an arbitrary argument list.
+ 
+We can't use the optparse parser, because the test may add its own
+command-line options. If the user passed in any of those, the
+optparse parsing will fail.
+ 
+Returns:
+  test_name or None
+ +
GetModernizedTestName(self, arg)
Sometimes tests change names but buildbots keep calling the old name.
+ 
+If arg matches an old test name, return the new test name instead.
+Otherwise, return the arg.
+ +
GetPageSet(self, test, page_set_filenames)
+ +
ParseCommandLine(self, args, test_dir, profile_creators_dir, page_set_filenames)
+ +
PrintParseError(self, message)
+ +
Run(self, test_dir, profile_creators_dir, page_set_filenames)
+ +
__init__(self)
+ +
+Data descriptors inherited from telemetry.page.page_test_runner.PageTestRunner:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+Functions
       
Main(measurement_dir, profile_creators_dir, page_set_filenames)
Turns a PageMeasurement into a command-line program.
+ 
+Args:
+  measurement_dir: Path to directory containing PageMeasurements.
+  profile_creators_dir: Path to directory containing ProfileCreators.
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_measurement_unittest_base.html b/tools/telemetry/docs/telemetry.page.page_measurement_unittest_base.html new file mode 100644 index 0000000..3c3867d --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_measurement_unittest_base.html @@ -0,0 +1,346 @@ + + +Python: module telemetry.page.page_measurement_unittest_base + + + + +
 
+ 
telemetry.page.page_measurement_unittest_base		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_measurement_unittest_base.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.unittest.options_for_unittests
+os
+		telemetry.page.page
+telemetry.page.page_runner
+		telemetry.page.page_set
+unittest
+

+ + + + + +
 
+Classes
       
+
unittest.case.TestCase(__builtin__.object) +
+
+
PageMeasurementUnitTestBase +
+
+
+

+ + + + + + + +
 
+class PageMeasurementUnitTestBase(unittest.case.TestCase)
   unittest.TestCase-derived class to help in the construction of unit tests
+for a measurement.
 
 
Method resolution order:
+
PageMeasurementUnitTestBase
+
unittest.case.TestCase
+
__builtin__.object
+
+
+Methods defined here:
+
CreatePageSet(self, test_filename)
+ +
CreatePageSetFromFileInUnittestDataDir(self, test_filename)
+ +
RunMeasurement(self, measurement, ps, options=None)
Runs a measurement against a pageset, returning the rows its outputs.
+ +
+Methods inherited from unittest.case.TestCase:
+
__call__(self, *args, **kwds)
+ +
__eq__(self, other)
+ +
__hash__(self)
+ +
__init__(self, methodName='runTest')
Create an instance of the class that will use the named test
+method when executed. Raises a ValueError if the instance does
+not have a method with the specified name.
+ +
__ne__(self, other)
+ +
__repr__(self)
+ +
__str__(self)
+ +
addCleanup(self, function, *args, **kwargs)
Add a function, with arguments, to be called when the test is
+completed. Functions added are called on a LIFO basis and are
+called after tearDown on test failure or success.
+ 
+Cleanup items are called even if setUp fails (unlike tearDown).
+ +
addTypeEqualityFunc(self, typeobj, function)
Add a type specific assertEqual style function to compare a type.
+ 
+This method is for use by TestCase subclasses that need to register
+their own type equality functions to provide nicer error messages.
+ 
+Args:
+    typeobj: The data type to call this function on when both values
+            are of the same type in assertEqual().
+    function: The callable taking two arguments and an optional
+            msg= argument that raises self.failureException with a
+            useful error message when the two arguments are not equal.
+ +
assertAlmostEqual(self, first, second, places=None, msg=None, delta=None)
Fail if the two objects are unequal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero, or by comparing that the
+between the two objects is more than the given delta.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ 
+If the two objects compare equal then they will automatically
+compare almost equal.
+ +
assertAlmostEquals = assertAlmostEqual(self, first, second, places=None, msg=None, delta=None)
Fail if the two objects are unequal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero, or by comparing that the
+between the two objects is more than the given delta.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ 
+If the two objects compare equal then they will automatically
+compare almost equal.
+ +
assertDictContainsSubset(self, expected, actual, msg=None)
Checks whether actual is a superset of expected.
+ +
assertDictEqual(self, d1, d2, msg=None)
+ +
assertEqual(self, first, second, msg=None)
Fail if the two objects are unequal as determined by the '=='
+operator.
+ +
assertEquals = assertEqual(self, first, second, msg=None)
Fail if the two objects are unequal as determined by the '=='
+operator.
+ +
assertFalse(self, expr, msg=None)
Check that the expression is false.
+ +
assertGreater(self, a, b, msg=None)
Just like assertTrue(a > b), but with a nicer default message.
+ +
assertGreaterEqual(self, a, b, msg=None)
Just like assertTrue(a >= b), but with a nicer default message.
+ +
assertIn(self, member, container, msg=None)
Just like assertTrue(a in b), but with a nicer default message.
+ +
assertIs(self, expr1, expr2, msg=None)
Just like assertTrue(a is b), but with a nicer default message.
+ +
assertIsInstance(self, obj, cls, msg=None)
Same as assertTrue(isinstance(obj, cls)), with a nicer
+default message.
+ +
assertIsNone(self, obj, msg=None)
Same as assertTrue(obj is None), with a nicer default message.
+ +
assertIsNot(self, expr1, expr2, msg=None)
Just like assertTrue(a is not b), but with a nicer default message.
+ +
assertIsNotNone(self, obj, msg=None)
Included for symmetry with assertIsNone.
+ +
assertItemsEqual(self, expected_seq, actual_seq, msg=None)
An unordered sequence specific comparison. It asserts that
+actual_seq and expected_seq have the same element counts.
+Equivalent to::
+ 
+    assertEqual(Counter(iter(actual_seq)),
+                     Counter(iter(expected_seq)))
+ 
+Asserts that each element has the same count in both sequences.
+Example:
+    - [0, 1, 1] and [1, 0, 1] compare equal.
+    - [0, 0, 1] and [0, 1] compare unequal.
+ +
assertLess(self, a, b, msg=None)
Just like assertTrue(a < b), but with a nicer default message.
+ +
assertLessEqual(self, a, b, msg=None)
Just like assertTrue(a <= b), but with a nicer default message.
+ +
assertListEqual(self, list1, list2, msg=None)
A list-specific equality assertion.
+ 
+Args:
+    list1: The first list to compare.
+    list2: The second list to compare.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ +
assertMultiLineEqual(self, first, second, msg=None)
Assert that two multi-line strings are equal.
+ +
assertNotAlmostEqual(self, first, second, places=None, msg=None, delta=None)
Fail if the two objects are equal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero, or by comparing that the
+between the two objects is less than the given delta.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ 
+Objects that are equal automatically fail.
+ +
assertNotAlmostEquals = assertNotAlmostEqual(self, first, second, places=None, msg=None, delta=None)
Fail if the two objects are equal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero, or by comparing that the
+between the two objects is less than the given delta.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ 
+Objects that are equal automatically fail.
+ +
assertNotEqual(self, first, second, msg=None)
Fail if the two objects are equal as determined by the '=='
+operator.
+ +
assertNotEquals = assertNotEqual(self, first, second, msg=None)
Fail if the two objects are equal as determined by the '=='
+operator.
+ +
assertNotIn(self, member, container, msg=None)
Just like assertTrue(a not in b), but with a nicer default message.
+ +
assertNotIsInstance(self, obj, cls, msg=None)
Included for symmetry with assertIsInstance.
+ +
assertNotRegexpMatches(self, text, unexpected_regexp, msg=None)
Fail the test if the text matches the regular expression.
+ +
assertRaises(self, excClass, callableObj=None, *args, **kwargs)
Fail unless an exception of class excClass is thrown
+by callableObj when invoked with arguments args and keyword
+arguments kwargs. If a different type of exception is
+thrown, it will not be caught, and the test case will be
+deemed to have suffered an error, exactly as for an
+unexpected exception.
+ 
+If called with callableObj omitted or None, will return a
+context object used like this::
+ 
+     with assertRaises(SomeException):
+         do_something()
+ 
+The context manager keeps a reference to the exception as
+the 'exception' attribute. This allows you to inspect the
+exception after the assertion::
+ 
+    with assertRaises(SomeException) as cm:
+        do_something()
+    the_exception = cm.exception
+    assertEqual(the_exception.error_code, 3)
+ +
assertRaisesRegexp(self, expected_exception, expected_regexp, callable_obj=None, *args, **kwargs)
Asserts that the message in a raised exception matches a regexp.
+ 
+Args:
+    expected_exception: Exception class expected to be raised.
+    expected_regexp: Regexp (re pattern object or string) expected
+            to be found in error message.
+    callable_obj: Function to be called.
+    args: Extra args.
+    kwargs: Extra kwargs.
+ +
assertRegexpMatches(self, text, expected_regexp, msg=None)
Fail the test unless the text matches the regular expression.
+ +
assertSequenceEqual(self, seq1, seq2, msg=None, seq_type=None)
An equality assertion for ordered sequences (like lists and tuples).
+ 
+For the purposes of this function, a valid ordered sequence type is one
+which can be indexed, has a length, and has an equality operator.
+ 
+Args:
+    seq1: The first sequence to compare.
+    seq2: The second sequence to compare.
+    seq_type: The expected datatype of the sequences, or None if no
+            datatype should be enforced.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ +
assertSetEqual(self, set1, set2, msg=None)
A set-specific equality assertion.
+ 
+Args:
+    set1: The first set to compare.
+    set2: The second set to compare.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ 
+assertSetEqual uses ducktyping to support different types of sets, and
+is optimized for sets specifically (parameters must support a
+difference method).
+ +
assertTrue(self, expr, msg=None)
Check that the expression is true.
+ +
assertTupleEqual(self, tuple1, tuple2, msg=None)
A tuple-specific equality assertion.
+ 
+Args:
+    tuple1: The first tuple to compare.
+    tuple2: The second tuple to compare.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ +
assert_ = assertTrue(self, expr, msg=None)
Check that the expression is true.
+ +
countTestCases(self)
+ +
debug(self)
Run the test without collecting errors in a TestResult
+ +
defaultTestResult(self)
+ +
doCleanups(self)
Execute all cleanup functions. Normally called for you after
+tearDown.
+ +
fail(self, msg=None)
Fail immediately, with the given message.
+ +
failIf = deprecated_func(*args, **kwargs)
+ +
failIfAlmostEqual = deprecated_func(*args, **kwargs)
+ +
failIfEqual = deprecated_func(*args, **kwargs)
+ +
failUnless = deprecated_func(*args, **kwargs)
+ +
failUnlessAlmostEqual = deprecated_func(*args, **kwargs)
+ +
failUnlessEqual = deprecated_func(*args, **kwargs)
+ +
failUnlessRaises = deprecated_func(*args, **kwargs)
+ +
id(self)
+ +
run(self, result=None)
+ +
setUp(self)
Hook method for setting up the test fixture before exercising it.
+ +
shortDescription(self)
Returns a one-line description of the test, or None if no
+description has been provided.
+ 
+The default implementation of this method returns the first line of
+the specified test method's docstring.
+ +
skipTest(self, reason)
Skip this test.
+ +
tearDown(self)
Hook method for deconstructing the test fixture after testing it.
+ +
+Class methods inherited from unittest.case.TestCase:
+
setUpClass(cls) from __builtin__.type
Hook method for setting up class fixture before running tests in the class.
+ +
tearDownClass(cls) from __builtin__.type
Hook method for deconstructing the class fixture after running all tests in the class.
+ +
+Data descriptors inherited from unittest.case.TestCase:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes inherited from unittest.case.TestCase:
+
failureException = <type 'exceptions.AssertionError'>
Assertion failed.
+ +
longMessage = False
+ +
maxDiff = 640
+ +

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_measurement_value.html b/tools/telemetry/docs/telemetry.page.page_measurement_value.html new file mode 100644 index 0000000..4765a62 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_measurement_value.html @@ -0,0 +1,61 @@ + + +Python: module telemetry.page.page_measurement_value + + + + +
 
+ 
telemetry.page.page_measurement_value		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_measurement_value.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.page.perf_tests_helper
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
PageMeasurementValue +
+
+
+

+ + + + + +
 
+class PageMeasurementValue(__builtin__.object)
    Methods defined here:
+
__init__(self, trace_name, units, value, chart_name, data_type)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
measurement_name
+
+
output_value
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_runner.html b/tools/telemetry/docs/telemetry.page.page_runner.html new file mode 100644 index 0000000..84d5844 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_runner.html @@ -0,0 +1,84 @@ + + +Python: module telemetry.page.page_runner + + + + +
 
+ 
telemetry.page.page_runner		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_runner.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.browser_finder
+codecs
+telemetry.core.exceptions
+glob
+		logging
+os
+telemetry.page.page_filter
+telemetry.page.page_test
+		random
+sys
+time
+traceback
+		urlparse
+telemetry.core.util
+telemetry.core.wpr_modes
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
PageState +
+
+
+

+ + + + + +
 
+class PageState(__builtin__.object)
    Methods defined here:
+
CleanUpPage(self, page, tab)
+ +
PreparePage(self, test, page, tab)
+ +
__init__(self)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+Functions
       
AddCommandLineOptions(parser)
+
Run(test, page_set, options)
Runs a given test against a given page_set with the given options.
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_set.html b/tools/telemetry/docs/telemetry.page.page_set.html new file mode 100644 index 0000000..a930673 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_set.html @@ -0,0 +1,82 @@ + + +Python: module telemetry.page.page_set + + + + +
 
+ 
telemetry.page.page_set		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_set.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
csv
+json
+		os
+telemetry.page.page
+		telemetry.page.page_set_archive_info
+urlparse
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
PageSet +
+
+
+

+ + + + + +
 
+class PageSet(__builtin__.object)
    Methods defined here:
+
ContainsOnlyFileURLs(self)
+ +
ReorderPageSet(self, results_file)
Reorders this page set based on the results of a past run.
+ +
WprFilePathForPage(self, page)
+ +
__getitem__(self, key)
+ +
__init__(self, file_path='', attributes=None)
+ +
__iter__(self)
+ +
__len__(self)
+ +
__setitem__(self, key, value)
+ +
+Class methods defined here:
+
FromDict(cls, data, file_path) from __builtin__.type
+ +
FromFile(cls, file_path) from __builtin__.type
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_set_archive_info.html b/tools/telemetry/docs/telemetry.page.page_set_archive_info.html new file mode 100644 index 0000000..873400b --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_set_archive_info.html @@ -0,0 +1,71 @@ + + +Python: module telemetry.page.page_set_archive_info + + + + +
 
+ 
telemetry.page.page_set_archive_info		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_set_archive_info.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
json
+logging
+		os
+re
+		shutil
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
PageSetArchiveInfo +
+
+
+

+ + + + + +
 
+class PageSetArchiveInfo(__builtin__.object)
    Methods defined here:
+
AddNewTemporaryRecording(self, temp_target_wpr_file_path)
+ +
AddRecordedPages(self, urls)
+ +
WprFilePathForPage(self, page)
+ +
__init__(self, archive_data_file_path, page_set_file_path, data)
+ +
+Class methods defined here:
+
FromFile(cls, file_path, page_set_file_path) from __builtin__.type
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_test.html b/tools/telemetry/docs/telemetry.page.page_test.html new file mode 100644 index 0000000..5d78d3e --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_test.html @@ -0,0 +1,190 @@ + + +Python: module telemetry.page.page_test + + + + +
 
+ 
telemetry.page.page_test		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_test.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.page.actions.all_page_actions
+telemetry.page.gtest_test_results
+		logging
+telemetry.page.actions.page_action
+		telemetry.page.page_test_results
+telemetry.core.util
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
PageTest +
+
+
exceptions.Exception(exceptions.BaseException) +
+
+
Failure +
+
+
+

+ + + + + + + +
 
+class Failure(exceptions.Exception)
   Exception that can be thrown from PageMeasurement to indicate an
+undesired but designed-for problem.
 
 
Method resolution order:
+
Failure
+
exceptions.Exception
+
exceptions.BaseException
+
__builtin__.object
+
+
+Data descriptors defined here:
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Methods inherited from exceptions.Exception:
+
__init__(...)
x.__init__(...) initializes x; see help(type(x)) for signature
+ +
+Data and other attributes inherited from exceptions.Exception:
+
__new__ = <built-in method __new__ of type object>
T.__new__(S, ...) -> a new object with type S, a subtype of T
+ +
+Methods inherited from exceptions.BaseException:
+
__delattr__(...)
x.__delattr__('name') <==> del x.name
+ +
__getattribute__(...)
x.__getattribute__('name') <==> x.name
+ +
__getitem__(...)
x.__getitem__(y) <==> x[y]
+ +
__getslice__(...)
x.__getslice__(i, j) <==> x[i:j]
+ 
+Use of negative indices is not supported.
+ +
__reduce__(...)
+ +
__repr__(...)
x.__repr__() <==> repr(x)
+ +
__setattr__(...)
x.__setattr__('name', value) <==> x.name = value
+ +
__setstate__(...)
+ +
__str__(...)
x.__str__() <==> str(x)
+ +
__unicode__(...)
+ +
+Data descriptors inherited from exceptions.BaseException:
+
__dict__
+
+
args
+
+
message
+
+

+ + + + + + + +
 
+class PageTest(__builtin__.object)
   A class styled on unittest.TestCase for creating page-specific tests.
 
 Methods defined here:
+
AddCommandLineOptions(self, parser)
Override to expose command-line options for this test.
+ 
+The provided parser is an optparse.OptionParser instance and accepts all
+normal results. The parsed options are available in Run as
+self.options.
+ +
AddOutputOptions(self, parser)
+ +
CanRunForPage(self, page)
Override to customize if the test can be ran for the given page.
+ +
CreatePageSet(self, args, options)
Override to make this test generate its own page set instead of
+allowing arbitrary page sets entered from the command-line.
+ +
CustomizeBrowserOptions(self, options)
Override to add test-specific options to the BrowserOptions object
+ +
CustomizeBrowserOptionsForPage(self, page, options)
Add options specific to the test and the given page.
+ +
DidNavigateToPage(self, page, tab)
Override to do operations right after the page is navigated, but before
+any waiting for completion has occurred.
+ +
DidRunAction(self, page, tab, action)
Override to do operations after running the action on the page.
+ +
DidRunPageSet(self, tab, results)
Override to do operations after page set is completed, but before browser
+is torn down.
+ +
DidStartHTTPServer(self, tab)
Override to do operations after the HTTP server is started.
+ +
NeedsBrowserRestartAfterEachRun(self, tab)
Override to specify browser restart after each run.
+ +
PrepareResults(self, options)
+ +
Run(self, options, page, tab, results)
+ +
SetUpBrowser(self, browser)
Override to customize the browser right after it has launched.
+ +
WillNavigateToPage(self, page, tab)
Override to do operations before the page is navigated.
+ +
WillRunAction(self, page, tab, action)
Override to do operations before running the action on the page.
+ +
WillRunPageSet(self, tab)
Override to do operations before the page set is navigated.
+ +
__init__(self, test_method_name, action_name_to_run='', needs_browser_restart_after_each_run=False, discard_first_result=False)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
action_name_to_run
+
+
discard_first_result
+
When set to True, the first run of the test is discarded.  This is
+useful for cases where it's desirable to have some test resource cached so
+the first run of the test can warm things up.
+
+
output_format_choices
+
Allowed output formats. The default is the first item in the list.
+
+

+ + + + + +
 
+Functions
       
GetCompoundActionFromPage(page, action_name)
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_test_results.html b/tools/telemetry/docs/telemetry.page.page_test_results.html new file mode 100644 index 0000000..cd7849e --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_test_results.html @@ -0,0 +1,120 @@ + + +Python: module telemetry.page.page_test_results + + + + +
 
+ 
telemetry.page.page_test_results		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_test_results.py
+

# Copyright (c) 2013 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.

+

+ + + + + +
 
+Modules
       
logging
+		sys
+		traceback
+		unittest
+

+ + + + + +
 
+Classes
       
+
unittest.result.TestResult(__builtin__.object) +
+
+
PageTestResults +
+
+
+

+ + + + + +
 
+class PageTestResults(unittest.result.TestResult)
    
Method resolution order:
+
PageTestResults
+
unittest.result.TestResult
+
__builtin__.object
+
+
+Methods defined here:
+
AddError(self, page, err)
+ +
AddErrorMessage(self, page, message)
+ +
AddFailure(self, page, err)
+ +
AddFailureMessage(self, page, message)
+ +
AddSkip(self, page, reason)
+ +
AddSuccess(self, page)
+ +
PrintSummary(self)
+ +
StartTest(self, page)
+ +
StopTest(self, page)
+ +
__init__(self)
+ +
addSkip(self, test, reason)
+ +
addSuccess(self, test)
+ +
+Methods inherited from unittest.result.TestResult:
+
__repr__(self)
+ +
addError(self, *args, **kw)
Called when an error has occurred. 'err' is a tuple of values as
+returned by sys.exc_info().
+ +
addExpectedFailure(self, test, err)
Called when an expected failure/error occured.
+ +
addFailure(self, *args, **kw)
Called when an error has occurred. 'err' is a tuple of values as
+returned by sys.exc_info().
+ +
addUnexpectedSuccess(self, *args, **kw)
Called when a test was expected to fail, but succeed.
+ +
printErrors(self)
Called by TestRunner after test run
+ +
startTest(self, test)
Called when the given test is about to be run
+ +
startTestRun(self)
Called once before any tests are executed.
+ 
+See startTest for a method called before each test.
+ +
stop(self)
Indicates that the tests should be aborted
+ +
stopTest(self, test)
Called when the given test has been run
+ +
stopTestRun(self)
Called once after all tests are executed.
+ 
+See stopTest for a method called after each test.
+ +
wasSuccessful(self)
Tells whether or not this result was a success
+ +
+Data descriptors inherited from unittest.result.TestResult:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.page_test_runner.html b/tools/telemetry/docs/telemetry.page.page_test_runner.html new file mode 100644 index 0000000..bf6d768 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.page_test_runner.html @@ -0,0 +1,104 @@ + + +Python: module telemetry.page.page_test_runner + + + + +
 
+ 
telemetry.page.page_test_runner		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/page_test_runner.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.browser_options
+telemetry.core.discover
+		os
+telemetry.page.page_runner
+		telemetry.page.page_set
+telemetry.page.page_test
+		telemetry.core.profile_types
+sys
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
PageTestRunner +
+
+
+

+ + + + + +
 
+class PageTestRunner(__builtin__.object)
    Methods defined here:
+
FindTestConstructors(self, test_dir)
+ +
FindTestName(self, test_constructors, args)
Find the test name in an arbitrary argument list.
+ 
+We can't use the optparse parser, because the test may add its own
+command-line options. If the user passed in any of those, the
+optparse parsing will fail.
+ 
+Returns:
+  test_name or None
+ +
GetModernizedTestName(self, arg)
Sometimes tests change names but buildbots keep calling the old name.
+ 
+If arg matches an old test name, return the new test name instead.
+Otherwise, return the arg.
+ +
GetPageSet(self, test, page_set_filenames)
+ +
ParseCommandLine(self, args, test_dir, profile_creators_dir, page_set_filenames)
+ +
PrintParseError(self, message)
+ +
Run(self, test_dir, profile_creators_dir, page_set_filenames)
+ +
__init__(self)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
test_class
+
+
test_class_name
+
+

+ + + + + +
 
+Functions
       
Main(test_dir, profile_creators_dir, page_set_filenames)
Turns a PageTest into a command-line program.
+ 
+Args:
+  test_dir: Path to directory containing PageTests.
+  profile_creators_dir: Path to a directory containing ProfileCreators
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.perf_tests_helper.html b/tools/telemetry/docs/telemetry.page.perf_tests_helper.html new file mode 100644 index 0000000..0017ea5 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.perf_tests_helper.html @@ -0,0 +1,41 @@ + + +Python: module telemetry.page.perf_tests_helper + + + + +
 
+ 
telemetry.page.perf_tests_helper		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/perf_tests_helper.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
os
+		pylib.perf_tests_helper
+		sys
+

+ + + + + +
 
+Functions
       
__init__()
+

+ + + + + +
 
+Data
       absolute_import = _Feature((2, 5, 0, 'alpha', 1), (2, 7, 0, 'alpha', 0), 16384)
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.page.record_wpr.html b/tools/telemetry/docs/telemetry.page.record_wpr.html new file mode 100644 index 0000000..0893900 --- /dev/null +++ b/tools/telemetry/docs/telemetry.page.record_wpr.html @@ -0,0 +1,137 @@ + + +Python: module telemetry.page.record_wpr + + + + +
 
+ 
telemetry.page.record_wpr		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/page/record_wpr.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.browser_finder
+telemetry.core.browser_options
+telemetry.core.discover
+logging
+		os
+telemetry.page.page_measurement
+telemetry.page.page_runner
+telemetry.page.page_set
+		telemetry.page.page_test
+telemetry.page.page_test_results
+sys
+tempfile
+		time
+telemetry.core.wpr_modes
+

+ + + + + +
 
+Classes
       
+
telemetry.page.page_test.PageTest(__builtin__.object) +
+
+
RecordPage +
+
+
+

+ + + + + +
 
+class RecordPage(telemetry.page.page_test.PageTest)
    
Method resolution order:
+
RecordPage
+
telemetry.page.page_test.PageTest
+
__builtin__.object
+
+
+Methods defined here:
+
CanRunForPage(self, page)
+ +
CustomizeBrowserOptionsForPage(self, page, options)
+ +
Run(self, options, page, tab, results)
+ +
__init__(self, measurements)
+ +
+Methods inherited from telemetry.page.page_test.PageTest:
+
AddCommandLineOptions(self, parser)
Override to expose command-line options for this test.
+ 
+The provided parser is an optparse.OptionParser instance and accepts all
+normal results. The parsed options are available in Run as
+self.options.
+ +
AddOutputOptions(self, parser)
+ +
CreatePageSet(self, args, options)
Override to make this test generate its own page set instead of
+allowing arbitrary page sets entered from the command-line.
+ +
CustomizeBrowserOptions(self, options)
Override to add test-specific options to the BrowserOptions object
+ +
DidNavigateToPage(self, page, tab)
Override to do operations right after the page is navigated, but before
+any waiting for completion has occurred.
+ +
DidRunAction(self, page, tab, action)
Override to do operations after running the action on the page.
+ +
DidRunPageSet(self, tab, results)
Override to do operations after page set is completed, but before browser
+is torn down.
+ +
DidStartHTTPServer(self, tab)
Override to do operations after the HTTP server is started.
+ +
NeedsBrowserRestartAfterEachRun(self, tab)
Override to specify browser restart after each run.
+ +
PrepareResults(self, options)
+ +
SetUpBrowser(self, browser)
Override to customize the browser right after it has launched.
+ +
WillNavigateToPage(self, page, tab)
Override to do operations before the page is navigated.
+ +
WillRunAction(self, page, tab, action)
Override to do operations before running the action on the page.
+ +
WillRunPageSet(self, tab)
Override to do operations before the page set is navigated.
+ +
+Data descriptors inherited from telemetry.page.page_test.PageTest:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
action_name_to_run
+
+
discard_first_result
+
When set to True, the first run of the test is discarded.  This is
+useful for cases where it's desirable to have some test resource cached so
+the first run of the test can warm things up.
+
+
output_format_choices
+
Allowed output formats. The default is the first item in the list.
+
+

+ + + + + +
 
+Functions
       
Main(measurement_dir)
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.unittest.gtest_testrunner.html b/tools/telemetry/docs/telemetry.unittest.gtest_testrunner.html new file mode 100644 index 0000000..9108b9a --- /dev/null +++ b/tools/telemetry/docs/telemetry.unittest.gtest_testrunner.html @@ -0,0 +1,121 @@ + + +Python: module telemetry.unittest.gtest_testrunner + + + + +
 
+ 
telemetry.unittest.gtest_testrunner		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/gtest_testrunner.py
+

Implements a unittest TestRunner with GTest output.
+ 
+This output is ported from gtest.cc's PrettyUnitTestResultPrinter, but
+designed to be a drop-in replacement for unittest's TextTestRunner.

+

+ + + + + +
 
+Modules
       
telemetry.page.gtest_test_results
+		time
+		unittest
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
GTestTestRunner +
+
+
unittest.suite.TestSuite(unittest.suite.BaseTestSuite) +
+
+
GTestTestSuite +
+
+
+

+ + + + + +
 
+class GTestTestRunner(__builtin__.object)
    Methods defined here:
+
__init__(self, print_result_after_run=True, runner=None)
+ +
run(self, test)
Run the given test case or test suite.
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+class GTestTestSuite(unittest.suite.TestSuite)
    
Method resolution order:
+
GTestTestSuite
+
unittest.suite.TestSuite
+
unittest.suite.BaseTestSuite
+
__builtin__.object
+
+
+Methods defined here:
+
__call__(self, *args, **kwargs)
+ +
+Methods inherited from unittest.suite.TestSuite:
+
debug(self)
Run the tests without collecting errors in a TestResult
+ +
run(self, result, debug=False)
+ +
+Methods inherited from unittest.suite.BaseTestSuite:
+
__eq__(self, other)
+ +
__init__(self, tests=())
+ +
__iter__(self)
+ +
__ne__(self, other)
+ +
__repr__(self)
+ +
addTest(self, test)
+ +
addTests(self, tests)
+ +
countTestCases(self)
+ +
+Data descriptors inherited from unittest.suite.BaseTestSuite:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes inherited from unittest.suite.BaseTestSuite:
+
__hash__ = None
+ +

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.unittest.html b/tools/telemetry/docs/telemetry.unittest.html new file mode 100644 index 0000000..803475f --- /dev/null +++ b/tools/telemetry/docs/telemetry.unittest.html @@ -0,0 +1,41 @@ + + +Python: package telemetry.unittest + + + + +
 
+ 
telemetry.unittest		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/__init__.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Package Contents
       
gtest_testrunner
+options_for_unittests
+		run_tests
+simple_mock
+		simple_mock_unittest
+system_stub
+		tab_test_case
+

+ + + + + +
 
+Functions
       
DisabledTest(func)
+
RequiresBrowserOfType(*types)
# Copyright (c) 2012 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.
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.unittest.options_for_unittests.html b/tools/telemetry/docs/telemetry.unittest.options_for_unittests.html new file mode 100644 index 0000000..87c5a76 --- /dev/null +++ b/tools/telemetry/docs/telemetry.unittest.options_for_unittests.html @@ -0,0 +1,31 @@ + + +Python: module telemetry.unittest.options_for_unittests + + + + +
 
+ 
telemetry.unittest.options_for_unittests		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/options_for_unittests.py
+

This module provides the global variable options_for_unittests.
+ 
+This is set to a BrowserOptions object by the test harness, or None
+if unit tests are not running.
+ 
+This allows multiple unit tests to use a specific
+browser, in face of multiple options.

+

+ + + + + +
 
+Functions
       
AreSet()
+
GetBrowserType()
+
GetCopy()
+
Set(options, browser_type)
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.unittest.run_tests.html b/tools/telemetry/docs/telemetry.unittest.run_tests.html new file mode 100644 index 0000000..4b3e0614 --- /dev/null +++ b/tools/telemetry/docs/telemetry.unittest.run_tests.html @@ -0,0 +1,42 @@ + + +Python: module telemetry.unittest.run_tests + + + + +
 
+ 
telemetry.unittest.run_tests		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/run_tests.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.browser_options
+telemetry.core.discover
+		telemetry.unittest.gtest_testrunner
+logging
+		telemetry.unittest.options_for_unittests
+os
+		sys
+unittest
+

+ + + + + +
 
+Functions
       
Discover(start_dir, top_level_dir=None, pattern='test*.py')
+
DiscoverAndRunTests(dir_name, args, top_level_dir, runner=None, run_disabled_tests=False)
+
FilterSuite(suite, predicate)
+
Main(args, start_dir, top_level_dir, runner=None)
Unit test suite that collects all test cases for telemetry.
+
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.unittest.simple_mock.html b/tools/telemetry/docs/telemetry.unittest.simple_mock.html new file mode 100644 index 0000000..662e668 --- /dev/null +++ b/tools/telemetry/docs/telemetry.unittest.simple_mock.html @@ -0,0 +1,106 @@ + + +Python: module telemetry.unittest.simple_mock + + + + +
 
+ 
telemetry.unittest.simple_mock		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/simple_mock.py
+

A very very simple mock object harness.

+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
MockFunctionCall +
MockObject +
MockTrace +
+
+
+

+ + + + + +
 
+class MockFunctionCall(__builtin__.object)
    Methods defined here:
+
VerifyEquals(self, got)
+ +
WhenCalled(self, handler)
+ +
WillReturn(self, value)
+ +
WithArgs(self, *args)
+ +
__init__(self, name)
+ +
__repr__(self)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+class MockObject(__builtin__.object)
    Methods defined here:
+
ExpectCall(self, func_name, *args)
+ +
__init__(self, parent_mock=None)
+ +
__setattr__(self, name, value)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+class MockTrace(__builtin__.object)
    Methods defined here:
+
__init__(self)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+Data
       DONT_CARE = ''
+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.unittest.system_stub.html b/tools/telemetry/docs/telemetry.unittest.system_stub.html new file mode 100644 index 0000000..cd380c7 --- /dev/null +++ b/tools/telemetry/docs/telemetry.unittest.system_stub.html @@ -0,0 +1,164 @@ + + +Python: module telemetry.unittest.system_stub + + + + +
 
+ 
telemetry.unittest.system_stub		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/system_stub.py
+

Provides stubs for os, sys and subprocess for testing
+ 
+This test allows one to test code that itself uses os, sys, and subprocess.

+

+ + + + + +
 
+Modules
       
os
+		re
+		sys
+		shlex
+

+ + + + + +
 
+Classes
       
+
__builtin__.object +
+
+
AdbCommandsModuleStub +
OsModuleStub +
Override +
SubprocessModuleStub +
SysModuleStub +
+
+
+

+ + + + + +
 
+class AdbCommandsModuleStub(__builtin__.object)
    Methods defined here:
+
GetAttachedDevices(self)
+ +
__init__(self)
+ +
+Static methods defined here:
+
HasForwarder(_=None)
+ +
IsAndroidSupported()
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes defined here:
+
AdbCommandsStub = <class 'telemetry.unittest.system_stub.AdbCommandsStub'>
+ +

+ + + + + +
 
+class OsModuleStub(__builtin__.object)
    Methods defined here:
+
__init__(self, sys_module=<module 'sys' (built-in)>)
+ +
getenv(self, name)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes defined here:
+
OsPathModuleStub = <class 'telemetry.unittest.system_stub.OsPathModuleStub'>
+ +

+ + + + + +
 
+class Override(__builtin__.object)
    Methods defined here:
+
Restore(self)
+ +
__del__(self)
+ +
__init__(self, base_module, module_list)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ + + + + +
 
+class SubprocessModuleStub(__builtin__.object)
    Methods defined here:
+
__init__(self)
+ +
call(self, *args, **kwargs)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes defined here:
+
PopenStub = <class 'telemetry.unittest.system_stub.PopenStub'>
+ +

+ + + + + +
 
+class SysModuleStub(__builtin__.object)
    Methods defined here:
+
__init__(self)
+ +
+Data descriptors defined here:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+

+ \ No newline at end of file diff --git a/tools/telemetry/docs/telemetry.unittest.tab_test_case.html b/tools/telemetry/docs/telemetry.unittest.tab_test_case.html new file mode 100644 index 0000000..8709440 --- /dev/null +++ b/tools/telemetry/docs/telemetry.unittest.tab_test_case.html @@ -0,0 +1,334 @@ + + +Python: module telemetry.unittest.tab_test_case + + + + +
 
+ 
telemetry.unittest.tab_test_case		index
/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/unittest/tab_test_case.py
+

# Copyright (c) 2012 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.

+

+ + + + + +
 
+Modules
       
telemetry.core.browser_finder
+		telemetry.unittest.options_for_unittests
+		unittest
+

+ + + + + +
 
+Classes
       
+
unittest.case.TestCase(__builtin__.object) +
+
+
TabTestCase +
+
+
+

+ + + + + +
 
+class TabTestCase(unittest.case.TestCase)
    
Method resolution order:
+
TabTestCase
+
unittest.case.TestCase
+
__builtin__.object
+
+
+Methods defined here:
+
CustomizeBrowserOptions(self, options)
Override to add test-specific options to the BrowserOptions object
+ +
__init__(self, *args)
+ +
setUp(self)
+ +
tearDown(self)
+ +
+Methods inherited from unittest.case.TestCase:
+
__call__(self, *args, **kwds)
+ +
__eq__(self, other)
+ +
__hash__(self)
+ +
__ne__(self, other)
+ +
__repr__(self)
+ +
__str__(self)
+ +
addCleanup(self, function, *args, **kwargs)
Add a function, with arguments, to be called when the test is
+completed. Functions added are called on a LIFO basis and are
+called after tearDown on test failure or success.
+ 
+Cleanup items are called even if setUp fails (unlike tearDown).
+ +
addTypeEqualityFunc(self, typeobj, function)
Add a type specific assertEqual style function to compare a type.
+ 
+This method is for use by TestCase subclasses that need to register
+their own type equality functions to provide nicer error messages.
+ 
+Args:
+    typeobj: The data type to call this function on when both values
+            are of the same type in assertEqual().
+    function: The callable taking two arguments and an optional
+            msg= argument that raises self.failureException with a
+            useful error message when the two arguments are not equal.
+ +
assertAlmostEqual(self, first, second, places=None, msg=None, delta=None)
Fail if the two objects are unequal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero, or by comparing that the
+between the two objects is more than the given delta.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ 
+If the two objects compare equal then they will automatically
+compare almost equal.
+ +
assertAlmostEquals = assertAlmostEqual(self, first, second, places=None, msg=None, delta=None)
Fail if the two objects are unequal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero, or by comparing that the
+between the two objects is more than the given delta.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ 
+If the two objects compare equal then they will automatically
+compare almost equal.
+ +
assertDictContainsSubset(self, expected, actual, msg=None)
Checks whether actual is a superset of expected.
+ +
assertDictEqual(self, d1, d2, msg=None)
+ +
assertEqual(self, first, second, msg=None)
Fail if the two objects are unequal as determined by the '=='
+operator.
+ +
assertEquals = assertEqual(self, first, second, msg=None)
Fail if the two objects are unequal as determined by the '=='
+operator.
+ +
assertFalse(self, expr, msg=None)
Check that the expression is false.
+ +
assertGreater(self, a, b, msg=None)
Just like assertTrue(a > b), but with a nicer default message.
+ +
assertGreaterEqual(self, a, b, msg=None)
Just like assertTrue(a >= b), but with a nicer default message.
+ +
assertIn(self, member, container, msg=None)
Just like assertTrue(a in b), but with a nicer default message.
+ +
assertIs(self, expr1, expr2, msg=None)
Just like assertTrue(a is b), but with a nicer default message.
+ +
assertIsInstance(self, obj, cls, msg=None)
Same as assertTrue(isinstance(obj, cls)), with a nicer
+default message.
+ +
assertIsNone(self, obj, msg=None)
Same as assertTrue(obj is None), with a nicer default message.
+ +
assertIsNot(self, expr1, expr2, msg=None)
Just like assertTrue(a is not b), but with a nicer default message.
+ +
assertIsNotNone(self, obj, msg=None)
Included for symmetry with assertIsNone.
+ +
assertItemsEqual(self, expected_seq, actual_seq, msg=None)
An unordered sequence specific comparison. It asserts that
+actual_seq and expected_seq have the same element counts.
+Equivalent to::
+ 
+    assertEqual(Counter(iter(actual_seq)),
+                     Counter(iter(expected_seq)))
+ 
+Asserts that each element has the same count in both sequences.
+Example:
+    - [0, 1, 1] and [1, 0, 1] compare equal.
+    - [0, 0, 1] and [0, 1] compare unequal.
+ +
assertLess(self, a, b, msg=None)
Just like assertTrue(a < b), but with a nicer default message.
+ +
assertLessEqual(self, a, b, msg=None)
Just like assertTrue(a <= b), but with a nicer default message.
+ +
assertListEqual(self, list1, list2, msg=None)
A list-specific equality assertion.
+ 
+Args:
+    list1: The first list to compare.
+    list2: The second list to compare.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ +
assertMultiLineEqual(self, first, second, msg=None)
Assert that two multi-line strings are equal.
+ +
assertNotAlmostEqual(self, first, second, places=None, msg=None, delta=None)
Fail if the two objects are equal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero, or by comparing that the
+between the two objects is less than the given delta.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ 
+Objects that are equal automatically fail.
+ +
assertNotAlmostEquals = assertNotAlmostEqual(self, first, second, places=None, msg=None, delta=None)
Fail if the two objects are equal as determined by their
+difference rounded to the given number of decimal places
+(default 7) and comparing to zero, or by comparing that the
+between the two objects is less than the given delta.
+ 
+Note that decimal places (from zero) are usually not the same
+as significant digits (measured from the most signficant digit).
+ 
+Objects that are equal automatically fail.
+ +
assertNotEqual(self, first, second, msg=None)
Fail if the two objects are equal as determined by the '=='
+operator.
+ +
assertNotEquals = assertNotEqual(self, first, second, msg=None)
Fail if the two objects are equal as determined by the '=='
+operator.
+ +
assertNotIn(self, member, container, msg=None)
Just like assertTrue(a not in b), but with a nicer default message.
+ +
assertNotIsInstance(self, obj, cls, msg=None)
Included for symmetry with assertIsInstance.
+ +
assertNotRegexpMatches(self, text, unexpected_regexp, msg=None)
Fail the test if the text matches the regular expression.
+ +
assertRaises(self, excClass, callableObj=None, *args, **kwargs)
Fail unless an exception of class excClass is thrown
+by callableObj when invoked with arguments args and keyword
+arguments kwargs. If a different type of exception is
+thrown, it will not be caught, and the test case will be
+deemed to have suffered an error, exactly as for an
+unexpected exception.
+ 
+If called with callableObj omitted or None, will return a
+context object used like this::
+ 
+     with assertRaises(SomeException):
+         do_something()
+ 
+The context manager keeps a reference to the exception as
+the 'exception' attribute. This allows you to inspect the
+exception after the assertion::
+ 
+    with assertRaises(SomeException) as cm:
+        do_something()
+    the_exception = cm.exception
+    assertEqual(the_exception.error_code, 3)
+ +
assertRaisesRegexp(self, expected_exception, expected_regexp, callable_obj=None, *args, **kwargs)
Asserts that the message in a raised exception matches a regexp.
+ 
+Args:
+    expected_exception: Exception class expected to be raised.
+    expected_regexp: Regexp (re pattern object or string) expected
+            to be found in error message.
+    callable_obj: Function to be called.
+    args: Extra args.
+    kwargs: Extra kwargs.
+ +
assertRegexpMatches(self, text, expected_regexp, msg=None)
Fail the test unless the text matches the regular expression.
+ +
assertSequenceEqual(self, seq1, seq2, msg=None, seq_type=None)
An equality assertion for ordered sequences (like lists and tuples).
+ 
+For the purposes of this function, a valid ordered sequence type is one
+which can be indexed, has a length, and has an equality operator.
+ 
+Args:
+    seq1: The first sequence to compare.
+    seq2: The second sequence to compare.
+    seq_type: The expected datatype of the sequences, or None if no
+            datatype should be enforced.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ +
assertSetEqual(self, set1, set2, msg=None)
A set-specific equality assertion.
+ 
+Args:
+    set1: The first set to compare.
+    set2: The second set to compare.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ 
+assertSetEqual uses ducktyping to support different types of sets, and
+is optimized for sets specifically (parameters must support a
+difference method).
+ +
assertTrue(self, expr, msg=None)
Check that the expression is true.
+ +
assertTupleEqual(self, tuple1, tuple2, msg=None)
A tuple-specific equality assertion.
+ 
+Args:
+    tuple1: The first tuple to compare.
+    tuple2: The second tuple to compare.
+    msg: Optional message to use on failure instead of a list of
+            differences.
+ +
assert_ = assertTrue(self, expr, msg=None)
Check that the expression is true.
+ +
countTestCases(self)
+ +
debug(self)
Run the test without collecting errors in a TestResult
+ +
defaultTestResult(self)
+ +
doCleanups(self)
Execute all cleanup functions. Normally called for you after
+tearDown.
+ +
fail(self, msg=None)
Fail immediately, with the given message.
+ +
failIf = deprecated_func(*args, **kwargs)
+ +
failIfAlmostEqual = deprecated_func(*args, **kwargs)
+ +
failIfEqual = deprecated_func(*args, **kwargs)
+ +
failUnless = deprecated_func(*args, **kwargs)
+ +
failUnlessAlmostEqual = deprecated_func(*args, **kwargs)
+ +
failUnlessEqual = deprecated_func(*args, **kwargs)
+ +
failUnlessRaises = deprecated_func(*args, **kwargs)
+ +
id(self)
+ +
run(self, result=None)
+ +
shortDescription(self)
Returns a one-line description of the test, or None if no
+description has been provided.
+ 
+The default implementation of this method returns the first line of
+the specified test method's docstring.
+ +
skipTest(self, reason)
Skip this test.
+ +
+Class methods inherited from unittest.case.TestCase:
+
setUpClass(cls) from __builtin__.type
Hook method for setting up class fixture before running tests in the class.
+ +
tearDownClass(cls) from __builtin__.type
Hook method for deconstructing the class fixture after running all tests in the class.
+ +
+Data descriptors inherited from unittest.case.TestCase:
+
__dict__
+
dictionary for instance variables (if defined)
+
+
__weakref__
+
list of weak references to the object (if defined)
+
+
+Data and other attributes inherited from unittest.case.TestCase:
+
failureException = <type 'exceptions.AssertionError'>
Assertion failed.
+ +
longMessage = False
+ +
maxDiff = 640
+ +

+ \ No newline at end of file diff --git a/tools/telemetry/telemetry/__init__.py b/tools/telemetry/telemetry/__init__.py index 19e6dbf..f3c162f 100644 --- a/tools/telemetry/telemetry/__init__.py +++ b/tools/telemetry/telemetry/__init__.py @@ -1,4 +1,29 @@ -# Copyright (c) 2012 The Chromium Authors. All rights reserved. +# Copyright (c) 2013 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. -"""A library for cross-platform browser tests.""" +""" +A library for cross-platform browser tests. +""" +import inspect +import sys + +from telemetry.core.browser import Browser +from telemetry.core.browser_options import BrowserOptions +from telemetry.core.tab import Tab + +from telemetry.page.page_measurement import PageMeasurement +from telemetry.page.page_runner import Run as RunPage + +__all__ = [] + +# Find all local vars that are classes or functions and make sure they're in the +# __all__ array so they're included in docs. +for x in dir(): + if x.startswith('_'): + continue + if x in (inspect, sys): + continue + m = sys.modules[__name__] + if (inspect.isclass(getattr(m, x)) or + inspect.isfunction(getattr(m, x))): + __all__.append(x) diff --git a/tools/telemetry/update_docs b/tools/telemetry/update_docs new file mode 100755 index 0000000..f2f92ac --- /dev/null +++ b/tools/telemetry/update_docs @@ -0,0 +1,11 @@ +#!/usr/bin/env python +# Copyright 2013 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. +import os +import sys + +from build import update_docs + +if __name__ == '__main__': + sys.exit(update_docs.Main(sys.argv[1:])) -- cgit v1.1