forked from appium/python-client
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlog_event.py
More file actions
80 lines (63 loc) · 2.65 KB
/
log_event.py
File metadata and controls
80 lines (63 loc) · 2.65 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
#!/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, Dict, List, 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', 'LogEvent'])
class LogEvent(webdriver.Remote):
def get_events(self: T, type: List[str] = None) -> Dict[str, Union[str, int]]:
""" Retrieves events information from the current session
(Since Appium 1.16.0)
Args:
type: The event type to filter with
Usage:
| events = driver.get_events()
| events = driver.get_events(['appium:funEvent'])
Returns:
`dict`: A dictionary of events timing information containing the following entries
| commands: (`list` of `dict`) List of dictionaries containing the following entries
| cmd: The command name that has been sent to the appium server
| startTime: Received time
| endTime: Response time
"""
data = {}
if type is not None:
data['type'] = type
return self.execute(Command.GET_EVENTS, data)['value']
def log_event(self: T, vendor: str, event: str) -> T:
"""Log a custom event on the Appium server.
(Since Appium 1.16.0)
Args:
vendor: The vendor to log
event: The event to log
Usage:
driver.log_event('appium', 'funEvent')
Returns:
Union['WebDriver', 'LogEvent']: Self instance
"""
data = {
'vendor': vendor,
'event': event
}
self.execute(Command.LOG_EVENT, data)
return self
# pylint: disable=protected-access
# noinspection PyProtectedMember
def _addCommands(self) -> None:
self.command_executor._commands[Command.GET_EVENTS] = \
('POST', '/session/$sessionId/appium/events')
self.command_executor._commands[Command.LOG_EVENT] = \
('POST', '/session/$sessionId/appium/log_event')