Merge pull request #257 from seleniumbase/simplify-submit-method

Add submit() method to simplify driver.find_element_by_*().submit()

Author: mdmintz

README.md

@@ -1,8 +1,8 @@
 [<img src="https://cdn2.hubspot.net/hubfs/100006/images/super_logo_2h2.png" title="SeleniumBase" height="48">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
 
-[<img src="https://img.shields.io/github/release/seleniumbase/SeleniumBase.svg" />](https://github.com/seleniumbase/SeleniumBase/releases) [<img src="https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master" alt="Build Status" />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="Join the Gitter Chat" />](https://gitter.im/seleniumbase/SeleniumBase)<br />
+[<img src="https://img.shields.io/github/release/seleniumbase/SeleniumBase.svg" />](https://github.com/seleniumbase/SeleniumBase/releases) [<img src="https://travis-ci.org/seleniumbase/SeleniumBase.svg?branch=master" alt="Build Status" />](https://travis-ci.org/seleniumbase/SeleniumBase) [<img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="Join the Gitter Chat" />](https://gitter.im/seleniumbase/SeleniumBase) [<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg" alt="GitHub Stars" />](https://github.com/seleniumbase/SeleniumBase/stargazers)<br />
 
-A fast, simple, and reliable framework for automating UI testing and [prototyping JS tours](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md). SeleniumBase uses [Pytest](https://docs.pytest.org/en/latest/) for running Python scripts, and [WebDriver](https://www.seleniumhq.org/) for controlling web browsers. [<img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg" alt="GitHub Stars" />](https://github.com/seleniumbase/SeleniumBase/stargazers)
+A fast, simple, and reliable framework for automating UI testing and [prototyping JS tours](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md). SeleniumBase uses [Pytest](https://docs.pytest.org/en/latest/) and [WebDriver](https://www.seleniumhq.org/) for running Python scripts to control web browsers.
 
 ## <img src="https://cdn2.hubspot.net/hubfs/100006/images/sb_logo_box2.png" title="SeleniumBase" height="32"> Quick Start
 

help_docs/method_summary.md

@@ -144,6 +144,8 @@ self.js_click(selector, by=By.CSS_SELECTOR)
 
 self.jquery_click(selector, by=By.CSS_SELECTOR)
 
+self.submit(selector, by=By.CSS_SELECTOR)
+
 self.hide_element(selector, by=By.CSS_SELECTOR)
 
 self.hide_elements(selector, by=By.CSS_SELECTOR)

seleniumbase/fixtures/base_case.py

@@ -1425,6 +1425,15 @@ def jquery_click(self, selector, by=By.CSS_SELECTOR):
         self.safe_execute_script(click_script)
         self.__demo_mode_pause_if_active()
 
+    def submit(self, selector, by=By.CSS_SELECTOR):
+        """ Alternative to self.driver.find_element_by_*(SELECTOR).submit() """
+        if page_utils.is_xpath_selector(selector):
+            by = By.XPATH
+        element = self.wait_for_element_visible(
+            selector, by=by, timeout=settings.SMALL_TIMEOUT)
+        element.submit()
+        self.__demo_mode_pause_if_active()
+
     def hide_element(self, selector, by=By.CSS_SELECTOR):
         """ Hide the first element on the page that matches the selector. """
         selector, by = self.__recalculate_selector(selector, by)

seleniumbase/utilities/selenium_ide/convert_ide.py

@@ -158,6 +158,19 @@ def main():
             seleniumbase_lines.append(command)
             continue
 
+        # Handle .find_element_by_id() + .submit()
+        data = re.match(
+            r'''^(\s*)driver\.find_element_by_id\(\"(\S+)\"\)'''
+            r'''\.submit\(\)\s*$''', line)
+        if data:
+            whitespace = data.group(1)
+            selector = '#%s' % data.group(2).replace('#', '\\#')
+            selector = selector.replace('[', '\\[').replace(']', '\\]')
+            selector = selector.replace('.', '\\.')
+            command = '''%sself.submit('%s')''' % (whitespace, selector)
+            seleniumbase_lines.append(command)
+            continue
+
         # Handle .find_element_by_id() + .send_keys()
         data = re.match(
             r'''^(\s*)driver\.find_element_by_id\(\"(\S+)\"\)'''
@@ -200,6 +213,17 @@ def main():
             seleniumbase_lines.append(command)
             continue
 
+        # Handle .find_element_by_name() + .submit()
+        data = re.match(
+            r'''^(\s*)driver\.find_element_by_name\(\"(\S+)\"\)'''
+            r'''\.submit\(\)\s*$''', line)
+        if data:
+            whitespace = data.group(1)
+            selector = '[name="%s"]' % data.group(2)
+            command = '''%sself.submit('%s')''' % (whitespace, selector)
+            seleniumbase_lines.append(command)
+            continue
+
         # Handle .find_element_by_name() + .send_keys()
         data = re.match(
             r'''^(\s*)driver\.find_element_by_name\(\"(\S+)\"\)'''
@@ -240,6 +264,19 @@ def main():
             seleniumbase_lines.append(command)
             continue
 
+        # Handle .find_element_by_css_selector() + .submit()
+        data = re.match(
+            r'''^(\s*)driver\.find_element_by_css_selector\(\"([\S\s]+)\"\)'''
+            r'''\.submit\(\)\s*$''', line)
+        if data:
+            whitespace = data.group(1)
+            selector = '%s' % data.group(2)
+            command = '''%sself.submit('%s')''' % (whitespace, selector)
+            if command.count('\\"') == command.count('"'):
+                command = command.replace('\\"', '"')
+            seleniumbase_lines.append(command)
+            continue
+
         # Handle .find_element_by_css_selector() + .send_keys()
         data = re.match(
             r'''^(\s*)driver\.find_element_by_css_selector\(\"([\S\s]+)\"\)'''
@@ -384,6 +421,22 @@ def main():
             seleniumbase_lines.append(command)
             continue
 
+        # Handle .find_element_by_xpath() + .submit()
+        data = re.match(
+            r'''^(\s*)driver\.find_element_by_xpath\(u?\"([\S\s]+)\"\)'''
+            r'''\.submit\(\)\s*$''', line)
+        if data:
+            whitespace = data.group(1)
+            xpath = '%s' % data.group(2)
+            uni = ""
+            if '(u"' in line:
+                uni = "u"
+                has_unicode = True
+            command = '''%sself.submit(%s"%s")''' % (
+                whitespace, uni, xpath)
+            seleniumbase_lines.append(command)
+            continue
+
         # Handle .find_element_by_link_text() + .click()
         data = re.match(
             r'''^(\s*)driver\.find_element_by_link_text\(u?\"([\S\s]+)\"\)'''

setup.py

@@ -17,7 +17,7 @@
 
 setup(
     name='seleniumbase',
-    version='1.17.13',
+    version='1.17.14',
     description='All-in-One Test Automation Framework',
     long_description=long_description,
     long_description_content_type='text/markdown',