Merge pull request #1905 from seleniumbase/update-console-scripts-and-exceptions

mdmintz · web-flow · commit 0270ed5e1353 · 2023-06-08T21:37:34.000-04:00
Update console scripts and exceptions
diff --git a/requirements.txt b/requirements.txt
@@ -42,7 +42,7 @@ sniffio==1.3.0;python_version>="3.7"
 h11==0.14.0;python_version>="3.7"
 outcome==1.2.0;python_version>="3.7"
 trio==0.22.0;python_version>="3.7"
-trio-websocket==0.10.2;python_version>="3.7"
+trio-websocket==0.10.3;python_version>="3.7"
 pyopenssl==23.2.0;python_version>="3.7"
 wsproto==1.2.0;python_version>="3.7"
 selenium==3.141.0;python_version<"3.7"
diff --git a/seleniumbase/__version__.py b/seleniumbase/__version__.py
@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "4.15.0"
+__version__ = "4.15.1"
diff --git a/seleniumbase/common/decorators.py b/seleniumbase/common/decorators.py
@@ -4,6 +4,7 @@
 import warnings
 from contextlib import contextmanager
 from functools import wraps
+from seleniumbase.common.exceptions import TimeoutException
 
 
 @contextmanager
@@ -62,7 +63,7 @@ def my_method():
             )
             if exception:
                 message = exception.msg + "\nAND " + message
-            raise Exception(message)
+            raise TimeoutException(message)
 
 
 @contextmanager
@@ -108,7 +109,7 @@ def my_method():
             )
             if exception:
                 message = exception.msg + "\nAND " + message
-            raise Exception(message)
+            raise TimeoutException(message)
 
 
 def retry_on_exception(tries=6, delay=1, backoff=2, max_delay=32):
diff --git a/seleniumbase/common/exceptions.py b/seleniumbase/common/exceptions.py
@@ -6,6 +6,7 @@
     OutOfScopeException => Used by BaseCase methods when setUp() is skipped.
     TextNotVisibleException => Called when expected text fails to appear.
     TimeLimitExceededException => Called when exceeding "--time-limit=SECONDS".
+    TimeoutException => Called when some timeout limit has been exceeded.
     VisualException => Called when there's a Visual Diff Assertion Failure.
 """
 
@@ -38,5 +39,64 @@ class TimeLimitExceededException(Exception):
     pass
 
 
+class TimeoutException(Exception):
+    pass
+
+
 class VisualException(Exception):
     pass
+
+
+""" Selenium Exceptions (Simplified for SeleniumBase) """
+
+
+class WebDriverException(Exception):
+    """Base webdriver exception."""
+
+    def __init__(self, msg=None, screen=None, stacktrace=None):
+        super().__init__()
+        self.msg = msg
+        self.screen = screen
+        self.stacktrace = stacktrace
+
+    def __str__(self):
+        exception_msg = "Message: %s\n" % self.msg
+        if self.screen:
+            exception_msg += "Screenshot: available via screen\n"
+        if self.stacktrace:
+            stacktrace = "\n".join(self.stacktrace)
+            exception_msg += "Stacktrace:\n%s" % stacktrace
+        return exception_msg
+
+
+class InvalidSwitchToTargetException(WebDriverException):
+    """Thrown when frame or window target to be switched doesn't exist."""
+
+
+class NoSuchFrameException(InvalidSwitchToTargetException):
+    """Thrown when frame target to be switched doesn't exist."""
+
+
+class NoSuchWindowException(InvalidSwitchToTargetException):
+    """Thrown when window target to be switched doesn't exist."""
+
+
+class NoSuchElementException(WebDriverException):
+    """Thrown when element could not be found."""
+
+
+class NoSuchAttributeException(WebDriverException):
+    """Thrown when the attribute of element could not be found."""
+
+
+class InvalidElementStateException(WebDriverException):
+    """Thrown when a command could not be completed because the element is in
+    an invalid state."""
+
+
+class NoAlertPresentException(WebDriverException):
+    """Thrown when switching to no presented alert."""
+
+
+class ElementNotVisibleException(InvalidElementStateException):
+    """Thrown when an element is present in the DOM, but not visible."""
diff --git a/seleniumbase/console_scripts/ReadMe.md b/seleniumbase/console_scripts/ReadMe.md
@@ -359,16 +359,25 @@ sbase mkfile new_test.py
 ``--ko`` / ``--Korean``     |    ``--pt`` / ``--Portuguese``
 ``--ru`` / ``--Russian``    |    ``--es`` / ``--Spanish``
 
+* Syntax Formats:
+
+``--bc`` / ``--basecase``  (BaseCase class inheritance)
+``--pf`` / ``--pytest-fixture``  (sb pytest fixture)
+``--cf`` / ``--class-fixture``  (class + sb pytest fixture)
+``--cm`` / ``--context-manager``  (SB context manager)
+``--dc`` / ``--driver-context``  (DriverContext manager)
+``--dm`` / ``--driver-manager``  (Driver manager)
+
 * Output:
 
-Creates a new SeleniumBase test file with boilerplate code.
+Creates a new SBase test file with boilerplate code.
 If the file already exists, an error is raised.
-By default, uses English mode and creates a
-boilerplate with the 5 most common SeleniumBase
-methods, which are "open", "type", "click",
-"assert_element", and "assert_text". If using the
-basic boilerplate option, only the "open" method
-is included.
+By default, uses English with BaseCase inheritance,
+and creates a boilerplate with common SeleniumBase
+methods: "open", "type", "click", "assert_element",
+and "assert_text". If using the basic boilerplate
+option, only the "open" method is included. Only the
+BaseCase format supports Languages or Recorder Mode.
 
 <h3>mkrec / record / codegen</h3>
 
diff --git a/seleniumbase/console_scripts/run.py b/seleniumbase/console_scripts/run.py
@@ -267,15 +267,22 @@ def show_mkfile_usage():
     print("           --it / --Italian    |    --ja / --Japanese")
     print("           --ko / --Korean     |    --pt / --Portuguese")
     print("           --ru / --Russian    |    --es / --Spanish")
+    print("  Syntax Formats:")
+    print("           --bc / --basecase  (BaseCase class inheritance)")
+    print("           --pf / --pytest-fixture  (sb pytest fixture)")
+    print("           --cf / --class-fixture  (class + sb pytest fixture)")
+    print("           --cm / --context-manager  (SB context manager)")
+    print("           --dc / --driver-context  (DriverContext manager)")
+    print("           --dm / --driver-manager  (Driver manager)")
     print("  Output:")
     print("           Creates a new SBase test file with boilerplate code.")
     print("           If the file already exists, an error is raised.")
-    print("           By default, uses English mode and creates a")
-    print("           boilerplate with the 5 most common SeleniumBase")
-    print('           methods, which are "open", "type", "click",')
-    print('           "assert_element", and "assert_text". If using the')
-    print('           basic boilerplate option, only the "open" method')
-    print("           is included.")
+    print("           By default, uses English with BaseCase inheritance,")
+    print("           and creates a boilerplate with common SeleniumBase")
+    print('           methods: "open", "type", "click", "assert_element",')
+    print('           and "assert_text". If using the basic boilerplate')
+    print('           option, only the "open" method is included. Only the')
+    print("           BaseCase format supports Languages or Recorder Mode.")
     print("")
 
 
diff --git a/seleniumbase/console_scripts/sb_mkfile.py b/seleniumbase/console_scripts/sb_mkfile.py
@@ -19,15 +19,23 @@
     --ko / --Korean     |    --pt / --Portuguese
     --ru / --Russian    |    --es / --Spanish
 
+Syntax Formats:
+    --bc / --basecase  (BaseCase class inheritance)
+    --pf / --pytest-fixture  (sb pytest fixture)
+    --cf / --class-fixture  (class + sb pytest fixture)
+    --cm / --context-manager  (SB context manager)
+    --dc / --driver-context  (DriverContext manager)
+    --dm / --driver-manager  (Driver manager)
+
 Output:
     Creates a new SBase test file with boilerplate code.
     If the file already exists, an error is raised.
