Merge pull request #1690 from seleniumbase/dependencies-and-refactoring

Dependencies and Refactoring

Author: mdmintz

README.md

@@ -99,9 +99,17 @@ class CoffeeCartTest(BaseCase):
 
 <p>💡 SeleniumBase methods often perform multiple actions in a single method call. For example, <code>self.type(selector,text)</code> does the following:<br />1. Waits for the element to be visible.<br />2. Waits for the element to be interactive.<br />3. Clears the text field.<br />4. Types in the new text.<br />5. Presses Enter/Submit if the text ends in "\n".<br />With raw Selenium, those actions require multiple method calls.</p>
 
-<p>💡 SeleniumBase uses default timeout values when not set, which means that methods automatically wait for elements to appear (<i>up to the timeout limit</i>) before failing:<br />✅<code>self.click("button")</code><br />With raw Selenium, methods would fail instantly (<i>by default</i>) if an element needed more time to load:<br />❌<code>self.driver.find_element(by="css selector", value="button").click()</code><br />(Reliable code is better than unreliable code.)</p>
-
-<p>💡 SeleniumBase lets you change the explicit timeout values of methods:<br />✅<code>self.click("button",timeout=10)</code><br />With raw Selenium, that requires more code:<br />❌<code>WebDriverWait(driver,10).until(EC.element_to_be_clickable("css selector", "button")).click()</code><br />(Simple code is better than complex code.)</p>
+<p>💡 SeleniumBase uses default timeout values when not set:<br />
+✅<code>self.click("button")</code><br />
+With raw Selenium, methods would fail instantly (<i>by default</i>) if an element needed more time to load:<br />
+❌<code>self.driver.find_element(by="css selector", value="button").click()</code><br />
+(Reliable code is better than unreliable code.)</p>
+
+<p>💡 SeleniumBase lets you change the explicit timeout values of methods:<br />
+✅<code>self.click("button",timeout=10)</code><br />
+With raw Selenium, that requires more code:<br />
+❌<code>WebDriverWait(driver,10).until(EC.element_to_be_clickable("css selector", "button")).click()</code><br />
+(Simple code is better than complex code.)</p>
 
 <p>💡 SeleniumBase gives you clean error output when a test fails. With raw Selenium, error messages can get very messy.</p>
 
@@ -1184,13 +1192,16 @@ pytest --reruns=1 --reruns-delay=1
 </p>
 <p><div><a href="https://github.com/mdmintz">https://github.com/mdmintz</a></div></p>
 
-<div><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/fancy_logo_14.png" title="SeleniumBase" width="220" /></a></div> <div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" title="SeleniumBase" /></a> <a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" title="SeleniumBase" alt="Join the chat!" /></a></div> <div><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://img.shields.io/badge/tested%20with-SeleniumBase-04C38E.svg" alt="Tested with SeleniumBase" /></a></div> <div><a href="https://seleniumbase.io"><img src="https://img.shields.io/badge/docs-seleniumbase.io-11BBAA.svg" alt="SeleniumBase Docs" /></a></div> <div><a href="https://pepy.tech/project/seleniumbase" target="_blank"><img src="https://pepy.tech/badge/seleniumbase" alt="SeleniumBase PyPI downloads" /></a></div>
+<div><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/fancy_logo_14.png" title="SeleniumBase" width="220" /></a></div> <div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" title="SeleniumBase" /></a> <a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" title="SeleniumBase" alt="Join the chat!" /></a></div> <div><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://img.shields.io/badge/tested%20with-SeleniumBase-04C38E.svg" alt="Tested with SeleniumBase" /></a></div> <div><a href="https://seleniumbase.io"><img src="https://img.shields.io/badge/docs-seleniumbase.io-11BBAA.svg" alt="SeleniumBase Docs" /></a></div>
 
 <p><div>
 <span><a href="https://www.youtube.com/playlist?list=PLp9uKicxkBc5UIlGi2BuE3aWC7JyXpD3m"><img src="https://seleniumbase.github.io/cdn/img/youtube.png" title="SeleniumBase Playlist on YouTube" alt="SeleniumBase Playlist on YouTube" width="54" /></a></span>
 <span><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://seleniumbase.github.io/img/social/share_github.svg" title="SeleniumBase on GitHub" alt="SeleniumBase on GitHub" width="50" /></a></span>
 <span><a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://seleniumbase.github.io/img/social/share_gitter.svg" title="SeleniumBase on Gitter" alt="SeleniumBase on Gitter" width="38" /></a></span>
 </div></p>
 
