pypi package 'seleniumbase'

Popularity: Medium (more popular than 90% of all packages)
Description: A complete web automation framework for end-to-end testing.
Installation: pip install seleniumbase
Last version: 4.13.1 (Download)
Homepage: https://github.com/seleniumbase/SeleniumBase
Size: 505.42 kB
License: MIT
Keywords: pytest, automation, selenium, browser, testing, webdriver, sbase

Activity

Last modified: February 21, 2023 6:08 PM (3 months ago)
Versions released in one year: 109
Weekly downloads: 72,035
06/05/202208/21/202211/06/202201/22/202304/09/2023040,00080,000120,000160,000036912released versions / week
  • Versions released
  • Weekly downloads

What's new in version 4.8.6

Delta between version 4.8.5 and version 4.8.6

Source: Github
Commits:
  • 4ea8680db2e0d56fd17e5d617598bd4f8deb61ef, November 18, 2022 7:17 PM:
    Remove deprecated drivers
  • 499137d0d381fee4ab6c7e43ca13b004aaf1d713, November 18, 2022 7:17 PM:
    Update the documentation
  • 6b500c03a6a4b9a9e969374f7b376fd53977812b, November 18, 2022 7:19 PM:
    Version 4.8.6
  • eb896f20f3e9ece682cdaa5c79d68bd669b06a3f, November 18, 2022 8:05 PM:
    Refactor an old script that's no longer used
  • 2d5904367683c30a7dd3efd2d6824f9a83aec14d, November 18, 2022 8:06 PM:
    Refactor the Dockerfile
  • c7d3a90368e2ca041739dc7f73530036c5f7968a, November 18, 2022 8:08 PM:
    Refactor the SB Manager and Driver Manager
  • e0fe5931d5c9555b9aa856aea7108c459be7c663, November 18, 2022 8:08 PM:
    Rename a test script
  • 842deb606a01d16918387835d17de9f8c18d4091, November 18, 2022 8:23 PM:
    Merge pull request #1614 from seleniumbase/refactoring-and-removing-old-drivers
    
    Refactoring and removing deprecated drivers
Files changed:
.travis.yml CHANGED
@@ -21,9 +21,8 @@ install:
21
  - "sudo rm -f /etc/boto.cfg"
22
  before_script:
23
  - "flake8 --exclude=temp"
24
- # - "wget https://chromedriver.storage.googleapis.com/2.44/chromedriver_linux64.zip && unzip chromedriver_linux64.zip && sudo cp chromedriver /usr/local/bin/ && sudo chmod +x /usr/local/bin/chromedriver"
25
- # - "wget https://github.com/mozilla/geckodriver/releases/download/v0.27.0/geckodriver-v0.27.0-linux64.tar.gz -O /tmp/geckodriver.tar.gz && tar -C /opt -xzf /tmp/geckodriver.tar.gz && sudo chmod 755 /opt/geckodriver && sudo ln -fs /opt/geckodriver /usr/bin/geckodriver && sudo ln -fs /opt/geckodriver /usr/local/bin/geckodriver"
26
- # - "wget https://bitbucket.org/ariya/phantomjs/downloads/phantomjs-2.1.1-linux-x86_64.tar.bz2 && tar -xvf ./phantomjs-2.1.1-linux-x86_64.tar.bz2 && export PATH=$PWD/phantomjs-2.1.1-linux-x86_64/bin:$PATH"
27
  - "seleniumbase"
28
  - "seleniumbase install chromedriver"
29
  # - "seleniumbase install geckodriver"
21
  - "sudo rm -f /etc/boto.cfg"
22
  before_script:
23
  - "flake8 --exclude=temp"
24
+ # - "wget https://chromedriver.storage.googleapis.com/72.0.3626.69/chromedriver_linux64.zip && unzip chromedriver_linux64.zip && sudo cp chromedriver /usr/local/bin/ && sudo chmod +x /usr/local/bin/chromedriver"
25
+ # - "wget https://github.com/mozilla/geckodriver/releases/download/v0.32.0/geckodriver-v0.32.0-linux64.tar.gz -O /tmp/geckodriver.tar.gz && tar -C /opt -xzf /tmp/geckodriver.tar.gz && sudo chmod 755 /opt/geckodriver && sudo ln -fs /opt/geckodriver /usr/bin/geckodriver && sudo ln -fs /opt/geckodriver /usr/local/bin/geckodriver"
 
26
  - "seleniumbase"
27
  - "seleniumbase install chromedriver"
28
  # - "seleniumbase install geckodriver"
Dockerfile CHANGED
@@ -88,8 +88,8 @@ RUN cd /SeleniumBase && pip3 install .
88
  #=====================
89
  # Download WebDrivers
90
  #=====================
91
- RUN wget https://github.com/mozilla/geckodriver/releases/download/v0.31.0/geckodriver-v0.31.0-linux64.tar.gz
92
- RUN tar -xvzf geckodriver-v0.31.0-linux64.tar.gz
93
  RUN chmod +x geckodriver
94
  RUN mv geckodriver /usr/local/bin/
95
  RUN wget https://chromedriver.storage.googleapis.com/72.0.3626.69/chromedriver_linux64.zip
88
  #=====================
89
  # Download WebDrivers
90
  #=====================
91
+ RUN wget https://github.com/mozilla/geckodriver/releases/download/v0.32.0/geckodriver-v0.32.0-linux64.tar.gz
92
+ RUN tar -xvzf geckodriver-v0.32.0-linux64.tar.gz
93
  RUN chmod +x geckodriver
94
  RUN mv geckodriver /usr/local/bin/
95
  RUN wget https://chromedriver.storage.googleapis.com/72.0.3626.69/chromedriver_linux64.zip
examples/raw_call.py CHANGED
@@ -1,5 +1,5 @@
1
- """Running tests with pure "python" instead of directly calling "pytest".
2
- To run, use: "python pure_python.py".
3
  Two examples: pytest.main() and subprocess.call()."""
4
  import pytest
5
  import subprocess
1
+ """Calling tests with "python" instead of directly using "pytest".
2
+ To run, use: "python raw_call.py".
3
  Two examples: pytest.main() and subprocess.call()."""
4
  import pytest
5
  import subprocess
help_docs/webdriver_installation.md CHANGED
@@ -1,59 +1,50 @@
1
  <!-- SeleniumBase Docs -->
2
 
3
- ## [<img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) Installing webdrivers
4
 
5
  To run web automation, you'll need webdrivers for each browser you plan on using. With SeleniumBase, drivers are downloaded automatically as needed into the SeleniumBase ``drivers`` folder.
6
 
7
  You can also download drivers manually with these commands:
8
 
9
  ```bash
10
- sbase get chromedriver
11
- sbase get geckodriver
12
- sbase get edgedriver
13
  ```
14
 
15
- * To get the latest ``chromedriver`` when you don't have the latest Chrome, use:
16
 
17
- ```bash
18
- sbase get chromedriver latest
19
- ```
20
 
21
- * You can also get a specific version of chromedriver for a specific version of Chrome:
22
 
23
  ```bash
24
- sbase get chromedriver 107.0.5304.62
25
-
26
  sbase get chromedriver 107
 
 
 
 
27
  ```
28
 