-    By default, uses English mode and creates a
-    boilerplate with the 5 most common SeleniumBase
-    methods, which are "open", "type", "click",
-    "assert_element", and "assert_text". If using the
-    basic boilerplate option, only the "open" method
-    is included.
+    By default, uses English with BaseCase inheritance,
+    and creates a boilerplate with common SeleniumBase
+    methods: "open", "type", "click", "assert_element",
+    and "assert_text". If using the basic boilerplate
+    option, only the "open" method is included. Only the
+    BaseCase format supports Languages or Recorder Mode.
 """
 import codecs
 import colorama
@@ -51,15 +59,22 @@ def invalid_run_command(msg=None):
     exp += "           --it / --Italian    |    --ja / --Japanese\n"
     exp += "           --ko / --Korean     |    --pt / --Portuguese\n"
     exp += "           --ru / --Russian    |    --es / --Spanish\n"
+    exp += "  Syntax Formats:\n"
+    exp += "           --bc / --basecase  (BaseCase class inheritance)\n"
+    exp += "           --pf / --pytest-fixture  (sb pytest fixture)\n"
+    exp += "           --cf / --class-fixture  (class + sb pytest fixture)\n"
+    exp += "           --cm / --context-manager  (SB context manager)\n"
+    exp += "           --dc / --driver-context  (DriverContext manager)\n"
+    exp += "           --dm / --driver-manager  (Driver manager)\n"
     exp += "  Output:\n"
     exp += "           Creates a new SBase test file with boilerplate code.\n"
     exp += "           If the file already exists, an error is raised.\n"
-    exp += "           By default, uses English mode and creates a\n"
-    exp += "           boilerplate with the 5 most common SeleniumBase\n"
-    exp += '           methods, which are "open", "type", "click",\n'
-    exp += '           "assert_element", and "assert_text". If using the\n'
-    exp += '           basic boilerplate option, only the "open" method\n'
-    exp += "           is included.\n"
+    exp += "           By default, uses English with BaseCase inheritance,\n"
+    exp += "           and creates a boilerplate with common SeleniumBase\n"
+    exp += '           methods: "open", "type", "click", "assert_element",\n'
+    exp += '           and "assert_text". If using the basic boilerplate\n'
+    exp += '           option, only the "open" method is included. Only the\n'
+    exp += "           BaseCase format supports Languages or Recorder Mode.\n"
     if not msg:
         raise Exception("INVALID RUN COMMAND!\n\n%s" % exp)
     elif msg == "help":
@@ -86,6 +101,7 @@ def main():
     recorder = False
     error_msg = None
     invalid_cmd = None
+    syntax = "BaseCase"
     language = "English"
 
     command_args = sys.argv[2:]
@@ -138,6 +154,18 @@ def main():
                 language = "Russian"
             elif option == "--es" or option == "--spanish":
                 language = "Spanish"
+            elif option == "--bc" or option == "--basecase":
+                syntax = "BaseCase"
+            elif option == "--pf" or option == "--pytest-fixture":
+                syntax = "PytestFixture"
+            elif option == "--cf" or option == "--class-fixture":
+                syntax = "ClassFixture"
+            elif option == "--cm" or option == "--context-manager":
+                syntax = "ContextManager"
+            elif option == "--dc" or option == "--driver-context":
+                syntax = "DriverContext"
+            elif option == "--dm" or option == "--driver-manager":
+                syntax = "DriverManager"
             else:
                 invalid_cmd = "\n===> INVALID OPTION: >> %s <<\n" % option
                 invalid_cmd = invalid_cmd.replace(">> ", ">>" + c5 + " ")
@@ -239,7 +267,70 @@ def main():
     data.append("")
 
     new_data = []
-    if language == "English":
+    if language == "English" and syntax == "BaseCase":
+        new_data = data
+    elif language == "English" and syntax == "PytestFixture":
+        data = []
+        data.append("def test_base(sb):")
+        data.append('    sb.open("data:text/html,<p>Hello<br><input>")')
+        if not basic:
+            data.append('    sb.type("input", "Goodbye")  # selector, text')
+            data.append('    sb.click("html body > p")  # selector')
+            data.append('    sb.assert_element("body")  # selector')
+            data.append('    sb.assert_text("Hello", "p")  # text, selector')
+        data.append("")
+        new_data = data
+    elif language == "English" and syntax == "ClassFixture":
+        data = []
+        data.append("class %s:" % class_name)
+        data.append("    def test_base(self, sb):")
+        data.append('        sb.open("data:text/html,<p>Hello<br><input>")')
+        if not basic:
+            data.append(
+                '        sb.type("input", "Goodbye")  # selector, text'
+            )
+            data.append('        sb.click("html body > p")  # selector')
+            data.append('        sb.assert_element("body")  # selector')
+            data.append(
+                '        sb.assert_text("Hello", "p")  # text, selector'
+            )
+        data.append("")
+        new_data = data
+    elif language == "English" and syntax == "ContextManager":
+        data = []
+        data.append("from seleniumbase import SB")
+        data.append("")
+        data.append('with SB(browser="chrome") as sb:')
+        data.append(
+            '    sb.open("data:text/html,<div>Hello<br><input></div>")'
+        )
+        if not basic:
+            data.append('    sb.type("input", "Goodbye")  # selector, text')
+            data.append('    sb.click("html body > div")  # selector')
+            data.append('    sb.assert_element("input")  # selector')
+            data.append('    sb.assert_text("Hello", "div")  # text, selector')
+            data.append('    sb.highlight("div")  # selector')
+            data.append("    sb.sleep(0.5)  # seconds")
+        data.append("")
+        new_data = data
+    elif language == "English" and syntax == "DriverContext":
+        data = []
+        data.append("from seleniumbase import DriverContext")
+        data.append("")
+        data.append('with DriverContext(browser="chrome") as driver:')
+        data.append('    driver.get("data:text/html,<p>Hello<br><input>")')
+        data.append("")
+        new_data = data
+    elif language == "English" and syntax == "DriverManager":
+        data = []
+        data.append("from seleniumbase import Driver")
+        data.append("")
+        data.append('driver = Driver(browser="chrome")')
+        data.append("try:")
+        data.append('    driver.get("data:text/html,<p>Hello<br><input>")')
+        data.append("finally:")
+        data.append("    driver.quit()")
+        data.append("")
         new_data = data
     else:
         from seleniumbase.translate.master_dict import MD
diff --git a/seleniumbase/fixtures/shared_utils.py b/seleniumbase/fixtures/shared_utils.py
@@ -124,42 +124,43 @@ def format_exc(exception, message):
     from selenium.common.exceptions import NoSuchWindowException
     from seleniumbase.common.exceptions import NoSuchFileException
     from seleniumbase.common.exceptions import TextNotVisibleException
+    from seleniumbase.common import exceptions
 
     if exception == Exception:
         exc = Exception
         return exc, message
     elif exception == ElementNotVisibleException:
-        exc = ElementNotVisibleException
+        exc = exceptions.ElementNotVisibleException
     elif exception == "ElementNotVisibleException":
-        exc = ElementNotVisibleException
+        exc = exceptions.ElementNotVisibleException
     elif exception == NoSuchElementException:
-        exc = NoSuchElementException
+        exc = exceptions.NoSuchElementException
     elif exception == "NoSuchElementException":
-        exc = NoSuchElementException
+        exc = exceptions.NoSuchElementException
     elif exception == TextNotVisibleException:
-        exc = TextNotVisibleException
+        exc = exceptions.TextNotVisibleException
     elif exception == "TextNotVisibleException":
-        exc = TextNotVisibleException
+        exc = exceptions.TextNotVisibleException
     elif exception == NoAlertPresentException:
-        exc = NoAlertPresentException
+        exc = exceptions.NoAlertPresentException
     elif exception == "NoAlertPresentException":
-        exc = NoAlertPresentException
+        exc = exceptions.NoAlertPresentException
     elif exception == NoSuchAttributeException:
-        exc = NoSuchAttributeException
+        exc = exceptions.NoSuchAttributeException
     elif exception == "NoSuchAttributeException":
-        exc = NoSuchAttributeException
+        exc = exceptions.NoSuchAttributeException
     elif exception == NoSuchFrameException:
-        exc = NoSuchFrameException
+        exc = exceptions.NoSuchFrameException
     elif exception == "NoSuchFrameException":
-        exc = NoSuchFrameException
+        exc = exceptions.NoSuchFrameException
     elif exception == NoSuchWindowException:
-        exc = NoSuchWindowException
+        exc = exceptions.NoSuchWindowException
     elif exception == "NoSuchWindowException":
-        exc = NoSuchWindowException
+        exc = exceptions.NoSuchWindowException
     elif exception == NoSuchFileException:
-        exc = NoSuchFileException
+        exc = exceptions.NoSuchFileException
     elif exception == "NoSuchFileException":
-        exc = NoSuchFileException
+        exc = exceptions.NoSuchFileException
     elif type(exception) is str:
         exc = Exception
         message = "%s: %s" % (exception, message)
diff --git a/seleniumbase/undetected/__init__.py b/seleniumbase/undetected/__init__.py
diff --git a/setup.py b/setup.py

Original file line number	Diff line number	Diff line change
`@@ -1,2 +1,2 @@`
`1`	`1`	`# seleniumbase package`
`2`		`-__version__ = "4.15.0"`
	`2`	`+__version__ = "4.15.1"`