+--------
+
 <p><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/sb_logo_b.png" alt="SeleniumBase" title="SeleniumBase" width="240" /></a></p>
+<p><a href="https://pepy.tech/project/seleniumbase" target="_blank"><img src="https://pepy.tech/badge/seleniumbase" alt="SeleniumBase PyPI downloads" /></a></p>
 <p><a href="https://www.python.org/downloads/" target="_blank"><img src="https://img.shields.io/pypi/pyversions/seleniumbase.svg?color=22AAEE&logo=python&logoColor=FEDC54" title="Supported Python Versions" /></a></p>

examples/basic_test.py

@@ -19,6 +19,7 @@ def test_basics(self):
         self.assert_element("div#login_button_container")
 
 
-if __name__ == "__main__":
+if __name__ == "__main__":  # If "python" called
     from pytest import main
-    main([__file__, "-s"])
+    from sys import argv
+    main([*argv, "-s"])  # Run pytest, same args

examples/gui_test_runner.py

@@ -1,16 +1,8 @@
-"""
-GUI TEST RUNNER
+"""GUI TEST RUNNER
 Run by Typing: "python gui_test_runner.py"
-(Use Python 3 - There are GUI issues when using Python 2)
-"""
-
+(Use Python 3)"""
 import subprocess
-import sys
-
-if sys.version_info[0] >= 3:
-    from tkinter import Tk, Frame, Button, Label
-else:
-    from Tkinter import Tk, Frame, Button, Label
+from tkinter import Tk, Frame, Button, Label
 
 
 class App:

examples/parameterized_test.py

@@ -1,5 +1,6 @@
 from parameterized import parameterized
 from seleniumbase import BaseCase
+BaseCase.main(__name__, __file__)
 
 
 class GoogleTests(BaseCase):

examples/test_event_firing.py

@@ -1,8 +1,8 @@
 """ Testing EventFiringWebDriver with AbstractEventListener """
-
 from selenium.webdriver.support.events import EventFiringWebDriver
 from selenium.webdriver.support.events import AbstractEventListener
 from seleniumbase import BaseCase
+BaseCase.main(__name__, __file__)
 
 
 class MyListener(AbstractEventListener):

examples/test_get_locale_code.py

@@ -1,4 +1,5 @@
 from seleniumbase import BaseCase
+BaseCase.main(__name__, __file__)
 
 
 class LocaleTests(BaseCase):

examples/test_show_file_choosers.py

@@ -1,7 +1,5 @@
-"""
-self.show_file_choosers() is used to show hidden file-upload fields.
-Verify that one can choose a file after the hidden input is visible.
-"""
+"""self.show_file_choosers() is used to show hidden file-upload fields.
+Verify that one can choose a file after the hidden input is visible."""
 import os
 from seleniumbase import BaseCase
 BaseCase.main(__name__, __file__)

examples/test_skype_site.py