29
- * On Linux, you can run the following two commands (once you've installed SeleniumBase) to automatically upgrade your Chromedriver to match your version of Chrome: (``wget`` downloads the file, and ``pytest`` runs it.)
30
 
31
- ```bash
32
- wget https://raw.githubusercontent.com/seleniumbase/SeleniumBase/master/examples/upgrade_chromedriver.py
33
- pytest upgrade_chromedriver.py -s
34
- ```
35
 
36
- * If you run a test without the correct webdriver available, the driver will be downloaded automatically.
37
-
38
- If you plan on using the [Selenium Grid integration](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md) (which allows for remote webdriver), you'll need to put the drivers on your System PATH. On macOS and Linux, ``/usr/local/bin`` is a good PATH spot. On Windows, you may need to set the System PATH under Environment Variables to include the location where you placed the driver files. As a shortcut, you could place the driver files into your Python ``Scripts/`` folder in the location where you have Python installed, which should already be on your System PATH.
39
 
40
  Here's where you can go to manually get web drivers from the source:
41
 
42
  * For Chrome, get [Chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads) on your System PATH.
43
 
44
- * For Firefox, get [Geckodriver](https://github.com/mozilla/geckodriver/releases) on your System PATH.
45
 
46
- * For Microsoft Edge, get [Edge Driver (Microsoft WebDriver)](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/) on your System PATH.
47
 
48
  * For Safari, get [Safari Driver](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/using_safari_driver.md) on your System PATH.
49
 
50
- * For Opera, get [Opera Chromium Driver](https://github.com/operasoftware/operachromiumdriver/releases) on your System PATH..
51
-
52
- * For PhantomJS headless browser automation, get [PhantomJS](http://phantomjs.org/download.html) on your System PATH. (NOTE: <i>PhantomJS is no longer officially supported by SeleniumHQ</i>)
53
-
54
  **macOS shortcuts**:
55
 
56
- * You can also install drivers by using ``brew`` (aka ``homebrew``), but you'll need to install that first. [Brew installation instructions are here](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/install_python_pip_git.md).
57
 
58
  ```bash
59
  brew install --cask chromedriver
@@ -71,7 +62,7 @@ brew upgrade geckodriver
71
 
72
  **Linux shortcuts**:
73
 
74
- If you still need the web drivers, here are some scripts to help you get chromedriver and geckodriver on a Linux machine:
75
 
76
  ```bash
77
  wget https://chromedriver.storage.googleapis.com/72.0.3626.69/chromedriver_linux64.zip
@@ -87,6 +78,6 @@ mv geckodriver /usr/local/bin/
87
  chmod +x /usr/local/bin/geckodriver
88
  ```
89
 
90
- * If you wish to verify that web drivers are working, **[follow these instructions](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/verify_webdriver.md)**.
91
 
92
- [<img src="https://seleniumbase.io/cdn/img/sb_logo_b.png" title="SeleniumBase" width="280">](https://github.com/seleniumbase/SeleniumBase)
1
  <!-- SeleniumBase Docs -->
2
 
3
+ ## [<img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) Installing webdrivers
4
 
5
  To run web automation, you'll need webdrivers for each browser you plan on using. With SeleniumBase, drivers are downloaded automatically as needed into the SeleniumBase ``drivers`` folder.
6
 
7
  You can also download drivers manually with these commands:
8
 
9
  ```bash
10
+ seleniumbase get chromedriver
11
+ seleniumbase get geckodriver
12
+ seleniumbase get edgedriver
13
  ```
14
 
15
+ After running the commands above, web drivers will get downloaded into the ``seleniumbase/drivers/`` folder. SeleniumBase uses those drivers during tests. (The drivers don't come with SeleniumBase by default.)
16
 
17
+ If the necessary driver is not found in this location while running tests, SeleniumBase will instead look for the driver on the System PATH. If the necessary driver is not on the System PATH either, SeleniumBase will automatically attempt to download the required driver.
 
 
18
 
19
+ * You can also download specific versions of drivers. Examples:
20
 
21
  ```bash
 
 
22
  sbase get chromedriver 107
23
+ sbase get chromedriver 107.0.5304.62
24
+ sbase get chromedriver latest
25
+ sbase get chromedriver latest-1
26
+ sbase get edgedriver 106.0.1370.42
27
  ```
28
 
29
+ (NOTE: ``sbase`` is a shortcut for ``seleniumbase``)
30
 
31
+ --------
 
 
 
32
 
33
+ If you plan on using the [Selenium Grid integration](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md) (which allows for ``remote`` webdriver), you'll need to put the drivers on your System PATH. On macOS and Linux, ``/usr/local/bin`` is a good PATH spot. On Windows, you may need to set the System PATH under Environment Variables to include the location where you placed the driver files. As a shortcut, you could place the driver files into your Python ``Scripts/`` folder in the location where you have Python installed, which should already be on your System PATH.
 
 
34
 
35
  Here's where you can go to manually get web drivers from the source:
36
 
37
  * For Chrome, get [Chromedriver](https://sites.google.com/a/chromium.org/chromedriver/downloads) on your System PATH.
38
 
39
+ * For Edge, get [Edge Driver (Microsoft WebDriver)](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/) on your System PATH.
40
 
41
+ * For Firefox, get [Geckodriver](https://github.com/mozilla/geckodriver/releases) on your System PATH.
42
 
43
  * For Safari, get [Safari Driver](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/using_safari_driver.md) on your System PATH.
44
 
 
 
 
 
45
  **macOS shortcuts**:
46
 
47
+ * You can also install drivers by using ``brew`` (aka ``homebrew``):
48
 
49
  ```bash
50
  brew install --cask chromedriver
62
 
63
  **Linux shortcuts**:
64
 
65
+ If you still need the web drivers, here are some scripts to help you get ``chromedriver`` and ``geckodriver`` on a Linux machine:
66
 
67
  ```bash
68
  wget https://chromedriver.storage.googleapis.com/72.0.3626.69/chromedriver_linux64.zip
78
  chmod +x /usr/local/bin/geckodriver
79
  ```
80
 
81
+ To verify that web drivers are working, **[follow these instructions](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/verify_webdriver.md)**.
82
 
83
+ [<img src="https://seleniumbase.github.io/cdn/img/sb_logo_b.png" title="SeleniumBase" width="280">](https://github.com/seleniumbase/SeleniumBase)
integrations/linux/Linuxfile.sh CHANGED
@@ -61,14 +61,6 @@ sudo apt-get install -y --force-yes libmysqlclient-dev
61
  sudo apt-get install -y --force-yes python-dev
62
  sudo apt-get install -y --force-yes python-MySQLdb
63
 
64
- # Install PhantomJS
65
- # cd ~
66
- # export PHANTOM_JS="phantomjs-2.1.1-linux-x86_64"
67
- # sudo wget https://bitbucket.org/ariya/phantomjs/downloads/$PHANTOM_JS.tar.bz2
68
- # sudo tar xvjf $PHANTOM_JS.tar.bz2
69
- # sudo mv -f $PHANTOM_JS /usr/local/share
70
- # sudo ln -sf /usr/local/share/$PHANTOM_JS/bin/phantomjs /usr/local/bin
71
-
72
  # Install Chrome
73
  cd /tmp
74
  sudo wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
61
  sudo apt-get install -y --force-yes python-dev
62
  sudo apt-get install -y --force-yes python-MySQLdb
63
 
 
 
 
 
 
 
 
 
64
  # Install Chrome
65
  cd /tmp
66
  sudo wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
seleniumbase/__version__.py CHANGED
@@ -1,2 +1,2 @@
1
  # seleniumbase package
2
- __version__ = "4.8.5"
1
  # seleniumbase package
2
+ __version__ = "4.8.6"
seleniumbase/behave/behave_sb.py CHANGED
@@ -8,7 +8,7 @@
8
  behave -D agent="User Agent String" -D demo
9
  ****************************************************************
10
  -D browser=BROWSER (The web browser to use. Default: "chrome".)
11
- -D chrome (Shortcut for "-D browser=chrome". On by default.)
12
  -D edge (Shortcut for "-D browser=edge".)
13
  -D firefox (Shortcut for "-D browser=firefox".)
14
  -D safari (Shortcut for "-D browser=safari".)
8
  behave -D agent="User Agent String" -D demo
9
  ****************************************************************
10
  -D browser=BROWSER (The web browser to use. Default: "chrome".)
11
+ -D chrome (Shortcut for "-D browser=chrome". Default.)
12
  -D edge (Shortcut for "-D browser=edge".)
13
  -D firefox (Shortcut for "-D browser=firefox".)
14
  -D safari (Shortcut for "-D browser=safari".)
seleniumbase/core/browser_launcher.py CHANGED
@@ -1633,44 +1633,6 @@ def get_remote_driver(
1633
  desired_capabilities=capabilities,
1634
  keep_alive=True,
1635
  )
1636
- elif browser_name == constants.Browser.PHANTOM_JS:
1637
- if selenium4_or_newer:
1638
- message = (
1639
- "\n"
1640
- "PhantomJS is no longer available for Selenium 4!\n"
1641
- 'Try using "--headless" mode with Chrome instead!'
1642
- )
1643
- raise Exception(message)
1644
- capabilities = webdriver.DesiredCapabilities.PHANTOMJS
1645
- for key in desired_caps.keys():
1646
- capabilities[key] = desired_caps[key]
1647
- with warnings.catch_warnings():
1648
- # Ignore "PhantomJS has been deprecated" UserWarning
1649
- warnings.simplefilter("ignore", category=UserWarning)
1650
- return webdriver.Remote(
1651
- command_executor=address,
1652
- desired_capabilities=capabilities,
1653
- keep_alive=True,
1654
- )
1655
- elif browser_name == constants.Browser.ANDROID:
1656
- capabilities = webdriver.DesiredCapabilities.ANDROID
1657
- if selenium4_or_newer:
1658
- remote_options = ArgOptions()
1659
- remote_options.set_capability("cloud:options", desired_caps)
1660
- return webdriver.Remote(
1661
- command_executor=address,
1662
- options=remote_options,
1663
- keep_alive=True,
1664
- )
1665
- else:
1666
- warnings.simplefilter("ignore", category=DeprecationWarning)
1667
- for key in desired_caps.keys():
1668
- capabilities[key] = desired_caps[key]
1669
- return webdriver.Remote(
1670
- command_executor=address,
1671
- desired_capabilities=capabilities,
1672
- keep_alive=True,
1673
- )
1674
  elif browser_name == constants.Browser.IPHONE:
1675
  capabilities = webdriver.DesiredCapabilities.IPHONE
1676
  if selenium4_or_newer:
@@ -2412,18 +2374,6 @@ def get_local_driver(
2412
  except Exception:
2413
  # Opera support was dropped! Downgrade to Python 3.6 to use it!
2414
  return webdriver.Opera()
2415
- elif browser_name == constants.Browser.PHANTOM_JS:
2416
- if selenium4_or_newer:
2417
- message = (
2418
- "\n"
2419
- "PhantomJS is no longer available for Selenium 4!\n"
2420
- 'Try using "--headless" mode with Chrome instead!'
2421
- )
2422
- raise Exception(message)
2423
- with warnings.catch_warnings():
2424
- # Ignore "PhantomJS has been deprecated" UserWarning
2425
- warnings.simplefilter("ignore", category=UserWarning)
2426
- return webdriver.PhantomJS()
2427
  elif browser_name == constants.Browser.GOOGLE_CHROME:
2428
  try:
2429
  chrome_options = _set_chrome_options(
1633
  desired_capabilities=capabilities,
1634
  keep_alive=True,
1635
  )
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1636
  elif browser_name == constants.Browser.IPHONE:
1637
  capabilities = webdriver.DesiredCapabilities.IPHONE
1638
  if selenium4_or_newer:
2374
  except Exception:
2375
  # Opera support was dropped! Downgrade to Python 3.6 to use it!
2376
  return webdriver.Opera()
 
 
 
 
 
 
 
 
 
 
 
 
2377
  elif browser_name == constants.Browser.GOOGLE_CHROME:
2378
  try:
2379
  chrome_options = _set_chrome_options(
seleniumbase/drivers/ReadMe.md CHANGED
@@ -1,30 +1,27 @@
1
- ### <img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> SeleniumBase webdriver storage
2
 
3
- * You need a different webdriver for each web browser you want to run automation on: ``chromedriver`` for Chrome, ``edgedriver`` for Edge, ``geckodriver`` for Firefox, ``operadriver`` for Opera, and ``iedriver`` for Internet Explorer.
 
 
4
 
5
  ```bash
6
  seleniumbase get chromedriver
7
  seleniumbase get geckodriver
8
  seleniumbase get edgedriver
9
- seleniumbase get iedriver
10
- seleniumbase get operadriver
11
  ```
12
 
13
- After running the commands above, web drivers will get downloaded into this folder. SeleniumBase will then use those drivers during tests if present. (The drivers don't come with SeleniumBase by default.)
14
-
15
- * If you have the latest version of Chrome installed, get the latest chromedriver (<i>otherwise it defaults to chromedriver 72.0.3626.69 for compatibility reasons</i>):
16
-
17
- ```bash
18
- sbase get chromedriver latest
19
- ```
20
 
21
  If the necessary driver is not found in this location while running tests, SeleniumBase will instead look for the driver on the System PATH. If the necessary driver is not on the System PATH either, SeleniumBase will automatically attempt to download the required driver.
22
 
23
  * You can also download specific versions of drivers. Examples:
24
 
25
  ```bash
26
- sbase get chromedriver 101
27
- sbase get chromedriver 101.0.4951.41
 
28
  sbase get chromedriver latest-1
29
- sbase get edgedriver 101.0.1210.32
30
  ```
 
 
1
+ ### <img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32" /> SeleniumBase webdriver storage
2
 
3
+ To run web automation, you'll need webdrivers for each browser you plan on using. With SeleniumBase, drivers are downloaded automatically as needed into the SeleniumBase ``drivers`` folder.
4
+
5
+ You can also download drivers manually with these commands:
6
 
7
  ```bash
8
  seleniumbase get chromedriver
9
  seleniumbase get geckodriver
10
  seleniumbase get edgedriver
 
 
11
  ```
12
 
13
+ After running the commands above, web drivers will get downloaded into the ``seleniumbase/drivers/`` folder. SeleniumBase uses those drivers during tests. (The drivers don't come with SeleniumBase by default.)
 
 
 
 
 
 
14
 
15
  If the necessary driver is not found in this location while running tests, SeleniumBase will instead look for the driver on the System PATH. If the necessary driver is not on the System PATH either, SeleniumBase will automatically attempt to download the required driver.
16
 
17
  * You can also download specific versions of drivers. Examples:
18
 
19
  ```bash
20
+ sbase get chromedriver 107
21
+ sbase get chromedriver 107.0.5304.62
22
+ sbase get chromedriver latest
23
  sbase get chromedriver latest-1
24
+ sbase get edgedriver 106.0.1370.42
25
  ```
26
+
27
+ (NOTE: ``sbase`` is a shortcut for ``seleniumbase``)
seleniumbase/fixtures/constants.py CHANGED
@@ -310,9 +310,7 @@ class ValidBrowsers:
310
  "firefox",
311
  "ie",
312
  "opera",
313
- "phantomjs",
314
  "safari",
315
- "android",
316
  "iphone",
317
  "ipad",
318
  "remote",
@@ -325,9 +323,7 @@ class Browser:
325
  FIREFOX = "firefox"
326
  INTERNET_EXPLORER = "ie"
327
  OPERA = "opera"
328
- PHANTOM_JS = "phantomjs"
329
  SAFARI = "safari"
330
- ANDROID = "android"
331
  IPHONE = "iphone"
332
  IPAD = "ipad"
333
  REMOTE = "remote"
@@ -338,9 +334,7 @@ class Browser:
338
  "firefox": None,
339
  "ie": None,
340
  "opera": None,
341
- "phantomjs": None,
342
  "safari": None,
343
- "android": None,
344
  "iphone": None,
345
  "ipad": None,
346
  "remote": None,
@@ -352,9 +346,7 @@ class Browser:
352
  "firefox": None,
353
  "ie": None,
354
  "opera": None,
355
- "phantomjs": None,
356
  "safari": None,
357
- "android": None,
358
  "iphone": None,
359
  "ipad": None,
360
  "remote": None,
310
  "firefox",
311
  "ie",
312
  "opera",
 
313
  "safari",
 
314
  "iphone",
315
  "ipad",
316
  "remote",
323
  FIREFOX = "firefox"
324
  INTERNET_EXPLORER = "ie"
325
  OPERA = "opera"
 
326
  SAFARI = "safari"
 
327
  IPHONE = "iphone"
328
  IPAD = "ipad"
329
  REMOTE = "remote"
334
  "firefox": None,
335
  "ie": None,
336
  "opera": None,
 
337
  "safari": None,
 
338
  "iphone": None,
339
  "ipad": None,
340
  "remote": None,
346
  "firefox": None,
347
  "ie": None,
348
  "opera": None,
 
349
  "safari": None,
 
350
  "iphone": None,
351
  "ipad": None,
352
  "remote": None,
seleniumbase/plugins/driver_manager.py CHANGED
@@ -139,10 +139,6 @@ def Driver(
139
  browser_changes += 1
140
  browser_set = "ie"
141
  browser_list.append("--browser=ie")
142
- if "--browser=phantomjs" in sys_argv or "--browser phantomjs" in sys_argv:
143
- browser_changes += 1
144
- browser_set = "phantomjs"
145
- browser_list.append("--browser=phantomjs")
146
  if "--browser=remote" in sys_argv or "--browser remote" in sys_argv:
147
  browser_changes += 1
148
  browser_set = "remote"
139
  browser_changes += 1
140
  browser_set = "ie"
141
  browser_list.append("--browser=ie")
 
 
 
 
142
  if "--browser=remote" in sys_argv or "--browser remote" in sys_argv:
143
  browser_changes += 1
144
  browser_set = "remote"
seleniumbase/plugins/pytest_plugin.py CHANGED
@@ -27,7 +27,7 @@ def pytest_addoption(parser):
27
  """
28
  This plugin adds the following command-line options to pytest:
29
  --browser=BROWSER (The web browser to use. Default: "chrome".)
30
- --chrome (Shortcut for "--browser=chrome". On by default.)
31
  --edge (Shortcut for "--browser=edge".)
32
  --firefox (Shortcut for "--browser=firefox".)
33
  --safari (Shortcut for "--browser=safari".)
@@ -137,50 +137,49 @@ def pytest_addoption(parser):
137
  choices=constants.ValidBrowsers.valid_browsers,
138
  default=constants.Browser.GOOGLE_CHROME,
139
  help="""Specifies the web browser to use. Default: Chrome.
140
- If you want to use Firefox, explicitly indicate that.
141
- Example: (--browser=firefox)""",
142
  )
143
  parser.addoption(
144
  "--chrome",
145
  action="store_true",
146
  dest="use_chrome",
147
  default=False,
148
- help="""Shortcut for --browser=chrome. On by default.)""",
149
  )
150
  parser.addoption(
151
  "--edge",
152
  action="store_true",
153
  dest="use_edge",
154
  default=False,
155
- help="""Shortcut for --browser=edge.)""",
156
  )
157
  parser.addoption(
158
  "--firefox",
159
  action="store_true",
160
  dest="use_firefox",
161
  default=False,
162
- help="""Shortcut for --browser=firefox.)""",
163
  )
164
  parser.addoption(
165
  "--ie",
166
  action="store_true",
167
  dest="use_ie",
168
  default=False,
169
- help="""Shortcut for --browser=ie.)""",
170
  )
171
  parser.addoption(
172
  "--opera",
173
  action="store_true",
174
  dest="use_opera",
175
  default=False,
176
- help="""Shortcut for --browser=opera.)""",
177
  )
178
  parser.addoption(
179
  "--safari",
180
  action="store_true",
181
  dest="use_safari",
182
  default=False,
183
- help="""Shortcut for --browser=safari.)""",
184
  )
185
  parser.addoption(
186
  "--with-selenium",
@@ -921,7 +920,7 @@ def pytest_addoption(parser):
921
  action="store_true",
922
  dest="uc_subprocess",
923
  default=None,
924
- help="""(DEPRECATED) - Setting will always be enabled.
925
  Use undetectable-chromedriver as a subprocess,
926
  which can help avoid issues that might result.
927
  It may reduce UC's ability to avoid detection.""",
@@ -1230,10 +1229,6 @@ def pytest_addoption(parser):
1230
  browser_changes += 1
1231
  browser_set = "ie"
1232
  browser_list.append("--browser=ie")
1233
- if "--browser=phantomjs" in sys_argv or "--browser phantomjs" in sys_argv:
1234
- browser_changes += 1
1235
- browser_set = "phantomjs"
1236
- browser_list.append("--browser=phantomjs")
1237
  if "--browser=remote" in sys_argv or "--browser remote" in sys_argv:
1238
  browser_changes += 1
1239
  browser_set = "remote"
27
  """
28
  This plugin adds the following command-line options to pytest:
29
  --browser=BROWSER (The web browser to use. Default: "chrome".)
30
+ --chrome (Shortcut for "--browser=chrome". Default.)
31
  --edge (Shortcut for "--browser=edge".)
32
  --firefox (Shortcut for "--browser=firefox".)
33
  --safari (Shortcut for "--browser=safari".)
137
  choices=constants.ValidBrowsers.valid_browsers,
138
  default=constants.Browser.GOOGLE_CHROME,
139
  help="""Specifies the web browser to use. Default: Chrome.
140
+ Examples: (--browser=edge OR --browser=firefox)""",
 
141
  )
142
  parser.addoption(
143
  "--chrome",
144
  action="store_true",
145
  dest="use_chrome",
146
  default=False,
147
+ help="""Shortcut for --browser=chrome (Default)""",
148
  )
149
  parser.addoption(
150
  "--edge",
151
  action="store_true",
152
  dest="use_edge",
153
  default=False,
154
+ help="""Shortcut for --browser=edge""",
155
  )
156
  parser.addoption(
157
  "--firefox",
158
  action="store_true",
159
  dest="use_firefox",
160
  default=False,
161
+ help="""Shortcut for --browser=firefox""",
162
  )
163
  parser.addoption(
164
  "--ie",
165
  action="store_true",
166
  dest="use_ie",
167
  default=False,
168
+ help="""Shortcut for --browser=ie""",
169
  )
170
  parser.addoption(
171
  "--opera",
172
  action="store_true",
173
  dest="use_opera",
174
  default=False,
175
+ help="""Shortcut for --browser=opera""",
176
  )
177
  parser.addoption(
178
  "--safari",
179
  action="store_true",
180
  dest="use_safari",
181
  default=False,
182
+ help="""Shortcut for --browser=safari""",
183
  )
184
  parser.addoption(
185
  "--with-selenium",
920
  action="store_true",
921
  dest="uc_subprocess",
922
  default=None,
923
+ help="""(DEPRECATED) - (UC Mode always uses this now.)
924
  Use undetectable-chromedriver as a subprocess,
925
  which can help avoid issues that might result.
926
  It may reduce UC's ability to avoid detection.""",
1229
  browser_changes += 1
1230
  browser_set = "ie"
1231
  browser_list.append("--browser=ie")
 
 
 
 
1232
  if "--browser=remote" in sys_argv or "--browser remote" in sys_argv:
1233
  browser_changes += 1
1234
  browser_set = "remote"
seleniumbase/plugins/sb_manager.py CHANGED
@@ -199,10 +199,6 @@ def SB(
199
  browser_changes += 1
200
  browser_set = "ie"
201
  browser_list.append("--browser=ie")
202
- if "--browser=phantomjs" in sys_argv or "--browser phantomjs" in sys_argv:
203
- browser_changes += 1
204
- browser_set = "phantomjs"
205
- browser_list.append("--browser=phantomjs")
206
  if "--browser=remote" in sys_argv or "--browser remote" in sys_argv:
207
  browser_changes += 1
208
  browser_set = "remote"
199
  browser_changes += 1
200
  browser_set = "ie"
201
  browser_list.append("--browser=ie")
 
 
 
 
202
  if "--browser=remote" in sys_argv or "--browser remote" in sys_argv:
203
  browser_changes += 1
204
  browser_set = "remote"
seleniumbase/plugins/selenium_plugin.py CHANGED
@@ -19,7 +19,7 @@ class SeleniumBrowser(Plugin):
19
  """
20
  This plugin adds the following command-line options to nosetests:
21
  --browser=BROWSER (The web browser to use. Default: "chrome".)
22
- --chrome (Shortcut for "--browser=chrome". On by default.)
23
  --edge (Shortcut for "--browser=edge".)
24
  --firefox (Shortcut for "--browser=firefox".)
25
  --safari (Shortcut for "--browser=safari".)
@@ -103,50 +103,49 @@ def options(self, parser, env):
103
  choices=constants.ValidBrowsers.valid_browsers,
104
  default=constants.Browser.GOOGLE_CHROME,
105
  help="""Specifies the web browser to use. Default: Chrome.
106
- If you want to use Firefox, explicitly indicate that.
107
- Example: (--browser=firefox)""",
108
  )
109
  parser.add_option(
110
  "--chrome",
111
  action="store_true",
112
  dest="use_chrome",
113
  default=False,
114
- help="""Shortcut for --browser=chrome. On by default.)""",
115
  )
116
  parser.add_option(
117
  "--edge",
118
  action="store_true",
119
  dest="use_edge",
120
  default=False,
121
- help="""Shortcut for --browser=edge.)""",
122
  )
123
  parser.add_option(
124
  "--firefox",
125
  action="store_true",
126
  dest="use_firefox",
127
  default=False,
128
- help="""Shortcut for --browser=firefox.)""",
129
  )
130
  parser.add_option(
131
  "--ie",
132
  action="store_true",
133
  dest="use_ie",
134
  default=False,
135
- help="""Shortcut for --browser=ie.)""",
136
  )
137
  parser.add_option(
138
  "--opera",
139
  action="store_true",
140
  dest="use_opera",
141
  default=False,
142
- help="""Shortcut for --browser=opera.)""",
143
  )
144
  parser.add_option(
145
  "--safari",
146
  action="store_true",
147
  dest="use_safari",
148
  default=False,
149
- help="""Shortcut for --browser=safari.)""",
150
  )
151
  parser.add_option(
152
  "--cap_file",
@@ -681,7 +680,7 @@ def options(self, parser, env):
681
  action="store_true",
682
  dest="uc_subprocess",
683
  default=None,
684
- help="""(DEPRECATED) - Setting will always be enabled.
685
  Use undetectable-chromedriver as a subprocess,
