SeleniumLibrary __init__.pyi

__init__pyi

from SeleniumLibrary.base import DynamicCore as DynamicCore, LibraryComponent as LibraryComponent
from SeleniumLibrary.errors import NoOpenBrowser as NoOpenBrowser, PluginError as PluginError
from SeleniumLibrary.keywords import AlertKeywords as AlertKeywords, BrowserManagementKeywords as BrowserManagementKeywords, CookieKeywords as CookieKeywords, ElementKeywords as ElementKeywords, FormElementKeywords as FormElementKeywords, FrameKeywords as FrameKeywords, JavaScriptKeywords as JavaScriptKeywords, RunOnFailureKeywords as RunOnFailureKeywords, ScreenshotKeywords as ScreenshotKeywords, SelectElementKeywords as SelectElementKeywords, TableElementKeywords as TableElementKeywords, WaitingKeywords as WaitingKeywords, WebDriverCache as WebDriverCache, WindowKeywords as WindowKeywords
from SeleniumLibrary.keywords.screenshot import EMBED as EMBED
from SeleniumLibrary.locators import ElementFinder as ElementFinder
from SeleniumLibrary.utils import LibraryListener as LibraryListener, is_truthy as is_truthy, timestr_to_secs as timestr_to_secs
from typing import Any, Optional

