uncheck

The command to deselect checkboxes and radio buttons.

Syntax

Element.uncheck() -> Element
Element.uncheck(allow_selected=False) -> Element

Usage

correct usage

# uncheck a radio button
py.get("[type='radio']").uncheck()

incorrect usage

# Errors, 'get' yields an Element that is not a checkbox or radio button
py.get("a").uncheck()

Arguments

• allow_deselected=False (bool) - If True, do not raise an error if the box or radio button to uncheck is already deselected.

Default is False because why would you want to deselect a box that's not selected?

Yields

• Element - The current Element so you can chain commands

Raises

• ValueError if the element is not selected already. Set allow_deselected to True to ignore this.

• ValueError if the element is not a checkbox or radio button

Examples

Given this HTML:

<form id="checkboxes">
    <input type="checkbox">
    checkbox 1
    <br>
    <input type="checkbox" checked="">
    checkbox 2
  </form>

We can uncheck the second checkbox:

def test_uncheck(py: Pylenium):
    py.visit("https://the-internet.herokuapp.com/checkboxes")
    checkboxes = py.find("input")
    second_box = checkboxes[1].uncheck()
    assert second_box.is_checked() is False