Merge pull request #529 from seleniumbase/checkbox-and-radio-button-methods

Add methods for checkboxes and radio buttons

Author: mdmintz

examples/test_checkboxes.py

@@ -0,0 +1,20 @@
+from seleniumbase import BaseCase
+
+
+class MyTestClass(BaseCase):
+
+    def test_checkboxes_and_radio_buttons(self):
+        self.open("https://www.w3schools.com/tags/tryit.asp"
+                  "?filename=tryhtml5_input_type_checkbox")
+        self.switch_to_frame("iframeResult")
+        checkbox = "input#vehicle2"
+        self.assert_false(self.is_selected(checkbox))
+        self.click(checkbox)
+        self.assert_true(self.is_selected(checkbox))
+        self.open("https://www.w3schools.com/tags/tryit.asp"
+                  "?filename=tryhtml5_input_type_radio")
+        self.switch_to_frame("iframeResult")
+        option_button = "input#male"
+        self.assert_false(self.is_selected(option_button))
+        self.click(option_button)
+        self.assert_true(self.is_selected(option_button))

examples/translations/italian_test_1.py

@@ -1,4 +1,4 @@
-# Italian Language Test
+# Italian Language Test - Python 3 Only!
 from seleniumbase.translate.italian import CasoDiProva
 
 

help_docs/method_summary.md

@@ -54,10 +54,10 @@ self.is_link_text_present(link_text)
 
 self.is_partial_link_text_present(link_text)
 
-self.get_link_attribute(link_text, attribute, hard_fail)
-# Duplicates: self.get_link_text_attribute(link_text, attribute, hard_fail)
+self.get_link_attribute(link_text, attribute, hard_fail=True)
+# Duplicates: self.get_link_text_attribute(link_text, attribute, hard_fail=True)
 
-self.get_partial_link_text_attribute(link_text, attribute, hard_fail)
+self.get_partial_link_text_attribute(link_text, attribute, hard_fail=True)
 
 self.click_link(link_text, timeout=None)
 # Duplicates: self.click_link_text(link_text, timeout=None)
@@ -66,7 +66,7 @@ self.click_partial_link_text(partial_link_text, timeout=None)
 
 self.get_text(selector, by=By.CSS_SELECTOR, timeout=None)
 
-self.get_attribute(selector, attribute, by=By.CSS_SELECTOR, timeout=None)
+self.get_attribute(selector, attribute, by=By.CSS_SELECTOR, timeout=None, hard_fail=True)
 
 self.set_attribute(selector, attribute, value, by=By.CSS_SELECTOR, timeout=None)
 
@@ -91,6 +91,15 @@ self.click_nth_visible_element(selector, number, by=By.CSS_SELECTOR)
 
 self.click_if_visible(selector, by=By.CSS_SELECTOR)
 
+self.is_selected(selector, by=By.CSS_SELECTOR, timeout=None)
+# Duplicates: self.is_checked(selector, by=By.CSS_SELECTOR, timeout=None)
+
+self.select_if_unselected(selector, by=By.CSS_SELECTOR)
+# Duplicates: self.check_if_unchecked(selector, by=By.CSS_SELECTOR)
+
+self.unselect_if_selected(selector, by=By.CSS_SELECTOR)
+# Duplicates: self.uncheck_if_checked(selector, by=By.CSS_SELECTOR)
+
 self.is_element_in_an_iframe(selector, by=By.CSS_SELECTOR)
 
 self.switch_to_frame_of_element(selector, by=By.CSS_SELECTOR)

requirements.txt

@@ -29,7 +29,7 @@ soupsieve==1.9.5;python_version<"3.5"
 soupsieve==2.0;python_version>="3.5"
 beautifulsoup4==4.8.2
 atomicwrites==1.3.0
-portalocker==1.5.2
+portalocker==1.6.0
 cryptography==2.8
 asn1crypto==1.3.0
 pyopenssl==19.1.0
@@ -42,7 +42,7 @@ pymysql==0.9.3
 pyotp==2.3.0
 boto==2.49.0
 cffi==1.14.0
-tqdm==4.43.0
+tqdm==4.44.1
 flake8==3.7.9
 certifi>=2019.11.28
 pdfminer.six==20191110;python_version<"3.5"

seleniumbase/fixtures/base_case.py

