7.1. Exceptions¶

Exceptions that may happen in all the webdriver code.

exception selenium.common.exceptions.ElementClickInterceptedException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

The Element Click command could not be completed because the element receiving the events is obscuring the element that was requested to be clicked.

exception selenium.common.exceptions.ElementNotInteractableException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: InvalidElementStateException

Thrown when an element is present in the DOM but interactions with that element will hit another element due to paint order.

exception selenium.common.exceptions.ElementNotSelectableException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: InvalidElementStateException

Thrown when trying to select an unselectable element.

For example, selecting a ‘script’ element.

exception selenium.common.exceptions.ElementNotVisibleException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: InvalidElementStateException

Thrown when an element is present on the DOM, but it is not visible, and so is not able to be interacted with.

Most commonly encountered when trying to click or read text of an element that is hidden from view.

exception selenium.common.exceptions.ImeActivationFailedException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

Thrown when activating an IME engine has failed.

exception selenium.common.exceptions.ImeNotAvailableException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

Thrown when IME support is not available.

This exception is thrown for every IME-related method call if IME support is not available on the machine.

exception selenium.common.exceptions.InsecureCertificateException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

Navigation caused the user agent to hit a certificate warning, which is usually the result of an expired or invalid TLS certificate.

exception selenium.common.exceptions.InvalidArgumentException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

The arguments passed to a command are either invalid or malformed.

exception selenium.common.exceptions.InvalidCookieDomainException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

Thrown when attempting to add a cookie under a different domain than the current URL.

exception selenium.common.exceptions.InvalidCoordinatesException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

The coordinates provided to an interaction’s operation are invalid.

exception selenium.common.exceptions.InvalidElementStateException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

Thrown when a command could not be completed because the element is in an invalid state.

This can be caused by attempting to clear an element that isn’t both editable and resettable.

exception selenium.common.exceptions.InvalidSelectorException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

Thrown when the selector which is used to find an element does not return a WebElement.

