tools/telemetry/docs/telemetry.core.chrome.adb_commands.html - Issue 17150002: [telemetry] Initial (autogenerated) documentation plus support scripts

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

Issue 17150002: [telemetry] Initial (autogenerated) documentation plus support scripts (Closed) Base URL: svn://svn.chromium.org/chrome/trunk/src

Patch Set: update with nits Created 7 years, 6 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.html ('k') | tools/telemetry/docs/telemetry.core.chrome.android_browser_backend.html » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

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

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 0000000000000000000000000000000000000000..7aa7d88c41034aeeef45eb43c760d7b32f7195d0

--- /dev/null

+++ b/tools/telemetry/docs/telemetry.core.chrome.adb_commands.html

@@ -0,0 +1,165 @@

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

+<html><head><title>Python: module telemetry.core.chrome.adb_commands</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>.adb_commands</big></big></td

+><td align=right valign=bottom

+><a href=".">index</a> <a href="file:/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/adb_commands.py">/Users/nduca/Local/chrome/src/tools/telemetry/telemetry/core/chrome/adb_commands.py</a></td></tr></table>

+ <tt>Brings in Chrome Android's android_commands module, which itself is a

+thin(ish) wrapper around adb.</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="pylib.android_commands.html">pylib.android_commands</a>

+<a href="pylib.cmd_helper.html">pylib.cmd_helper</a>

+</td><td width="25%" valign=top><a href="pylib.forwarder.html">pylib.forwarder</a>

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

+</td><td width="25%" valign=top><a href="pylib.ports.html">pylib.ports</a>

+<a href="sys.html">sys</a>

+</td><td width="25%" valign=top><a href="pylib.valgrind_tools.html">pylib.valgrind_tools</a>

+</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.adb_commands.html#AdbCommands">AdbCommands</a>

+</dt><dt><a href="telemetry.core.chrome.adb_commands.html#Forwarder">Forwarder</a>

+</dt></dl>

+</dd>

+</dl>

+

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

+<tr bgcolor="#ffc8d8">

+<td colspan=3 valign=bottom>

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

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

+<td colspan=2><tt>A thin wrapper around ADB  </tt></td></tr>

+<tr><td> </td>

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

+<dl><dt><a name="AdbCommands-Adb">Adb</a>(self)</dt></dl>

+<dl><dt><a name="AdbCommands-CloseApplication">CloseApplication</a>(self, package)</dt><dd><tt>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</tt></dd></dl>

+<dl><dt><a name="AdbCommands-ExtractPid">ExtractPid</a>(self, process_name)</dt><dd><tt>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.</tt></dd></dl>

+<dl><dt><a name="AdbCommands-FileExistsOnDevice">FileExistsOnDevice</a>(self, file_name)</dt></dl>

+<dl><dt><a name="AdbCommands-Forward">Forward</a>(self, local, remote)</dt></dl>

+<dl><dt><a name="AdbCommands-IsRootEnabled">IsRootEnabled</a>(self)</dt></dl>

+<dl><dt><a name="AdbCommands-KillAll">KillAll</a>(self, process)</dt><dd><tt>Android version of killall, connected via adb.

+

+Args:

+  process: name of the process to kill off

+

+Returns:

+  the number of processess killed</tt></dd></dl>

+<dl><dt><a name="AdbCommands-Pull">Pull</a>(self, remote, local)</dt></dl>

+<dl><dt><a name="AdbCommands-Push">Push</a>(self, local, remote)</dt></dl>

+<dl><dt><a name="AdbCommands-RunShellCommand">RunShellCommand</a>(self, command, timeout_time=20, log_result=False)</dt><dd><tt>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</tt></dd></dl>

+<dl><dt><a name="AdbCommands-StartActivity">StartActivity</a>(self, package, activity, wait_for_completion=False, action='android.intent.action.VIEW', category=None, data=None, extras=None, trace_file_name=None)</dt><dd><tt>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. '<a href="http://www.example.com/">http://www.example.com/</a>').

+  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.</tt></dd></dl>

+<dl><dt><a name="AdbCommands-__init__">__init__</a>(self, device)</dt></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>

+</td></tr></table>

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

+<tr bgcolor="#ffc8d8">

+<td colspan=3 valign=bottom>

+<a name="Forwarder">class Forwarder</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="Forwarder-Close">Close</a>(self)</dt></dl>

+<dl><dt><a name="Forwarder-__init__">__init__</a>(self, adb, *port_pairs)</dt></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>url</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="-AllocateTestServerPort">AllocateTestServerPort</a>()</dt></dl>

+ <dl><dt><a name="-GetAttachedDevices">GetAttachedDevices</a>()</dt><dd><tt>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.</tt></dd></dl>

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

+ <dl><dt><a name="-HasForwarder">HasForwarder</a>(buildtype=None)</dt></dl>

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

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

+</td></tr></table>

+</body></html>