tools/telemetry/docs/telemetry.core.chrome.cros_interface.html - Issue 196383034: Update telemetry docs by running the update_docs script.

Unified Diff: tools/telemetry/docs/telemetry.core.chrome.cros_interface.html

Issue 196383034: Update telemetry docs by running the update_docs script. (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: Created 6 years, 9 months ago

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

Jump to:

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

Download patch

« no previous file with comments | « tools/telemetry/docs/telemetry.core.chrome.cros_browser_finder.html ('k') | tools/telemetry/docs/telemetry.core.chrome.crx_id.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

Index: tools/telemetry/docs/telemetry.core.chrome.cros_interface.html

diff --git a/tools/telemetry/docs/telemetry.core.chrome.cros_interface.html b/tools/telemetry/docs/telemetry.core.chrome.cros_interface.html

deleted file mode 100644

index 205da41475349e0d65bf89011ab8750eebc0eca0..0000000000000000000000000000000000000000

--- a/tools/telemetry/docs/telemetry.core.chrome.cros_interface.html

+++ /dev/null

@@ -1,250 +0,0 @@

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

-<html><head><title>Python: module telemetry.core.chrome.cros_interface</title>

-</head><body bgcolor="#f0f0f8">

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

-<tr bgcolor="#7799ee">

-<td valign=bottom>

-  <big><big><a href="telemetry.html">telemetry</a>.<a href="telemetry.core.html">core</a>.<a href="telemetry.core.chrome.html">chrome</a>.cros_interface</big></big></td

-><td align=right valign=bottom

-><a href=".">index</a> <a href="../telemetry/core/chrome/cros_interface.py">telemetry/core/chrome/cros_interface.py</a></td></tr></table>

- <tt>A wrapper around ssh for common operations on a CrOS-based device</tt>

-

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

-<tr bgcolor="#aa55cc">

-<td colspan=3 valign=bottom>

-<big>Modules</big></td></tr>

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

-<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="logging.html">logging</a>

-<a href="os.html">os</a>

-</td><td width="25%" valign=top><a href="re.html">re</a>

-<a href="subprocess.html">subprocess</a>

-</td><td width="25%" valign=top><a href="sys.html">sys</a>

-<a href="tempfile.html">tempfile</a>

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

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

-<tr bgcolor="#ee77aa">

-<td colspan=3 valign=bottom>

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

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

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

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

-</dt><dd>

-<dl>

-<dt><a href="telemetry.core.chrome.cros_interface.html#CrOSInterface">CrOSInterface</a>

-</dt></dl>

-</dd>

-<dt><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)

-</dt><dd>

-<dl>

-<dt><a href="telemetry.core.chrome.cros_interface.html#LoginException">LoginException</a>

-</dt><dd>

-<dl>

-<dt><a href="telemetry.core.chrome.cros_interface.html#KeylessLoginRequiredException">KeylessLoginRequiredException</a>

-</dt></dl>

-</dd>

-</dl>

-</dd>

-</dl>

-

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

-<tr bgcolor="#ffc8d8">

-<td colspan=3 valign=bottom>

-<a name="CrOSInterface">class CrOSInterface</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</td></tr>

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

-<td width="100%">Methods defined here:

-<dl><dt><a name="CrOSInterface-FileExistsOnDevice">FileExistsOnDevice</a>(self, file_name, quiet=False)</dt></dl>

-<dl><dt><a name="CrOSInterface-FilesystemMountedAt">FilesystemMountedAt</a>(self, path)</dt><dd><tt>Returns the filesystem mounted at |path|</tt></dd></dl>

-<dl><dt><a name="CrOSInterface-FormSSHCommandLine">FormSSHCommandLine</a>(self, args, extra_ssh_args=None)</dt></dl>

-<dl><dt><a name="CrOSInterface-GetFileContents">GetFileContents</a>(self, filename)</dt></dl>

-<dl><dt><a name="CrOSInterface-GetRemotePort">GetRemotePort</a>(self)</dt></dl>

-<dl><dt><a name="CrOSInterface-IsHTTPServerRunningOnPort">IsHTTPServerRunningOnPort</a>(self, port)</dt></dl>

-<dl><dt><a name="CrOSInterface-IsServiceRunning">IsServiceRunning</a>(self, service_name)</dt></dl>

-<dl><dt><a name="CrOSInterface-KillAllMatching">KillAllMatching</a>(self, predicate)</dt></dl>

-<dl><dt><a name="CrOSInterface-ListProcesses">ListProcesses</a>(self)</dt><dd><tt>Returns a tuple (pid, cmd, ppid) of all processes on the device.</tt></dd></dl>

-<dl><dt><a name="CrOSInterface-PushContents">PushContents</a>(self, text, remote_filename)</dt></dl>

-<dl><dt><a name="CrOSInterface-PushFile">PushFile</a>(self, filename, remote_filename)</dt></dl>

-<dl><dt><a name="CrOSInterface-RmRF">RmRF</a>(self, filename)</dt></dl>

-<dl><dt><a name="CrOSInterface-RunCmdOnDevice">RunCmdOnDevice</a>(self, args, cwd=None, quiet=False)</dt></dl>

-<dl><dt><a name="CrOSInterface-TryLogin">TryLogin</a>(self)</dt></dl>

-<dl><dt><a name="CrOSInterface-__init__">__init__</a>(self, hostname=None, ssh_identity=None)</dt><dd><tt># pylint: disable=R0923</tt></dd></dl>

-<hr>

-Data descriptors defined here:

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

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

-</dl>

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

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

-</dl>

-<dl><dt>hostname</dt>

-</dl>

-<dl><dt>local</dt>

-</dl>

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

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

-<tr bgcolor="#ffc8d8">

