SeleniumBase

Warnings

• gotcha SeleniumBase methods (`self.open()`, `sb.type()`, etc.) must be called within the `BaseCase` test class context (using `self`) or the `SB()` context manager instance. Calling them directly or outside this scope will result in errors like 'It looks like you are trying to call a SeleniumBase method from outside the scope of your test class's `self` object'.
  Fix: Ensure all SeleniumBase methods are invoked via the `self` object within a `BaseCase` inheriting class or an `SB()` context manager instance. For example, `self.open(url)` or `sb.open(url)`.
• gotcha Element detection can be less reliable in headless mode compared to visible browser mode, leading to 'Element Not Found' errors due to differences in page rendering or dynamic content loading. This is a common challenge with headless browser automation.
  Fix: Explicitly set the browser window size using `sb.set_window_size(width, height)` to simulate a real viewport, and consider adjusting user-agent strings to mimic real user behavior (`--user-agent="..."` command-line option).
• gotcha Web scraping scripts using SeleniumBase can break unexpectedly if the target website's HTML structure, element selectors (CSS/XPath), or anti-bot mechanisms change. SeleniumBase's auto-waiting features mitigate flakiness but cannot prevent issues arising from fundamental site changes. Additionally, anti-bot services and CAPTCHAs (like reCAPTCHA) can still detect automation, especially after browser updates, even with stealth options.
  Fix: Regularly verify and update selectors. Employ robust error handling and retry mechanisms. For anti-bot issues, experiment with `--uc` (undetected-chromedriver) mode, `--user-agent` rotation, and other stealth options, but be aware that detection is an ongoing cat-and-mouse game. Consider using proxy integration for IP rotation.
• breaking As of recent versions (e.g., around v4.x), `allure-pytest` is no longer bundled with SeleniumBase and must be installed separately if you wish to generate Allure Reports.
  Fix: If you use Allure Reports, manually install `allure-pytest` with `pip install allure-pytest`.
• gotcha Overriding `setUp()` or `tearDown()` methods in a `BaseCase` subclass requires careful invocation of `super().setUp()` and `super().tearDown()` to ensure SeleniumBase's core setup and teardown functionalities (like browser initialization/quitting, screenshot capture) are not inadvertently bypassed or corrupted. Calling `super()` at the wrong point, or not at all, can lead to broken tests or resource leaks.
  Fix: When customizing `setUp()`/`tearDown()`, always call `super().setUp()` early in your `setUp()` method and `super().tearDown()` late in your `tearDown()` method to preserve SeleniumBase's default behavior. For example: `super().setUp()` then your custom code, and then your custom teardown code then `super().tearDown()`.

Install

• pip install seleniumbase Install SeleniumBase
• seleniumbase install chromedriver latest Install latest ChromeDriver (recommended)

Imports

• BaseCase

  from seleniumbase import BaseCase

  Import BaseCase directly from seleniumbase for class-based tests.
• SB

  from seleniumbase import SB

  Use the SB context manager for non-pytest script execution.
• Driver

  from seleniumbase import Driver

  For direct, low-level WebDriver access with SeleniumBase enhancements.

Quickstart

This quickstart demonstrates a basic interaction with a demo page using the `SB()` context manager. It opens a URL, types text into an input field, clicks a button, asserts text presence, highlights an element, and then asserts the presence of another element. This format allows running SeleniumBase scripts without explicit pytest integration.

from seleniumbase import SB

with SB() as sb:
    sb.open("https://seleniumbase.io/demo_page")
    sb.type("#myTextInput", "This is an automated test")
    sb.click("#myButton")
    sb.assert_text("Automation Practice", "h3")
    sb.highlight("#myButton")
    sb.sleep(1)
    sb.assert_element("tbody#tbodyId")
    print("Test completed successfully!")