686
  which can help avoid issues that might result.
687
  It may reduce UC's ability to avoid detection.""",
19
  """
20
  This plugin adds the following command-line options to nosetests:
21
  --browser=BROWSER (The web browser to use. Default: "chrome".)
22
+ --chrome (Shortcut for "--browser=chrome". Default.)
23
  --edge (Shortcut for "--browser=edge".)
24
  --firefox (Shortcut for "--browser=firefox".)
25
  --safari (Shortcut for "--browser=safari".)
103
  choices=constants.ValidBrowsers.valid_browsers,
104
  default=constants.Browser.GOOGLE_CHROME,
105
  help="""Specifies the web browser to use. Default: Chrome.
106
+ Examples: (--browser=edge OR --browser=firefox)""",
 
107
  )
108
  parser.add_option(
109
  "--chrome",
110
  action="store_true",
111
  dest="use_chrome",
112
  default=False,
113
+ help="""Shortcut for --browser=chrome (Default)""",
114
  )
115
  parser.add_option(
116
  "--edge",
117
  action="store_true",
118
  dest="use_edge",
119
  default=False,
120
+ help="""Shortcut for --browser=edge""",
121
  )
122
  parser.add_option(
123
  "--firefox",
124
  action="store_true",
125
  dest="use_firefox",
126
  default=False,
127
+ help="""Shortcut for --browser=firefox""",
128
  )
129
  parser.add_option(
130
  "--ie",
131
  action="store_true",
132
  dest="use_ie",
133
  default=False,
134
+ help="""Shortcut for --browser=ie""",
135
  )
136
  parser.add_option(
137
  "--opera",
138
  action="store_true",
139
  dest="use_opera",
140
  default=False,
141
+ help="""Shortcut for --browser=opera""",
142
  )
143
  parser.add_option(
144
  "--safari",
145
  action="store_true",
146
  dest="use_safari",
147
  default=False,
148
+ help="""Shortcut for --browser=safari""",
149
  )
150
  parser.add_option(
151
  "--cap_file",
680
  action="store_true",
681
  dest="uc_subprocess",
682
  default=None,
683
+ help="""(DEPRECATED) - (UC Mode always uses this now.)
684
  Use undetectable-chromedriver as a subprocess,
