telemetry.page.shared_page_state | index telemetry/page/shared_page_state.py

`# Copyright 2014 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.internal.browser.browser_finder telemetry.internal.browser.browser_finder_exceptions telemetry.internal.browser.browser_info catapult_base.cloud_storage telemetry.decorators
telemetry.internal.util.exception_formatter
telemetry.core.exceptions
telemetry.internal.util.file_handle
telemetry.util.image_util
logging
os
telemetry.page.page_test
telemetry.internal.platform.profiler.profiler_finder
shutil
telemetry.story
sys
tempfile
telemetry.web_perf.timeline_based_measurement
telemetry.core.util
telemetry.util.wpr_modes
zipfile

Classes
`` |  |

telemetry.story.shared_state.SharedState(__builtin__.object)
  SharedPageState
    Shared10InchTabletPageState
    SharedDesktopPageState
    SharedMobilePageState
    SharedTabletPageState

class Shared10InchTabletPageState(SharedPageState)
`` |  |

Method resolution order:
  Shared10InchTabletPageState
  SharedPageState
  telemetry.story.shared_state.SharedState
  __builtin__.object

Methods inherited from SharedPageState:

CanRunOnBrowser(self, browser_info, page)
  `Override this to return whether the browser brought up by this state
  instance is suitable for running the given page.
  Args:
  browser_info: an instance of telemetry.core.browser_info.BrowserInfo
  page: an instance of telemetry.page.Page`

CanRunStory(self, page)

DidRunStory(self, results)

GetPregeneratedProfileArchiveDir(self)

RunStory(self, results)

SetPregeneratedProfileArchiveDir(self, archive_path)
  `Benchmarks can set a pre-generated profile archive to indicate that when
  Chrome is launched, it should have a --user-data-dir set to the
  pregenerated profile, rather than to an empty profile.
  If the benchmark is invoked with the option --profile-dir=<dir>, that
  option overrides this value.`

TearDownState(self)

WillRunStory(self, page)

__init__(self, test, finder_options, story_set)

Data descriptors inherited from SharedPageState:

browser

current_page

current_tab

page_test

platform

Data descriptors inherited from telemetry.story.shared_state.SharedState:

__dict__
  `dictionary for instance variables (if defined)`

__weakref__
  `list of weak references to the object (if defined)`

class SharedDesktopPageState(SharedPageState)
`` |  |

Method resolution order:
  SharedDesktopPageState
  SharedPageState
  telemetry.story.shared_state.SharedState
  __builtin__.object

Methods inherited from SharedPageState:

CanRunOnBrowser(self, browser_info, page)
  `Override this to return whether the browser brought up by this state
  instance is suitable for running the given page.
  Args:
  browser_info: an instance of telemetry.core.browser_info.BrowserInfo
  page: an instance of telemetry.page.Page`

CanRunStory(self, page)

DidRunStory(self, results)

GetPregeneratedProfileArchiveDir(self)

RunStory(self, results)

SetPregeneratedProfileArchiveDir(self, archive_path)
  `Benchmarks can set a pre-generated profile archive to indicate that when
  Chrome is launched, it should have a --user-data-dir set to the
  pregenerated profile, rather than to an empty profile.
  If the benchmark is invoked with the option --profile-dir=<dir>, that
  option overrides this value.`

TearDownState(self)

WillRunStory(self, page)

__init__(self, test, finder_options, story_set)

Data descriptors inherited from SharedPageState:

browser

current_page

current_tab

page_test

platform

Data descriptors inherited from telemetry.story.shared_state.SharedState:

__dict__
  `dictionary for instance variables (if defined)`

__weakref__
  `list of weak references to the object (if defined)`

class SharedMobilePageState(SharedPageState)
`` |  |

Method resolution order:
  SharedMobilePageState
  SharedPageState
  telemetry.story.shared_state.SharedState
  __builtin__.object

Methods inherited from SharedPageState:

CanRunOnBrowser(self, browser_info, page)
  `Override this to return whether the browser brought up by this state
  instance is suitable for running the given page.
  Args:
  browser_info: an instance of telemetry.core.browser_info.BrowserInfo
  page: an instance of telemetry.page.Page`

CanRunStory(self, page)

DidRunStory(self, results)

GetPregeneratedProfileArchiveDir(self)

RunStory(self, results)

SetPregeneratedProfileArchiveDir(self, archive_path)
  `Benchmarks can set a pre-generated profile archive to indicate that when
  Chrome is launched, it should have a --user-data-dir set to the
  pregenerated profile, rather than to an empty profile.
  If the benchmark is invoked with the option --profile-dir=<dir>, that
  option overrides this value.`

TearDownState(self)

WillRunStory(self, page)

__init__(self, test, finder_options, story_set)

Data descriptors inherited from SharedPageState:

browser

current_page

current_tab

page_test

platform

Data descriptors inherited from telemetry.story.shared_state.SharedState:

__dict__
  `dictionary for instance variables (if defined)`

__weakref__
  `list of weak references to the object (if defined)`

class SharedPageState(telemetry.story.shared_state.SharedState)
`` | `This class contains all specific logic necessary to run a Chrome browser benchmark.`

Method resolution order:
  SharedPageState
  telemetry.story.shared_state.SharedState
  __builtin__.object

Methods defined here:

CanRunOnBrowser(self, browser_info, page)
  `Override this to return whether the browser brought up by this state
  instance is suitable for running the given page.
  Args:
  browser_info: an instance of telemetry.core.browser_info.BrowserInfo
  page: an instance of telemetry.page.Page`

CanRunStory(self, page)

DidRunStory(self, results)

GetPregeneratedProfileArchiveDir(self)

RunStory(self, results)

SetPregeneratedProfileArchiveDir(self, archive_path)
  `Benchmarks can set a pre-generated profile archive to indicate that when
  Chrome is launched, it should have a --user-data-dir set to the
  pregenerated profile, rather than to an empty profile.
  If the benchmark is invoked with the option --profile-dir=<dir>, that
  option overrides this value.`

TearDownState(self)

WillRunStory(self, page)

__init__(self, test, finder_options, story_set)

Data descriptors defined here:

browser

current_page

current_tab

page_test

platform

Data descriptors inherited from telemetry.story.shared_state.SharedState:

__dict__
  `dictionary for instance variables (if defined)`

__weakref__
  `list of weak references to the object (if defined)`

class SharedTabletPageState(SharedPageState)
`` |  |

Method resolution order:
  SharedTabletPageState
  SharedPageState
  telemetry.story.shared_state.SharedState
  __builtin__.object

Methods inherited from SharedPageState:

CanRunOnBrowser(self, browser_info, page)
  `Override this to return whether the browser brought up by this state
  instance is suitable for running the given page.
  Args:
  browser_info: an instance of telemetry.core.browser_info.BrowserInfo
  page: an instance of telemetry.page.Page`

CanRunStory(self, page)

DidRunStory(self, results)

GetPregeneratedProfileArchiveDir(self)

RunStory(self, results)

SetPregeneratedProfileArchiveDir(self, archive_path)
  `Benchmarks can set a pre-generated profile archive to indicate that when
  Chrome is launched, it should have a --user-data-dir set to the
  pregenerated profile, rather than to an empty profile.
  If the benchmark is invoked with the option --profile-dir=<dir>, that
  option overrides this value.`

TearDownState(self)

WillRunStory(self, page)

__init__(self, test, finder_options, story_set)

Data descriptors inherited from SharedPageState:

browser

current_page

current_tab

page_test

platform

Data descriptors inherited from telemetry.story.shared_state.SharedState:

__dict__
  `dictionary for instance variables (if defined)`

__weakref__
  `list of weak references to the object (if defined)`