forked from appium/python-client
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathime.py
More file actions
99 lines (75 loc) · 3.31 KB
/
ime.py
File metadata and controls
99 lines (75 loc) · 3.31 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
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
#!/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 List, TypeVar
from selenium import webdriver
from ..mobilecommand import MobileCommand as Command
T = TypeVar('T', bound='IME')
class IME(webdriver.Remote):
@property
def available_ime_engines(self) -> List[str]:
"""Get the available input methods for an Android device.
Package and activity are returned (e.g., ['com.android.inputmethod.latin/.LatinIME'])
Android only.
Returns:
:obj:`list` of :obj:`str`: The available input methods for an Android device
"""
return self.execute(Command.GET_AVAILABLE_IME_ENGINES, {})['value']
def is_ime_active(self) -> bool:
"""Checks whether the device has IME service active.
Android only.
Returns:
bool: `True` if IME service is active
"""
return self.execute(Command.IS_IME_ACTIVE, {})['value']
def activate_ime_engine(self, engine: str) -> T:
"""Activates the given IME engine on the device.
Android only.
Args:
engine (str): the package and activity of the IME engine to activate
(e.g., 'com.android.inputmethod.latin/.LatinIME')
Returns:
`appium.webdriver.webdriver.WebDriver`
"""
data = {
'engine': engine
}
self.execute(Command.ACTIVATE_IME_ENGINE, data)
return self
def deactivate_ime_engine(self) -> T:
"""Deactivates the currently active IME engine on the device.
Android only.
Returns:
`appium.webdriver.webdriver.WebDriver`
"""
self.execute(Command.DEACTIVATE_IME_ENGINE, {})
return self
@property
def active_ime_engine(self) -> str:
"""Returns the activity and package of the currently active IME engine(e.g., 'com.android.inputmethod.latin/.LatinIME').
Android only.
Returns:
str: The activity and package of the currently active IME engine
"""
return self.execute(Command.GET_ACTIVE_IME_ENGINE, {})['value']
# pylint: disable=protected-access
def _addCommands(self) -> None:
self.command_executor._commands[Command.GET_AVAILABLE_IME_ENGINES] = \
('GET', '/session/$sessionId/ime/available_engines')
self.command_executor._commands[Command.IS_IME_ACTIVE] = \
('GET', '/session/$sessionId/ime/activated')
self.command_executor._commands[Command.ACTIVATE_IME_ENGINE] = \
('POST', '/session/$sessionId/ime/activate')
self.command_executor._commands[Command.DEACTIVATE_IME_ENGINE] = \
('POST', '/session/$sessionId/ime/deactivate')
self.command_executor._commands[Command.GET_ACTIVE_IME_ENGINE] = \
('GET', '/session/$sessionId/ime/active_engine')