@@ -794,7 +794,7 @@ def get_text(self, selector, by=By.CSS_SELECTOR, timeout=None):
         return element_text
 
     def get_attribute(self, selector, attribute, by=By.CSS_SELECTOR,
-                      timeout=None):
+                      timeout=None, hard_fail=True):
         """ This method uses JavaScript to get the value of an attribute. """
         if not timeout:
             timeout = settings.SMALL_TIMEOUT
@@ -816,8 +816,11 @@ def get_attribute(self, selector, attribute, by=By.CSS_SELECTOR,
         if attribute_value is not None:
             return attribute_value
         else:
-            raise Exception("Element {%s} has no attribute {%s}!" % (
-                selector, attribute))
+            if hard_fail:
+                raise Exception("Element {%s} has no attribute {%s}!" % (
+                    selector, attribute))
+            else:
+                return None
 
     def set_attribute(self, selector, attribute, value, by=By.CSS_SELECTOR,
                       timeout=None):
@@ -1049,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. """

seleniumbase/translate/chinese.py

@@ -195,3 +195,7 @@ def 滚动到底部(self, *args, **kwargs):
     def 悬停并单击(self, *args, **kwargs):
         # hover_and_click(hover_selector, click_selector)
         return self.hover_and_click(*args, **kwargs)
+
+    def 是否被选中(self, *args, **kwargs):
+        # is_selected(selector)
+        return self.is_selected(*args, **kwargs)

seleniumbase/translate/french.py

@@ -195,3 +195,7 @@ def faites_défiler_vers_le_bas(self, *args, **kwargs):
     def planer_au_dessus_et_cliquez(self, *args, **kwargs):
         # hover_and_click(hover_selector, click_selector)
         return self.hover_and_click(*args, **kwargs)
+
+    def est_il_sélectionné(self, *args, **kwargs):
+        # is_selected(selector)
+        return self.is_selected(*args, **kwargs)

seleniumbase/translate/italian.py

@@ -1,4 +1,4 @@
-# Italian / italiano - Translations
+# Italian / italiano - Translations - Python 3 Only!
 from seleniumbase import BaseCase
 
 
@@ -88,15 +88,15 @@ def avanti(self, *args, **kwargs):
         # go_forward()
         return self.go_forward(*args, **kwargs)
 
-    def il_testo_viene_visualizzato(self, *args, **kwargs):
+    def è_testo_visto(self, *args, **kwargs):  # noqa
         # is_text_visible(text, selector="html")
         return self.is_text_visible(*args, **kwargs)
 
-    def elemento_viene_visualizzato(self, *args, **kwargs):
+    def è_elemento_visto(self, *args, **kwargs):
         # is_element_visible(selector)
         return self.is_element_visible(*args, **kwargs)
 
-    def elemento_presente(self, *args, **kwargs):
+    def è_elemento_presente(self, *args, **kwargs):
         # is_element_present(selector)
         return self.is_element_present(*args, **kwargs)
 
@@ -195,3 +195,7 @@ def scorri_verso_il_basso(self, *args, **kwargs):
     def passa_il_mouse_sopra_e_fai_clic(self, *args, **kwargs):
         # hover_and_click(hover_selector, click_selector)
         return self.hover_and_click(*args, **kwargs)
+
+    def è_selezionato(self, *args, **kwargs):
+        # is_selected(selector)
+        return self.is_selected(*args, **kwargs)

seleniumbase/translate/japanese.py

@@ -195,3 +195,7 @@ def 一番下までスクロール(self, *args, **kwargs):
     def 上にマウスを移動しクリック(self, *args, **kwargs):
         # hover_and_click(hover_selector, click_selector)
         return self.hover_and_click(*args, **kwargs)
+
+    def 選択されていることを(self, *args, **kwargs):
+        # is_selected(selector)
+        return self.is_selected(*args, **kwargs)

seleniumbase/translate/korean.py

@@ -195,3 +195,7 @@ def 하단으로_스크롤(self, *args, **kwargs):
     def 위로_마우스를_이동하고_클릭(self, *args, **kwargs):
         # hover_and_click(hover_selector, click_selector)
         return self.hover_and_click(*args, **kwargs)
+
+    def 선택되어_있는지(self, *args, **kwargs):
+        # is_selected(selector)
+        return self.is_selected(*args, **kwargs)