class SeleniumLibrary(DynamicCore):
    ROBOT_LIBRARY_SCOPE: str = ...
    ROBOT_LIBRARY_VERSION: Any = ...
    timeout: Any = ...
    implicit_wait: Any = ...
    speed: float = ...
    run_on_failure_keyword: Any = ...
    screenshot_root_directory: Any = ...
    ROBOT_LIBRARY_LISTENER: Any = ...
    event_firing_webdriver: Any = ...
    def __init__(self, timeout: float = ..., implicit_wait: float = ..., run_on_failure: str = ..., screenshot_root_directory: Optional[Any] = ..., plugins: Optional[Any] = ..., event_firing_webdriver: Optional[Any] = ...) -> None: ...
    def run_keyword(self, name: Any, args: Any, kwargs: Any): ...
    def get_keyword_tags(self, name: Any): ...
    def get_keyword_documentation(self, name: Any): ...
    def register_driver(self, driver: Any, alias: Any): ...
    def failure_occurred(self) -> None: ...
    @property
    def driver(self): ...
    def find_element(self, locator: Any, parent: Optional[Any] = ...): ...
    def find_elements(self, locator: Any, parent: Optional[Any] = ...): ...
    def add_cookie(self, name: Any, value: Any, path: Optional[Any] = ..., domain: Optional[Any] = ..., secure: Optional[Any] = ..., expiry: Optional[Any] = ...) -> None: ...
    def add_location_strategy(self, strategy_name: Any, strategy_keyword: Any, persist: bool = ...) -> None: ...
    def alert_should_be_present(self, text: str = ..., action: Any = ..., timeout: Optional[Any] = ...) -> None: ...
    def alert_should_not_be_present(self, action: Any = ..., timeout: int = ...) -> None: ...
    def assign_id_to_element(self, locator: Any, id: Any) -> None: ...
    def capture_element_screenshot(self, locator: Any, filename: Any = ...): ...
    def capture_page_screenshot(self, filename: Any = ...): ...
    def checkbox_should_be_selected(self, locator: Any) -> None: ...
    def checkbox_should_not_be_selected(self, locator: Any) -> None: ...
    def choose_file(self, locator: Any, file_path: Any) -> None: ...
    def clear_element_text(self, locator: Any) -> None: ...
    def click_button(self, locator: Any, modifier: bool = ...) -> None: ...
    def click_element(self, locator: Any, modifier: bool = ..., action_chain: bool = ...) -> None: ...
    def click_element_at_coordinates(self, locator: Any, xoffset: Any, yoffset: Any) -> None: ...
    def click_image(self, locator: Any, modifier: bool = ...) -> None: ...
    def click_link(self, locator: Any, modifier: bool = ...) -> None: ...
    def close_all_browsers(self) -> None: ...
    def close_browser(self) -> None: ...
    def close_window(self) -> None: ...
    def cover_element(self, locator: Any) -> None: ...
    def create_webdriver(self, driver_name: Any, alias: Optional[Any] = ..., kwargs: Any = ..., **init_kwargs: Any): ...
    def current_frame_should_contain(self, text: Any, loglevel: str = ...) -> None: ...
    def current_frame_should_not_contain(self, text: Any, loglevel: str = ...) -> None: ...
    def delete_all_cookies(self) -> None: ...
    def delete_cookie(self, name: Any) -> None: ...
    def double_click_element(self, locator: Any) -> None: ...
    def drag_and_drop(self, locator: Any, target: Any) -> None: ...
    def drag_and_drop_by_offset(self, locator: Any, xoffset: Any, yoffset: Any) -> None: ...
    def element_attribute_value_should_be(self, locator: Any, attribute: Any, expected: Any, message: Optional[Any] = ...) -> None: ...
    def element_should_be_disabled(self, locator: Any) -> None: ...
    def element_should_be_enabled(self, locator: Any) -> None: ...
    def element_should_be_focused(self, locator: Any) -> None: ...
    def element_should_be_visible(self, locator: Any, message: Optional[Any] = ...) -> None: ...
    def element_should_contain(self, locator: Any, expected: Any, message: Optional[Any] = ..., ignore_case: bool = ...) -> None: ...
    def element_should_not_be_visible(self, locator: Any, message: Optional[Any] = ...) -> None: ...
    def element_should_not_contain(self, locator: Any, expected: Any, message: Optional[Any] = ..., ignore_case: bool = ...) -> None: ...
    def element_text_should_be(self, locator: Any, expected: Any, message: Optional[Any] = ..., ignore_case: bool = ...) -> None: ...
    def element_text_should_not_be(self, locator: Any, not_expected: Any, message: Optional[Any] = ..., ignore_case: bool = ...) -> None: ...
    def execute_async_javascript(self, *code: Any): ...
    def execute_javascript(self, *code: Any): ...
    def frame_should_contain(self, locator: Any, text: Any, loglevel: str = ...) -> None: ...
    def get_all_links(self): ...
    def get_browser_aliases(self): ...
    def get_browser_ids(self): ...
    def get_cookie(self, name: Any): ...
    def get_cookies(self, as_dict: bool = ...): ...
    def get_element_attribute(self, locator: Any, attribute: Any): ...
    def get_element_count(self, locator: Any): ...
    def get_element_size(self, locator: Any): ...
    def get_horizontal_position(self, locator: Any): ...
    def get_list_items(self, locator: Any, values: bool = ...): ...
    def get_location(self): ...
    def get_locations(self, browser: str = ...): ...
    def get_selected_list_label(self, locator: Any): ...
    def get_selected_list_labels(self, locator: Any): ...
    def get_selected_list_value(self, locator: Any): ...
    def get_selected_list_values(self, locator: Any): ...
    def get_selenium_implicit_wait(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: Any, row: Any, column: Any, loglevel: str = ...): ...
    def get_text(self, locator: Any): ...
    def get_title(self): ...
    def get_value(self, locator: Any): ...
    def get_vertical_position(self, locator: Any): ...
    def get_webelement(self, locator: Any): ...
    def get_webelements(self, locator: Any): ...
    def get_window_handles(self, browser: str = ...): ...
    def get_window_identifiers(self, browser: str = ...): ...
    def get_window_names(self, browser: str = ...): ...
    def get_window_position(self): ...
    def get_window_size(self, inner: bool = ...): ...
    def get_window_titles(self, browser: str = ...): ...
    def go_back(self) -> None: ...
    def go_to(self, url: Any) -> None: ...
    def handle_alert(self, action: Any = ..., timeout: Optional[Any] = ...): ...
    def input_password(self, locator: Any, password: Any, clear: bool = ...) -> None: ...
    def input_text(self, locator: Any, text: Any, clear: bool = ...) -> None: ...
    def input_text_into_alert(self, text: Any, action: Any = ..., timeout: Optional[Any] = ...) -> None: ...
    def list_selection_should_be(self, locator: Any, *expected: Any) -> None: ...
    def list_should_have_no_selections(self, locator: Any) -> None: ...
    def location_should_be(self, url: Any, message: Optional[Any] = ...) -> None: ...
    def location_should_contain(self, expected: Any, message: Optional[Any] = ...) -> None: ...
    def locator_should_match_x_times(self, locator: Any, x: Any, message: Optional[Any] = ..., loglevel: str = ...) -> None: ...
    def log_location(self): ...
    def log_source(self, loglevel: str = ...): ...
    def log_title(self): ...
    def maximize_browser_window(self) -> None: ...
    def mouse_down(self, locator: Any) -> None: ...
    def mouse_down_on_image(self, locator: Any) -> None: ...
    def mouse_down_on_link(self, locator: Any) -> None: ...
    def mouse_out(self, locator: Any) -> None: ...
    def mouse_over(self, locator: Any) -> None: ...
    def mouse_up(self, locator: Any) -> None: ...
    def open_browser(self, url: Optional[Any] = ..., browser: str = ..., alias: Optional[Any] = ..., remote_url: bool = ..., desired_capabilities: Optional[Any] = ..., ff_profile_dir: Optional[Any] = ..., options: Optional[Any] = ..., service_log_path: Optional[Any] = ..., executable_path: Optional[Any] = ...): ...
    def open_context_menu(self, locator: Any) -> None: ...
    def page_should_contain(self, text: Any, loglevel: str = ...) -> None: ...
    def page_should_contain_button(self, locator: Any, message: Optional[Any] = ..., loglevel: str = ...) -> None: ...
    def page_should_contain_checkbox(self, locator: Any, message: Optional[Any] = ..., loglevel: str = ...) -> None: ...
    def page_should_contain_element(self, locator: Any, message: Optional[Any] = ..., loglevel: str = ..., limit: Optional[Any] = ...): ...
    def page_should_contain_image(self, locator: Any, message: Optional[Any] = ..., loglevel: str = ...) -> None: ...
    def page_should_contain_link(self, locator: Any, message: Optional[Any] = ..., loglevel: str = ...) -> None: ...
    def page_should_contain_list(self, locator: Any, message: Optional[Any] = ..., loglevel: str = ...) -> None: ...
    def page_should_contain_radio_button(self, locator: Any, message: Optional[Any] = ..., loglevel: str = ...) -> None: ...
    def page_should_contain_textfield(self, locator: Any, message: Optional[Any] = ..., loglevel: str = ...) -> None: ...
    def page_should_not_contain(self, text: Any, loglevel: str = ...) -> None: ...
    def page_should_not_contain_button(self, locator: Any, message: Optional[Any] = ..., loglevel: str = ...) -> None: ...
    def page_should_not_contain_checkbox(self, locator: Any, message: Optional[Any] = ..., loglevel: str = ...) -> None: ...
    def page_should_not_contain_element(self, locator: Any, message: Optional[Any] = ..., loglevel: str = ...) -> None: ...
    def page_should_not_contain_image(self, locator: Any, message: Optional[Any] = ..., loglevel: str = ...) -> None: ...
    def page_should_not_contain_link(self, locator: Any, message: Optional[Any] = ..., loglevel: str = ...) -> None: ...
    def page_should_not_contain_list(self, locator: Any, message: Optional[Any] = ..., loglevel: str = ...) -> None: ...
    def page_should_not_contain_radio_button(self, locator: Any, message: Optional[Any] = ..., loglevel: str = ...) -> None: ...
    def page_should_not_contain_textfield(self, locator: Any, message: Optional[Any] = ..., loglevel: str = ...) -> None: ...
    def press_key(self, locator: Any, key: Any) -> None: ...
    def press_keys(self, locator: Optional[Any] = ..., *keys: Any) -> None: ...
    def radio_button_should_be_set_to(self, group_name: Any, value: Any) -> None: ...
    def radio_button_should_not_be_selected(self, group_name: Any) -> None: ...
    def register_keyword_to_run_on_failure(self, keyword: Any): ...
    def reload_page(self) -> None: ...
    def remove_location_strategy(self, strategy_name: Any) -> None: ...
    def scroll_element_into_view(self, locator: Any) -> None: ...
    def select_all_from_list(self, locator: Any) -> None: ...
    def select_checkbox(self, locator: Any) -> None: ...
    def select_frame(self, locator: Any) -> None: ...
    def select_from_list_by_index(self, locator: Any, *indexes: Any) -> None: ...
    def select_from_list_by_label(self, locator: Any, *labels: Any) -> None: ...
    def select_from_list_by_value(self, locator: Any, *values: Any) -> None: ...
    def select_radio_button(self, group_name: Any, value: Any) -> None: ...
    def select_window(self, locator: str = ..., timeout: Optional[Any] = ...): ...
    def set_browser_implicit_wait(self, value: Any) -> None: ...
    def set_focus_to_element(self, locator: Any) -> None: ...
    def set_screenshot_directory(self, path: Any): ...
    def set_selenium_implicit_wait(self, value: Any): ...
    def set_selenium_speed(self, value: Any): ...
    def set_selenium_timeout(self, value: Any): ...
    def set_window_position(self, x: Any, y: Any) -> None: ...
    def set_window_size(self, width: Any, height: Any, inner: bool = ...): ...
    def simulate_event(self, locator: Any, event: Any) -> None: ...
    def submit_form(self, locator: Optional[Any] = ...) -> None: ...
    def switch_browser(self, index_or_alias: Any) -> None: ...
    def switch_window(self, locator: str = ..., timeout: Optional[Any] = ..., browser: str = ...): ...
    def table_cell_should_contain(self, locator: Any, row: Any, column: Any, expected: Any, loglevel: str = ...) -> None: ...
    def table_column_should_contain(self, locator: Any, column: Any, expected: Any, loglevel: str = ...) -> None: ...
    def table_footer_should_contain(self, locator: Any, expected: Any, loglevel: str = ...) -> None: ...
    def table_header_should_contain(self, locator: Any, expected: Any, loglevel: str = ...) -> None: ...
    def table_row_should_contain(self, locator: Any, row: Any, expected: Any, loglevel: str = ...) -> None: ...
    def table_should_contain(self, locator: Any, expected: Any, loglevel: str = ...) -> None: ...
    def textarea_should_contain(self, locator: Any, expected: Any, message: Optional[Any] = ...) -> None: ...
    def textarea_value_should_be(self, locator: Any, expected: Any, message: Optional[Any] = ...) -> None: ...
    def textfield_should_contain(self, locator: Any, expected: Any, message: Optional[Any] = ...) -> None: ...
    def textfield_value_should_be(self, locator: Any, expected: Any, message: Optional[Any] = ...) -> None: ...
    def title_should_be(self, title: Any, message: Optional[Any] = ...) -> None: ...
    def unselect_all_from_list(self, locator: Any) -> None: ...
    def unselect_checkbox(self, locator: Any) -> None: ...
    def unselect_frame(self) -> None: ...
    def unselect_from_list_by_index(self, locator: Any, *indexes: Any) -> None: ...
    def unselect_from_list_by_label(self, locator: Any, *labels: Any) -> None: ...
    def unselect_from_list_by_value(self, locator: Any, *values: Any) -> None: ...
    def wait_for_condition(self, condition: Any, timeout: Optional[Any] = ..., error: Optional[Any] = ...): ...
    def wait_until_element_contains(self, locator: Any, text: Any, timeout: Optional[Any] = ..., error: Optional[Any] = ...): ...
    def wait_until_element_does_not_contain(self, locator: Any, text: Any, timeout: Optional[Any] = ..., error: Optional[Any] = ...): ...
    def wait_until_element_is_enabled(self, locator: Any, timeout: Optional[Any] = ..., error: Optional[Any] = ...): ...
    def wait_until_element_is_not_visible(self, locator: Any, timeout: Optional[Any] = ..., error: Optional[Any] = ...): ...
    def wait_until_element_is_visible(self, locator: Any, timeout: Optional[Any] = ..., error: Optional[Any] = ...): ...
    def wait_until_location_contains(self, expected: Any, timeout: Optional[Any] = ..., message: Optional[Any] = ...): ...
    def wait_until_location_does_not_contain(self, location: Any, timeout: Optional[Any] = ..., message: Optional[Any] = ...): ...
    def wait_until_location_is(self, expected: Any, timeout: Optional[Any] = ..., message: Optional[Any] = ...): ...
    def wait_until_location_is_not(self, location: Any, timeout: Optional[Any] = ..., message: Optional[Any] = ...): ...
    def wait_until_page_contains(self, text: Any, timeout: Optional[Any] = ..., error: Optional[Any] = ...): ...
    def wait_until_page_contains_element(self, locator: Any, timeout: Optional[Any] = ..., error: Optional[Any] = ..., limit: Optional[Any] = ...): ...
    def wait_until_page_does_not_contain(self, text: Any, timeout: Optional[Any] = ..., error: Optional[Any] = ...): ...
    def wait_until_page_does_not_contain_element(self, locator: Any, timeout: Optional[Any] = ..., error: Optional[Any] = ..., limit: Optional[Any] = ...): ...