685
  which can help avoid issues that might result.
686
  It may reduce UC's ability to avoid detection.""",
seleniumbase/utilities/selenium_grid/grid-node CHANGED
@@ -40,7 +40,7 @@ if [ "$GRID_NODE_VERBOSE_LOGS" == "True" ]; then
40
  fi
41
 
42
  WEBDRIVER_SERVER_JAR=${DIR}/selenium-server-standalone.jar
43
- WEBDRIVER_NODE_PARAMS="-role node -hub http://${GRID_HUB_SERVER_IP}:4444/grid/register -browser browserName=chrome,maxInstances=5,version=latest,seleniumProtocol=WebDriver -browser browserName=firefox,maxInstances=5,version=latest,seleniumProtocol=WebDriver -browser browserName=opera,maxInstances=5,version=latest,seleniumProtocol=WebDriver"
44
  WEBDRIVER_NODE_PIDFILE="/tmp/webdriver_node.pid"
45
 
46
  if [ ! -f $WEBDRIVER_SERVER_JAR ]; then
40
  fi
41
 
42
  WEBDRIVER_SERVER_JAR=${DIR}/selenium-server-standalone.jar
43
+ WEBDRIVER_NODE_PARAMS="-role node -hub http://${GRID_HUB_SERVER_IP}:4444/grid/register -browser browserName=chrome,maxInstances=5,version=latest,seleniumProtocol=WebDriver -browser browserName=firefox,maxInstances=5,version=latest,seleniumProtocol=WebDriver"
44
  WEBDRIVER_NODE_PIDFILE="/tmp/webdriver_node.pid"
45
 
46
  if [ ! -f $WEBDRIVER_SERVER_JAR ]; then
seleniumbase/utilities/selenium_grid/grid_node.py CHANGED
@@ -120,8 +120,6 @@ def main():
120
  """Name=chrome,maxInstances=5,version=latest,"""
121
  """seleniumProtocol=WebDriver -browser browserName=firefox,"""
122
  """maxInstances=5,version=latest,seleniumProtocol=WebDriver"""
123
- """ -browser browserName=opera,"""
124
- """maxInstances=5,version=latest,seleniumProtocol=WebDriver"""
125
  % (dir_path, server_ip)
126
  )
127
  print("\nStarting Selenium-WebDriver Grid node...\n")
120
  """Name=chrome,maxInstances=5,version=latest,"""
121
  """seleniumProtocol=WebDriver -browser browserName=firefox,"""
122
  """maxInstances=5,version=latest,seleniumProtocol=WebDriver"""
 
 
123
  % (dir_path, server_ip)
124
  )
125
  print("\nStarting Selenium-WebDriver Grid node...\n")
seleniumbase/utilities/selenium_grid/register-grid-node.bat CHANGED
@@ -1 +1 @@
1
- java -jar selenium-server-standalone.jar -role node -hub http://127.0.0.1:4444/grid/register -browser browserName=chrome,maxInstances=5,version=latest,seleniumProtocol=WebDriver -browser browserName=firefox,maxInstances=5,version=latest,seleniumProtocol=WebDriver -browser browserName=opera,maxInstances=5,version=latest,seleniumProtocol=WebDriver
1
+ java -jar selenium-server-standalone.jar -role node -hub http://127.0.0.1:4444/grid/register -browser browserName=chrome,maxInstances=5,version=latest,seleniumProtocol=WebDriver -browser browserName=firefox,maxInstances=5,version=latest,seleniumProtocol=WebDriver
seleniumbase/utilities/selenium_grid/register-grid-node.sh CHANGED
@@ -1,2 +1,2 @@
1
  #!/bin/bash
2
- java -jar selenium-server-standalone.jar -role node -hub http://127.0.0.1:4444/grid/register -browser browserName=chrome,maxInstances=5,version=latest,seleniumProtocol=WebDriver -browser browserName=firefox,maxInstances=5,version=latest,seleniumProtocol=WebDriver -browser browserName=opera,maxInstances=5,version=latest,seleniumProtocol=WebDriver
1
  #!/bin/bash
2
+ java -jar selenium-server-standalone.jar -role node -hub http://127.0.0.1:4444/grid/register -browser browserName=chrome,maxInstances=5,version=latest,seleniumProtocol=WebDriver -browser browserName=firefox,maxInstances=5,version=latest,seleniumProtocol=WebDriver

Readme

<!-- SeleniumBase Docs --><h1>SeleniumBase</h1><h3 align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/sb_logo_10t.png" alt="SeleniumBase" title="SeleniumBase" width="266" /></a></h3><h3 align="center">Create reliable end-to-end browser tests with Python</h3><p align="center"><a href="https://pypi.python.org/pypi/seleniumbase" target="_blank"><img src="https://img.shields.io/pypi/v/seleniumbase.svg?color=3399EE" alt="PyPI version" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/releases" target="_blank"><img src="https://img.shields.io/github/v/release/seleniumbase/SeleniumBase.svg?color=22AAEE" alt="GitHub version" /></a> <a href="https://seleniumbase.io"><img src="https://img.shields.io/badge/docs-seleniumbase.io-11BBAA.svg" alt="SeleniumBase Docs" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/actions" target="_blank"><img src="https://github.com/seleniumbase/SeleniumBase/workflows/CI%20build/badge.svg" alt="SeleniumBase GitHub Actions" /></a> <a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="SeleniumBase" /></a></p><p align="center"> <a href="#python_installation">πŸš€ Start</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md">🏰 Features</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">πŸ“š Examples</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md">πŸŽ›οΈ Options</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/console_scripts/ReadMe.md">🌠 Scripts</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/mobile_testing.md">πŸ“± Phone</a> <br /> <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md">πŸ“˜ APIs</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md"> πŸ”‘ Formats</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md">πŸ“Š Dashboard</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/recorder_mode.md">πŸ”΄ Recorder</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/locale_codes.md">πŸ—Ύ Locales</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md">🌐 Grid</a> <br /> <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/commander.md">πŸŽ–οΈ GUI</a> | <a href="https://seleniumbase.io/demo_page">πŸ“° TestPage</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/case_plans.md">πŸ—‚οΈ CasePlans</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/html_inspector.md">πŸ•΅οΈ Inspector</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md">🧬 Hybrid</a> | <a href="https://seleniumbase.io/devices/?url=seleniumbase.com">πŸ’» Farm</a> <br /> <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/how_it_works.md">πŸ‘οΈ How</a> | <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/migration/raw_selenium">🚝 Migrate</a> | <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/boilerplates">♻️ Templates</a> | <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js">πŸš‰ NodeGUI</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/chart_maker/ReadMe.md">πŸ“Ά Charts</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md">🚎 Tours</a> <br /> <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/github/workflows/ReadMe.md">πŸ€– CI/CD</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/js_package_manager.md">πŸ•ΉοΈ JSMgr</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/translations.md">🌏 Translator</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/presenter/ReadMe.md">🎞️ Presenter</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/dialog_boxes/ReadMe.md">πŸ›‚ Boxes</a> | <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/visual_testing/ReadMe.md">πŸ–ΌοΈ Visual</a> <br /> </p>

<a id="multiple_examples"></a>

<p align="left"><b>Example:</b> <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_coffee_cart.py" target="_blank">test_coffee_cart.py</a> from <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples" target="_blank">./examples/</a></p>
cd examples/
pytest test_coffee_cart.py --demo
<p>(<code>--demo</code> mode slows down tests and highlights actions)</p><p align="left"><a href="https://seleniumbase.io/coffee/" target="_blank"><img src="https://seleniumbase.github.io/cdn/gif/coffee_cart.gif" width="480" alt="SeleniumBase Coffee Cart Test" title="SeleniumBase Coffee Cart Test" /></a></p>
  • Here's a preview of that test:
from seleniumbase import BaseCase
BaseCase.main(__name__, __file__)

class CoffeeCartTest(BaseCase):
    def test_coffee_cart(self):
        self.open("https://seleniumbase.io/coffee/")
        self.assert_title("Coffee Cart")
        self.click('div[data-sb="Cappuccino"]')
        self.click('div[data-sb="Flat-White"]')
        self.click('div[data-sb="Cafe-Latte"]')
        self.click('a[aria-label="Cart page"]')
        self.assert_exact_text("Total: $53.00", "button.pay")
        self.click("button.pay")
        self.type("input#name", "Selenium Coffee")
        self.type("input#email", "test@test.test")
        self.click("button#submit-payment")
        self.assert_text("Thanks for your purchase.", "#app .success")