Currently this only happens when the selector is an xpath expression and it is either syntactically invalid (i.e. it is not a xpath expression) or the expression does not select WebElements (e.g. “count(//input)”).

__init__(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None) → None¶

exception selenium.common.exceptions.InvalidSessionIdException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

Occurs if the given session id is not in the list of active sessions, meaning the session either does not exist or that it’s not active.

exception selenium.common.exceptions.InvalidSwitchToTargetException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

Thrown when frame or window target to be switched doesn’t exist.

exception selenium.common.exceptions.JavascriptException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

An error occurred while executing JavaScript supplied by the user.

exception selenium.common.exceptions.MoveTargetOutOfBoundsException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

Thrown when the target provided to the ActionsChains move() method is invalid, i.e. out of document.

exception selenium.common.exceptions.NoAlertPresentException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

Thrown when switching to no presented alert.

This can be caused by calling an operation on the Alert() class when an alert is not yet on the screen.

exception selenium.common.exceptions.NoSuchAttributeException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

Thrown when the attribute of element could not be found.

You may want to check if the attribute exists in the particular browser you are testing against. Some browsers may have different property names for the same property. (IE8’s .innerText vs. Firefox .textContent)

exception selenium.common.exceptions.NoSuchCookieException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

No cookie matching the given path name was found amongst the associated cookies of the current browsing context’s active document.

exception selenium.common.exceptions.NoSuchDriverException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

Raised when driver is not specified and cannot be located.

__init__(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None) → None¶

exception selenium.common.exceptions.NoSuchElementException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

Thrown when element could not be found.

If you encounter this exception, you may want to check the following:

• Check your selector used in your find_by…

• Element may not yet be on the screen at the time of the find operation, (webpage is still loading) see selenium.webdriver.support.wait.WebDriverWait() for how to write a wait wrapper to wait for an element to appear.

__init__(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None) → None¶

exception selenium.common.exceptions.NoSuchFrameException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: InvalidSwitchToTargetException

Thrown when frame target to be switched doesn’t exist.

exception selenium.common.exceptions.NoSuchShadowRootException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

Thrown when trying to access the shadow root of an element when it does not have a shadow root attached.

exception selenium.common.exceptions.NoSuchWindowException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: InvalidSwitchToTargetException

Thrown when window target to be switched doesn’t exist.

To find the current set of active window handles, you can get a list of the active window handles in the following way:

print driver.window_handles

exception selenium.common.exceptions.ScreenshotException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

A screen capture was made impossible.

exception selenium.common.exceptions.SessionNotCreatedException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

A new session could not be created.

exception selenium.common.exceptions.StaleElementReferenceException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

Thrown when a reference to an element is now “stale”.

Stale means the element no longer appears on the DOM of the page.

Possible causes of StaleElementReferenceException include, but not limited to:

• You are no longer on the same page, or the page may have refreshed since the element was located.

• The element may have been removed and re-added to the screen, since it was located. Such as an element being relocated. This can happen typically with a javascript framework when values are updated and the node is rebuilt.

• Element may have been inside an iframe or another context which was refreshed.

__init__(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None) → None¶

exception selenium.common.exceptions.TimeoutException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

Thrown when a command does not complete in enough time.

exception selenium.common.exceptions.UnableToSetCookieException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

Thrown when a driver fails to set a cookie.

exception selenium.common.exceptions.UnexpectedAlertPresentException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None, alert_text: str | None = None)¶

Bases: WebDriverException

Thrown when an unexpected alert has appeared.

Usually raised when an unexpected modal is blocking the webdriver from executing commands.

__init__(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None, alert_text: str | None = None) → None¶

exception selenium.common.exceptions.UnexpectedTagNameException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

Thrown when a support class did not get an expected web element.

exception selenium.common.exceptions.UnknownMethodException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: WebDriverException

The requested command matched a known URL but did not match any methods for that URL.

exception selenium.common.exceptions.WebDriverException(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None)¶

Bases: Exception

Base webdriver exception.

__init__(msg: str | None = None, screen: str | None = None, stacktrace: Sequence[str] | None = None) → None¶

7.2. Action Chains¶

The ActionChains implementation.

class selenium.webdriver.common.action_chains.ActionChains(driver: WebDriver, duration: int = 250, devices: list[AnyDevice] | None = None)¶

Bases: object

ActionChains are a way to automate low level interactions such as mouse movements, mouse button actions, key press, and context menu interactions. This is useful for doing more complex actions like hover over and drag and drop.

Generate user actions.

When you call methods for actions on the ActionChains object, the actions are stored in a queue in the ActionChains object. When you call perform(), the events are fired in the order they are queued up.

ActionChains can be used in a chain pattern:

menu = driver.find_element(By.CSS_SELECTOR, ".nav")
hidden_submenu = driver.find_element(By.CSS_SELECTOR, ".nav #submenu1")

ActionChains(driver).move_to_element(menu).click(hidden_submenu).perform()

Or actions can be queued up one by one, then performed.:

menu = driver.find_element(By.CSS_SELECTOR, ".nav")
hidden_submenu = driver.find_element(By.CSS_SELECTOR, ".nav #submenu1")

actions = ActionChains(driver)
actions.move_to_element(menu)
actions.click(hidden_submenu)
actions.perform()

Either way, the actions are performed in the order they are called, one after another.

__init__(driver: WebDriver, duration: int = 250, devices: list[AnyDevice] | None = None) → None¶

Creates a new ActionChains.

Args:

• driver: The WebDriver instance which performs user actions.

• duration: override the default 250 msecs of DEFAULT_MOVE_DURATION in PointerInput

click(on_element: WebElement | None = None) → ActionChains¶

Clicks an element.

Args:

• on_element: The element to click. If None, clicks on current mouse position.

click_and_hold(on_element: WebElement | None = None) → ActionChains¶

Holds down the left mouse button on an element.

Args:

• on_element: The element to mouse down. If None, clicks on current mouse position.

context_click(on_element: WebElement | None = None) → ActionChains¶

Performs a context-click (right click) on an element.

Args:

• on_element: The element to context-click. If None, clicks on current mouse position.

double_click(on_element: WebElement | None = None) → ActionChains¶

Double-clicks an element.

Args:

• on_element: The element to double-click. If None, clicks on current mouse position.

drag_and_drop(source: WebElement, target: WebElement) → ActionChains¶

Holds down the left mouse button on the source element, then moves to the target element and releases the mouse button.

Args:

• source: The element to mouse down.

• target: The element to mouse up.

drag_and_drop_by_offset(source: WebElement, xoffset: int, yoffset: int) → ActionChains¶

Holds down the left mouse button on the source element, then moves to the target offset and releases the mouse button.

Args:

• source: The element to mouse down.

• xoffset: X offset to move to.

• yoffset: Y offset to move to.

key_down(value: str, element: WebElement | None = None) → ActionChains¶

Sends a key press only, without releasing it. Should only be used with modifier keys (Control, Alt and Shift).

Args:

• value: The modifier key to send. Values are defined in Keys class.

• element: The element to send keys. If None, sends a key to current focused element.

Example, pressing ctrl+c:

ActionChains(driver).key_down(Keys.CONTROL).send_keys('c').key_up(Keys.CONTROL).perform()

key_up(value: str, element: WebElement | None = None) → ActionChains¶

Releases a modifier key.

Args:

• value: The modifier key to send. Values are defined in Keys class.

• element: The element to send keys. If None, sends a key to current focused element.

Example, pressing ctrl+c:

ActionChains(driver).key_down(Keys.CONTROL).send_keys('c').key_up(Keys.CONTROL).perform()

move_by_offset(xoffset: int, yoffset: int) → ActionChains¶

Moving the mouse to an offset from current mouse position.

Args:

• xoffset: X offset to move to, as a positive or negative integer.

• yoffset: Y offset to move to, as a positive or negative integer.

move_to_element(to_element: WebElement) → ActionChains¶

Moving the mouse to the middle of an element.

Args:

• to_element: The WebElement to move to.

move_to_element_with_offset(to_element: WebElement, xoffset: int, yoffset: int) → ActionChains¶

Move the mouse by an offset of the specified element. Offsets are relative to the in-view center point of the element.

Args:

• to_element: The WebElement to move to.

• xoffset: X offset to move to, as a positive or negative integer.

• yoffset: Y offset to move to, as a positive or negative integer.

pause(seconds: float | int) → ActionChains¶

Pause all inputs for the specified duration in seconds.

perform() → None¶

Performs all stored actions.

release(on_element: WebElement | None = None) → ActionChains¶

Releasing a held mouse button on an element.

Args:

• on_element: The element to mouse up. If None, releases on current mouse position.

reset_actions() → None¶

Clears actions that are already stored locally and on the remote end.

scroll_by_amount(delta_x: int, delta_y: int) → ActionChains¶

Scrolls by provided amounts with the origin in the top left corner of the viewport.

Args:

• delta_x: Distance along X axis to scroll using the wheel. A negative value scrolls left.

• delta_y: Distance along Y axis to scroll using the wheel. A negative value scrolls up.

scroll_from_origin(scroll_origin: ScrollOrigin, delta_x: int, delta_y: int) → ActionChains¶

Scrolls by provided amount based on a provided origin. The scroll origin is either the center of an element or the upper left of the viewport plus any offsets. If the origin is an element, and the element is not in the viewport, the bottom of the element will first be scrolled to the bottom of the viewport.

Args:

• origin: Where scroll originates (viewport or element center) plus provided offsets.

• delta_x: Distance along X axis to scroll using the wheel. A negative value scrolls left.

• delta_y: Distance along Y axis to scroll using the wheel. A negative value scrolls up.

Raises:

If the origin with offset is outside the viewport. - MoveTargetOutOfBoundsException - If the origin with offset is outside the viewport.

scroll_to_element(element: WebElement) → ActionChains¶

If the element is outside the viewport, scrolls the bottom of the element to the bottom of the viewport.

Args:

• element: Which element to scroll into the viewport.

send_keys(*keys_to_send: str) → ActionChains¶

Sends keys to current focused element.

Args:

• keys_to_send: The keys to send. Modifier keys constants can be found in the ‘Keys’ class.

send_keys_to_element(element: WebElement, *keys_to_send: str) → ActionChains¶

Sends keys to an element.

Args:

• element: The element to send keys.

• keys_to_send: The keys to send. Modifier keys constants can be found in the ‘Keys’ class.

7.3. Alerts¶

The Alert implementation.

class selenium.webdriver.common.alert.Alert(driver)¶

Bases: object

Allows to work with alerts.

Use this class to interact with alert prompts. It contains methods for dismissing, accepting, inputting, and getting text from alert prompts.

Accepting / Dismissing alert prompts:

Alert(driver).accept()
Alert(driver).dismiss()

Inputting a value into an alert prompt:

name_prompt = Alert(driver)
name_prompt.send_keys("Willian Shakesphere")
name_prompt.accept()

Reading a the text of a prompt for verification:

alert_text = Alert(driver).text
self.assertEqual("Do you wish to quit?", alert_text)

__init__(driver) → None¶

Creates a new Alert.

Args:

• driver: The WebDriver instance which performs user actions.

accept() → None¶

Accepts the alert available.

Usage:

Alert(driver).accept() # Confirm a alert dialog.

dismiss() → None¶

Dismisses the alert available.

send_keys(keysToSend: str) → None¶

Send Keys to the Alert.

Args:

• keysToSend: The text to be sent to Alert.

property text: str¶

Gets the text of the Alert.

7.4. Special Keys¶

The Keys implementation.

class selenium.webdriver.common.keys.Keys¶

Bases: object

Set of special keys codes.

ADD = '\ue025'¶

ALT = '\ue00a'¶

ARROW_DOWN = '\ue015'¶

ARROW_LEFT = '\ue012'¶

ARROW_RIGHT = '\ue014'¶

ARROW_UP = '\ue013'¶

BACKSPACE = '\ue003'¶

BACK_SPACE = '\ue003'¶

CANCEL = '\ue001'¶

CLEAR = '\ue005'¶

COMMAND = '\ue03d'¶

CONTROL = '\ue009'¶

DECIMAL = '\ue028'¶

DELETE = '\ue017'¶

DIVIDE = '\ue029'¶

DOWN = '\ue015'¶

END = '\ue010'¶

ENTER = '\ue007'¶

EQUALS = '\ue019'¶

ESCAPE = '\ue00c'¶

F1 = '\ue031'¶

F10 = '\ue03a'¶

F11 = '\ue03b'¶

F12 = '\ue03c'¶

F2 = '\ue032'¶

F3 = '\ue033'¶

F4 = '\ue034'¶

F5 = '\ue035'¶

F6 = '\ue036'¶

F7 = '\ue037'¶

F8 = '\ue038'¶

F9 = '\ue039'¶

HELP = '\ue002'¶

HOME = '\ue011'¶

INSERT = '\ue016'¶

LEFT = '\ue012'¶

LEFT_ALT = '\ue00a'¶

LEFT_CONTROL = '\ue009'¶

LEFT_SHIFT = '\ue008'¶

META = '\ue03d'¶

MULTIPLY = '\ue024'¶

NULL = '\ue000'¶

NUMPAD0 = '\ue01a'¶

NUMPAD1 = '\ue01b'¶

NUMPAD2 = '\ue01c'¶

NUMPAD3 = '\ue01d'¶

NUMPAD4 = '\ue01e'¶

NUMPAD5 = '\ue01f'¶

NUMPAD6 = '\ue020'¶

NUMPAD7 = '\ue021'¶

NUMPAD8 = '\ue022'¶

NUMPAD9 = '\ue023'¶

PAGE_DOWN = '\ue00f'¶

PAGE_UP = '\ue00e'¶

PAUSE = '\ue00b'¶

RETURN = '\ue006'¶

RIGHT = '\ue014'¶

SEMICOLON = '\ue018'¶

SEPARATOR = '\ue026'¶

SHIFT = '\ue008'¶

SPACE = '\ue00d'¶

SUBTRACT = '\ue027'¶

TAB = '\ue004'¶

UP = '\ue013'¶

ZENKAKU_HANKAKU = '\ue040'¶

7.5. Locate elements By¶

These are the attributes which can be used to locate elements. See the Locating Elements chapter for example usages.

The By implementation.

class selenium.webdriver.common.by.By¶

Bases: object

Set of supported locator strategies.

CLASS_NAME = 'class name'¶

CSS_SELECTOR = 'css selector'¶

ID = 'id'¶

LINK_TEXT = 'link text'¶

NAME = 'name'¶

PARTIAL_LINK_TEXT = 'partial link text'¶

TAG_NAME = 'tag name'¶

XPATH = 'xpath'¶

7.6. Desired Capabilities¶

See the Using Selenium with remote WebDriver section for example usages of desired capabilities.

The Desired Capabilities implementation.

class selenium.webdriver.common.desired_capabilities.DesiredCapabilities¶

Bases: object

Set of default supported desired capabilities.

Use this as a starting point for creating a desired capabilities object for requesting remote webdrivers for connecting to selenium server or selenium grid.

Usage Example:

from selenium import webdriver

selenium_grid_url = "http://198.0.0.1:4444/wd/hub"

# Create a desired capabilities object as a starting point.
capabilities = DesiredCapabilities.FIREFOX.copy()
capabilities['platform'] = "WINDOWS"
capabilities['version'] = "10"

# Instantiate an instance of Remote WebDriver with the desired capabilities.
driver = webdriver.Remote(desired_capabilities=capabilities,
                          command_executor=selenium_grid_url)

Note: Always use ‘.copy()’ on the DesiredCapabilities object to avoid the side effects of altering the Global class instance.

CHROME = {'browserName': 'chrome'}¶

EDGE = {'browserName': 'MicrosoftEdge'}¶

FIREFOX = {'acceptInsecureCerts': True, 'browserName': 'firefox', 'moz:debuggerAddress': True}¶

HTMLUNIT = {'browserName': 'htmlunit', 'platform': 'ANY', 'version': ''}¶

HTMLUNITWITHJS = {'browserName': 'htmlunit', 'javascriptEnabled': True, 'platform': 'ANY', 'version': 'firefox'}¶

INTERNETEXPLORER = {'browserName': 'internet explorer', 'platformName': 'windows'}¶

IPAD = {'browserName': 'iPad', 'platform': 'mac', 'version': ''}¶

IPHONE = {'browserName': 'iPhone', 'platform': 'mac', 'version': ''}¶

SAFARI = {'browserName': 'safari', 'platformName': 'mac'}¶

WEBKITGTK = {'browserName': 'MiniBrowser'}¶

WPEWEBKIT = {'browserName': 'MiniBrowser'}¶

7.7. Proxy¶

The Proxy implementation.

class selenium.webdriver.common.proxy.Proxy(raw=None)¶

Bases: object

Proxy contains information about proxy type and necessary proxy settings.

__init__(raw=None)¶

Creates a new Proxy.

Args:

• raw: raw proxy data. If None, default class values are used.

to_capabilities()¶

auto_detect¶

Gets and Sets auto_detect

7. Usage¶

• Get

  • self.auto_detect

• Set

  • self.auto_detect = value

7. Parameters¶

value: str

autodetect = False¶

ftpProxy = ''¶

ftp_proxy¶

Gets and Sets ftp_proxy

7. Usage¶

• Get

  • self.ftp_proxy

• Set

  • self.ftp_proxy = value

7. Parameters¶

value: str

httpProxy = ''¶

http_proxy¶

Gets and Sets http_proxy

7. Usage¶

• Get

  • self.http_proxy

• Set

  • self.http_proxy = value

7. Parameters¶

value: str

noProxy = ''¶

no_proxy¶

Gets and Sets no_proxy

7. Usage¶

• Get

  • self.no_proxy

• Set

  • self.no_proxy = value

7. Parameters¶

value: str

proxyAutoconfigUrl = ''¶

proxyType = {'ff_value': 6, 'string': 'UNSPECIFIED'}¶

proxy_autoconfig_url¶

Gets and Sets proxy_autoconfig_url

7. Usage¶

• Get

  • self.proxy_autoconfig_url

• Set

  • self.proxy_autoconfig_url = value

7. Parameter¶

value: str

property proxy_type¶

Returns proxy type as ProxyType.

socksPassword = ''¶

socksProxy = ''¶

socksUsername = ''¶

socksVersion = None¶

socks_password¶

Gets and Sets socks_password

7. Usage¶

• Get

  • self.socks_password

• Set

  • self.socks_password = value

7. Parameter¶

value: str

socks_proxy¶

Gets and Sets socks_proxy

7. Usage¶

• Get

  • self.sock_proxy

• Set

  • self.socks_proxy = value

7. Parameter¶

value: str

socks_username¶

Gets and Sets socks_password

7. Usage¶

• Get

  • self.socks_password

• Set

  • self.socks_password = value

7. Parameter¶

value: str

socks_version¶

Gets and Sets socks_version

7. Usage¶

• Get

  • self.socks_version

• Set

  • self.socks_version = value

7. Parameter¶

value: str

sslProxy = ''¶

ssl_proxy¶

Gets and Sets ssl_proxy

7. Usage¶

• Get

  • self.ssl_proxy

• Set

  • self.ssl_proxy = value

7. Parameter¶

value: str

class selenium.webdriver.common.proxy.ProxyType¶

Bases: object

Set of possible types of proxy.

Each proxy type has 2 properties: ‘ff_value’ is value of Firefox profile preference, ‘string’ is id of proxy type.

classmethod load(value)¶

AUTODETECT = {'ff_value': 4, 'string': 'AUTODETECT'}¶

DIRECT = {'ff_value': 0, 'string': 'DIRECT'}¶

MANUAL = {'ff_value': 1, 'string': 'MANUAL'}¶

PAC = {'ff_value': 2, 'string': 'PAC'}¶

RESERVED_1 = {'ff_value': 3, 'string': 'RESERVED1'}¶

SYSTEM = {'ff_value': 5, 'string': 'SYSTEM'}¶

UNSPECIFIED = {'ff_value': 6, 'string': 'UNSPECIFIED'}¶

class selenium.webdriver.common.proxy.ProxyTypeFactory¶

Bases: object

Factory for proxy types.

static make(ff_value, string)¶

7.8. Utilities¶

The Utils methods.

selenium.webdriver.common.utils.find_connectable_ip(host: str | bytes | bytearray | None, port: int | None = None) → str | None¶

Resolve a hostname to an IP, preferring IPv4 addresses.

We prefer IPv4 so that we don’t change behavior from previous IPv4-only implementations, and because some drivers (e.g., FirefoxDriver) do not support IPv6 connections.

If the optional port number is provided, only IPs that listen on the given port are considered.

Args:

• host - A hostname.

• port - Optional port number.

Returns:

A single IP address, as a string. If any IPv4 address is found, one is returned. Otherwise, if any IPv6 address is found, one is returned. If neither, then None is returned.

selenium.webdriver.common.utils.free_port() → int¶

Determines a free port using sockets.

selenium.webdriver.common.utils.is_connectable(port: int, host: str | None = 'localhost') → bool¶

Tries to connect to the server at port to see if it is running.

Args:

• port - The port to connect.

selenium.webdriver.common.utils.is_url_connectable(port: int | str) → bool¶

Tries to connect to the HTTP server at /status path and specified port to see if it responds successfully.

Args:

• port - The port to connect.

selenium.webdriver.common.utils.join_host_port(host: str, port: int) → str¶

Joins a hostname and port together.

This is a minimal implementation intended to cope with IPv6 literals. For example, _join_host_port(‘::1’, 80) == ‘[::1]:80’.

Args:

• host - A hostname.

• port - An integer port.

selenium.webdriver.common.utils.keys_to_typing(value: Iterable[str | int | float]) → List[str]¶

Processes the values that will be typed in the element.

7.9. Service¶

class selenium.webdriver.common.service.Service(executable_path: str | None = None, port: int = 0, log_output: int | str | IO[Any] | None = None, env: Mapping[Any, Any] | None = None, **kwargs)¶

Bases: ABC

The abstract base class for all service objects. Services typically launch a child program in a new process as an interim process to communicate with a browser.

Parameters:

• executable – install path of the executable.

• port – Port for the service to run on, defaults to 0 where the operating system will decide.

• log_output – (Optional) int representation of STDOUT/DEVNULL, any IO instance or String path to file.

• env – (Optional) Mapping of environment variables for the new process, defaults to os.environ.

__init__(executable_path: str | None = None, port: int = 0, log_output: int | str | IO[Any] | None = None, env: Mapping[Any, Any] | None = None, **kwargs) → None¶

assert_process_still_running() → None¶

Check if the underlying process is still running.

abstract command_line_args() → List[str]¶

A List of program arguments (excluding the executable).

is_connectable() → bool¶

Establishes a socket connection to determine if the service running on the port is accessible.

send_remote_shutdown_command() → None¶

Dispatch an HTTP request to the shutdown endpoint for the service in an attempt to stop it.

start() → None¶

Starts the Service.

Exceptions:

• WebDriverException : Raised either when it can’t start the service or when it can’t connect to the service

stop() → None¶

Stops the service.

property path: str¶

property service_url: str¶

Gets the url of the Service.

7.10. Application Cache¶

7.11. Firefox WebDriver¶

class selenium.webdriver.firefox.webdriver.WebDriver(options: Options | None = None, service: Service | None = None, keep_alive: bool = True)¶

Bases: WebDriver

Controls the GeckoDriver and allows you to drive the browser.

__init__(options: Options | None = None, service: Service | None = None, keep_alive: bool = True) → None¶

Creates a new instance of the Firefox driver. Starts the service and then creates new instance of Firefox driver.

Args:

• options - Instance of options.Options.

• service - (Optional) service instance for managing the starting and stopping of the driver.

• keep_alive - Whether to configure remote_connection.RemoteConnection to use HTTP keep-alive.

context(context)¶

Sets the context that Selenium commands are running in using a with statement. The state of the context on the server is saved before entering the block, and restored upon exiting it.

Parameters:

context – Context, may be one of the class properties CONTEXT_CHROME or CONTEXT_CONTENT.

Usage example:

with selenium.context(selenium.CONTEXT_CHROME):
    # chrome scope
    ... do stuff ...

get_full_page_screenshot_as_base64() → str¶

Gets the full document screenshot of the current window as a base64 encoded string which is useful in embedded images in HTML.

Usage:

driver.get_full_page_screenshot_as_base64()

get_full_page_screenshot_as_file(filename) → bool¶

Saves a full document 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.

Args:

• filename: The full path you wish to save your screenshot to. This should end with a .png extension.

Usage:

driver.get_full_page_screenshot_as_file('/Screenshots/foo.png')

get_full_page_screenshot_as_png() → bytes¶

Gets the full document screenshot of the current window as a binary data.

Usage:

driver.get_full_page_screenshot_as_png()

install_addon(path, temporary=False) → str¶

Installs Firefox addon.

Returns identifier of installed addon. This identifier can later be used to uninstall addon.

Parameters:

• temporary – allows you to load browser extensions temporarily during a session

• path – Absolute path to the addon that will be installed.

Usage:

driver.install_addon('/path/to/firebug.xpi')

quit() → None¶

Closes the browser and shuts down the GeckoDriver executable.

save_full_page_screenshot(filename) → bool¶

Saves a full document 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.

Args:

• filename: The full path you wish to save your screenshot to. This should end with a .png extension.

Usage:

driver.save_full_page_screenshot('/Screenshots/foo.png')

set_context(context) → None¶

uninstall_addon(identifier) → None¶

Uninstalls Firefox addon using its identifier.

Usage:

driver.uninstall_addon('[email protected]')

CONTEXT_CHROME = 'chrome'¶

CONTEXT_CONTENT = 'content'¶

7.12. Firefox WebDriver Options¶

class selenium.webdriver.firefox.options.Log¶

Bases: object

__init__() → None¶

to_capabilities() → dict¶

class selenium.webdriver.firefox.options.Options¶

Bases: ArgOptions

__init__() → None¶

enable_mobile(android_package: str = 'org.mozilla.firefox', android_activity=None, device_serial=None)¶

Enables mobile browser use for browsers that support it.

Args:

android_activity: The name of the android package to start

set_preference(name: str, value: str | int | bool)¶

Sets a preference.

to_capabilities() → dict¶

Marshals the Firefox options to a moz:firefoxOptions object.

KEY = 'moz:firefoxOptions'¶

property binary: FirefoxBinary¶

Returns the FirefoxBinary instance.

property binary_location: str¶

Returns:

The location of the binary.

property default_capabilities: dict¶

Return minimal capabilities necessary as a dictionary.

property preferences: dict¶

Returns:

A dict of preferences.

property profile: FirefoxProfile¶

Returns:

The Firefox profile to use.

7.13. Firefox WebDriver Profile¶

exception selenium.webdriver.firefox.firefox_profile.AddonFormatError(**kwargs)¶

Bases: Exception

Exception for not well-formed add-on manifest files.

class selenium.webdriver.firefox.firefox_profile.FirefoxProfile(profile_directory=None)¶

Bases: object

__init__(profile_directory=None)¶

Initialises a new instance of a Firefox Profile.

Args:

• profile_directory: Directory of profile that you want to use. If a directory is passed in it will be cloned and the cloned directory will be used by the driver when instantiated. This defaults to None and will create a new directory when object is created.

add_extension(extension=None)¶

set_preference(key, value)¶

Sets the preference that we want in the profile.

update_preferences()¶

Writes the desired user prefs to disk.

DEFAULT_PREFERENCES = None¶

property accept_untrusted_certs¶

property assume_untrusted_cert_issuer¶

property encoded: str¶

Updates preferences and creates a zipped, base64 encoded string of profile directory.

property path¶

Gets the profile directory that is currently being used.

property port¶

Gets the port that WebDriver is working on.