-<td colspan=3 valign=bottom>

-<a name="KeylessLoginRequiredException">class KeylessLoginRequiredException</a>(<a href="telemetry.core.chrome.cros_interface.html#LoginException">LoginException</a>)</td></tr>

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

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

-<dd><a href="telemetry.core.chrome.cros_interface.html#KeylessLoginRequiredException">KeylessLoginRequiredException</a></dd>

-<dd><a href="telemetry.core.chrome.cros_interface.html#LoginException">LoginException</a></dd>

-<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

-<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

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

-</dl>

-<hr>

-Data descriptors inherited from <a href="telemetry.core.chrome.cros_interface.html#LoginException">LoginException</a>:

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

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

-</dl>

-<hr>

-Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

-<dl><dt><a name="KeylessLoginRequiredException-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

-<hr>

-Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

-<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#KeylessLoginRequiredException-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>

-<hr>

-Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

-<dl><dt><a name="KeylessLoginRequiredException-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

-<dl><dt><a name="KeylessLoginRequiredException-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

-<dl><dt><a name="KeylessLoginRequiredException-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

-<dl><dt><a name="KeylessLoginRequiredException-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

-

-Use of negative indices is not supported.</tt></dd></dl>

-<dl><dt><a name="KeylessLoginRequiredException-__reduce__">__reduce__</a>(...)</dt></dl>

-<dl><dt><a name="KeylessLoginRequiredException-__repr__">__repr__</a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>

-<dl><dt><a name="KeylessLoginRequiredException-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

-<dl><dt><a name="KeylessLoginRequiredException-__setstate__">__setstate__</a>(...)</dt></dl>

-<dl><dt><a name="KeylessLoginRequiredException-__str__">__str__</a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__str__">__str__</a>() <==> str(x)</tt></dd></dl>

-<dl><dt><a name="KeylessLoginRequiredException-__unicode__">__unicode__</a>(...)</dt></dl>

-<hr>

-Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

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

-</dl>

-<dl><dt>args</dt>

-</dl>

-<dl><dt>message</dt>

-</dl>

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

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

-<tr bgcolor="#ffc8d8">

-<td colspan=3 valign=bottom>

-<a name="LoginException">class LoginException</a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</td></tr>

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

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

-<dd><a href="telemetry.core.chrome.cros_interface.html#LoginException">LoginException</a></dd>

-<dd><a href="exceptions.html#Exception">exceptions.Exception</a></dd>

-<dd><a href="exceptions.html#BaseException">exceptions.BaseException</a></dd>

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

-</dl>

-<hr>

-Data descriptors defined here:

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

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

-</dl>

-<hr>

-Methods inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

-<dl><dt><a name="LoginException-__init__">__init__</a>(...)</dt><dd><tt>x.<a href="#LoginException-__init__">__init__</a>(...) initializes x; see help(type(x)) for signature</tt></dd></dl>

-<hr>

-Data and other attributes inherited from <a href="exceptions.html#Exception">exceptions.Exception</a>:

-<dl><dt>__new__ = <built-in method __new__ of type object><dd><tt>T.<a href="#LoginException-__new__">__new__</a>(S, ...) -> a new <a href="__builtin__.html#object">object</a> with type S, a subtype of T</tt></dl>

-<hr>

-Methods inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

-<dl><dt><a name="LoginException-__delattr__">__delattr__</a>(...)</dt><dd><tt>x.<a href="#LoginException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>

-<dl><dt><a name="LoginException-__getattribute__">__getattribute__</a>(...)</dt><dd><tt>x.<a href="#LoginException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>

-<dl><dt><a name="LoginException-__getitem__">__getitem__</a>(...)</dt><dd><tt>x.<a href="#LoginException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>

-<dl><dt><a name="LoginException-__getslice__">__getslice__</a>(...)</dt><dd><tt>x.<a href="#LoginException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]

-

-Use of negative indices is not supported.</tt></dd></dl>

-<dl><dt><a name="LoginException-__reduce__">__reduce__</a>(...)</dt></dl>

-<dl><dt><a name="LoginException-__repr__">__repr__</a>(...)</dt><dd><tt>x.<a href="#LoginException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>

-<dl><dt><a name="LoginException-__setattr__">__setattr__</a>(...)</dt><dd><tt>x.<a href="#LoginException-__setattr__">__setattr__</a>('name', value) <==> x.name = value</tt></dd></dl>

-<dl><dt><a name="LoginException-__setstate__">__setstate__</a>(...)</dt></dl>

-<dl><dt><a name="LoginException-__str__">__str__</a>(...)</dt><dd><tt>x.<a href="#LoginException-__str__">__str__</a>() <==> str(x)</tt></dd></dl>

-<dl><dt><a name="LoginException-__unicode__">__unicode__</a>(...)</dt></dl>

-<hr>

-Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:

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

-</dl>

-<dl><dt>args</dt>

-</dl>

-<dl><dt>message</dt>

-</dl>

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

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

-<tr bgcolor="#eeaa77">

-<td colspan=3 valign=bottom>

-<big>Functions</big></td></tr>

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

-<td width="100%"><dl><dt><a name="-GetAllCmdOutput">GetAllCmdOutput</a>(args, cwd=None, quiet=False)</dt><dd><tt>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).</tt></dd></dl>

- <dl><dt><a name="-HasSSH">HasSSH</a>()</dt></dl>

- <dl><dt><a name="-IsRunningOnCrosDevice">IsRunningOnCrosDevice</a>()</dt><dd><tt>Returns True if we're on a ChromeOS device.</tt></dd></dl>

- <dl><dt><a name="-RunCmd">RunCmd</a>(args, cwd=None, quiet=False)</dt><dd><tt>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.</tt></dd></dl>

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

-</body></html>