@@ -1,6 +1,6 @@
 """
 This is a mobile device test for Chromium-based browsers (such as MS Edge)
-Usage:  pytest test_skype_site.py --mobile --browser=edge
+Usage:  pytest test_skype_site.py --mobile --edge
 
 Default mobile settings for User Agent and Device Metrics if not specified:
         User Agent:   --agent="Mozilla/5.0 (Linux; Android 11; Pixel 4 XL)"
@@ -27,3 +27,8 @@ def test_skype_mobile_site(self):
         self.highlight("#get-skype-0_android-download")
         self.highlight('[data-bi-id*="ios"]')
         self.highlight('[data-bi-id*="windows10"]')
+
+
+if __name__ == "__main__":
+    from pytest import main
+    main([__file__, "--mobile", "--edge", "-s"])

mkdocs_build/requirements.txt

@@ -29,7 +29,7 @@ cssselect2==0.7.0
 tinycss2==1.2.1
 defusedxml==0.7.1
 mkdocs==1.4.2
-mkdocs-material==9.0.5
+mkdocs-material==9.0.6
 mkdocs-exclude-search==0.6.4
 mkdocs-simple-hooks==0.1.5
 mkdocs-material-extensions==1.1.1

requirements.txt

@@ -1,27 +1,27 @@
-pip>=21.3.1;python_version>="3.6" and python_version<"3.7"
+pip>=21.3.1;python_version<"3.7"
 pip>=22.3.1;python_version>="3.7"
-packaging>=21.3;python_version>="3.6" and python_version<"3.7"
+packaging>=21.3;python_version<"3.7"
 packaging>=23.0;python_version>="3.7"
-setuptools>=59.6.0;python_version>="3.6" and python_version<"3.7"
+setuptools>=59.6.0;python_version<"3.7"
 setuptools>=65.7.0;python_version>="3.7"
-tomli>=1.2.3;python_version>="3.6" and python_version<"3.7"
+tomli>=1.2.3;python_version<"3.7"
 tomli>=2.0.1;python_version>="3.7"
 tqdm>=4.64.1
 wheel>=0.37.1;python_version<"3.7"
 wheel>=0.38.4;python_version>="3.7"
-attrs==22.1.0;python_version>="3.6" and python_version<"3.7"
+attrs==22.1.0;python_version<"3.7"
 attrs>=22.2.0;python_version>="3.7"
-PyYAML>=6.0;python_version>="3.6"
-certifi>=2022.12.7;python_version>="3.6"
-filelock>=3.4.1;python_version>="3.6" and python_version<"3.7"
+PyYAML>=6.0
+certifi>=2022.12.7
+filelock>=3.4.1;python_version<"3.7"
 filelock>=3.9.0;python_version>="3.7"
-platformdirs>=2.4.0;python_version>="3.6" and python_version<"3.7"
+platformdirs>=2.4.0;python_version<"3.7"
 platformdirs>=2.6.2;python_version>="3.7"
-pyparsing>=3.0.7;python_version>="3.6" and python_version<"3.7"
+pyparsing>=3.0.7;python_version<"3.7"
 pyparsing>=3.0.9;python_version>="3.7"
 six==1.16.0
-idna==3.4;python_version>="3.6"
-chardet==4.0.0;python_version>="3.6" and python_version<"3.7"
+idna==3.4
+chardet==4.0.0;python_version<"3.7"
 chardet==5.1.0;python_version>="3.7"
 charset-normalizer==2.0.12;python_version<"3.7"
 charset-normalizer==3.0.1;python_version>="3.7"
@@ -42,22 +42,22 @@ wsproto==1.2.0;python_version>="3.7"
 selenium==3.141.0;python_version<"3.7"
 selenium==4.7.2;python_version>="3.7"
 msedge-selenium-tools==3.141.3;python_version<"3.7"
-more-itertools==8.14.0;python_version>="3.6" and python_version<"3.7"
+more-itertools==8.14.0;python_version<"3.7"
 more-itertools==9.0.0;python_version>="3.7"
 cssselect==1.1.0;python_version<"3.7"
 cssselect==1.2.0;python_version>="3.7"
 sortedcontainers==2.4.0
-fasteners==0.17.3;python_version>="3.6" and python_version<"3.7"
+fasteners==0.17.3;python_version<"3.7"
 fasteners==0.18;python_version>="3.7"
 execnet==1.9.0
 iniconfig==1.1.1;python_version<"3.7"
 iniconfig==2.0.0;python_version>="3.7"
-pluggy==1.0.0;python_version>="3.6"
-py==1.11.0;python_version>="3.6"
+pluggy==1.0.0
+py==1.11.0
 pytest==7.0.1;python_version<"3.7"
 pytest==7.2.1;python_version>="3.7"
-pytest-forked==1.4.0;python_version>="3.6"
-pytest-html==2.0.1;python_version>="3.6"
+pytest-forked==1.4.0
+pytest-html==2.0.1
 pytest-metadata==1.11.0;python_version<"3.7"
 pytest-metadata==2.0.4;python_version>="3.7"
 pytest-ordering==0.6
@@ -70,37 +70,40 @@ sbvirtualdisplay==1.1.1
 behave==1.2.6
 parse==1.19.0
 parse-type==0.6.0
-soupsieve==2.3.2.post1;python_version>="3.6"
-beautifulsoup4==4.11.1;python_version>="3.6"
-cryptography==36.0.2;python_version>="3.6" and python_version<"3.7"
+soupsieve==2.3.2.post1
+beautifulsoup4==4.11.1
+cryptography==36.0.2;python_version<"3.7"
 cryptography==39.0.0;python_version>="3.7"
-pygments==2.14.0;python_version>="3.6"
-pyreadline3==3.4.1;platform_system=="Windows" and python_version>="3.6"
+pygments==2.14.0
+pyreadline3==3.4.1;platform_system=="Windows"
 tabcompleter==1.1.0
-pdbp==1.2.7
-colorama==0.4.5;python_version>="3.6" and python_version<"3.7"
+pdbp==1.2.8
+colorama==0.4.5;python_version<"3.7"
 colorama==0.4.6;python_version>="3.7"
 exceptiongroup==1.1.0;python_version>="3.7"
-importlib-metadata==4.2.0;python_version>="3.6" and python_version<"3.8"
+importlib-metadata==4.2.0;python_version<"3.8"
 pycparser==2.21
-pyotp==2.7.0;python_version>="3.6" and python_version<"3.7"
+pyotp==2.7.0;python_version<"3.7"
 pyotp==2.8.0;python_version>="3.7"
 cffi==1.15.1
-typing-extensions==4.1.1;python_version>="3.6" and python_version<"3.7"
+typing-extensions==4.1.1;python_version<"3.7"
 typing-extensions==4.4.0;python_version>="3.7" and python_version<"3.9"
-rich==12.6.0;python_version>="3.6" and python_version<"3.7"
-rich==13.1.0;python_version>="3.7" and python_version<"4.0"
+commonmark==0.9.1;python_version<"3.7"
+markdown-it-py==2.1.0;python_version>="3.7"
+mdurl==0.1.2;python_version>="3.7"
+rich==12.6.0;python_version<"3.7"
+rich==13.2.0;python_version>="3.7"
 
 # --- Testing Requirements --- #
 # ("pip install -r requirements.txt" also installs this, but "pip install -e ." won't.)
 
-coverage==6.2;python_version>="3.6" and python_version<"3.7"
+coverage==6.2;python_version<"3.7"
 coverage==7.0.5;python_version>="3.7"
-pytest-cov==4.0.0;python_version>="3.6"
-flake8==5.0.4;python_version>="3.6" and python_version<"3.9"
+pytest-cov==4.0.0
+flake8==5.0.4;python_version<"3.9"
 flake8==6.0.0;python_version>="3.9"
-mccabe==0.7.0;python_version>="3.6"
-pyflakes==2.5.0;python_version>="3.6" and python_version<"3.9"
+mccabe==0.7.0
+pyflakes==2.5.0;python_version<"3.9"
 pyflakes==3.0.1;python_version>="3.9"
-pycodestyle==2.9.1;python_version>="3.6" and python_version<"3.9"
+pycodestyle==2.9.1;python_version<"3.9"
 pycodestyle==2.10.0;python_version>="3.9"