<details> <summary> ▢️ How is <b>SeleniumBase</b> different from raw Selenium? (<b>click to expand</b>)</summary> <div><p>πŸ’‘ SeleniumBase is a Python framework for browser automation and testing. SeleniumBase uses <a href="https://www.w3.org/TR/webdriver2/#endpoints" target="_blank">Selenium/WebDriver</a> APIs, and incorporates test-runners such as <code>pytest</code>, <code>nosetests</code>, and <code>behave</code> to provide organized structure, test discovery, test execution, test state (<i>eg. passed, failed, or skipped</i>), and command-line options for changing default settings (<i>such as choosing the browser to use</i>). With raw Selenium, you would need to set up your own options-parser for configuring tests from the command-line.</p><p>πŸ’‘ With raw Selenium, commands that use selectors need to specify the type of selector (eg. <code>"css selector", "button#myButton"</code>). With SeleniumBase, there's auto-detection between CSS Selectors and XPath, which means you don't need to specify the type of selector in your commands (<i>but optionally you could</i>).</p><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:<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><p>πŸ’‘ SeleniumBase gives you the option to generate a dashboard and reports for tests. It also saves screenshots from failing tests to the <code>./latest_logs/</code> folder. Raw <a href="https://www.selenium.dev/documentation/webdriver/" target="_blank">Selenium</a> does not have these options out-of-the-box.</p><p>πŸ’‘ SeleniumBase includes desktop GUI apps for running tests, such as <b>SeleniumBase Commander</b> for <code>pytest</code>, and <b>SeleniumBase Behave GUI.</b></p><p>πŸ’‘ SeleniumBase has its own Recorder & Test Generator that can create tests from manual browser actions. SeleniumBase also has many other useful tools and console scripts for getting things done quickly. (<i>See the documentation for more details!</i>)</p></div> </details>
<details> <summary> ▢️ Learn about different ways of writing tests (<b>click to expand</b>)</summary> <div><p align="left">πŸ“˜πŸ“ An example test with the <b>BaseCase</b> class. Runs with <b><a href="https://docs.pytest.org/en/latest/how-to/usage.html">pytest</a></b> or <b>nosetests</b>. (<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">Learn more</a>)</p>
from seleniumbase import BaseCase

class TestMFALogin(BaseCase):
    def test_mfa_login(self):
        self.open("https://seleniumbase.io/realworld/login")
        self.type("#username", "demo_user")
        self.type("#password", "secret_pass")
        self.enter_mfa_code("#totpcode", "GAXG2MTEOR3DMMDG")  # 6-digit
        self.assert_exact_text("Welcome!", "h1")
        self.assert_element("img#image1")
        self.click('a:contains("This Page")')
        self.save_screenshot_to_logs()
<p align="left">πŸ“—πŸ“ An example test with the <b><code>sb</code></b> <code>pytest</code> fixture. Runs with <b><a href="https://docs.pytest.org/en/latest/how-to/usage.html">pytest</a></b>.</p>
def test_mfa_login(sb):
    sb.open("https://seleniumbase.io/realworld/login")
    sb.type("#username", "demo_user")
    sb.type("#password", "secret_pass")
    sb.enter_mfa_code("#totpcode", "GAXG2MTEOR3DMMDG")  # 6-digit
    sb.assert_exact_text("Welcome!", "h1")
    sb.assert_element("img#image1")
    sb.click('a:contains("This Page")')
    sb.save_screenshot_to_logs()
<p align="left">πŸ“™πŸ“ An example test with the <b><code>SB</code></b> Context Manager. Runs with pure <b><code>python</code></b>.</p>
from seleniumbase import SB

with SB() as sb:  # By default, browser="chrome" if not set.
    sb.open("https://seleniumbase.io/realworld/login")
    sb.type("#username", "demo_user")
    sb.type("#password", "secret_pass")
    sb.enter_mfa_code("#totpcode", "GAXG2MTEOR3DMMDG")  # 6-digit
    sb.assert_text("Welcome!", "h1")
    sb.highlight("img#image1")  # A fancier assert_element() call
    sb.click('a:contains("This Page")')  # Use :contains() on any tag
    sb.click_link("Sign out")  # Link must be "a" tag. Not "button".
    sb.assert_element('a:contains("Sign in")')
    sb.assert_exact_text("You have been signed out!", "#top_message")
<p align="left">πŸ“•πŸ“ An example test with <b>behave-BDD</b> <a href="https://behave.readthedocs.io/en/stable/gherkin.html" target="_blank">Gherkin</a> structure. Runs with <b><code>behave</code></b>. (<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/behave_bdd/ReadMe.md">Learn more</a>)</p>
Feature: SeleniumBase scenarios for the RealWorld App

  Scenario: Verify RealWorld App
    Given Open "seleniumbase.io/realworld/login"
    When Type "demo_user" into "#username"
    And Type "secret_pass" into "#password"
    And Do MFA "GAXG2MTEOR3DMMDG" into "#totpcode"
    Then Assert exact text "Welcome!" in "h1"
    And Assert element "img#image1"
    And Click 'a:contains("This Page")'
    And Save screenshot to logs
</div> </details>

<a id="python_installation"></a>

<h2><img src="https://seleniumbase.github.io/cdn/img/python_logo.png" title="SeleniumBase" width="42" /> Set up Python & Git:</h2>

πŸ”΅ Add <b><a href="https://www.python.org/downloads/">Python</a></b> and <b><a href="https://git-scm.com/">Git</a></b> to your System PATH.

πŸ”΅ Using a <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/virtualenv_instructions.md">Python virtual env</a> is recommended.

<a id="install_seleniumbase"></a>

<h2><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Install SeleniumBase:</h2>

You can install seleniumbase from GitHub or PyPI:

πŸ”΅ Installing seleniumbase from a GitHub clone:

git clone https://github.com/seleniumbase/SeleniumBase.git
cd SeleniumBase/
pip install -e .

To upgrade an existing install from a GitHub clone:

git pull
pip install -e .

πŸ”΅ Installing seleniumbase from PyPI:

pip install seleniumbase
  • (Add --upgrade OR -U to upgrade SeleniumBase.)
  • (Add --force-reinstall to upgrade indirect libraries.)
  • (Use pip3 if multiple versions of Python are present.)

To upgrade an existing install from PyPI:

pip install -U seleniumbase

πŸ”΅ Type seleniumbase or sbase to verify that SeleniumBase was installed successfully:

   ______     __           _                  ____                
  / ____/__  / /__  ____  (_)_  ______ ___   / _  \____  ________ 
  \__ \/ _ \/ / _ \/ __ \/ / / / / __ `__ \ / /_) / __ \/ ___/ _ \
 ___/ /  __/ /  __/ / / / / /_/ / / / / / // /_) / (_/ /__  /  __/
/____/\___/_/\___/_/ /_/_/\__,_/_/ /_/ /_//_____/\__,_/____/\___/ 
------------------------------------------------------------------

 * USAGE: "seleniumbase [COMMAND] [PARAMETERS]"
 *    OR:        "sbase [COMMAND] [PARAMETERS]"

COMMANDS:
      get / install    [DRIVER] [OPTIONS]
      methods          (List common Python methods)
      options          (List common pytest options)
      behave-options   (List common behave options)
      gui / commander  [OPTIONAL PATH or TEST FILE]
      behave-gui       (SBase Commander for Behave)
      caseplans        [OPTIONAL PATH or TEST FILE]
      mkdir            [DIRECTORY] [OPTIONS]
      mkfile           [FILE.py] [OPTIONS]
      mkrec / codegen  [FILE.py] [OPTIONS]
      recorder         (Open Recorder Desktop App.)
      record           (If args: mkrec. Else: App.)
      mkpres           [FILE.py] [LANG]
      mkchart          [FILE.py] [LANG]
      print            [FILE] [OPTIONS]
      translate        [SB_FILE.py] [LANG] [ACTION]
      convert          [WEBDRIVER_UNITTEST_FILE.py]
      extract-objects  [SB_FILE.py]
      inject-objects   [SB_FILE.py] [OPTIONS]
      objectify        [SB_FILE.py] [OPTIONS]
      revert-objects   [SB_FILE.py] [OPTIONS]
      encrypt / obfuscate
      decrypt / unobfuscate
      download server  (Get Selenium Grid JAR file)
      grid-hub         [start|stop] [OPTIONS]
      grid-node        [start|stop] --hub=[HOST/IP]
 * (EXAMPLE: "sbase get chromedriver latest") *

    Type "sbase help [COMMAND]" for specific command info.
    For info on all commands, type: "seleniumbase --help".
    Use "pytest" for running tests.
<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Downloading web drivers:</h3>

βœ… SeleniumBase automatically downloads web drivers as needed, such as chromedriver, edgedriver, and geckodriver.

βœ… To manually download a webdriver, see Console Scripts OR Webdriver Installation.

<a id="basic_example_and_usage"></a>

<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Basic Example & Usage:</h3>

πŸ”΅ If you've cloned SeleniumBase, you can run tests from the examples/ folder.

<p align="left">Here's <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py">my_first_test.py</a>:</p>
cd examples/
pytest my_first_test.py

(Uses --chrome by default.)

<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py"><img src="https://seleniumbase.github.io/cdn/gif/swag_labs_4.gif" alt="SeleniumBase Test" title="SeleniumBase Test" width="480" /></a>

<p align="left"><b>Here's the code for <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py">my_first_test.py</a>:</b></p>
from seleniumbase import BaseCase

class MyTestClass(BaseCase):
    def test_swag_labs(self):
        self.open("https://www.saucedemo.com")
        self.type("#user-name", "standard_user")
        self.type("#password", "secret_sauce\n")
        self.assert_element("div.inventory_list")
        self.assert_text("PRODUCTS", "span.title")
        self.click('button[name*="backpack"]')
        self.click("#shopping_cart_container a")
        self.assert_text("YOUR CART", "span.title")
        self.assert_text("Backpack", "div.cart_item")
        self.click("button#checkout")
        self.type("#first-name", "SeleniumBase")
        self.type("#last-name", "Automation")
        self.type("#postal-code", "77123")
        self.click("input#continue")
        self.assert_text("CHECKOUT: OVERVIEW")
        self.assert_text("Backpack", "div.cart_item")
        self.click("button#finish")
        self.assert_exact_text("THANK YOU FOR YOUR ORDER", "h2")
        self.assert_element('img[alt="Pony Express"]')
        self.js_click("a#logout_sidebar_link")
        self.assert_element("div#login_button_container")

<a id="common_methods"></a>

<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Here are some common SeleniumBase methods that you might find in tests:</h3>
self.open(url)  # Navigate the browser window to the URL.
self.type(selector, text)  # Update the field with the text.
self.click(selector)  # Click the element with the selector.
self.click_link(link_text)  # Click the link containing text.
self.go_back()  # Navigate back to the previous URL.
self.select_option_by_text(dropdown_selector, option)
self.hover_and_click(hover_selector, click_selector)
self.drag_and_drop(drag_selector, drop_selector)
self.get_text(selector)  # Get the text from the element.
self.get_current_url()  # Get the URL of the current page.
self.get_page_source()  # Get the HTML of the current page.
self.get_attribute(selector, attribute)  # Get element attribute.
self.get_title()  # Get the title of the current page.
self.switch_to_frame(frame)  # Switch into the iframe container.
self.switch_to_default_content()  # Leave the iframe container.
self.open_new_window()  # Open a new window in the same browser.
self.switch_to_window(window)  # Switch to the browser window.
self.switch_to_default_window()  # Switch to the original window.
self.get_new_driver(OPTIONS)  # Open a new driver with OPTIONS.
self.switch_to_driver(driver)  # Switch to the browser driver.
self.switch_to_default_driver()  # Switch to the original driver.
self.wait_for_element(selector)  # Wait until element is visible.
self.is_element_visible(selector)  # Return element visibility.
self.is_text_visible(text, selector)  # Return text visibility.
self.sleep(seconds)  # Do nothing for the given amount of time.
self.save_screenshot(name)  # Save a screenshot in .png format.
self.assert_element(selector)  # Verify the element is visible.
self.assert_text(text, selector)  # Verify text in the element.
self.assert_title(title)  # Verify the title of the web page.
self.assert_downloaded_file(file)  # Verify file was downloaded.
self.assert_no_404_errors()  # Verify there are no broken links.
self.assert_no_js_errors()  # Verify there are no JS errors.

πŸ”΅ For the complete list of SeleniumBase methods, see: <b><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md">Method Summary</a></b>

<a id="fun_facts"></a>

<h2><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Fun Facts / Learn More:</h2><p>βœ… SeleniumBase automatically handles common <a href="https://www.selenium.dev/documentation/webdriver/" target="_blank">WebDriver</a> actions such as launching web browsers before tests, saving screenshots during failures, and closing web browsers after tests.</p><p>βœ… SeleniumBase lets you <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md">customize test runs from the command-line</a>.</p><p>βœ… SeleniumBase uses simple syntax for commands. Example:</p>
self.type("input", "dogs\n")

SeleniumBase tests can be run with <code>pytest</code> or <code>nosetests</code>. (There's also a <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/behave_bdd/ReadMe.md">behave BDD</a> format.)

pytest my_first_test.py --chrome

nosetests test_suite.py --firefox
<p>βœ… <code>pytest</code> includes automatic test discovery. If you don't specify a specific file or folder to run, <code>pytest</code> will automatically search through all subdirectories for tests to run based on the following criteria:</p>
  • Python files that start with test_ or end with _test.py.
  • Python methods that start with test_.

With a SeleniumBase pytest.ini file present, you can modify default discovery settings. The Python class name can be anything because seleniumbase.BaseCase inherits unittest.TestCase, which triggers autodiscovery.

<p>βœ… You can do a pre-flight check to see which tests would get discovered by <code>pytest</code> before the real flight:</p>
pytest --collect-only -q
<p>βœ… You can be more specific when calling <code>pytest</code> on a file:</p>
pytest [FILE_NAME.py]::[CLASS_NAME]::[METHOD_NAME]

nosetests [FILE_NAME.py]:[CLASS_NAME].[METHOD_NAME]
<p>βœ… No More Flaky Tests! SeleniumBase methods automatically wait for page elements to finish loading before interacting with them (<i>up to a timeout limit</i>). This means <b>you no longer need random <span><code>time.sleep()</code></span> statements</b> in your scripts.</p> <img src="https://img.shields.io/badge/Flaky%20Tests%3F-%20NO%21-11BBDD.svg" alt="NO MORE FLAKY TESTS!" />

βœ… SeleniumBase supports all major browsers and operating systems:

<p><b>Browsers:</b> Chrome, Edge, Firefox, and Safari.</p> <p><b>Systems: </b>Linux/Ubuntu, macOS, and Windows.</p>

βœ… SeleniumBase works on all popular CI/CD platforms:

<p><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/github/workflows/ReadMe.md"><img alt="GitHub Actions integration" src="https://img.shields.io/badge/GitHub_Actions-12B2C2.svg?logo=GitHubActions&logoColor=CFFFC2" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/azure/jenkins/ReadMe.md"><img alt="Jenkins integration" src="https://img.shields.io/badge/Jenkins-32B242.svg?logo=jenkins&logoColor=white" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/azure/azure_pipelines/ReadMe.md"><img alt="Azure integration" src="https://img.shields.io/badge/Azure-2288EE.svg?logo=AzurePipelines&logoColor=white" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/google_cloud/ReadMe.md"><img alt="Google Cloud integration" src="https://img.shields.io/badge/Google_Cloud-11CAE8.svg?logo=GoogleCloud&logoColor=EE0066" /></a> <a href="#utilizing_advanced_features"><img alt="AWS integration" src="https://img.shields.io/badge/AWS-4488DD.svg?logo=AmazonAWS&logoColor=FFFF44" /></a> <a href="https://en.wikipedia.org/wiki/Personal_computer" target="_blank"><img alt="Your Computer" src="https://img.shields.io/badge/πŸ’»_Your_Computer-44E6E6.svg" /></a></p><p>βœ… SeleniumBase includes an automated/manual hybrid solution called <b><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md">MasterQA</a></b>, which speeds up manual testing by having automation perform all the browser actions while the manual tester handles validation.</p><p>βœ… For a full list of SeleniumBase features, <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/features_list.md">Click Here</a>.</p>

<a id="detailed_instructions"></a>

<h2><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Detailed Instructions:</h2>

<a id="seleniumbase_demo_mode"></a> πŸ”΅ <b>Demo Mode</b> helps you see what a test is doing. If a test is moving too fast for your eyes, run it in <b>Demo Mode</b>, which pauses the browser briefly between actions, highlights page elements being acted on, and displays assertions:

pytest my_first_test.py --demo

πŸ”΅ You can use the following calls in your scripts to help you debug issues:

import time; time.sleep(5)  # Makes the test wait and do nothing for 5 seconds.
import pdb; pdb.set_trace()  # Enter debugging mode. n = next, c = continue, s = step.
import pytest; pytest.set_trace()  # Enter debugging mode. n = next, c = continue, s = step.

πŸ”΅ To pause an active test that throws an exception or error, (and keep the browser window open while Debug Mode begins in the console), add --pdb as a pytest option:

pytest my_first_test.py --pdb

(pdb console commands: n, c, s => next, continue, step).

<a id="pytest_options"></a> πŸ”΅ Here are some useful command-line options that come with <code>pytest</code>:

-v  # Verbose mode. Prints the full name of each test and shows more details.
-q  # Quiet mode. Print fewer details in the console output when running tests.
-x  # Stop running the tests after the first failure is reached.
--html=report.html  # Creates a detailed pytest-html report after tests finish.
--collect-only | --co  # Show what tests would get run. (Without running them)
-n=NUM  # Multithread the tests using that many threads. (Speed up test runs!)
-s  # See print statements. (Should be on by default with pytest.ini present.)
--junit-xml=report.xml  # Creates a junit-xml report after tests finish.
--pdb  # If a test fails, enter Post Mortem Debug Mode. (Don't use with CI!)
--trace  # Enter Debug Mode at the beginning of each test. (Don't use with CI!)
-m=MARKER  # Run tests with the specified pytest marker.

<a id="new_pytest_options"></a> πŸ”΅ SeleniumBase provides additional <code>pytest</code> command-line options for tests:

--browser=BROWSER  # (The web browser to use. Default: "chrome".)
--chrome  # (Shortcut for "--browser=chrome". On by default.)
--edge  # (Shortcut for "--browser=edge".)
--firefox  # (Shortcut for "--browser=firefox".)
--safari  # (Shortcut for "--browser=safari".)
--cap-file=FILE  # (The web browser's desired capabilities to use.)
--cap-string=STRING  # (The web browser's desired capabilities to use.)
--settings-file=FILE  # (Override default SeleniumBase settings.)
--env=ENV  # (Set the test env. Access with "self.env" in tests.)
--account=STR  # (Set account. Access with "self.account" in tests.)
--data=STRING  # (Extra test data. Access with "self.data" in tests.)
--var1=STRING  # (Extra test data. Access with "self.var1" in tests.)
--var2=STRING  # (Extra test data. Access with "self.var2" in tests.)
--var3=STRING  # (Extra test data. Access with "self.var3" in tests.)
--variables=DICT  # (Extra test data. Access with "self.variables".)
--user-data-dir=DIR  # (Set the Chrome user data directory to use.)
--protocol=PROTOCOL  # (The Selenium Grid protocol: http|https.)
--server=SERVER  # (The Selenium Grid server/IP used for tests.)
--port=PORT  # (The Selenium Grid port used by the test server.)
--proxy=SERVER:PORT  # (Connect to a proxy server:port for tests.)
--proxy=USERNAME:PASSWORD@SERVER:PORT  # (Use authenticated proxy server.)
--proxy-bypass-list=STRING  # (";"-separated hosts to bypass, Eg "*.foo.com")
--proxy-pac-url=URL  # (Connect to a proxy server using a PAC_URL.pac file.)
--proxy-pac-url=USERNAME:PASSWORD@URL  # (Authenticated proxy with PAC URL.)
--agent=STRING  # (Modify the web browser's User-Agent string.)
--mobile  # (Use the mobile device emulator while running tests.)
--metrics=STRING  # (Set mobile metrics: "CSSWidth,CSSHeight,PixelRatio".)
--chromium-arg="ARG=N,ARG2"  # (Set Chromium args, ","-separated, no spaces.)
--firefox-arg="ARG=N,ARG2"  # (Set Firefox args, comma-separated, no spaces.)
--firefox-pref=SET  # (Set a Firefox preference:value set, comma-separated.)
--extension-zip=ZIP  # (Load a Chrome Extension .zip|.crx, comma-separated.)
--extension-dir=DIR  # (Load a Chrome Extension directory, comma-separated.)
--binary-location=PATH  # (Set path of the Chromium browser binary to use.)
--sjw  # (Skip JS Waits for readyState to be "complete" or Angular to load.)
--pls=PLS  # (Set pageLoadStrategy on Chrome: "normal", "eager", or "none".)
--headless  # (Run tests in headless mode. The default arg on Linux OS.)
--headless2  # (Use the new headless mode, which supports extensions.)
--headed  # (Run tests in headed/GUI mode on Linux OS, where not default.)
--xvfb  # (Run tests using the Xvfb virtual display server on Linux OS.)
--locale=LOCALE_CODE  # (Set the Language Locale Code for the web browser.)
--interval=SECONDS  # (The autoplay interval for presentations & tour steps)
--start-page=URL  # (The starting URL for the web browser when tests begin.)
--archive-logs  # (Archive existing log files instead of deleting them.)
--archive-downloads  # (Archive old downloads instead of deleting them.)
--time-limit=SECONDS  # (Safely fail any test that exceeds the time limit.)
--slow  # (Slow down the automation. Faster than using Demo Mode.)
--demo  # (Slow down and visually see test actions as they occur.)
--demo-sleep=SECONDS  # (Set the wait time after Slow & Demo Mode actions.)
--highlights=NUM  # (Number of highlight animations for Demo Mode actions.)
--message-duration=SECONDS  # (The time length for Messenger alerts.)
--check-js  # (Check for JavaScript errors after page loads.)
--ad-block  # (Block some types of display ads from loading.)
--block-images  # (Block images from loading during tests.)
--do-not-track  # (Indicate to websites that you don't want to be tracked.)
--verify-delay=SECONDS  # (The delay before MasterQA verification checks.)
--recorder  # (Enables the Recorder for turning browser actions into code.)
--rec-behave  # (Same as Recorder Mode, but also generates behave-gherkin.)
--rec-sleep  # (If the Recorder is enabled, also records self.sleep calls.)
--rec-print  # (If the Recorder is enabled, prints output after tests end.)
--disable-js  # (Disable JavaScript on websites. Pages might break!)
--disable-csp  # (Disable the Content Security Policy of websites.)
--disable-ws  # (Disable Web Security on Chromium-based browsers.)
--enable-ws  # (Enable Web Security on Chromium-based browsers.)
--enable-sync  # (Enable "Chrome Sync" on websites.)
--uc | --undetected  # (Use undetected-chromedriver to evade bot-detection.)
--uc-cdp-events  # (Capture CDP events when running in "--undetected" mode.)
--remote-debug  # (Sync to Chrome Remote Debugger chrome://inspect/#devices)
--final-debug  # (Enter Debug Mode after each test ends. Don't use with CI!)
--dashboard  # (Enable the SeleniumBase Dashboard. Saved at: dashboard.html)
--dash-title=STRING  # (Set the title shown for the generated dashboard.)
--swiftshader  # (Use Chrome's "--use-gl=swiftshader" feature.)
--incognito  # (Enable Chrome's Incognito mode.)
--guest  # (Enable Chrome's Guest mode.)
--devtools  # (Open Chrome's DevTools when the browser opens.)
--reuse-session | --rs  # (Reuse browser session for all tests.)
--reuse-class-session | --rcs  # (Reuse session for tests in class.)
--crumbs  # (Delete all cookies between tests reusing a session.)
--disable-beforeunload  # (Disable the "beforeunload" event on Chrome.)
--window-size=WIDTH,HEIGHT  # (Set the browser's starting window size.)
--maximize  # (Start tests with the browser window maximized.)
--screenshot  # (Save a screenshot at the end of each test.)
--no-screenshot  # (No screenshots saved unless tests directly ask it.)
--visual-baseline  # (Set the visual baseline for Visual/Layout tests.)
--wire  # (Use selenium-wire's webdriver for replacing selenium webdriver.)
--external-pdf  # (Set Chromium "plugins.always_open_pdf_externally":True.)
--timeout-multiplier=MULTIPLIER  # (Multiplies the default timeout values.)
--list-fail-page  # (After each failing test, list the URL of the failure.)

(See the full list of command-line option definitions here. For detailed examples of command-line options, see customizing_test_runs.md)

πŸ”΅ During test failures, logs and screenshots from the most recent test run will get saved to the latest_logs/ folder. Those logs will get moved to archived_logs/ if you add --archive_logs to command-line options, or have ARCHIVE_EXISTING_LOGS set to True in settings.py, otherwise log files with be cleaned up at the start of the next test run. The test_suite.py collection contains tests that fail on purpose so that you can see how logging works.

cd examples/

pytest test_suite.py --browser=chrome

pytest test_suite.py --browser=firefox

An easy way to override seleniumbase/config/settings.py is by using a custom settings file. Here's the command-line option to add to tests: (See examples/custom_settings.py) --settings_file=custom_settings.py (Settings include default timeout values, a two-factor auth key, DB credentials, S3 credentials, and other important settings used by tests.)

πŸ”΅ To pass additional data from the command-line to tests, add --data="ANY STRING". Inside your tests, you can use self.data to access that.

<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Test Directory Configuration:</h3>

πŸ”΅ When running tests with pytest, you'll want a copy of pytest.ini in your root folders. When running tests with nosetests, you'll want a copy of setup.cfg in your root folders. These files specify default configuration details for tests. Folders should also include a blank __init__.py file, which allows your tests to import files from that folder.

πŸ”΅ sbase mkdir DIR creates a folder with config files and sample tests:

sbase mkdir ui_tests

That new folder will have these files:

ui_tests/
β”œβ”€β”€ __init__.py
β”œβ”€β”€ my_first_test.py
β”œβ”€β”€ parameterized_test.py
β”œβ”€β”€ pytest.ini
β”œβ”€β”€ requirements.txt
β”œβ”€β”€ setup.cfg
β”œβ”€β”€ test_demo_site.py
└── boilerplates/
    β”œβ”€β”€ __init__.py
    β”œβ”€β”€ base_test_case.py
    β”œβ”€β”€ boilerplate_test.py
    β”œβ”€β”€ classic_obj_test.py
    β”œβ”€β”€ page_objects.py
    β”œβ”€β”€ sb_fixture_test.py
    └── samples/
        β”œβ”€β”€ __init__.py
        β”œβ”€β”€ google_objects.py
        β”œβ”€β”€ google_test.py
        β”œβ”€β”€ sb_swag_test.py
        └── swag_labs_test.py

<b>ProTipβ„’:</b> You can also create a boilerplate folder without any sample tests in it by adding -b or --basic to the sbase mkdir command:

sbase mkdir ui_tests --basic

That new folder will have these files:

ui_tests/
β”œβ”€β”€ __init__.py
β”œβ”€β”€ pytest.ini
β”œβ”€β”€ requirements.txt
└── setup.cfg

Of those files, the pytest.ini config file is the most important, followed by a blank __init__.py file. There's also a setup.cfg file (only needed for nosetests). Finally, the requirements.txt file can be used to help you install seleniumbase into your environments (if it's not already installed).


<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Log files from failed tests:</h3>

Let's try an example of a test that fails:

""" test_fail.py """
from seleniumbase import BaseCase

class MyTestClass(BaseCase):

    def test_find_army_of_robots_on_xkcd_desert_island(self):
        self.open("https://xkcd.com/731/")
        self.assert_element("div#ARMY_OF_ROBOTS", timeout=1)  # This should fail

You can run it from the examples/ folder like this:

pytest test_fail.py

πŸ”΅ You'll notice that a logs folder, "latest_logs", was created to hold information about the failing test, and screenshots. During test runs, past results get moved to the archived_logs folder if you have ARCHIVE_EXISTING_LOGS set to True in settings.py, or if your run tests with --archive-logs. If you choose not to archive existing logs, they will be deleted and replaced by the logs of the latest test run.


<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> The SeleniumBase Dashboard:</h3>

πŸ”΅ The --dashboard option for pytest generates a SeleniumBase Dashboard located at dashboard.html, which updates automatically as tests run and produce results. Example:

pytest --dashboard --rs --headless
<img src="https://seleniumbase.github.io/cdn/img/dashboard_1.png" alt="The SeleniumBase Dashboard" title="The SeleniumBase Dashboard" width="380" />

πŸ”΅ Additionally, you can host your own SeleniumBase Dashboard Server on a port of your choice. Here's an example of that using Python 3's http.server:

python -m http.server 1948

πŸ”΅ Now you can navigate to http://localhost:1948/dashboard.html in order to view the dashboard as a web app. This requires two different terminal windows: one for running the server, and another for running the tests, which should be run from the same directory. (Use CTRL+C to stop the http server.)

πŸ”΅ Here's a full example of what the SeleniumBase Dashboard may look like:

pytest test_suite.py --dashboard --rs --headless
<img src="https://seleniumbase.github.io/cdn/img/dashboard_2.png" alt="The SeleniumBase Dashboard" title="The SeleniumBase Dashboard" width="480" />

<a id="creating_visual_reports"></a>

<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Generating Test Reports:</h3><h4><b>Pytest Reports:</b></h4>

πŸ”΅ Using --html=report.html gives you a fancy report of the name specified after your test suite completes.

pytest test_suite.py --html=report.html
<img src="https://seleniumbase.github.io/cdn/img/html_report.png" alt="Example Pytest Report" title="Example Pytest Report" width="520" />

πŸ”΅ When combining pytest html reports with SeleniumBase Dashboard usage, the pie chart from the Dashboard will get added to the html report. Additionally, if you set the html report URL to be the same as the Dashboard URL when also using the dashboard, (example: --dashboard --html=dashboard.html), then the Dashboard will become an advanced html report when all the tests complete.

πŸ”΅ Here's an example of an upgraded html report:

pytest test_suite.py --dashboard --html=report.html
<img src="https://seleniumbase.github.io/cdn/img/dash_report.jpg" alt="Dashboard Pytest HTML Report" title="Dashboard Pytest HTML Report" width="520" />

If viewing pytest html reports in Jenkins, you may need to configure Jenkins settings for the html to render correctly. This is due to Jenkins CSP changes.

You can also use --junit-xml=report.xml to get an xml report instead. Jenkins can use this file to display better reporting for your tests.

pytest test_suite.py --junit-xml=report.xml
<h4><b>Nosetest Reports:</b></h4>

The --report option gives you a fancy report after your test suite completes.

nosetests test_suite.py --report
<img src="https://seleniumbase.github.io/cdn/img/nose_report.png" alt="Example Nosetest Report" title="Example Nosetest Report" width="320" />

(NOTE: You can add --show-report to immediately display Nosetest reports after the test suite completes. Only use --show-report when running tests locally because it pauses the test run.)

<h4><b>Behave Dashboard & Reports:</b></h4>

(The behave_bdd/ folder can be found in the examples/ folder.)

behave behave_bdd/features/ -D dashboard -D headless
<img src="https://seleniumbase.github.io/cdn/img/sb_behave_dashboard.png" title="SeleniumBase" width="500">

You can also use --junit to get .xml reports for each Behave feature. Jenkins can use these files to display better reporting for your tests.

behave behave_bdd/features/ --junit -D rs -D headless
<h4><b>Allure Reports:</b></h4>

See: https://docs.qameta.io/allure/

SeleniumBase no longer includes allure-pytest as part of installed dependencies. If you want to use it, install it first:

pip install allure-pytest

Now your tests can create Allure results files, which can be processed by Allure Reports.

pytest test_suite.py --alluredir=allure_results
<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Using a Proxy Server:</h3>

If you wish to use a proxy server for your browser tests (Chromium or Firefox), you can add --proxy=IP_ADDRESS:PORT as an argument on the command line.

pytest proxy_test.py --proxy=IP_ADDRESS:PORT

If the proxy server that you wish to use requires authentication, you can do the following (Chromium only):

pytest proxy_test.py --proxy=USERNAME:PASSWORD@IP_ADDRESS:PORT

SeleniumBase also supports SOCKS4 and SOCKS5 proxies:

pytest proxy_test.py --proxy="socks4://IP_ADDRESS:PORT"

pytest proxy_test.py --proxy="socks5://IP_ADDRESS:PORT"

To make things easier, you can add your frequently-used proxies to PROXY_LIST in proxy_list.py, and then use --proxy=KEY_FROM_PROXY_LIST to use the IP_ADDRESS:PORT of that key.

pytest proxy_test.py --proxy=proxy1
<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Changing the User-Agent:</h3>

πŸ”΅ If you wish to change the User-Agent for your browser tests (Chromium and Firefox only), you can add --agent="USER AGENT STRING" as an argument on the command-line.

pytest user_agent_test.py --agent="Mozilla/5.0 (Nintendo 3DS; U; ; en) Version/1.7412.EU"
<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Handling Pop-Up / Pop Up Alerts:</h3>

πŸ”΅ <code>self.accept_alert()</code> automatically waits for and accepts alert pop-ups. <code>self.dismiss_alert()</code> automatically waits for and dismisses alert pop-ups. On occasion, some methods like <code>self.click(SELECTOR)</code> might dismiss a pop-up on its own because they call JavaScript to make sure that the <code>readyState</code> of the page is <code>complete</code> before advancing. If you're trying to accept a pop-up that got dismissed this way, use this workaround: Call <code>self.find_element(SELECTOR).click()</code> instead, (which will let the pop-up remain on the screen), and then use <code>self.accept_alert()</code> to accept the pop-up (<a href="https://github.com/seleniumbase/SeleniumBase/issues/600#issuecomment-647270426">more on that here</a>). If pop-ups are intermittent, wrap code in a try/except block.

<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Building Guided Tours for Websites:</h3>

πŸ”΅ Learn about <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/tour_examples/ReadMe.md">SeleniumBase Interactive Walkthroughs</a> (in the examples/tour_examples/ folder). It's great for prototyping a website onboarding experience.

<a id="utilizing_advanced_features"></a>


<div></div> <h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Production Environments & Integrations:</h3><div></div> <details> <summary> ▢️ Here are some things you can do to set up a production environment for your testing. (<b>click to expand</b>)</summary><ul> <li>You can set up a <a href="https://jenkins.io/" target="_blank">Jenkins</a> build server for running tests at regular intervals. For a real-world Jenkins example of headless browser automation in action, check out the <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/azure/jenkins/ReadMe.md">SeleniumBase Jenkins example on Azure</a> or the <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/google_cloud/ReadMe.md">SeleniumBase Jenkins example on Google Cloud</a>.</li><li>You can use <a href="https://selenium.dev/documentation/en/grid/" target="_blank">the Selenium Grid</a> to scale your testing by distributing tests on several machines with parallel execution. To do this, check out the <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/utilities/selenium_grid">SeleniumBase selenium_grid folder</a>, which should have everything you need, including the <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md">Selenium Grid ReadMe</a>, which will help you get started.</li><li>If you're using the <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/mysql_installation.md">SeleniumBase MySQL feature</a> to save results from tests running on a server machine, you can install <a href="https://dev.mysql.com/downloads/tools/workbench/">MySQL Workbench</a> to help you read & write from your DB more easily.</li><li>If you're using AWS, you can set up an <a href="https://aws.amazon.com/s3/" target="_blank">Amazon S3</a> account for saving log files and screenshots from your tests. To activate this feature, modify <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py">settings.py</a> with connection details in the S3 section, and add <code>--with-s3-logging</code> on the command-line when running your tests.</li> </ul>

Here's an example of running tests with some additional features enabled:

pytest [YOUR_TEST_FILE.py] --with-db-reporting --with-s3-logging
</details>

<a id="detailed_method_specifications"></a>

<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Detailed Method Specifications and Examples:</h3>

πŸ”΅ Navigating to a web page: (and related commands)

self.open("https://xkcd.com/378/")  # This method opens the specified page.

self.go_back()  # This method navigates the browser to the previous page.

self.go_forward()  # This method navigates the browser forward in history.

self.refresh_page()  # This method reloads the current page.

self.get_current_url()  # This method returns the current page URL.

self.get_page_source()  # This method returns the current page source.

<b>ProTipβ„’:</b> You can use the <code>self.get_page_source()</code> method with Python's <code>find()</code> command to parse through HTML to find something specific. (For more advanced parsing, see the <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_parse_soup.py">BeautifulSoup example</a>.)

source = self.get_page_source()
head_open_tag = source.find('<head>')
head_close_tag = source.find('</head>', head_open_tag)
everything_inside_head = source[head_open_tag+len('<head>'):head_close_tag]

πŸ”΅ Clicking:

To click an element on the page:

self.click("div#my_id")

ProTipβ„’: In most web browsers, you can right-click on a page and select Inspect Element to see the CSS selector details that you'll need to create your own scripts.

πŸ”΅ Typing Text:

<code>self.type(selector, text)</code> # updates the text from the specified element with the specified value. An exception is raised if the element is missing or if the text field is not editable. Example:

self.type("input#id_value", "2012")

You can also use <code>self.add_text()</code> or the <a href="https://www.selenium.dev/documentation/webdriver/" target="_blank">WebDriver</a> <code>.send_keys()</code> command, but those won't clear the text box first if there's already text inside.

πŸ”΅ Getting the text from an element on a page:

text = self.get_text("header h2")

πŸ”΅ Getting the attribute value from an element on a page:

attribute = self.get_attribute("#comic img", "title")

πŸ”΅ Asserting existence of an element on a page within some number of seconds:

self.wait_for_element_present("div.my_class", timeout=10)

(NOTE: You can also use: self.assert_element_present(ELEMENT))

πŸ”΅ Asserting visibility of an element on a page within some number of seconds:

self.wait_for_element_visible("a.my_class", timeout=5)

(NOTE: The short versions of that are self.find_element(ELEMENT) and self.assert_element(ELEMENT). The find_element() version returns the element.)

Since the line above returns the element, you can combine that with .click() as shown below:

self.find_element("a.my_class", timeout=5).click()

# But you're better off using the following statement, which does the same thing:

self.click("a.my_class")  # DO IT THIS WAY!

ProTipβ„’: You can use dots to signify class names (Ex: div.class_name) as a simplified version of div[class="class_name"] within a CSS selector.

You can also use *= to search for any partial value in a CSS selector as shown below:

self.click('a[name*="partial_name"]')

πŸ”΅ Asserting visibility of text inside an element on a page within some number of seconds:

self.assert_text("Make it so!", "div#trek div.picard div.quotes")
self.assert_text("Tea. Earl Grey. Hot.", "div#trek div.picard div.quotes", timeout=3)

(NOTE: self.find_text(TEXT, ELEMENT) and self.wait_for_text(TEXT, ELEMENT) also do this. For backwards compatibility, older method names were kept, but the default timeout may be different.)

πŸ”΅ Asserting Anything:

self.assert_true(var1 == var2)

self.assert_false(var1 == var2)

self.assert_equal(var1, var2)

πŸ”΅ Useful Conditional Statements: (with creative examples)

❓ is_element_visible(selector): (visible on the page)

if self.is_element_visible('div#warning'):
    print("Red Alert: Something bad might be happening!")

❓ is_element_present(selector): (present in the HTML)

if self.is_element_present('div#top_secret img.tracking_cookie'):
    self.contact_cookie_monster()  # Not a real SeleniumBase method
else:
    current_url = self.get_current_url()
    self.contact_the_nsa(url=current_url, message="Dark Zone Found")  # Not a real SeleniumBase method
def is_there_a_cloaked_klingon_ship_on_this_page():
    if self.is_element_present("div.ships div.klingon"):
        return not self.is_element_visible("div.ships div.klingon")
    return False

❓ is_text_visible(text, selector): (text visible on element)

if self.is_text_visible("You Shall Not Pass!", "h1"):
    self.open("https://www.youtube.com/watch?v=3xYXUeSmb-Y")
<div></div> <details> <summary> ▢️ Click for a longer example of <code>is_text_visible():</code></summary>
def get_mirror_universe_captain_picard_superbowl_ad(superbowl_year):
    selector = "div.superbowl_%s div.commercials div.transcript div.picard" % superbowl_year
    if self.is_text_visible("Yes, it was I who summoned you all here.", selector):
        return "Picard Paramount+ Superbowl Ad 2020"
    elif self.is_text_visible("Commander, signal the following: Our Network is Secure!"):
        return "Picard Mirror Universe iboss Superbowl Ad 2018"
    elif self.is_text_visible("For the Love of Marketing and Earl Grey Tea!", selector):
        return "Picard Mirror Universe HubSpot Superbowl Ad 2015"
    elif self.is_text_visible("Delivery Drones... Engage", selector):
        return "Picard Mirror Universe Amazon Superbowl Ad 2015"
    elif self.is_text_visible("Bing it on Screen!", selector):
        return "Picard Mirror Universe Microsoft Superbowl Ad 2015"
    elif self.is_text_visible("OK Glass, Make it So!", selector):
        return "Picard Mirror Universe Google Superbowl Ad 2015"
    elif self.is_text_visible("Number One, I've Never Seen Anything Like It.", selector):
        return "Picard Mirror Universe Tesla Superbowl Ad 2015"
    elif self.is_text_visible("Let us make sure history never forgets the name ... Facebook", selector):
        return "Picard Mirror Universe Facebook Superbowl Ad 2015"
    elif self.is_text_visible("""With the first link, the chain is forged.
                              The first speech censored, the first thought forbidden,
                              the first freedom denied, chains us all irrevocably.""", selector):
        return "Picard Mirror Universe Wikimedia Superbowl Ad 2015"
    else:
        raise Exception("Reports of my assimilation are greatly exaggerated.")
</details>

❓ is_link_text_visible(link_text):

if self.is_link_text_visible("Stop! Hammer time!"):
    self.click_link("Stop! Hammer time!")

πŸ”΅ Switching Tabs:

<p>If your test opens up a new tab/window, you can switch to it. (SeleniumBase automatically switches to new tabs that don't open to <code>about:blank</code> URLs.)</p>
self.switch_to_window(1)  # This switches to the new tab (0 is the first one)

πŸ”΅ <b>ProTipβ„’:</b> iframes follow the same principle as new windows - you need to specify the iframe if you want to take action on something in there

self.switch_to_frame('ContentManagerTextBody_ifr')
# Now you can act inside the iframe
# .... Do something cool (here)
self.switch_to_default_content()  # Exit the iframe when you're done

πŸ”΅ Executing Custom jQuery Scripts:

<p>jQuery is a powerful JavaScript library that allows you to perform advanced actions in a web browser. If the web page you're on already has jQuery loaded, you can start executing jQuery scripts immediately. You'd know this because the web page would contain something like the following in the HTML:</p>
<script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.3/jquery.min.js"></script>

πŸ”΅ It's OK if you want to use jQuery on a page that doesn't have it loaded yet. To do so, run the following command first:

self.activate_jquery()
<div></div> <details> <summary> ▢️ Here are some examples of using jQuery in your scripts. (<b>click to expand</b>)</summary>
self.execute_script("jQuery, window.scrollTo(0, 600)")  # Scrolling the page

self.execute_script("jQuery('#annoying-widget').hide()")  # Hiding elements on a page

self.execute_script("jQuery('#hidden-widget').show(0)")  # Showing hidden elements on a page

self.execute_script("jQuery('#annoying-button a').remove()")  # Removing elements on a page

self.execute_script("jQuery('%s').mouseover()" % (mouse_over_item))  # Mouse-over elements on a page

self.execute_script("jQuery('input#the_id').val('my_text')")  # Fast text input on a page

self.execute_script("jQuery('div#dropdown a.link').click()")  # Click elements on a page

self.execute_script("return jQuery('div#amazing')[0].text")  # Returns the css "text" of the element given

self.execute_script("return jQuery('textarea')[2].value")  # Returns the css "value" of the 3rd textarea element on the page

(Most of the above commands can be done directly with built-in SeleniumBase methods.)

</details>

πŸ”΅ Some websites have a restrictive Content Security Policy to prevent users from loading jQuery and other external libraries onto their websites. If you need to use jQuery or another JS library on such a website, add --disable-csp on the command-line.

<div></div> <details> <summary> ▢️ In this example, JavaScript creates a referral button on a page, which is then clicked. (<b>click to expand</b>)</summary>
start_page = "https://xkcd.com/465/"
destination_page = "https://github.com/seleniumbase/SeleniumBase"
self.open(start_page)
referral_link = '''<a class='analytics test' href='%s'>Free-Referral Button!</a>''' % destination_page
self.execute_script('''document.body.innerHTML = \"%s\"''' % referral_link)
self.click("a.analytics")  # Clicks the generated button

(Due to popular demand, this traffic generation example has been included in SeleniumBase with the <code>self.generate_referral(start_page, end_page)</code> and the <code>self.generate_traffic(start_page, end_page, loops)</code> methods.)

</details>

πŸ”΅ Using deferred asserts:

<p>Let's say you want to verify multiple different elements on a web page in a single test, but you don't want the test to fail until you verified several elements at once so that you don't have to rerun the test to find more missing elements on the same page. That's where deferred asserts come in. Here's the example:</p>
from seleniumbase import BaseCase

class MyTestClass(BaseCase):

    def test_deferred_asserts(self):
        self.open('https://xkcd.com/993/')
        self.wait_for_element('#comic')
        self.deferred_assert_element('img[alt="Brand Identity"]')
        self.deferred_assert_element('img[alt="Rocket Ship"]')  # Will Fail
        self.deferred_assert_element('#comicmap')
        self.deferred_assert_text('Fake Item', '#middleContainer')  # Will Fail
        self.deferred_assert_text('Random', '#middleContainer')
        self.deferred_assert_element('a[name="Super Fake !!!"]')  # Will Fail
        self.process_deferred_asserts()

<code>deferred_assert_element()</code> and <code>deferred_assert_text()</code> will save any exceptions that would be raised. To flush out all the failed deferred asserts into a single exception, make sure to call <code>self.process_deferred_asserts()</code> at the end of your test method. If your test hits multiple pages, you can call <code>self.process_deferred_asserts()</code> before navigating to a new page so that the screenshot from your log files matches the URL where the deferred asserts were made.

πŸ”΅ Accessing Raw <a href="https://www.selenium.dev/documentation/webdriver/" target="_blank">WebDriver</a>:

<p>If you need access to any commands that come with standard <a href="https://www.selenium.dev/documentation/webdriver/" target="_blank">WebDriver</a>, you can call them directly like this:</p>
self.driver.delete_all_cookies()
capabilities = self.driver.capabilities
self.driver.find_elements("partial link text", "GitHub")

(In general, you'll want to use the SeleniumBase versions of methods when available.)

πŸ”΅ Retrying failing tests automatically:

<p>You can use <code>--reruns=NUM</code> to retry failing tests that many times. Use <code>--reruns-delay=SECONDS</code> to wait that many seconds between retries. Example:</p>
pytest --reruns=1 --reruns-delay=1
<p>You can use the <code>@retry_on_exception()</code> decorator to retry failing methods. (First import: <code>from seleniumbase import decorators</code>). To learn more about SeleniumBase decorators, <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/seleniumbase/common">click here</a>.</p><h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Wrap-Up</h3>

<b>Congratulations on getting started with SeleniumBase!</b>

<p> <div><b>If you see something, say something!</b></div> <div><a href="https://github.com/seleniumbase/SeleniumBase/issues?q=is%3Aissue+is%3Aclosed"><img src="https://img.shields.io/github/issues-closed-raw/seleniumbase/SeleniumBase.svg?color=22BB88" title="Closed Issues" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/pulls?q=is%3Apr+is%3Aclosed"><img src="https://img.shields.io/github/issues-pr-closed/seleniumbase/SeleniumBase.svg?logo=github&logoColor=white&color=22BB99" title="Closed Pull Requests" /></a></div> </p><p> <div><b>If you like SeleniumBase, star us! ⭐</b></div> <div><a href="https://github.com/seleniumbase/SeleniumBase/stargazers"><img src="https://img.shields.io/github/stars/seleniumbase/seleniumbase.svg?color=19A57B" title="Stargazers" /></a></div> </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><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>