Merge pull request #296 from seleniumbase/add-attribute-methods

Add methods for setting and removing element attributes

Author: mdmintz

help_docs/method_summary.md

@@ -33,6 +33,15 @@ self.get_text(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
 self.get_attribute(selector, attribute, by=By.CSS_SELECTOR,
     timeout=settings.SMALL_TIMEOUT)
 
+self.set_attribute(selector, attribute, value, by=By.CSS_SELECTOR,
+    timeout=settings.SMALL_TIMEOUT)
+
+self.remove_attribute(selector, attribute, by=By.CSS_SELECTOR,
+    timeout=settings.SMALL_TIMEOUT)
+
+self.get_property_value(selector, property, by=By.CSS_SELECTOR,
+    timeout=settings.SMALL_TIMEOUT)
+
 self.refresh_page()
 
 self.refresh()
@@ -129,9 +138,6 @@ self.post_error_message(message, duration=None, pause=True)
 self.set_messenger_theme(theme="default", location="default",
     max_messages="default")
 
-self.get_property_value(selector, property, by=By.CSS_SELECTOR,
-    timeout=settings.SMALL_TIMEOUT)
-
 self.bring_to_front(selector, by=By.CSS_SELECTOR)
 
 self.highlight(selector, by=By.CSS_SELECTOR, loops=4, scroll=True)

seleniumbase/fixtures/base_case.py

@@ -399,6 +399,7 @@ def get_text(self, selector, by=By.CSS_SELECTOR,
 
     def get_attribute(self, selector, attribute, by=By.CSS_SELECTOR,
                       timeout=settings.SMALL_TIMEOUT):
+        """ This method uses JavaScript to get the value of an attribute. """
         if self.timeout_multiplier and timeout == settings.SMALL_TIMEOUT:
             timeout = self.__get_new_timeout(timeout)
         if page_utils.is_xpath_selector(selector):
@@ -424,6 +425,79 @@ def get_attribute(self, selector, attribute, by=By.CSS_SELECTOR,
             raise Exception("Element {%s} has no attribute {%s}!" % (
                 selector, attribute))
 
+    def set_attribute(self, selector, attribute, value, by=By.CSS_SELECTOR,
+                      timeout=settings.SMALL_TIMEOUT):
+        """ This method uses JavaScript to set/update an attribute. """
+        if self.timeout_multiplier and timeout == settings.SMALL_TIMEOUT:
+            timeout = self.__get_new_timeout(timeout)
+        if page_utils.is_xpath_selector(selector):
+            by = By.XPATH
+        if self.is_element_visible(selector, by=by):
+            self.scroll_to(selector, by=by, timeout=timeout)
+        attribute = re.escape(attribute)
+        attribute = self.__escape_quotes_if_needed(attribute)
+        value = re.escape(value)
+        value = self.__escape_quotes_if_needed(value)
+        css_selector = self.convert_to_css_selector(selector, by=by)
+        css_selector = re.escape(css_selector)
+        css_selector = self.__escape_quotes_if_needed(css_selector)
+        script = ("""document.querySelector('%s').setAttribute('%s','%s');"""
+                  % (css_selector, attribute, value))
+        self.execute_script(script)
+
+    def remove_attribute(self, selector, attribute, by=By.CSS_SELECTOR,
+                         timeout=settings.SMALL_TIMEOUT):
+        """ This method uses JavaScript to remove an attribute. """
+        if self.timeout_multiplier and timeout == settings.SMALL_TIMEOUT:
+            timeout = self.__get_new_timeout(timeout)
+        if page_utils.is_xpath_selector(selector):
+            by = By.XPATH
+        if self.is_element_visible(selector, by=by):
+            self.scroll_to(selector, by=by, timeout=timeout)
+        attribute = re.escape(attribute)
+        attribute = self.__escape_quotes_if_needed(attribute)
+        css_selector = self.convert_to_css_selector(selector, by=by)
+        css_selector = re.escape(css_selector)
+        css_selector = self.__escape_quotes_if_needed(css_selector)
+        script = ("""document.querySelector('%s').removeAttribute('%s');"""
+                  % (css_selector, attribute))
+        self.execute_script(script)
+
+    def get_property_value(self, selector, property, by=By.CSS_SELECTOR,
+                           timeout=settings.SMALL_TIMEOUT):
+        """ Returns the property value of a page element's computed style.
+            Example:
+                opacity = self.get_property_value("html body a", "opacity")
+                self.assertTrue(float(opacity) > 0, "Element not visible!") """
+        if self.timeout_multiplier and timeout == settings.SMALL_TIMEOUT:
+            timeout = self.__get_new_timeout(timeout)
+        if page_utils.is_xpath_selector(selector):
+            by = By.XPATH
+        if page_utils.is_link_text_selector(selector):
+            selector = page_utils.get_link_text_from_selector(selector)
+            by = By.LINK_TEXT
+        self.wait_for_ready_state_complete()
+        page_actions.wait_for_element_present(
+            self.driver, selector, by, timeout)
+        try:
+            selector = self.convert_to_css_selector(selector, by=by)
+        except Exception:
+            # Don't run action if can't convert to CSS_Selector for JavaScript
+            raise Exception(
+                "Exception: Could not convert {%s}(by=%s) to CSS_SELECTOR!" % (
+                    selector, by))
+        selector = re.escape(selector)
+        selector = self.__escape_quotes_if_needed(selector)
+        script = ("""var $elm = document.querySelector('%s');
+                  $val = window.getComputedStyle($elm).getPropertyValue('%s');
+                  return $val;"""
+                  % (selector, property))
+        value = self.execute_script(script)
+        if value is not None:
+            return value
+        else:
+            return ""  # Return an empty string if the property doesn't exist
+
     def refresh_page(self):
         self.__last_page_load_url = None
         self.driver.refresh()
@@ -1297,41 +1371,6 @@ def post_error_message(self, message, duration=None, pause=True):
             duration = float(duration) + 0.15
             time.sleep(float(duration))
 
-    def get_property_value(self, selector, property, by=By.CSS_SELECTOR,
-                           timeout=settings.SMALL_TIMEOUT):
-        """ Returns the property value of a page element's computed style.
-            Example:
-                opacity = self.get_property_value("html body a", "opacity")
-                self.assertTrue(float(opacity) > 0, "Element not visible!") """
-        if self.timeout_multiplier and timeout == settings.SMALL_TIMEOUT:
-            timeout = self.__get_new_timeout(timeout)
-        if page_utils.is_xpath_selector(selector):
-            by = By.XPATH
-        if page_utils.is_link_text_selector(selector):
-            selector = page_utils.get_link_text_from_selector(selector)
-            by = By.LINK_TEXT
-        self.wait_for_ready_state_complete()
-        page_actions.wait_for_element_present(
-            self.driver, selector, by, timeout)
-        try:
-            selector = self.convert_to_css_selector(selector, by=by)
-        except Exception:
-            # Don't run action if can't convert to CSS_Selector for JavaScript
-            raise Exception(
-                "Exception: Could not convert {%s}(by=%s) to CSS_SELECTOR!" % (
-                    selector, by))
-        selector = re.escape(selector)
-        selector = self.__escape_quotes_if_needed(selector)
-        script = ("""var $elm = document.querySelector('%s');
-                  $val = window.getComputedStyle($elm).getPropertyValue('%s');
-                  return $val;"""
-                  % (selector, property))
-        value = self.execute_script(script)
-        if value is not None:
-            return value
-        else:
-            return ""  # Return an empty string if the property doesn't exist
-
     def bring_to_front(self, selector, by=By.CSS_SELECTOR):
         """ Updates the Z-index of a page element to bring it into view.
             Useful when getting a WebDriverException, such as the one below:

setup.py

@@ -17,7 +17,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.21.4',
+    version='1.21.5',
     description='Reliable Browser Automation & Testing Framework',
     long_description=long_description,
     long_description_content_type='text/markdown',