-
Notifications
You must be signed in to change notification settings - Fork 783
Expand file tree
/
Copy path__init__.pyi
More file actions
213 lines (211 loc) · 16.8 KB
/
__init__.pyi
File metadata and controls
213 lines (211 loc) · 16.8 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
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
from datetime import timedelta
from typing import Any, Optional, Union
import selenium
from selenium.webdriver.remote.webdriver import WebDriver
from selenium.webdriver.remote.webelement import WebElement
class SeleniumLibrary:
def __init__(self, timeout = timedelta(seconds=5.0), implicit_wait = timedelta(seconds=0.0), run_on_failure = 'Capture Page Screenshot', screenshot_root_directory: Optional[Optional] = None, plugins: Optional[Optional] = None, event_firing_webdriver: Optional[Optional] = None, page_load_timeout = timedelta(seconds=300.0), action_chain_delay = timedelta(seconds=0.25), language: Optional[Optional] = None): ...
def add_cookie(self, name: str, value: str, path: Optional[Optional] = None, domain: Optional[Optional] = None, secure: Optional[Optional] = None, expiry: Optional[Optional] = None): ...
def add_location_strategy(self, strategy_name: str, strategy_keyword: str, persist: bool = False): ...
def alert_should_be_present(self, text: str = '', action: str = 'ACCEPT', timeout: Optional[Optional] = None): ...
def alert_should_not_be_present(self, action: str = 'ACCEPT', timeout: Optional[Optional] = None): ...
def assign_id_to_element(self, locator: Union, id: str): ...
def capture_element_screenshot(self, locator: Union, filename: str = 'selenium-element-screenshot-{index}.png'): ...
def capture_page_screenshot(self, filename: str = 'selenium-screenshot-{index}.png'): ...
def checkbox_should_be_selected(self, locator: Union): ...
def checkbox_should_not_be_selected(self, locator: Union): ...
def choose_file(self, locator: Union, file_path: str): ...
def clear_element_text(self, locator: Union): ...
def click_button(self, locator: Union, modifier: Union = False): ...
def click_element(self, locator: Union, modifier: Union = False, action_chain: bool = False): ...
def click_element_at_coordinates(self, locator: Union, xoffset: int, yoffset: int): ...
def click_image(self, locator: Union, modifier: Union = False): ...
def click_link(self, locator: Union, modifier: Union = False): ...
def close_all_browsers(self): ...
def close_browser(self): ...
def close_window(self): ...
def cover_element(self, locator: Union): ...
def create_webdriver(self, driver_name: str, alias: Optional[Optional] = None, kwargs: Optional[Optional] = None, **init_kwargs): ...
def current_frame_should_contain(self, text: str, loglevel: str = 'TRACE'): ...
def current_frame_should_not_contain(self, text: str, loglevel: str = 'TRACE'): ...
def delete_all_cookies(self): ...
def delete_cookie(self, name): ...
def double_click_element(self, locator: Union): ...
def drag_and_drop(self, locator: Union, target: Union): ...
def drag_and_drop_by_offset(self, locator: Union, xoffset: int, yoffset: int): ...
def element_attribute_value_should_be(self, locator: Union, attribute: str, expected: Optional, message: Optional[Optional] = None): ...
def element_should_be_disabled(self, locator: Union): ...
def element_should_be_enabled(self, locator: Union): ...
def element_should_be_focused(self, locator: Union): ...
def element_should_be_visible(self, locator: Union, message: Optional[Optional] = None): ...
def element_should_contain(self, locator: Union, expected: Optional, message: Optional[Optional] = None, ignore_case: bool = False): ...
def element_should_not_be_visible(self, locator: Union, message: Optional[Optional] = None): ...
def element_should_not_contain(self, locator: Union, expected: Optional, message: Optional[Optional] = None, ignore_case: bool = False): ...
def element_text_should_be(self, locator: Union, expected: Optional, message: Optional[Optional] = None, ignore_case: bool = False): ...
def element_text_should_not_be(self, locator: Union, not_expected: Optional, message: Optional[Optional] = None, ignore_case: bool = False): ...
def execute_async_javascript(self, *code: Any): ...
def execute_javascript(self, *code: Any): ...
def frame_should_contain(self, locator: Union, text: str, loglevel: str = 'TRACE'): ...
def get_action_chain_delay(self): ...
def get_all_links(self): ...
def get_browser_aliases(self): ...
def get_browser_ids(self): ...
def get_cookie(self, name: str): ...
def get_cookies(self, as_dict: bool = False): ...
def get_dom_attribute(self, locator: Union, attribute: str): ...
def get_element_attribute(self, locator: Union, attribute: str): ...
def get_element_count(self, locator: Union): ...
def get_element_size(self, locator: Union): ...
def get_horizontal_position(self, locator: Union): ...
def get_list_items(self, locator: Union, values: bool = False): ...
def get_location(self): ...
def get_locations(self, browser: str = 'CURRENT'): ...
def get_property(self, locator: Union, property: str): ...
def get_selected_list_label(self, locator: Union): ...
def get_selected_list_labels(self, locator: Union): ...
def get_selected_list_value(self, locator: Union): ...
def get_selected_list_values(self, locator: Union): ...
def get_selenium_implicit_wait(self): ...
def get_selenium_page_load_timeout(self): ...
def get_selenium_speed(self): ...
def get_selenium_timeout(self): ...
def get_session_id(self): ...
def get_source(self): ...
def get_table_cell(self, locator: Union, row: int, column: int, loglevel: str = 'TRACE'): ...
def get_text(self, locator: Union): ...
def get_title(self): ...
def get_value(self, locator: Union): ...
def get_vertical_position(self, locator: Union): ...
def get_webelement(self, locator: Union): ...
def get_webelements(self, locator: Union): ...
def get_window_handles(self, browser: str = 'CURRENT'): ...
def get_window_identifiers(self, browser: str = 'CURRENT'): ...
def get_window_names(self, browser: str = 'CURRENT'): ...
def get_window_position(self): ...
def get_window_size(self, inner: bool = False): ...
def get_window_titles(self, browser: str = 'CURRENT'): ...
def go_back(self): ...
def go_to(self, url): ...
def handle_alert(self, action: str = 'ACCEPT', timeout: Optional[Optional] = None): ...
def input_password(self, locator: Union, password: str, clear: bool = True): ...
def input_text(self, locator: Union, text: str, clear: bool = True): ...
def input_text_into_alert(self, text: str, action: str = 'ACCEPT', timeout: Optional[Optional] = None): ...
def list_selection_should_be(self, locator: Union, *expected: str): ...
def list_should_have_no_selections(self, locator: Union): ...
def location_should_be(self, url: str, message: Optional[Optional] = None): ...
def location_should_contain(self, expected: str, message: Optional[Optional] = None): ...
def log_location(self): ...
def log_source(self, loglevel: str = 'INFO'): ...
def log_title(self): ...
def maximize_browser_window(self): ...
def minimize_browser_window(self): ...
def mouse_down(self, locator: Union): ...
def mouse_down_on_image(self, locator: Union): ...
def mouse_down_on_link(self, locator: Union): ...
def mouse_out(self, locator: Union): ...
def mouse_over(self, locator: Union): ...
def mouse_up(self, locator: Union): ...
def open_browser(self, url: Optional[Optional] = None, browser: str = 'firefox', alias: Optional[Optional] = None, remote_url: Union = False, desired_capabilities: Optional[Union] = None, ff_profile_dir: Optional[Union] = None, options: Optional[Any] = None, service_log_path: Optional[Optional] = None, executable_path: Optional[Optional] = None, service: Optional[Any] = None): ...
def open_context_menu(self, locator: Union): ...
def page_should_contain(self, text: str, loglevel: str = 'TRACE'): ...
def page_should_contain_button(self, locator: Union, message: Optional[Optional] = None, loglevel: str = 'TRACE'): ...
def page_should_contain_checkbox(self, locator: Union, message: Optional[Optional] = None, loglevel: str = 'TRACE'): ...
def page_should_contain_element(self, locator: Union, message: Optional[Optional] = None, loglevel: str = 'TRACE', limit: Optional[Optional] = None): ...
def page_should_contain_image(self, locator: Union, message: Optional[Optional] = None, loglevel: str = 'TRACE'): ...
def page_should_contain_link(self, locator: Union, message: Optional[Optional] = None, loglevel: str = 'TRACE'): ...
def page_should_contain_list(self, locator: Union, message: Optional[Optional] = None, loglevel: str = 'TRACE'): ...
def page_should_contain_radio_button(self, locator: Union, message: Optional[Optional] = None, loglevel: str = 'TRACE'): ...
def page_should_contain_textfield(self, locator: Union, message: Optional[Optional] = None, loglevel: str = 'TRACE'): ...
def page_should_not_contain(self, text: str, loglevel: str = 'TRACE'): ...
def page_should_not_contain_button(self, locator: Union, message: Optional[Optional] = None, loglevel: str = 'TRACE'): ...
def page_should_not_contain_checkbox(self, locator: Union, message: Optional[Optional] = None, loglevel: str = 'TRACE'): ...
def page_should_not_contain_element(self, locator: Union, message: Optional[Optional] = None, loglevel: str = 'TRACE'): ...
def page_should_not_contain_image(self, locator: Union, message: Optional[Optional] = None, loglevel: str = 'TRACE'): ...
def page_should_not_contain_link(self, locator: Union, message: Optional[Optional] = None, loglevel: str = 'TRACE'): ...
def page_should_not_contain_list(self, locator: Union, message: Optional[Optional] = None, loglevel: str = 'TRACE'): ...
def page_should_not_contain_radio_button(self, locator: Union, message: Optional[Optional] = None, loglevel: str = 'TRACE'): ...
def page_should_not_contain_textfield(self, locator: Union, message: Optional[Optional] = None, loglevel: str = 'TRACE'): ...
def press_key(self, locator: Union, key: str): ...
def press_keys(self, locator: Optional[Union] = None, *keys: str): ...
def print_page_as_pdf(self, filename: str = 'selenium-page-{index}.pdf', background: Optional[Optional] = None, margin_bottom: Optional[Optional] = None, margin_left: Optional[Optional] = None, margin_right: Optional[Optional] = None, margin_top: Optional[Optional] = None, orientation: Optional[Optional] = None, page_height: Optional[Optional] = None, page_ranges: Optional[Optional] = None, page_width: Optional[Optional] = None, scale: Optional[Optional] = None, shrink_to_fit: Optional[Optional] = None): ...
def radio_button_should_be_set_to(self, group_name: str, value: str): ...
def radio_button_should_not_be_selected(self, group_name: str): ...
def register_keyword_to_run_on_failure(self, keyword: Optional): ...
def reload_page(self): ...
def remove_location_strategy(self, strategy_name: str): ...
def scroll_element_into_view(self, locator: Union): ...
def select_all_from_list(self, locator: Union): ...
def select_checkbox(self, locator: Union): ...
def select_frame(self, locator: Union): ...
def select_from_list_by_index(self, locator: Union, *indexes: str): ...
def select_from_list_by_label(self, locator: Union, *labels: str): ...
def select_from_list_by_value(self, locator: Union, *values: str): ...
def select_radio_button(self, group_name: str, value: str): ...
def set_action_chain_delay(self, value: timedelta): ...
def set_browser_implicit_wait(self, value: timedelta): ...
def set_focus_to_element(self, locator: Union): ...
def set_screenshot_directory(self, path: Optional): ...
def set_selenium_implicit_wait(self, value: timedelta): ...
def set_selenium_page_load_timeout(self, value: timedelta): ...
def set_selenium_speed(self, value: timedelta): ...
def set_selenium_timeout(self, value: timedelta): ...
def set_window_position(self, x: int, y: int): ...
def set_window_size(self, width: int, height: int, inner: bool = False): ...
def simulate_event(self, locator: Union, event: str): ...
def submit_form(self, locator: Optional[Union] = None): ...
def switch_browser(self, index_or_alias: str): ...
def switch_window(self, locator: Union = MAIN, timeout: Optional[Optional] = None, browser: str = 'CURRENT'): ...
def table_cell_should_contain(self, locator: Union, row: int, column: int, expected: str, loglevel: str = 'TRACE'): ...
def table_column_should_contain(self, locator: Union, column: int, expected: str, loglevel: str = 'TRACE'): ...
def table_footer_should_contain(self, locator: Union, expected: str, loglevel: str = 'TRACE'): ...
def table_header_should_contain(self, locator: Union, expected: str, loglevel: str = 'TRACE'): ...
def table_row_should_contain(self, locator: Union, row: int, expected: str, loglevel: str = 'TRACE'): ...
def table_should_contain(self, locator: Union, expected: str, loglevel: str = 'TRACE'): ...
def textarea_should_contain(self, locator: Union, expected: str, message: Optional[Optional] = None): ...
def textarea_value_should_be(self, locator: Union, expected: str, message: Optional[Optional] = None): ...
def textfield_should_contain(self, locator: Union, expected: str, message: Optional[Optional] = None): ...
def textfield_value_should_be(self, locator: Union, expected: str, message: Optional[Optional] = None): ...
def title_should_be(self, title: str, message: Optional[Optional] = None): ...
def unselect_all_from_list(self, locator: Union): ...
def unselect_checkbox(self, locator: Union): ...
def unselect_frame(self): ...
def unselect_from_list_by_index(self, locator: Union, *indexes: str): ...
def unselect_from_list_by_label(self, locator: Union, *labels: str): ...
def unselect_from_list_by_value(self, locator: Union, *values: str): ...
def wait_for_condition(self, condition: str, timeout: Optional[Optional] = None, error: Optional[Optional] = None): ...
def wait_for_expected_condition(self, condition: string, *args, timeout: Optional = 10): ...
def wait_until_element_contains(self, locator: Union, text: str, timeout: Optional[Optional] = None, error: Optional[Optional] = None): ...
def wait_until_element_does_not_contain(self, locator: Union, text: str, timeout: Optional[Optional] = None, error: Optional[Optional] = None): ...
def wait_until_element_is_enabled(self, locator: Union, timeout: Optional[Optional] = None, error: Optional[Optional] = None): ...
def wait_until_element_is_not_visible(self, locator: Union, timeout: Optional[Optional] = None, error: Optional[Optional] = None): ...
def wait_until_element_is_visible(self, locator: Union, timeout: Optional[Optional] = None, error: Optional[Optional] = None): ...
def wait_until_location_contains(self, expected: str, timeout: Optional[Optional] = None, message: Optional[Optional] = None): ...
def wait_until_location_does_not_contain(self, location: str, timeout: Optional[Optional] = None, message: Optional[Optional] = None): ...
def wait_until_location_is(self, expected: str, timeout: Optional[Optional] = None, message: Optional[Optional] = None): ...
def wait_until_location_is_not(self, location: str, timeout: Optional[Optional] = None, message: Optional[Optional] = None): ...
def wait_until_page_contains(self, text: str, timeout: Optional[Optional] = None, error: Optional[Optional] = None): ...
def wait_until_page_contains_element(self, locator: Union, timeout: Optional[Optional] = None, error: Optional[Optional] = None, limit: Optional[Optional] = None): ...
def wait_until_page_does_not_contain(self, text: str, timeout: Optional[Optional] = None, error: Optional[Optional] = None): ...
def wait_until_page_does_not_contain_element(self, locator: Union, timeout: Optional[Optional] = None, error: Optional[Optional] = None, limit: Optional[Optional] = None): ...
# methods from library.
def add_library_components(self, library_components): ...
def get_keyword_names(self): ...
def run_keyword(self, name: str, args: tuple, kwargs: Optional[dict] = None): ...
def get_keyword_arguments(self, name: str): ...
def get_keyword_tags(self, name: str): ...
def get_keyword_documentation(self, name: str): ...
def get_keyword_types(self, name: str): ...
def get_keyword_source(self, keyword_name: str): ...
def failure_occurred(self): ...
def register_driver(self, driver: WebDriver, alias: str): ...
@property
def driver(self) -> WebDriver: ...
def find_element(self, locator: str, parent: Optional[WebElement] = None): ...
def find_elements(self, locator: str, parent: WebElement = None): ...
def _parse_plugins(self, plugins: Any): ...
def _parse_plugin_doc(self): ...
def _get_intro_documentation(self): ...
def _parse_listener(self, event_firing_webdriver: Any): ...
def _string_to_modules(self, modules: Any): ...
def _store_plugin_keywords(self, plugin): ...
def _resolve_screenshot_root_directory(self): ...