forked from appium/python-client
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathexecute_driver.py
More file actions
71 lines (53 loc) · 2.79 KB
/
execute_driver.py
File metadata and controls
71 lines (53 loc) · 2.79 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
#!/usr/bin/env python
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from typing import TYPE_CHECKING, Any, Dict, Optional, TypeVar, Union
from selenium import webdriver
from ..mobilecommand import MobileCommand as Command
if TYPE_CHECKING:
# noinspection PyUnresolvedReferences
from appium.webdriver.webdriver import WebDriver
T = TypeVar('T', bound=Union['WebDriver', 'ExecuteDriver'])
class ExecuteDriver(webdriver.Remote):
# TODO Inner class case
def execute_driver(self: T, script: str, script_type: str = 'webdriverio', timeout_ms: Optional[int] = None) -> Any:
"""Run a set of script against the current session, allowing execution of many commands in one Appium request.
Please read http://appium.io/docs/en/commands/session/execute-driver for more details about the acceptable
scripts and the output format.
Args:
script: The string consisting of the script itself
script_type: The name of the script type. Defaults to 'webdriverio'.
timeout_ms: The number of `ms` Appium should wait for the script to finish before
killing it due to timeout_ms.
Usage:
| self.driver.execute_driver(script='return [];')
| self.driver.execute_driver(script='return [];', script_type='webdriverio')
| self.driver.execute_driver(script='return [];', script_type='webdriverio', timeout_ms=10000)
Returns:
ExecuteDriver.Result: The result of the script. It has 'result' and 'logs' keys.
Raises:
WebDriverException: If something error happenes in the script. The message has the original error message.
"""
class Result:
def __init__(self, res: Dict):
self.result = res['result']
self.logs = res['logs']
option: Dict[str, Union[str, int]] = {'script': script, 'type': script_type}
if timeout_ms is not None:
option['timeout'] = timeout_ms
response = self.execute(Command.EXECUTE_DRIVER, option)['value']
return Result(response)
# pylint: disable=protected-access
# noinspection PyProtectedMember
def _addCommands(self) -> None:
self.command_executor._commands[Command.EXECUTE_DRIVER] = \
('POST', '/session/$sessionId/appium/execute_driver')