250 lines
16 KiB
HTML
250 lines
16 KiB
HTML
|
|
||
|
|
<!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> <br>
|
||
|
|
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="telemetry.html"><font color="#ffffff">telemetry</font></a>.<a href="telemetry.core.html"><font color="#ffffff">core</font></a>.<a href="telemetry.core.chrome.html"><font color="#ffffff">chrome</font></a>.cros_interface</strong></big></big></font></td
|
||
|
|
><td align=right valign=bottom
|
||
|
|
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="../telemetry/core/chrome/cros_interface.py">telemetry/core/chrome/cros_interface.py</a></font></td></tr></table>
|
||
|
|
<p><tt>A wrapper around ssh for common operations on a CrOS-based device</tt></p>
|
||
|
|
<p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#aa55cc">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></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><br>
|
||
|
|
<a href="os.html">os</a><br>
|
||
|
|
</td><td width="25%" valign=top><a href="re.html">re</a><br>
|
||
|
|
<a href="subprocess.html">subprocess</a><br>
|
||
|
|
</td><td width="25%" valign=top><a href="sys.html">sys</a><br>
|
||
|
|
<a href="tempfile.html">tempfile</a><br>
|
||
|
|
</td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#ee77aa">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
||
|
|
|
||
|
|
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
||
|
|
<td width="100%"><dl>
|
||
|
|
<dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
|
||
|
|
</font></dt><dd>
|
||
|
|
<dl>
|
||
|
|
<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.cros_interface.html#CrOSInterface">CrOSInterface</a>
|
||
|
|
</font></dt></dl>
|
||
|
|
</dd>
|
||
|
|
<dt><font face="helvetica, arial"><a href="exceptions.html#Exception">exceptions.Exception</a>(<a href="exceptions.html#BaseException">exceptions.BaseException</a>)
|
||
|
|
</font></dt><dd>
|
||
|
|
<dl>
|
||
|
|
<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.cros_interface.html#LoginException">LoginException</a>
|
||
|
|
</font></dt><dd>
|
||
|
|
<dl>
|
||
|
|
<dt><font face="helvetica, arial"><a href="telemetry.core.chrome.cros_interface.html#KeylessLoginRequiredException">KeylessLoginRequiredException</a>
|
||
|
|
</font></dt></dl>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#ffc8d8">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#000000" face="helvetica, arial"><a name="CrOSInterface">class <strong>CrOSInterface</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
|
||
|
|
|
||
|
|
<tr><td bgcolor="#ffc8d8"><tt> </tt></td><td> </td>
|
||
|
|
<td width="100%">Methods defined here:<br>
|
||
|
|
<dl><dt><a name="CrOSInterface-FileExistsOnDevice"><strong>FileExistsOnDevice</strong></a>(self, file_name, quiet<font color="#909090">=False</font>)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CrOSInterface-FilesystemMountedAt"><strong>FilesystemMountedAt</strong></a>(self, path)</dt><dd><tt>Returns the filesystem mounted at |path|</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CrOSInterface-FormSSHCommandLine"><strong>FormSSHCommandLine</strong></a>(self, args, extra_ssh_args<font color="#909090">=None</font>)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CrOSInterface-GetFileContents"><strong>GetFileContents</strong></a>(self, filename)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CrOSInterface-GetRemotePort"><strong>GetRemotePort</strong></a>(self)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CrOSInterface-IsHTTPServerRunningOnPort"><strong>IsHTTPServerRunningOnPort</strong></a>(self, port)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CrOSInterface-IsServiceRunning"><strong>IsServiceRunning</strong></a>(self, service_name)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CrOSInterface-KillAllMatching"><strong>KillAllMatching</strong></a>(self, predicate)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CrOSInterface-ListProcesses"><strong>ListProcesses</strong></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"><strong>PushContents</strong></a>(self, text, remote_filename)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CrOSInterface-PushFile"><strong>PushFile</strong></a>(self, filename, remote_filename)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CrOSInterface-RmRF"><strong>RmRF</strong></a>(self, filename)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CrOSInterface-RunCmdOnDevice"><strong>RunCmdOnDevice</strong></a>(self, args, cwd<font color="#909090">=None</font>, quiet<font color="#909090">=False</font>)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CrOSInterface-TryLogin"><strong>TryLogin</strong></a>(self)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="CrOSInterface-__init__"><strong>__init__</strong></a>(self, hostname<font color="#909090">=None</font>, ssh_identity<font color="#909090">=None</font>)</dt><dd><tt># pylint: disable=R0923</tt></dd></dl>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
Data descriptors defined here:<br>
|
||
|
|
<dl><dt><strong>__dict__</strong></dt>
|
||
|
|
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt><strong>__weakref__</strong></dt>
|
||
|
|
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
||
|
|
</dl>
|
||
|
|
<dl><dt><strong>hostname</strong></dt>
|
||
|
|
</dl>
|
||
|
|
<dl><dt><strong>local</strong></dt>
|
||
|
|
</dl>
|
||
|
|
</td></tr></table> <p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#ffc8d8">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#000000" face="helvetica, arial"><a name="KeylessLoginRequiredException">class <strong>KeylessLoginRequiredException</strong></a>(<a href="telemetry.core.chrome.cros_interface.html#LoginException">LoginException</a>)</font></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>:<br>
|
||
|
|
<dl><dt><strong>__weakref__</strong></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>:<br>
|
||
|
|
<dl><dt><a name="KeylessLoginRequiredException-__init__"><strong>__init__</strong></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>:<br>
|
||
|
|
<dl><dt><strong>__new__</strong> = <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>:<br>
|
||
|
|
<dl><dt><a name="KeylessLoginRequiredException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="KeylessLoginRequiredException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="KeylessLoginRequiredException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="KeylessLoginRequiredException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
|
||
|
|
<br>
|
||
|
|
Use of negative indices is not supported.</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="KeylessLoginRequiredException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="KeylessLoginRequiredException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="KeylessLoginRequiredException-__setattr__"><strong>__setattr__</strong></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__"><strong>__setstate__</strong></a>(...)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="KeylessLoginRequiredException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#KeylessLoginRequiredException-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="KeylessLoginRequiredException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
||
|
|
<dl><dt><strong>__dict__</strong></dt>
|
||
|
|
</dl>
|
||
|
|
<dl><dt><strong>args</strong></dt>
|
||
|
|
</dl>
|
||
|
|
<dl><dt><strong>message</strong></dt>
|
||
|
|
</dl>
|
||
|
|
</td></tr></table> <p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#ffc8d8">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#000000" face="helvetica, arial"><a name="LoginException">class <strong>LoginException</strong></a>(<a href="exceptions.html#Exception">exceptions.Exception</a>)</font></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:<br>
|
||
|
|
<dl><dt><strong>__weakref__</strong></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>:<br>
|
||
|
|
<dl><dt><a name="LoginException-__init__"><strong>__init__</strong></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>:<br>
|
||
|
|
<dl><dt><strong>__new__</strong> = <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>:<br>
|
||
|
|
<dl><dt><a name="LoginException-__delattr__"><strong>__delattr__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__delattr__">__delattr__</a>('name') <==> del x.name</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="LoginException-__getattribute__"><strong>__getattribute__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__getattribute__">__getattribute__</a>('name') <==> x.name</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="LoginException-__getitem__"><strong>__getitem__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__getitem__">__getitem__</a>(y) <==> x[y]</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="LoginException-__getslice__"><strong>__getslice__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__getslice__">__getslice__</a>(i, j) <==> x[i:j]<br>
|
||
|
|
<br>
|
||
|
|
Use of negative indices is not supported.</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="LoginException-__reduce__"><strong>__reduce__</strong></a>(...)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="LoginException-__repr__"><strong>__repr__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__repr__">__repr__</a>() <==> repr(x)</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="LoginException-__setattr__"><strong>__setattr__</strong></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__"><strong>__setstate__</strong></a>(...)</dt></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="LoginException-__str__"><strong>__str__</strong></a>(...)</dt><dd><tt>x.<a href="#LoginException-__str__">__str__</a>() <==> str(x)</tt></dd></dl>
|
||
|
|
|
||
|
|
<dl><dt><a name="LoginException-__unicode__"><strong>__unicode__</strong></a>(...)</dt></dl>
|
||
|
|
|
||
|
|
<hr>
|
||
|
|
Data descriptors inherited from <a href="exceptions.html#BaseException">exceptions.BaseException</a>:<br>
|
||
|
|
<dl><dt><strong>__dict__</strong></dt>
|
||
|
|
</dl>
|
||
|
|
<dl><dt><strong>args</strong></dt>
|
||
|
|
</dl>
|
||
|
|
<dl><dt><strong>message</strong></dt>
|
||
|
|
</dl>
|
||
|
|
</td></tr></table></td></tr></table><p>
|
||
|
|
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
||
|
|
<tr bgcolor="#eeaa77">
|
||
|
|
<td colspan=3 valign=bottom> <br>
|
||
|
|
<font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
|
||
|
|
|
||
|
|
<tr><td bgcolor="#eeaa77"><tt> </tt></td><td> </td>
|
||
|
|
<td width="100%"><dl><dt><a name="-GetAllCmdOutput"><strong>GetAllCmdOutput</strong></a>(args, cwd<font color="#909090">=None</font>, quiet<font color="#909090">=False</font>)</dt><dd><tt>Open a subprocess to execute a program and returns its output.<br>
|
||
|
|
<br>
|
||
|
|
Args:<br>
|
||
|
|
args: A string or a sequence of program arguments. The program to execute is<br>
|
||
|
|
the string or the first item in the args sequence.<br>
|
||
|
|
cwd: If not None, the subprocess's current directory will be changed to<br>
|
||
|
|
|cwd| before it's executed.<br>
|
||
|
|
<br>
|
||
|
|
Returns:<br>
|
||
|
|
Captures and returns the command's stdout.<br>
|
||
|
|
Prints the command's stderr to logger (which defaults to stdout).</tt></dd></dl>
|
||
|
|
<dl><dt><a name="-HasSSH"><strong>HasSSH</strong></a>()</dt></dl>
|
||
|
|
<dl><dt><a name="-IsRunningOnCrosDevice"><strong>IsRunningOnCrosDevice</strong></a>()</dt><dd><tt>Returns True if we're on a ChromeOS device.</tt></dd></dl>
|
||
|
|
<dl><dt><a name="-RunCmd"><strong>RunCmd</strong></a>(args, cwd<font color="#909090">=None</font>, quiet<font color="#909090">=False</font>)</dt><dd><tt>Opens a subprocess to execute a program and returns its return value.<br>
|
||
|
|
<br>
|
||
|
|
Args:<br>
|
||
|
|
args: A string or a sequence of program arguments. The program to execute is<br>
|
||
|
|
the string or the first item in the args sequence.<br>
|
||
|
|
cwd: If not None, the subprocess's current directory will be changed to<br>
|
||
|
|
|cwd| before it's executed.<br>
|
||
|
|
<br>
|
||
|
|
Returns:<br>
|
||
|
|
Return code from the command execution.</tt></dd></dl>
|
||
|
|
</td></tr></table>
|
||
|
|
</body></html>
|