check

The command to select a checkbox or radio buttons.

Syntax

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

Usage

correct usage

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

---or---

# check a box
py.get("[type='checkbox']").check()

incorrect usage

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

Arguments

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

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

Yields

• Element - The current instance so you can chain commands

Raises

• ValueError if the element is selected already. Set allow_selected 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 check the first checkbox:

def test_check_the_box(py: Pylenium):
    py.visit("https://the-internet.herokuapp.com/checkboxes")
    checkbox = py.get("input").check()
    assert checkbox.should().be_checked()