Improve non-pytest script processing during pytest collection

Author: mdmintz

seleniumbase/plugins/driver_manager.py

@@ -127,11 +127,39 @@ def Driver(
     wire=None,  # Shortcut / Duplicate of "use_wire".
     pls=None,  # Shortcut / Duplicate of "page_load_strategy".
 ):
+    from seleniumbase import config as sb_config
     from seleniumbase.fixtures import constants
     from seleniumbase.fixtures import shared_utils
 
     sys_argv = sys.argv
     arg_join = " ".join(sys_argv)
+    existing_runner = False
+    collect_only = ("--co" in sys_argv or "--collect-only" in sys_argv)
+    all_scripts = (hasattr(sb_config, "all_scripts") and sb_config.all_scripts)
+    if (
+        (hasattr(sb_config, "is_behave") and sb_config.is_behave)
+        or (hasattr(sb_config, "is_pytest") and sb_config.is_pytest)
+        or (hasattr(sb_config, "is_nosetest") and sb_config.is_nosetest)
+    ):
+        existing_runner = True
+    if (
+        existing_runner
+        and not hasattr(sb_config, "_context_of_runner")
+    ):
+        if hasattr(sb_config, "is_pytest") and sb_config.is_pytest:
+            import pytest
+            msg = "Skipping `Driver()` script. (Use `python`, not `pytest`)"
+            if not collect_only and not all_scripts:
+                print("\n  *** %s" % msg)
+            if collect_only or not all_scripts:
+                pytest.skip(allow_module_level=True)
+        elif hasattr(sb_config, "is_nosetest") and sb_config.is_nosetest:
+            raise Exception(
+                "\n  A Driver() script was triggered by nosetest collection!"
+                '\n  (Prevent that by using: ``if __name__ == "__main__":``)'
+            )
+    elif existing_runner:
+        sb_config._context_of_runner = True
     browser_changes = 0
     browser_set = None
     browser_text = None

seleniumbase/plugins/pytest_plugin.py

@@ -759,6 +759,16 @@ def pytest_addoption(parser):
         help="""This is used by the BaseCase class to tell apart
                 pytest runs from nosetest runs. (Automatic)""",
     )
+    parser.addoption(
+        "--all-scripts",
+        "--all_scripts",
+        action="store_true",
+        dest="all_scripts",
+        default=False,
+        help="""Use this to run `SB()`, `DriverContext()` and
+                `Driver()` scripts that are discovered during
+                the pytest collection phase.""",
+    )
     parser.addoption(
         "--time_limit",
         "--time-limit",
@@ -1525,6 +1535,7 @@ def pytest_configure(config):
         settings.ARCHIVE_EXISTING_DOWNLOADS = True
     if config.getoption("skip_js_waits"):
         settings.SKIP_JS_WAITS = True
+    sb_config.all_scripts = config.getoption("all_scripts")
     sb_config._time_limit = config.getoption("time_limit")
     sb_config.time_limit = config.getoption("time_limit")
     sb_config.slow_mode = config.getoption("slow_mode")

seleniumbase/plugins/sb_manager.py

@@ -136,6 +136,8 @@ def SB(
     arg_join = " ".join(sys_argv)
     archive_logs = False
     existing_runner = False
+    collect_only = ("--co" in sys_argv or "--collect-only" in sys_argv)
+    all_scripts = (hasattr(sb_config, "all_scripts") and sb_config.all_scripts)
     do_log_folder_setup = False  # The first "test=True" run does it
     if (
         (hasattr(sb_config, "is_behave") and sb_config.is_behave)
@@ -146,21 +148,21 @@ def SB(
         test = False  # Already using a test runner. Skip extra test steps.
     elif test is None and "--test" in sys_argv:
         test = True
-    if (
-        existing_runner
-        and not hasattr(sb_config, "_context_of_runner")
-    ):
-        sb_config._context_of_runner = True
+    if existing_runner and not hasattr(sb_config, "_context_of_runner"):
         if hasattr(sb_config, "is_pytest") and sb_config.is_pytest:
-            print(
-                "\n  SB Manager script was triggered by pytest collection!"
-                '\n  (Prevent that by using: `if __name__ == "__main__":`)'
-            )
+            import pytest
+            msg = "Skipping `SB()` script. (Use `python`, not `pytest`)"
+            if not collect_only and not all_scripts:
+                print("\n  *** %s" % msg)
+            if collect_only or not all_scripts:
+                pytest.skip(allow_module_level=True)
         elif hasattr(sb_config, "is_nosetest") and sb_config.is_nosetest:
             raise Exception(
                 "\n  SB Manager script was triggered by nosetest collection!"
                 '\n  (Prevent that by using: ``if __name__ == "__main__":``)'
             )
+    elif existing_runner:
+        sb_config._context_of_runner = True
     if (
         not existing_runner
         and not hasattr(sb_config, "_has_older_context")
@@ -959,8 +961,6 @@ def SB(
         sb_config = sb_config_backup
         if test:
             sb_config._has_older_context = True
-        if existing_runner:
-            sb_config._context_of_runner = True
         if test_name:
             result = "passed"
             if test and not test_passed: