Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(19)

Side by Side Diff: devil/docs/adb_wrapper.md

Issue 2707113002: [devil] Add an iteration timeout option to cmd_helper.IterCmdStdoutLines. (Closed)
Patch Set: mikecase comments Created 3 years, 10 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 unified diff | Download patch
« no previous file with comments | « devil/devil/utils/cmd_helper_test.py ('k') | devil/docs/device_utils.md » ('j') | no next file with comments »
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
OLDNEW
1 # [devil.android.sdk.adb_wrapper](https://github.com/catapult-project/catapult/b lob/master/devil/devil/android/sdk/adb_wrapper.py) 1 # [devil.android.sdk.adb_wrapper](https://github.com/catapult-project/catapult/b lob/master/devil/devil/android/sdk/adb_wrapper.py)
2 2
3 *This page was autogenerated by `devil/utils/markdown.py --module-link https://g ithub.com/catapult-project/catapult/blob/master/devil/devil/android/sdk/adb_wrap per.py`* 3 *This page was autogenerated by `devil/utils/markdown.py --module-link https://g ithub.com/catapult-project/catapult/blob/master/devil/devil/android/sdk/adb_wrap per.py`*
4 4
5 ## DeviceStat
6
7 DeviceStat(st\_mode, st\_size, st\_time)
8 ### DeviceStat.\_\_repr\_\_
9
10 Return a nicely formatted representation string
11 ### DeviceStat.\_\_getnewargs\_\_
12
13 Return self as a plain tuple. Used by copy and pickle.
14 ### DeviceStat.\_\_getstate\_\_
15
16 Exclude the OrderedDict from pickling
5 ## AdbWrapper 17 ## AdbWrapper
6 18
7 A wrapper around a local Android Debug Bridge executable. 19 A wrapper around a local Android Debug Bridge executable.
8 ### AdbWrapper.\_\_init\_\_
9
10 Initializes the AdbWrapper.
11 ```
12 Args:
13 device_serial: The device serial number as a string.
14 ```
15
16
17 ### AdbWrapper.\_\_eq\_\_
18
19 Consider instances equal if they refer to the same device.
20 ```
21 Args:
22 other: The instance to compare equality with.
23
24 Returns:
25 True if the instances are considered equal, false otherwise.
26 ```
27
28
29 ### AdbWrapper.\_\_str\_\_
30
31 The string representation of an instance.
32 ```
33 Returns:
34 The device serial number as a string.
35 ```
36
37
38 ### AdbWrapper.\_\_repr\_\_
39
40 ### AdbWrapper.GetDeviceSerial 20 ### AdbWrapper.GetDeviceSerial
41 21
42 Gets the device serial number associated with this object. 22 Gets the device serial number associated with this object.
43 ``` 23 ```
44 Returns: 24 Returns:
45 Device serial number as a string. 25 Device serial number as a string.
46 ``` 26 ```
47 27
48 28
49 ### AdbWrapper.Push 29 ### AdbWrapper.Push
(...skipping 80 matching lines...) Expand 10 before | Expand all | Expand 10 after
130 Args: 110 Args:
131 clear: If true, clear the logcat. 111 clear: If true, clear the logcat.
132 dump: If true, dump the current logcat contents. 112 dump: If true, dump the current logcat contents.
133 filter_specs: If set, a list of specs to filter the logcat. 113 filter_specs: If set, a list of specs to filter the logcat.
134 logcat_format: If set, the format in which the logcat should be output. 114 logcat_format: If set, the format in which the logcat should be output.
135 Options include "brief", "process", "tag", "thread", "raw", "time", 115 Options include "brief", "process", "tag", "thread", "raw", "time",
136 "threadtime", and "long" 116 "threadtime", and "long"
137 ring_buffer: If set, a list of alternate ring buffers to request. 117 ring_buffer: If set, a list of alternate ring buffers to request.
138 Options include "main", "system", "radio", "events", "crash" or "all". 118 Options include "main", "system", "radio", "events", "crash" or "all".
139 The default is equivalent to ["main", "system", "crash"]. 119 The default is equivalent to ["main", "system", "crash"].
120 iter_timeout: If set and neither clear nor dump is set, the number of
121 seconds to wait between iterations. If no line is found before the
122 given number of seconds elapses, the iterable will yield None.
140 timeout: (optional) If set, timeout per try in seconds. If clear or dump 123 timeout: (optional) If set, timeout per try in seconds. If clear or dump
141 is set, defaults to DEFAULT_TIMEOUT. 124 is set, defaults to DEFAULT_TIMEOUT.
142 retries: (optional) If clear or dump is set, the number of retries to 125 retries: (optional) If clear or dump is set, the number of retries to
143 attempt. Otherwise, does nothing. 126 attempt. Otherwise, does nothing.
144 127
145 Yields: 128 Yields:
146 logcat output line by line. 129 logcat output line by line.
147 ``` 130 ```
148 131
149 132
(...skipping 202 matching lines...) Expand 10 before | Expand all | Expand 10 after
352 The output of the emulator console command. 335 The output of the emulator console command.
353 ``` 336 ```
354 337
355 338
356 ### AdbWrapper.DisableVerity 339 ### AdbWrapper.DisableVerity
357 340
358 Disable Marshmallow's Verity security feature 341 Disable Marshmallow's Verity security feature
359 ### AdbWrapper.EnableVerity 342 ### AdbWrapper.EnableVerity
360 343
361 Enable Marshmallow's Verity security feature 344 Enable Marshmallow's Verity security feature
362 ## DeviceStat 345 ### AdbWrapper.\_\_init\_\_
363 346
364 DeviceStat(st\_mode, st\_size, st\_time) 347 Initializes the AdbWrapper.
365 ### DeviceStat.\_\_repr\_\_ 348 ```
349 Args:
350 device_serial: The device serial number as a string.
351 ```
366 352
367 Return a nicely formatted representation string
368 ### DeviceStat.\_\_getnewargs\_\_
369 353
370 Return self as a plain tuple. Used by copy and pickle. 354 ### AdbWrapper.\_\_eq\_\_
371 ### DeviceStat.\_\_getstate\_\_
372 355
373 Exclude the OrderedDict from pickling 356 Consider instances equal if they refer to the same device.
357 ```
358 Args:
359 other: The instance to compare equality with.
360
361 Returns:
362 True if the instances are considered equal, false otherwise.
363 ```
364
365
366 ### AdbWrapper.\_\_str\_\_
367
368 The string representation of an instance.
369 ```
370 Returns:
371 The device serial number as a string.
372 ```
373
374
375 ### AdbWrapper.\_\_repr\_\_
376
374 ### VerifyLocalFileExists 377 ### VerifyLocalFileExists
375 378
376 Verifies a local file exists. 379 Verifies a local file exists.
377 ``` 380 ```
378 Args: 381 Args:
379 path: Path to the local file. 382 path: Path to the local file.
380 383
381 Raises: 384 Raises:
382 IOError: If the file doesn't exist. 385 IOError: If the file doesn't exist.
383 ``` 386 ```
384 387
385 388
OLDNEW
« no previous file with comments | « devil/devil/utils/cmd_helper_test.py ('k') | devil/docs/device_utils.md » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698