Add methods for checkboxes and radio buttons

Author: mdmintz

seleniumbase/fixtures/base_case.py

@@ -1052,6 +1052,59 @@ def click_if_visible(self, selector, by=By.CSS_SELECTOR):
         if self.is_element_visible(selector, by=by):
             self.click(selector, by=by)
 
+    def is_checked(self, selector, by=By.CSS_SELECTOR, timeout=None):
+        """ Determines if a checkbox or a radio button element is checked.
+            Returns True if the element is checked.
+            Returns False if the element is not checked.
+            If the element is not present on the page, raises an exception.
+            If the element is not a checkbox or radio, raises an exception. """
+        if not timeout:
+            timeout = settings.SMALL_TIMEOUT
+        if self.timeout_multiplier and timeout == settings.SMALL_TIMEOUT:
+            timeout = self.__get_new_timeout(timeout)
+        selector, by = self.__recalculate_selector(selector, by)
+        kind = self.get_attribute(selector, "type", by=by, timeout=timeout)
+        if kind != "checkbox" and kind != "radio":
+            raise Exception("Expecting a checkbox or a radio button element!")
+        is_checked = self.get_attribute(
+            selector, "checked", by=by, timeout=timeout, hard_fail=False)
+        if is_checked:
+            return True
+        else:  # (NoneType)
+            return False
+
+    def is_selected(self, selector, by=By.CSS_SELECTOR, timeout=None):
+        """ Same as is_checked() """
+        return self.is_checked(selector, by=by, timeout=timeout)
+
+    def check_if_unchecked(self, selector, by=By.CSS_SELECTOR):
+        """ If a checkbox or radio button is not checked, will check it. """
+        selector, by = self.__recalculate_selector(selector, by)
+        if not self.is_checked(selector, by=by):
+            if self.is_element_visible(selector, by=by):
+                self.click(selector, by=by)
+            else:
+                selector = self.convert_to_css_selector(selector, by=by)
+                self.js_click(selector, by=By.CSS_SELECTOR)
+
+    def select_if_unselected(self, selector, by=By.CSS_SELECTOR):
+        """ Same as check_if_unchecked() """
+        self.check_if_unchecked(selector, by=by)
+
+    def uncheck_if_checked(self, selector, by=By.CSS_SELECTOR):
+        """ If a checkbox is checked, will uncheck it. """
+        selector, by = self.__recalculate_selector(selector, by)
+        if self.is_checked(selector, by=by):
+            if self.is_element_visible(selector, by=by):
+                self.click(selector, by=by)
+            else:
+                selector = self.convert_to_css_selector(selector, by=by)
+                self.js_click(selector, by=By.CSS_SELECTOR)
+
+    def unselect_if_selected(self, selector, by=By.CSS_SELECTOR):
+        """ Same as uncheck_if_checked() """
+        self.uncheck_if_checked(selector, by=by)
+
     def is_element_in_an_iframe(self, selector, by=By.CSS_SELECTOR):
         """ Returns True if the selector's element is located in an iframe.
             Otherwise returns False. """