# Licensed to the Software Freedom Conservancy (SFC) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The SFC licenses this file
# to you 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.
"""The WebDriver implementation."""
import base64
import contextlib
import copy
import os
import pkgutil
import tempfile
import types
import warnings
import zipfile
from abc import ABCMeta
from base64 import b64decode
from base64 import urlsafe_b64encode
from contextlib import asynccontextmanager
from contextlib import contextmanager
from importlib import import_module
from typing import Dict
from typing import List
from typing import Optional
from typing import Type
from typing import Union
from selenium.common.exceptions import InvalidArgumentException
from selenium.common.exceptions import JavascriptException
from selenium.common.exceptions import NoSuchCookieException
from selenium.common.exceptions import NoSuchElementException
from selenium.common.exceptions import WebDriverException
from selenium.webdriver.common.bidi.script import Script
from selenium.webdriver.common.by import By
from selenium.webdriver.common.options import ArgOptions
from selenium.webdriver.common.options import BaseOptions
from selenium.webdriver.common.print_page_options import PrintOptions
from selenium.webdriver.common.timeouts import Timeouts
from selenium.webdriver.common.virtual_authenticator import Credential
from selenium.webdriver.common.virtual_authenticator import VirtualAuthenticatorOptions
from selenium.webdriver.common.virtual_authenticator import (
required_virtual_authenticator,
)
from selenium.webdriver.support.relative_locator import RelativeBy
from ..common.fedcm.dialog import Dialog
from .bidi_connection import BidiConnection
from .client_config import ClientConfig
from .command import Command
from .errorhandler import ErrorHandler
from .fedcm import FedCM
from .file_detector import FileDetector
from .file_detector import LocalFileDetector
from .locator_converter import LocatorConverter
from .mobile import Mobile
from .remote_connection import RemoteConnection
from .script_key import ScriptKey
from .shadowroot import ShadowRoot
from .switch_to import SwitchTo
from .webelement import WebElement
from .websocket_connection import WebSocketConnection
cdp = None
devtools = None
[docs]
def import_cdp():
global cdp
if not cdp:
cdp = import_module("selenium.webdriver.common.bidi.cdp")
def _create_caps(caps):
"""Makes a W3C alwaysMatch capabilities object.
Filters out capability names that are not in the W3C spec. Spec-compliant
drivers will reject requests containing unknown capability names.
Moves the Firefox profile, if present, from the old location to the new Firefox
options object.
Parameters:
-----------
caps : dict
- A dictionary of capabilities requested by the caller.
"""
caps = copy.deepcopy(caps)
always_match = {}
for k, v in caps.items():
always_match[k] = v
return {"capabilities": {"firstMatch": [{}], "alwaysMatch": always_match}}
[docs]
def get_remote_connection(
capabilities: dict,
command_executor: Union[str, RemoteConnection],
keep_alive: bool,
ignore_local_proxy: bool,
client_config: Optional[ClientConfig] = None,
) -> RemoteConnection:
if isinstance(command_executor, str):
client_config = client_config or ClientConfig(remote_server_addr=command_executor)
client_config.remote_server_addr = command_executor
command_executor = RemoteConnection(client_config=client_config)
from selenium.webdriver.chrome.remote_connection import ChromeRemoteConnection
from selenium.webdriver.edge.remote_connection import EdgeRemoteConnection
from selenium.webdriver.firefox.remote_connection import FirefoxRemoteConnection
from selenium.webdriver.safari.remote_connection import SafariRemoteConnection
candidates = [ChromeRemoteConnection, EdgeRemoteConnection, SafariRemoteConnection, FirefoxRemoteConnection]
handler = next((c for c in candidates if c.browser_name == capabilities.get("browserName")), RemoteConnection)
return handler(
remote_server_addr=command_executor,
keep_alive=keep_alive,
ignore_proxy=ignore_local_proxy,
client_config=client_config,
)
[docs]
def create_matches(options: List[BaseOptions]) -> Dict:
capabilities = {"capabilities": {}}
opts = []
for opt in options:
opts.append(opt.to_capabilities())
opts_size = len(opts)
samesies = {}
# Can not use bitwise operations on the dicts or lists due to
# https://bugs.python.org/issue38210
for i in range(opts_size):
min_index = i
if i + 1 < opts_size:
first_keys = opts[min_index].keys()
for kys in first_keys:
if kys in opts[i + 1].keys():
if opts[min_index][kys] == opts[i + 1][kys]:
samesies.update({kys: opts[min_index][kys]})
always = {}
for k, v in samesies.items():
always[k] = v
for i in opts:
for k in always:
del i[k]
capabilities["capabilities"]["alwaysMatch"] = always
capabilities["capabilities"]["firstMatch"] = opts
return capabilities
[docs]
class BaseWebDriver(metaclass=ABCMeta):
"""Abstract Base Class for all Webdriver subtypes.
ABC's allow custom implementations of Webdriver to be registered so
that isinstance type checks will succeed.
"""
[docs]
class WebDriver(BaseWebDriver):
"""Controls a browser by sending commands to a remote server. This server
is expected to be running the WebDriver wire protocol as defined at
https://www.selenium.dev/documentation/legacy/json_wire_protocol/.
Attributes:
-----------
session_id - String ID of the browser session started and controlled by this WebDriver.
capabilities - Dictionary of effective capabilities of this browser session as returned
by the remote server. See https://www.selenium.dev/documentation/legacy/desired_capabilities/
command_executor : str or remote_connection.RemoteConnection object used to execute commands.
error_handler - errorhandler.ErrorHandler object used to handle errors.
"""
_web_element_cls = WebElement
_shadowroot_cls = ShadowRoot
def __init__(
self,
command_executor: Union[str, RemoteConnection] = "http://127.0.0.1:4444",
keep_alive: bool = True,
file_detector: Optional[FileDetector] = None,
options: Optional[Union[BaseOptions, List[BaseOptions]]] = None,
locator_converter: Optional[LocatorConverter] = None,
web_element_cls: Optional[type] = None,
client_config: Optional[ClientConfig] = None,
) -> None:
"""Create a new driver that will issue commands using the wire
protocol.
Parameters:
-----------
command_executor : str or remote_connection.RemoteConnection
- Either a string representing the URL of the remote server or a custom
remote_connection.RemoteConnection object. Defaults to 'http://127.0.0.1:4444/wd/hub'.
keep_alive : bool (Deprecated)
- Whether to configure remote_connection.RemoteConnection to use HTTP keep-alive. Defaults to True.
file_detector : object or None
- Pass a custom file detector object during instantiation. If None, the default LocalFileDetector() will be used.
options : options.Options
- Instance of a driver options.Options class.
locator_converter : object or None
- Custom locator converter to use. Defaults to None.
web_element_cls : class
- Custom class to use for web elements. Defaults to WebElement.
client_config : object or None
- Custom client configuration to use. Defaults to None.
"""
if isinstance(options, list):
capabilities = create_matches(options)
_ignore_local_proxy = False
else:
capabilities = options.to_capabilities()
_ignore_local_proxy = options._ignore_local_proxy
self.command_executor = command_executor
if isinstance(self.command_executor, (str, bytes)):
self.command_executor = get_remote_connection(
capabilities,
command_executor=command_executor,
keep_alive=keep_alive,
ignore_local_proxy=_ignore_local_proxy,
client_config=client_config,
)
self._is_remote = True
self.session_id = None
self.caps = {}
self.pinned_scripts = {}
self.error_handler = ErrorHandler()
self._switch_to = SwitchTo(self)
self._mobile = Mobile(self)
self.file_detector = file_detector or LocalFileDetector()
self.locator_converter = locator_converter or LocatorConverter()
self._web_element_cls = web_element_cls or self._web_element_cls
self._authenticator_id = None
self.start_client()
self.start_session(capabilities)
self._fedcm = FedCM(self)
self._websocket_connection = None
self._script = None
def __repr__(self):
return f'<{type(self).__module__}.{type(self).__name__} (session="{self.session_id}")>'
def __enter__(self):
return self
def __exit__(
self,
exc_type: Optional[Type[BaseException]],
exc: Optional[BaseException],
traceback: Optional[types.TracebackType],
):
self.quit()
[docs]
@contextmanager
def file_detector_context(self, file_detector_class, *args, **kwargs):
"""Overrides the current file detector (if necessary) in limited
context. Ensures the original file detector is set afterwards.
Parameters:
-----------
file_detector_class : object
- Class of the desired file detector. If the class is different
from the current file_detector, then the class is instantiated with args and kwargs
and used as a file detector during the duration of the context manager.
args : tuple
- Optional arguments that get passed to the file detector class during instantiation.
kwargs : dict
- Keyword arguments, passed the same way as args.
Example:
--------
>>> with webdriver.file_detector_context(UselessFileDetector):
>>> someinput.send_keys('/etc/hosts')
"""
last_detector = None
if not isinstance(self.file_detector, file_detector_class):
last_detector = self.file_detector
self.file_detector = file_detector_class(*args, **kwargs)
try:
yield
finally:
if last_detector:
self.file_detector = last_detector
@property
def mobile(self) -> Mobile:
return self._mobile
@property
def name(self) -> str:
"""Returns the name of the underlying browser for this instance.
Example:
--------
>>> name = driver.name
"""
if "browserName" in self.caps:
return self.caps["browserName"]
raise KeyError("browserName not specified in session capabilities")
[docs]
def start_client(self):
"""Called before starting a new session.
This method may be overridden to define custom startup behavior.
"""
pass
[docs]
def stop_client(self):
"""Called after executing a quit command.
This method may be overridden to define custom shutdown
behavior.
"""
pass
[docs]
def start_session(self, capabilities: dict) -> None:
"""Creates a new session with the desired capabilities.
Parameters:
-----------
capabilities : dict
- A capabilities dict to start the session with.
"""
caps = _create_caps(capabilities)
response = self.execute(Command.NEW_SESSION, caps)["value"]
self.session_id = response.get("sessionId")
self.caps = response.get("capabilities")
def _wrap_value(self, value):
if isinstance(value, dict):
converted = {}
for key, val in value.items():
converted[key] = self._wrap_value(val)
return converted
if isinstance(value, self._web_element_cls):
return {"element-6066-11e4-a52e-4f735466cecf": value.id}
if isinstance(value, self._shadowroot_cls):
return {"shadow-6066-11e4-a52e-4f735466cecf": value.id}
if isinstance(value, list):
return list(self._wrap_value(item) for item in value)
return value
[docs]
def create_web_element(self, element_id: str) -> WebElement:
"""Creates a web element with the specified `element_id`."""
return self._web_element_cls(self, element_id)
def _unwrap_value(self, value):
if isinstance(value, dict):
if "element-6066-11e4-a52e-4f735466cecf" in value:
return self.create_web_element(value["element-6066-11e4-a52e-4f735466cecf"])
if "shadow-6066-11e4-a52e-4f735466cecf" in value:
return self._shadowroot_cls(self, value["shadow-6066-11e4-a52e-4f735466cecf"])
for key, val in value.items():
value[key] = self._unwrap_value(val)
return value
if isinstance(value, list):
return list(self._unwrap_value(item) for item in value)
return value
[docs]
def execute_cdp_cmd(self, cmd: str, cmd_args: dict):
"""Execute Chrome Devtools Protocol command and get returned result The
command and command args should follow chrome devtools protocol
domains/commands, refer to link
https://chromedevtools.github.io/devtools-protocol/
Parameters:
-----------
cmd : str,
- Command name
cmd_args : dict
- Command args
- Empty dict {} if there is no command args
Returns:
--------
A dict, empty dict {} if there is no result to return.
- To getResponseBody: {'base64Encoded': False, 'body': 'response body string'}
Example:
--------
>>> driver.execute_cdp_cmd('Network.getResponseBody', {'requestId': requestId})
"""
return self.execute("executeCdpCommand", {"cmd": cmd, "params": cmd_args})["value"]
[docs]
def execute(self, driver_command: str, params: dict = None) -> dict:
"""Sends a command to be executed by a command.CommandExecutor.
Parameters:
-----------
driver_command : str
- The name of the command to execute as a string.
params : dict
- A dictionary of named Parameters to send with the command.
Returns:
--------
dict - The command's JSON response loaded into a dictionary object.
"""
params = self._wrap_value(params)
if self.session_id:
if not params:
params = {"sessionId": self.session_id}
elif "sessionId" not in params:
params["sessionId"] = self.session_id
response = self.command_executor.execute(driver_command, params)
if response:
self.error_handler.check_response(response)
response["value"] = self._unwrap_value(response.get("value", None))
return response
# If the server doesn't send a response, assume the command was
# a success
return {"success": 0, "value": None, "sessionId": self.session_id}
[docs]
def get(self, url: str) -> None:
"""Navigate the browser to the specified URL in the current window or
tab.
The method does not return until the page is fully loaded (i.e. the
onload event has fired).
Parameters:
-----------
url : str
- The URL to be opened by the browser.
- Must include the protocol (e.g., http://, https://).
Example:
--------
>>> driver = webdriver.Chrome()
>>> driver.get("https://example.com")
"""
self.execute(Command.GET, {"url": url})
@property
def title(self) -> str:
"""Returns the title of the current page.
Example:
--------
>>> element = driver.find_element(By.ID, 'foo')
>>> print(element.title())
"""
return self.execute(Command.GET_TITLE).get("value", "")
[docs]
def pin_script(self, script: str, script_key=None) -> ScriptKey:
"""Store common javascript scripts to be executed later by a unique
hashable ID.
Example:
--------
>>> script = "return document.getElementById('foo').value"
"""
script_key_instance = ScriptKey(script_key)
self.pinned_scripts[script_key_instance.id] = script
return script_key_instance
[docs]
def unpin(self, script_key: ScriptKey) -> None:
"""Remove a pinned script from storage.
Example:
--------
>>> driver.unpin(script_key)
"""
try:
self.pinned_scripts.pop(script_key.id)
except KeyError:
raise KeyError(f"No script with key: {script_key} existed in {self.pinned_scripts}") from None
[docs]
def get_pinned_scripts(self) -> List[str]:
"""Return a list of all pinned scripts.
Example:
--------
>>> pinned_scripts = driver.get_pinned_scripts()
"""
return list(self.pinned_scripts)
[docs]
def execute_script(self, script, *args):
"""Synchronously Executes JavaScript in the current window/frame.
Parameters:
-----------
script : str
- The javascript to execute.
*args : tuple
- Any applicable arguments for your JavaScript.
Example:
--------
>>> input_id = "username"
>>> input_value = "test_user"
>>> driver.execute_script(
... "document.getElementById(arguments[0]).value = arguments[1];", input_id, input_value
... )
"""
if isinstance(script, ScriptKey):
try:
script = self.pinned_scripts[script.id]
except KeyError:
raise JavascriptException("Pinned script could not be found")
converted_args = list(args)
command = Command.W3C_EXECUTE_SCRIPT
return self.execute(command, {"script": script, "args": converted_args})["value"]
[docs]
def execute_async_script(self, script: str, *args):
"""Asynchronously Executes JavaScript in the current window/frame.
Parameters:
-----------
script : str
- The javascript to execute.
*args : tuple
- Any applicable arguments for your JavaScript.
Example:
--------
>>> script = "var callback = arguments[arguments.length - 1]; "
... "window.setTimeout(function(){ callback('timeout') }, 3000);"
>>> driver.execute_async_script(script)
"""
converted_args = list(args)
command = Command.W3C_EXECUTE_SCRIPT_ASYNC
return self.execute(command, {"script": script, "args": converted_args})["value"]
@property
def current_url(self) -> str:
"""Gets the URL of the current page.
Example:
--------
>>> print(driver.current_url)
"""
return self.execute(Command.GET_CURRENT_URL)["value"]
@property
def page_source(self) -> str:
"""Gets the source of the current page.
Example:
--------
>>> print(driver.page_source)
"""
return self.execute(Command.GET_PAGE_SOURCE)["value"]
[docs]
def close(self) -> None:
"""Closes the current window.
Example:
--------
>>> driver.close()
"""
self.execute(Command.CLOSE)
[docs]
def quit(self) -> None:
"""Quits the driver and closes every associated window.
Example:
--------
>>> driver.quit()
"""
try:
self.execute(Command.QUIT)
finally:
self.stop_client()
self.command_executor.close()
@property
def current_window_handle(self) -> str:
"""Returns the handle of the current window.
Example:
--------
>>> print(driver.current_window_handle)
"""
return self.execute(Command.W3C_GET_CURRENT_WINDOW_HANDLE)["value"]
@property
def window_handles(self) -> List[str]:
"""Returns the handles of all windows within the current session.
Example:
--------
>>> print(driver.window_handles)
"""
return self.execute(Command.W3C_GET_WINDOW_HANDLES)["value"]
[docs]
def maximize_window(self) -> None:
"""Maximizes the current window that webdriver is using.
Example:
--------
>>> driver.maximize_window()
"""
command = Command.W3C_MAXIMIZE_WINDOW
self.execute(command, None)
[docs]
def fullscreen_window(self) -> None:
"""Invokes the window manager-specific 'full screen' operation.
Example:
--------
>>> driver.fullscreen_window()
"""
self.execute(Command.FULLSCREEN_WINDOW)
[docs]
def minimize_window(self) -> None:
"""Invokes the window manager-specific 'minimize' operation."""
self.execute(Command.MINIMIZE_WINDOW)
[docs]
def print_page(self, print_options: Optional[PrintOptions] = None) -> str:
"""Takes PDF of the current page.
The driver makes a best effort to return a PDF based on the
provided Parameters.
Example:
--------
>>> driver.print_page()
"""
options = {}
if print_options:
options = print_options.to_dict()
return self.execute(Command.PRINT_PAGE, options)["value"]
@property
def switch_to(self) -> SwitchTo:
"""Return an object containing all options to switch focus into.
Returns:
--------
SwitchTo: an object containing all options to switch focus into.
Examples:
--------
>>> element = driver.switch_to.active_element
>>> alert = driver.switch_to.alert
>>> driver.switch_to.default_content()
>>> driver.switch_to.frame('frame_name')
>>> driver.switch_to.frame(1)
>>> driver.switch_to.frame(driver.find_elements(By.TAG_NAME, "iframe")[0])
>>> driver.switch_to.parent_frame()
>>> driver.switch_to.window('main')
"""
return self._switch_to
# Navigation
[docs]
def back(self) -> None:
"""Goes one step backward in the browser history.
Example:
--------
>>> driver.back()
"""
self.execute(Command.GO_BACK)
[docs]
def forward(self) -> None:
"""Goes one step forward in the browser history.
Example:
--------
>>> driver.forward()
"""
self.execute(Command.GO_FORWARD)
[docs]
def refresh(self) -> None:
"""Refreshes the current page.
Example:
--------
>>> driver.refresh()
"""
self.execute(Command.REFRESH)
# Options
[docs]
def get_cookies(self) -> List[dict]:
"""Returns a set of dictionaries, corresponding to cookies visible in
the current session.
Returns:
--------
cookies:List[dict] : A list of dictionaries, corresponding to cookies visible in the current
Example:
--------
>>> cookies = driver.get_cookies()
"""
return self.execute(Command.GET_ALL_COOKIES)["value"]
[docs]
def get_cookie(self, name) -> Optional[Dict]:
"""Get a single cookie by name. Raises ValueError if the name is empty
or whitespace. Returns the cookie if found, None if not.
Example:
--------
>>> cookie = driver.get_cookie('my_cookie')
"""
if not name or name.isspace():
raise ValueError("Cookie name cannot be empty")
with contextlib.suppress(NoSuchCookieException):
return self.execute(Command.GET_COOKIE, {"name": name})["value"]
return None
[docs]
def delete_cookie(self, name) -> None:
"""Deletes a single cookie with the given name. Raises ValueError if
the name is empty or whitespace.
Example:
--------
>>> driver.delete_cookie('my_cookie')
"""
# firefox deletes all cookies when "" is passed as name
if not name or name.isspace():
raise ValueError("Cookie name cannot be empty")
self.execute(Command.DELETE_COOKIE, {"name": name})
[docs]
def delete_all_cookies(self) -> None:
"""Delete all cookies in the scope of the session.
Example:
--------
>>> driver.delete_all_cookies()
"""
self.execute(Command.DELETE_ALL_COOKIES)
[docs]
def add_cookie(self, cookie_dict) -> None:
"""Adds a cookie to your current session.
Parameters:
-----------
cookie_dict : dict
- A dictionary object, with required keys - "name" and "value";
- Optional keys - "path", "domain", "secure", "httpOnly", "expiry", "sameSite"
Examples:
--------
>>> driver.add_cookie({'name' : 'foo', 'value' : 'bar'})
>>> driver.add_cookie({'name' : 'foo', 'value' : 'bar', 'path' : '/'})
>>> driver.add_cookie({'name' : 'foo', 'value' : 'bar', 'path' : '/', 'secure' : True})
>>> driver.add_cookie({'name' : 'foo', 'value' : 'bar', 'sameSite' : 'Strict'})
"""
if "sameSite" in cookie_dict:
assert cookie_dict["sameSite"] in ["Strict", "Lax", "None"]
self.execute(Command.ADD_COOKIE, {"cookie": cookie_dict})
else:
self.execute(Command.ADD_COOKIE, {"cookie": cookie_dict})
# Timeouts
[docs]
def implicitly_wait(self, time_to_wait: float) -> None:
"""Sets a sticky timeout to implicitly wait for an element to be found,
or a command to complete. This method only needs to be called one time
per session. To set the timeout for calls to execute_async_script, see
set_script_timeout.
Parameters:
-----------
time_to_wait : float
- Amount of time to wait (in seconds)
Example:
--------
>>> driver.implicitly_wait(30)
"""
self.execute(Command.SET_TIMEOUTS, {"implicit": int(float(time_to_wait) * 1000)})
[docs]
def set_script_timeout(self, time_to_wait: float) -> None:
"""Set the amount of time that the script should wait during an
execute_async_script call before throwing an error.
Parameters:
-----------
time_to_wait : float
- The amount of time to wait (in seconds)
Example:
--------
>>> driver.set_script_timeout(30)
"""
self.execute(Command.SET_TIMEOUTS, {"script": int(float(time_to_wait) * 1000)})
[docs]
def set_page_load_timeout(self, time_to_wait: float) -> None:
"""Set the amount of time to wait for a page load to complete before
throwing an error.
Parameters:
-----------
time_to_wait : float
- The amount of time to wait (in seconds)
Example:
--------
>>> driver.set_page_load_timeout(30)
"""
try:
self.execute(Command.SET_TIMEOUTS, {"pageLoad": int(float(time_to_wait) * 1000)})
except WebDriverException:
self.execute(Command.SET_TIMEOUTS, {"ms": float(time_to_wait) * 1000, "type": "page load"})
@property
def timeouts(self) -> Timeouts:
"""Get all the timeouts that have been set on the current session.
Returns:
--------
Timeouts: A named tuple with the following fields:
- implicit_wait: The time to wait for elements to be found.
- page_load: The time to wait for a page to load.
- script: The time to wait for scripts to execute.
Example:
--------
>>> driver.timeouts
"""
timeouts = self.execute(Command.GET_TIMEOUTS)["value"]
timeouts["implicit_wait"] = timeouts.pop("implicit") / 1000
timeouts["page_load"] = timeouts.pop("pageLoad") / 1000
timeouts["script"] = timeouts.pop("script") / 1000
return Timeouts(**timeouts)
@timeouts.setter
def timeouts(self, timeouts) -> None:
"""Set all timeouts for the session. This will override any previously
set timeouts.
Example:
--------
>>> my_timeouts = Timeouts()
>>> my_timeouts.implicit_wait = 10
>>> driver.timeouts = my_timeouts
"""
_ = self.execute(Command.SET_TIMEOUTS, timeouts._to_json())["value"]
[docs]
def find_element(self, by=By.ID, value: Optional[str] = None) -> WebElement:
"""Find an element given a By strategy and locator.
Parameters:
-----------
by : selenium.webdriver.common.by.By
The locating strategy to use. Default is `By.ID`. Supported values include:
- By.ID: Locate by element ID.
- By.NAME: Locate by the `name` attribute.
- By.XPATH: Locate by an XPath expression.
- By.CSS_SELECTOR: Locate by a CSS selector.
- By.CLASS_NAME: Locate by the `class` attribute.
- By.TAG_NAME: Locate by the tag name (e.g., "input", "button").
- By.LINK_TEXT: Locate a link element by its exact text.
- By.PARTIAL_LINK_TEXT: Locate a link element by partial text match.
- RelativeBy: Locate elements relative to a specified root element.
Example:
--------
element = driver.find_element(By.ID, 'foo')
Returns:
-------
WebElement
The first matching `WebElement` found on the page.
"""
by, value = self.locator_converter.convert(by, value)
if isinstance(by, RelativeBy):
elements = self.find_elements(by=by, value=value)
if not elements:
raise NoSuchElementException(f"Cannot locate relative element with: {by.root}")
return elements[0]
return self.execute(Command.FIND_ELEMENT, {"using": by, "value": value})["value"]
[docs]
def find_elements(self, by=By.ID, value: Optional[str] = None) -> List[WebElement]:
"""Find elements given a By strategy and locator.
Parameters:
-----------
by : selenium.webdriver.common.by.By
The locating strategy to use. Default is `By.ID`. Supported values include:
- By.ID: Locate by element ID.
- By.NAME: Locate by the `name` attribute.
- By.XPATH: Locate by an XPath expression.
- By.CSS_SELECTOR: Locate by a CSS selector.
- By.CLASS_NAME: Locate by the `class` attribute.
- By.TAG_NAME: Locate by the tag name (e.g., "input", "button").
- By.LINK_TEXT: Locate a link element by its exact text.
- By.PARTIAL_LINK_TEXT: Locate a link element by partial text match.
- RelativeBy: Locate elements relative to a specified root element.
Example:
--------
element = driver.find_elements(By.ID, 'foo')
Returns:
-------
List[WebElement]
list of `WebElements` matching locator strategy found on the page.
"""
by, value = self.locator_converter.convert(by, value)
if isinstance(by, RelativeBy):
_pkg = ".".join(__name__.split(".")[:-1])
raw_function = pkgutil.get_data(_pkg, "findElements.js").decode("utf8")
find_element_js = f"/* findElements */return ({raw_function}).apply(null, arguments);"
return self.execute_script(find_element_js, by.to_dict())
# Return empty list if driver returns null
# See https://github.com/SeleniumHQ/selenium/issues/4555
return self.execute(Command.FIND_ELEMENTS, {"using": by, "value": value})["value"] or []
@property
def capabilities(self) -> dict:
"""Returns the drivers current capabilities being used.
Example:
--------
>>> print(driver.capabilities)
"""
return self.caps
[docs]
def get_screenshot_as_file(self, filename) -> bool:
"""Saves a screenshot of the current window to a PNG image file.
Returns False if there is any IOError, else returns True. Use full
paths in your filename.
Parameters:
-----------
filename : str
- The full path you wish to save your screenshot to. This
- should end with a `.png` extension.
Example:
--------
>>> driver.get_screenshot_as_file('/Screenshots/foo.png')
"""
if not str(filename).lower().endswith(".png"):
warnings.warn(
"name used for saved screenshot does not match file type. It should end with a `.png` extension",
UserWarning,
stacklevel=2,
)
png = self.get_screenshot_as_png()
try:
with open(filename, "wb") as f:
f.write(png)
except OSError:
return False
finally:
del png
return True
[docs]
def save_screenshot(self, filename) -> bool:
"""Saves a screenshot of the current window to a PNG image file.
Returns False if there is any IOError, else returns True. Use full
paths in your filename.
Parameters:
-----------
filename : str
- The full path you wish to save your screenshot to. This
- should end with a `.png` extension.
Example:
--------
>>> driver.save_screenshot('/Screenshots/foo.png')
"""
return self.get_screenshot_as_file(filename)
[docs]
def get_screenshot_as_png(self) -> bytes:
"""Gets the screenshot of the current window as a binary data.
Example:
--------
>>> driver.get_screenshot_as_png()
"""
return b64decode(self.get_screenshot_as_base64().encode("ascii"))
[docs]
def get_screenshot_as_base64(self) -> str:
"""Gets the screenshot of the current window as a base64 encoded string
which is useful in embedded images in HTML.
Example:
--------
>>> driver.get_screenshot_as_base64()
"""
return self.execute(Command.SCREENSHOT)["value"]
[docs]
def set_window_size(self, width, height, windowHandle: str = "current") -> None:
"""Sets the width and height of the current window. (window.resizeTo)
Parameters:
-----------
width : int
- the width in pixels to set the window to
height : int
- the height in pixels to set the window to
Example:
--------
>>> driver.set_window_size(800,600)
"""
self._check_if_window_handle_is_current(windowHandle)
self.set_window_rect(width=int(width), height=int(height))
[docs]
def get_window_size(self, windowHandle: str = "current") -> dict:
"""Gets the width and height of the current window.
Example:
--------
>>> driver.get_window_size()
"""
self._check_if_window_handle_is_current(windowHandle)
size = self.get_window_rect()
if size.get("value", None):
size = size["value"]
return {k: size[k] for k in ("width", "height")}
[docs]
def set_window_position(self, x: float, y: float, windowHandle: str = "current") -> dict:
"""Sets the x,y position of the current window. (window.moveTo)
Parameters:
---------
x : float
- The x-coordinate in pixels to set the window position
y : float
- The y-coordinate in pixels to set the window position
Example:
--------
>>> driver.set_window_position(0,0)
"""
self._check_if_window_handle_is_current(windowHandle)
return self.set_window_rect(x=int(x), y=int(y))
[docs]
def get_window_position(self, windowHandle="current") -> dict:
"""Gets the x,y position of the current window.
Example:
--------
>>> driver.get_window_position()
"""
self._check_if_window_handle_is_current(windowHandle)
position = self.get_window_rect()
return {k: position[k] for k in ("x", "y")}
def _check_if_window_handle_is_current(self, windowHandle: str) -> None:
"""Warns if the window handle is not equal to `current`."""
if windowHandle != "current":
warnings.warn("Only 'current' window is supported for W3C compatible browsers.", stacklevel=2)
[docs]
def get_window_rect(self) -> dict:
"""Gets the x, y coordinates of the window as well as height and width
of the current window.
Example:
--------
>>> driver.get_window_rect()
"""
return self.execute(Command.GET_WINDOW_RECT)["value"]
[docs]
def set_window_rect(self, x=None, y=None, width=None, height=None) -> dict:
"""Sets the x, y coordinates of the window as well as height and width
of the current window. This method is only supported for W3C compatible
browsers; other browsers should use `set_window_position` and
`set_window_size`.
Example:
--------
>>> driver.set_window_rect(x=10, y=10)
>>> driver.set_window_rect(width=100, height=200)
>>> driver.set_window_rect(x=10, y=10, width=100, height=200)
"""
if (x is None and y is None) and (not height and not width):
raise InvalidArgumentException("x and y or height and width need values")
return self.execute(Command.SET_WINDOW_RECT, {"x": x, "y": y, "width": width, "height": height})["value"]
@property
def file_detector(self) -> FileDetector:
return self._file_detector
@file_detector.setter
def file_detector(self, detector) -> None:
"""Set the file detector to be used when sending keyboard input. By
default, this is set to a file detector that does nothing.
- see FileDetector
- see LocalFileDetector
- see UselessFileDetector
Parameters:
-----------
detector : Any
- The detector to use. Must not be None.
"""
if not detector:
raise WebDriverException("You may not set a file detector that is null")
if not isinstance(detector, FileDetector):
raise WebDriverException("Detector has to be instance of FileDetector")
self._file_detector = detector
@property
def orientation(self):
"""Gets the current orientation of the device.
Example:
--------
>>> orientation = driver.orientation
"""
return self.execute(Command.GET_SCREEN_ORIENTATION)["value"]
@orientation.setter
def orientation(self, value) -> None:
"""Sets the current orientation of the device.
Parameters:
-----------
value : str
- orientation to set it to.
Example:
--------
>>> driver.orientation = 'landscape'
"""
allowed_values = ["LANDSCAPE", "PORTRAIT"]
if value.upper() in allowed_values:
self.execute(Command.SET_SCREEN_ORIENTATION, {"orientation": value})
else:
raise WebDriverException("You can only set the orientation to 'LANDSCAPE' and 'PORTRAIT'")
@property
def log_types(self):
"""Gets a list of the available log types. This only works with w3c
compliant browsers.
Example:
--------
>>> driver.log_types
"""
return self.execute(Command.GET_AVAILABLE_LOG_TYPES)["value"]
[docs]
def get_log(self, log_type):
"""Gets the log for a given log type.
Parameters:
-----------
log_type : str
- Type of log that which will be returned
Example:
--------
>>> driver.get_log('browser')
>>> driver.get_log('driver')
>>> driver.get_log('client')
>>> driver.get_log('server')
"""
return self.execute(Command.GET_LOG, {"type": log_type})["value"]
[docs]
@asynccontextmanager
async def bidi_connection(self):
global cdp
import_cdp()
if self.caps.get("se:cdp"):
ws_url = self.caps.get("se:cdp")
version = self.caps.get("se:cdpVersion").split(".")[0]
else:
version, ws_url = self._get_cdp_details()
if not ws_url:
raise WebDriverException("Unable to find url to connect to from capabilities")
devtools = cdp.import_devtools(version)
async with cdp.open_cdp(ws_url) as conn:
targets = await conn.execute(devtools.target.get_targets())
target_id = targets[0].target_id
async with conn.open_session(target_id) as session:
yield BidiConnection(session, cdp, devtools)
@property
def script(self):
if not self._websocket_connection:
self._start_bidi()
if not self._script:
self._script = Script(self._websocket_connection)
return self._script
def _start_bidi(self):
if self.caps.get("webSocketUrl"):
ws_url = self.caps.get("webSocketUrl")
else:
raise WebDriverException("Unable to find url to connect to from capabilities")
self._websocket_connection = WebSocketConnection(ws_url)
def _get_cdp_details(self):
import json
import urllib3
http = urllib3.PoolManager()
if self.caps.get("browserName") == "chrome":
debugger_address = self.caps.get("goog:chromeOptions").get("debuggerAddress")
elif self.caps.get("browserName") == "MicrosoftEdge":
debugger_address = self.caps.get("ms:edgeOptions").get("debuggerAddress")
res = http.request("GET", f"http://{debugger_address}/json/version")
data = json.loads(res.data)
browser_version = data.get("Browser")
websocket_url = data.get("webSocketDebuggerUrl")
import re
version = re.search(r".*/(\d+)\.", browser_version).group(1)
return version, websocket_url
# Virtual Authenticator Methods
[docs]
def add_virtual_authenticator(self, options: VirtualAuthenticatorOptions) -> None:
"""Adds a virtual authenticator with the given options.
Example:
--------
>>> from selenium.webdriver.common.virtual_authenticator import VirtualAuthenticatorOptions
>>> options = VirtualAuthenticatorOptions(protocol="u2f", transport="usb", device_id="myDevice123")
>>> driver.add_virtual_authenticator(options)
"""
self._authenticator_id = self.execute(Command.ADD_VIRTUAL_AUTHENTICATOR, options.to_dict())["value"]
@property
def virtual_authenticator_id(self) -> str:
"""Returns the id of the virtual authenticator.
Example:
--------
>>> print(driver.virtual_authenticator_id)
"""
return self._authenticator_id
[docs]
@required_virtual_authenticator
def remove_virtual_authenticator(self) -> None:
"""Removes a previously added virtual authenticator.
The authenticator is no longer valid after removal, so no
methods may be called.
Example:
--------
>>> driver.remove_virtual_authenticator()
"""
self.execute(Command.REMOVE_VIRTUAL_AUTHENTICATOR, {"authenticatorId": self._authenticator_id})
self._authenticator_id = None
[docs]
@required_virtual_authenticator
def add_credential(self, credential: Credential) -> None:
"""Injects a credential into the authenticator.
Example:
--------
>>> from selenium.webdriver.common.credential import Credential
>>> credential = Credential(id="user@example.com", password="aPassword")
>>> driver.add_credential(credential)
"""
self.execute(Command.ADD_CREDENTIAL, {**credential.to_dict(), "authenticatorId": self._authenticator_id})
[docs]
@required_virtual_authenticator
def get_credentials(self) -> List[Credential]:
"""Returns the list of credentials owned by the authenticator.
Example:
--------
>>> credentials = driver.get_credentials()
"""
credential_data = self.execute(Command.GET_CREDENTIALS, {"authenticatorId": self._authenticator_id})
return [Credential.from_dict(credential) for credential in credential_data["value"]]
[docs]
@required_virtual_authenticator
def remove_credential(self, credential_id: Union[str, bytearray]) -> None:
"""Removes a credential from the authenticator.
Example:
--------
>>> credential_id = "user@example.com"
>>> driver.remove_credential(credential_id)
"""
# Check if the credential is bytearray converted to b64 string
if isinstance(credential_id, bytearray):
credential_id = urlsafe_b64encode(credential_id).decode()
self.execute(
Command.REMOVE_CREDENTIAL, {"credentialId": credential_id, "authenticatorId": self._authenticator_id}
)
[docs]
@required_virtual_authenticator
def remove_all_credentials(self) -> None:
"""Removes all credentials from the authenticator.
Example:
--------
>>> driver.remove_all_credentials()
"""
self.execute(Command.REMOVE_ALL_CREDENTIALS, {"authenticatorId": self._authenticator_id})
[docs]
@required_virtual_authenticator
def set_user_verified(self, verified: bool) -> None:
"""Sets whether the authenticator will simulate success or fail on user
verification.
Parameters:
-----------
verified: True if the authenticator will pass user verification, False otherwise.
Example:
--------
>>> driver.set_user_verified(True)
"""
self.execute(Command.SET_USER_VERIFIED, {"authenticatorId": self._authenticator_id, "isUserVerified": verified})
[docs]
def get_downloadable_files(self) -> list:
"""Retrieves the downloadable files as a list of file names.
Example:
--------
>>> files = driver.get_downloadable_files()
"""
if "se:downloadsEnabled" not in self.capabilities:
raise WebDriverException("You must enable downloads in order to work with downloadable files.")
return self.execute(Command.GET_DOWNLOADABLE_FILES)["value"]["names"]
[docs]
def download_file(self, file_name: str, target_directory: str) -> None:
"""Downloads a file with the specified file name to the target
directory.
Parameters:
-----------
file_name : str
- The name of the file to download.
target_directory : str
- The path to the directory to save the downloaded file.
Example:
--------
>>> driver.download_file("example.zip", "/path/to/directory")
"""
if "se:downloadsEnabled" not in self.capabilities:
raise WebDriverException("You must enable downloads in order to work with downloadable files.")
if not os.path.exists(target_directory):
os.makedirs(target_directory)
contents = self.execute(Command.DOWNLOAD_FILE, {"name": file_name})["value"]["contents"]
with tempfile.TemporaryDirectory() as tmp_dir:
zip_file = os.path.join(tmp_dir, file_name + ".zip")
with open(zip_file, "wb") as file:
file.write(base64.b64decode(contents))
with zipfile.ZipFile(zip_file, "r") as zip_ref:
zip_ref.extractall(target_directory)
[docs]
def delete_downloadable_files(self) -> None:
"""Deletes all downloadable files.
Example:
--------
>>> driver.delete_downloadable_files()
"""
if "se:downloadsEnabled" not in self.capabilities:
raise WebDriverException("You must enable downloads in order to work with downloadable files.")
self.execute(Command.DELETE_DOWNLOADABLE_FILES)
@property
def fedcm(self) -> FedCM:
"""Returns the Federated Credential Management (FedCM) dialog object
for interaction.
Returns:
-------
FedCM: an object providing access to all Federated Credential Management (FedCM) dialog commands.
Examples:
--------
>>> title = driver.fedcm.title
>>> subtitle = driver.fedcm.subtitle
>>> dialog_type = driver.fedcm.dialog_type
>>> accounts = driver.fedcm.account_list
>>> driver.fedcm.select_account(0)
>>> driver.fedcm.accept()
>>> driver.fedcm.dismiss()
>>> driver.fedcm.enable_delay()
>>> driver.fedcm.disable_delay()
>>> driver.fedcm.reset_cooldown()
"""
return self._fedcm
@property
def supports_fedcm(self) -> bool:
"""Returns whether the browser supports FedCM capabilities.
Example:
--------
>>> print(driver.supports_fedcm)
"""
return self.capabilities.get(ArgOptions.FEDCM_CAPABILITY, False)
def _require_fedcm_support(self):
"""Raises an exception if FedCM is not supported."""
if not self.supports_fedcm:
raise WebDriverException(
"This browser does not support Federated Credential Management. "
"Please ensure you're using a supported browser."
)
@property
def dialog(self):
"""Returns the FedCM dialog object for interaction.
Example:
--------
>>> dialog = driver.dialog
"""
self._require_fedcm_support()
return Dialog(self)
[docs]
def fedcm_dialog(self, timeout=5, poll_frequency=0.5, ignored_exceptions=None):
"""Waits for and returns the FedCM dialog.
Parameters:
-----------
timeout : int
- How long to wait for the dialog
poll_frequency : floatHow
- Frequently to poll
ignored_exceptions : Any
- Exceptions to ignore while waiting
Returns:
-------
The FedCM dialog object if found
Raises:
-------
TimeoutException if dialog doesn't appear
WebDriverException if FedCM not supported
"""
from selenium.common.exceptions import NoAlertPresentException
from selenium.webdriver.support.wait import WebDriverWait
self._require_fedcm_support()
if ignored_exceptions is None:
ignored_exceptions = (NoAlertPresentException,)
def _check_fedcm():
try:
dialog = Dialog(self)
return dialog if dialog.type else None
except NoAlertPresentException:
return None
wait = WebDriverWait(self, timeout, poll_frequency=poll_frequency, ignored_exceptions=ignored_exceptions)
return wait.until(lambda _: _check_fedcm())