index.html


<!doctype html>
<html lang="en" class="no-js">
  <head>
    
      <meta charset="utf-8">
      <meta name="viewport" content="width=device-width,initial-scale=1">
      
        <meta name="description" content="A complete framework for end-to-end testing with Python, pytest, behave-BDD, and WebDriver.">
      
      
        <meta name="author" content="Michael Mintz">
      
      
        <link rel="canonical" href="https://seleniumbase.io/">
      
      
        <link rel="next" href="help_docs/features_list/">
      
      
      <link rel="icon" href="img/green_logo3.png">
      <meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
    
    
        <title>SeleniumBase Docs</title>
      
    
      <link rel="stylesheet" href="assets/stylesheets/main.342714a4.min.css">
      
        
        <link rel="stylesheet" href="assets/stylesheets/palette.06af60db.min.css">
      
      
        <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
        <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
        <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
      
    
    <script>__md_scope=new URL(".",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
    
      
<script id="__analytics">function __md_analytics(){function e(){dataLayer.push(arguments)}window.dataLayer=window.dataLayer||[],e("js",new Date),e("config","G-P5KFWRNLRN"),document.addEventListener("DOMContentLoaded",(function(){document.forms.search&&document.forms.search.query.addEventListener("blur",(function(){this.value&&e("event","search",{search_term:this.value})}));document$.subscribe((function(){var t=document.forms.feedback;if(void 0!==t)for(var a of t.querySelectorAll("[type=submit]"))a.addEventListener("click",(function(a){a.preventDefault();var n=document.location.pathname,d=this.getAttribute("data-md-value");e("event","feedback",{page:n,data:d}),t.firstElementChild.disabled=!0;var r=t.querySelector(".md-feedback__note [data-md-value='"+d+"']");r&&(r.hidden=!1)})),t.hidden=!1})),location$.subscribe((function(t){e("config","G-P5KFWRNLRN",{page_path:t.pathname})}))}));var t=document.createElement("script");t.async=!0,t.src="https://www.googletagmanager.com/gtag/js?id=G-P5KFWRNLRN",document.getElementById("__analytics").insertAdjacentElement("afterEnd",t)}</script>
  
    <script>"undefined"!=typeof __md_analytics&&__md_analytics()</script>
  

  </head>
  
  
    <body dir="ltr" data-md-color-scheme="default" data-md-color-primary="blue" data-md-color-accent="green">
  
    
    <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
    <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
    <label class="md-overlay" for="__drawer"></label>
    <div data-md-component="skip">
      
    </div>
    <div data-md-component="announce">
      
    </div>
    
    
<header class="md-header md-header--shadow" data-md-component="header">
  <nav class="md-header__inner md-grid" aria-label="Header">
    <a href="." title="SeleniumBase Docs" class="md-header__button md-logo" aria-label="SeleniumBase Docs" data-md-component="logo">
      
  <img src="img/logo3c.png" alt="logo">

    </a>
    <label class="md-header__button md-icon" for="__drawer">
      
      <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
    </label>
    <div class="md-header__title" data-md-component="header-title">
      <div class="md-header__ellipsis">
        <div class="md-header__topic">
          <span class="md-ellipsis">
            SeleniumBase Docs
          </span>
        </div>
        <div class="md-header__topic" data-md-component="header-topic">
          <span class="md-ellipsis">
            
              ✅ SeleniumBase README
            
          </span>
        </div>
      </div>
    </div>
    
      
        <label class="md-header__button md-icon" for="__search">
          
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
        </label>
        <div class="md-search" data-md-component="search" role="dialog">
  <label class="md-search__overlay" for="__search"></label>
  <div class="md-search__inner" role="search">
    <form class="md-search__form" name="search">
      <input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
      <label class="md-search__icon md-icon" for="__search">
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
        
        <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
      </label>
      <nav class="md-search__options" aria-label="Search">
        
        <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
          
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
        </button>
      </nav>
      
    </form>
    <div class="md-search__output">
      <div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
        <div class="md-search-result" data-md-component="search-result">
          <div class="md-search-result__meta">
            Initializing search
          </div>
          <ol class="md-search-result__list" role="presentation"></ol>
        </div>
      </div>
    </div>
  </div>
</div>
      
    
      <div class="md-header__source">
        <a href="https://github.com/seleniumbase/SeleniumBase" title="Go to repository" class="md-source" data-md-component="source">
  <div class="md-source__icon md-icon">
    
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  </div>
  <div class="md-source__repository">
    seleniumbase/SeleniumBase
  </div>
</a>
      </div>
    
  </nav>
  
</header>
    
    <div class="md-container" data-md-component="container">
      
      
      <main class="md-main" data-md-component="main">
        <div class="md-main__inner md-grid">
          
            
              <div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    

<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
  <label class="md-nav__title" for="__drawer">
    <a href="." title="SeleniumBase Docs" class="md-nav__button md-logo" aria-label="SeleniumBase Docs" data-md-component="logo">
      
  <img src="img/logo3c.png" alt="logo">

    </a>
    SeleniumBase Docs
  </label>
  
    <div class="md-nav__source">
      <a href="https://github.com/seleniumbase/SeleniumBase" title="Go to repository" class="md-source" data-md-component="source">
  <div class="md-source__icon md-icon">
    
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81"/></svg>
  </div>
  <div class="md-source__repository">
    seleniumbase/SeleniumBase
  </div>
</a>
    </div>
  
  <ul class="md-nav__list" data-md-scrollfix>
    
      
    <li class="md-nav__item md-nav__item--active">
      
      <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
      
      
      <a href="." class="md-nav__link md-nav__link--active">
        
  
  <span class="md-ellipsis">
    ✅ SeleniumBase README
    
  </span>
  

      </a>
      
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/features_list/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🏰 List of Features
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="examples/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    📚 Running Example Tests
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/customizing_test_runs/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🎛️ Command Line Options
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="seleniumbase/console_scripts/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🌠 Console Scripts
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="examples/example_logs/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    📊 Dashboard / Reports
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/syntax_formats/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🔡 Syntax Formats
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/commander/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🎖️ GUI / Commander
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/recorder_mode/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🔴 Recorder Mode
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/method_summary/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    📘 API Reference
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_11" >
        
          
          <label class="md-nav__link" for="__nav_11" id="__nav_11_label" tabindex="">
            
  
  <span class="md-ellipsis">
    Python Setup / Install
    
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_11_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_11">
            <span class="md-nav__icon md-icon"></span>
            Python Setup / Install
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="help_docs/install_python_pip_git/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🐉 Get Python, pip, & git
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/virtualenv_instructions/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    ⚙️ Virtualenv Instructions
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/install/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🏄 Install SeleniumBase
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/how_it_works/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    👁️ How it Works
    
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_12" >
        
          
          <label class="md-nav__link" for="__nav_12" id="__nav_12_label" tabindex="">
            
  
  <span class="md-ellipsis">
    JS Manager / JS Tools
    
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_12_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_12">
            <span class="md-nav__icon md-icon"></span>
            JS Manager / JS Tools
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="help_docs/js_package_manager/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🕹️ Package Manager
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/demo_mode/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🎦 Demo Mode
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="examples/tour_examples/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🚎 Tour Maker
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="examples/dialog_boxes/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🛂 Dialog Boxes
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="examples/master_qa/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🛂 MasterQA Mode
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="examples/chart_maker/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    📶 Chart Maker
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="examples/presenter/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🎞️ Presentation Maker
    
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_13" >
        
          
          <label class="md-nav__link" for="__nav_13" id="__nav_13_label" tabindex="">
            
  
  <span class="md-ellipsis">
    Integrations
    
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_13_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_13">
            <span class="md-nav__icon md-icon"></span>
            Integrations
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="help_docs/uc_mode/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    👤 UC Mode
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="examples/cdp_mode/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🐙 CDP Mode
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="integrations/github/workflows/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🤖 GitHub CI
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="seleniumbase/masterqa/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🛂 MasterQA
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/case_plans/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🗂️ Case Plans
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/mobile_testing/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    📱 Mobile Mode
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="seleniumbase/utilities/selenium_grid/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🌐 Selenium Grid
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="examples/visual_testing/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🖼️ Visual Testing
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/html_inspector/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🕵️ The HTML Inspector
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="integrations/azure/azure_pipelines/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🤖 Azure Pipelines
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="integrations/azure/jenkins/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🤖 Jenkins on Azure
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="integrations/google_cloud/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🤖 Jenkins on Google Cloud
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🤖 NodeJS Test Runner
    
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_14" >
        
          
          <label class="md-nav__link" for="__nav_14" id="__nav_14_label" tabindex="">
            
  
  <span class="md-ellipsis">
    Presentations
    
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_14_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_14">
            <span class="md-nav__icon md-icon"></span>
            Presentations
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="https://seleniumbase.io/other/core_presentation.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    ✅ Core Presentation
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/other/presenter.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🎞️ Presenter Demo
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/other/chart_presentation.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    📊 Chart Maker Demo
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/other/py_virtual_envs.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    ⚙️ Python Virtual Envs
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/other/fundamentals.html" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🔰 Fundamentals Demo
    
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_15" >
        
          
          <label class="md-nav__link" for="__nav_15" id="__nav_15_label" tabindex="">
            
  
  <span class="md-ellipsis">
    Demo Pages
    
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_15_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_15">
            <span class="md-nav__icon md-icon"></span>
            Demo Pages
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="https://seleniumbase.io/coffee/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🍵 Coffee Cart (Test App)
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/demo_page" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    📑 Demo Page (Test Page)
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/simple/login" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🔑 Simple App (Test Page)
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/realworld/login" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🔑 MFA Login (Test App)
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/tinymce/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    📝 TinyMCE (Test Page)
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/apps/calculator" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🔢 Calculator (Test App)
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/devices/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    📱 Device Farm (Virtual)
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/error_page/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    ⚠️ Error Page (Test Page)
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/other/broken_page" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    ⚠️ Page with broken links
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/other/drag_and_drop" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    ↔️ Drag & Drop (Test Page)
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/canvas/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🖼️ Canvas Test Page One
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/other/canvas" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🖼️ Canvas Test Page Two
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/other/shadow_dom" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    👤 Shadow DOM/Root Page
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/w3schools/sbase" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🖥️ SeleniumBase in iframe
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/w3schools/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🖥️ W3Schools Playground
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/w3schools/iframes" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🖥️ W3Schools iframes
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/w3schools/file_upload" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🗃️ W3Schools file upload
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/w3schools/double_click" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🖲️ W3Schools doubleclick
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/w3schools/drag_drop" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    ↔️ W3Schools drag & drop
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/w3schools/checkboxes" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    ☑️ W3Schools checkboxes
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/w3schools/radio_buttons" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🔘 W3Schools radio buttons
    
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_16" >
        
          
          <label class="md-nav__link" for="__nav_16" id="__nav_16_label" tabindex="">
            
  
  <span class="md-ellipsis">
    Pages with CAPTCHAs
    
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_16_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_16">
            <span class="md-nav__icon md-icon"></span>
            Pages with CAPTCHAs
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="https://seleniumbase.io/apps/turnstile" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🔑 CF Turnstile Test
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/apps/form_turnstile" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🔑 CF Turnstile on Form
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/apps/recaptcha" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🔐 reCAPTCHA v2 Test
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/apps/form_recaptcha" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🔐 reCAPTCHA v2 on Form
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="https://seleniumbase.io/apps/invisible_recaptcha" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🔐 reCAPTCHA, invisible
    
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_17" >
        
          
          <label class="md-nav__link" for="__nav_17" id="__nav_17_label" tabindex="">
            
  
  <span class="md-ellipsis">
    Additional Help Docs
    
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_17_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_17">
            <span class="md-nav__icon md-icon"></span>
            Additional Help Docs
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="help_docs/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    📑 Table of Contents
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/handling_iframes/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🖼️ How to handle iframes
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="seleniumbase/common/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🔐 Decorators / Security
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="examples/case_summary/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🗂️ Case Plans (examples)
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/using_safari_driver/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🧭 Using Safari Driver
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="integrations/docker/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🐳 Docker Start Guide
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/shadow_dom/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    👤 Shadow DOM Support
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/hidden_files_info/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    👥 macOS Hidden Files
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/mysql_installation/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🗄️ MySQL Instructions
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/desired_capabilities/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    📃 Desired Capabilities
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/useful_grep_commands/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    📜 Useful grep commands
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/webdriver_installation/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    ⚙️ Downloading drivers
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="examples/migration/raw_selenium/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    ✅ Selenium Migration
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/verify_webdriver/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    ✔️ Verifying drivers
    
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_18" >
        
          
          <label class="md-nav__link" for="__nav_18" id="__nav_18_label" tabindex="">
            
  
  <span class="md-ellipsis">
    Behave-BDD Integration
    
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_18_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_18">
            <span class="md-nav__icon md-icon"></span>
            Behave-BDD Integration
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="examples/behave_bdd/ReadMe/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🐝 Behave-BDD ReadMe
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/behave_gui/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🐝 Behave-BDD GUI App
    
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_19" >
        
          
          <label class="md-nav__link" for="__nav_19" id="__nav_19_label" tabindex="">
            
  
  <span class="md-ellipsis">
    Languages
    
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_19_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_19">
            <span class="md-nav__icon md-icon"></span>
            Languages
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="help_docs/translations/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🌏 Translations
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/chinese/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🐲 Chinese Docs
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/locale_codes/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🗾 Locale Codes
    
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

    <li class="md-nav__item md-nav__item--section md-nav__item--nested">
      
        
        <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_20" >
        
          
          <label class="md-nav__link" for="__nav_20" id="__nav_20_label" tabindex="">
            
  
  <span class="md-ellipsis">
    Other
    
  </span>
  

            <span class="md-nav__icon md-icon"></span>
          </label>
        
        <nav class="md-nav" data-md-level="1" aria-labelledby="__nav_20_label" aria-expanded="false">
          <label class="md-nav__title" for="__nav_20">
            <span class="md-nav__icon md-icon"></span>
            Other
          </label>
          <ul class="md-nav__list" data-md-scrollfix>
            
              
    <li class="md-nav__item">
      <a href="https://www.youtube.com/playlist?list=PLp9uKicxkBc5UIlGi2BuE3aWC7JyXpD3m" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    📺 YouTube Link
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/happy_customers/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    📋 Case Studies
    
  </span>
  

      </a>
    </li>
  

    <li class="md-nav__item">
      <a href="help_docs/thank_you/" class="md-nav__link">
        
  
  <span class="md-ellipsis">
    🙏 Thank You
    
  </span>
  

      </a>
    </li>
  

          </ul>
        </nav>
      
    </li>
  

  </ul>
</nav>
                  </div>
                </div>
              </div>
            
            
              <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" hidden>
                <div class="md-sidebar__scrollwrap">
                  <div class="md-sidebar__inner">
                    

<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
  
  
</nav>
                  </div>
                </div>
              </div>
            
          
            <div class="md-content" data-md-component="content">
              <article class="md-content__inner md-typeset">
                
                  
<p><meta property="og:site_name" content="SeleniumBase">
<meta property="og:title" content="SeleniumBase: Python Web Automation and E2E Testing" />
<meta property="og:description" content="Fast, easy, and reliable Web/UI testing with Python." />
<meta property="og:keywords" content="Python, pytest, selenium, webdriver, testing, automation, seleniumbase, framework, dashboard, recorder, reports, screenshots">
<meta property="og:image" content="https://seleniumbase.github.io/cdn/img/mac_sb_logo_5b.png" />
<link rel="icon" href="https://seleniumbase.github.io/img/logo7.png" /></p>
<h1>SeleniumBase</h1>

<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/super_logo_sb3.png" alt="SeleniumBase" title="SeleniumBase" width="350" /></a></p>

<p align="center" class="hero__title"><b>All-in-one Browser Automation Framework:<br />Web Crawling / Testing / Scraping / Stealth</b></p>

<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://github.com/seleniumbase/SeleniumBase"><img src="https://img.shields.io/badge/✅%20View%20Code-on%20GitHub%20🌎-02A79E.svg" alt="SeleniumBase on GitHub" /></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://discord.gg/EdhQTn3EyE" target="_blank"><img src="https://img.shields.io/discord/727927627830001734?color=7289DA&label=Discord&logo=discord&logoColor=white"/></a></p>

<p align="center">
<a href="#python_installation">🚀 Start</a> |
<a href="help_docs/features_list/">🏰 Features</a> |
<a href="help_docs/customizing_test_runs/">🎛️ Options</a> |
<a href="examples/ReadMe/">📚 Examples</a> |
<a href="seleniumbase/console_scripts/ReadMe/">🌠 Scripts</a> |
<a href="help_docs/mobile_testing/">📱 Mobile</a>
<br />
<a href="help_docs/method_summary/">📘 APIs</a> |
<a href="help_docs/syntax_formats/"> 🔠 Formats</a> |
<a href="help_docs/recorder_mode/">🔴 Recorder</a> |
<a href="examples/example_logs/ReadMe/">📊 Dashboard</a> |
<a href="help_docs/locale_codes/">🗾 Locales</a> |
<a href="https://seleniumbase.io/devices/?url=seleniumbase.com">💻 Farm</a>
<br />
<a href="help_docs/commander/">🎖️ GUI</a> |
<a href="https://seleniumbase.io/demo_page">📰 TestPage</a> |
<a href="help_docs/uc_mode/">👤 UC Mode</a> |
<a href="examples/cdp_mode/ReadMe/">🐙 CDP Mode</a> |
<a href="examples/chart_maker/ReadMe/">📶 Charts</a> |
<a href="seleniumbase/utilities/selenium_grid/ReadMe/">🌐 Grid</a>
<br />
<a href="help_docs/how_it_works/">👁️ How</a> |
<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/migration/raw_selenium">🚝 Migrate</a> |
<a href="help_docs/case_plans/">🗂️ CasePlans</a> |
<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/boilerplates">♻️ Template</a> |
<a href="examples/master_qa/ReadMe/">🧬 Hybrid</a> |
<a href="examples/tour_examples/ReadMe/">🚎 Tours</a>
<br />
<a href="integrations/github/workflows/ReadMe/">🤖 CI/CD</a> |
<a href="help_docs/js_package_manager/">🕹️ JSMgr</a> |
<a href="help_docs/translations/">🌏 Translator</a> |
<a href="examples/presenter/ReadMe/">🎞️ Presenter</a> |
<a href="examples/dialog_boxes/ReadMe/">🛂 Dialog</a> |
<a href="examples/visual_testing/ReadMe/">🖼️ Visual</a>
<br />
</p>

<p>SeleniumBase is the professional toolkit for web automation activities. Built for testing websites, bypassing CAPTCHAs, enhancing productivity, completing tasks, and scaling your business.</p>

<hr />
<p>📚 Learn from <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples"><strong>over 200 examples</strong> in the <strong>SeleniumBase/examples/</strong> folder</a>.</p>
<p>🐙 Note that <a translate="no" href="help_docs/uc_mode/"><b>UC Mode</b></a> / <a href="examples/cdp_mode/ReadMe/"><b>CDP Mode</b></a> (Stealth Mode) have their own ReadMe files.</p>
<p>ℹ️ Most scripts run with raw <code translate="no"><b>python</b></code>, although some scripts use <a href="help_docs/syntax_formats/">Syntax Formats</a> that expect <a href="https://docs.pytest.org/en/latest/how-to/usage.html" translate="no"><b>pytest</b></a> (a Python unit-testing framework included with SeleniumBase that can discover, collect, and run tests automatically).</p>
<hr />
<p align="left">📗 Here's <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/raw_google.py">raw_google.py</a>, which performs a Google search:</p>

<div class="highlight"><pre><span></span><code><span class="kn">from</span><span class="w"> </span><span class="nn">seleniumbase</span><span class="w"> </span><span class="kn">import</span> <span class="n">SB</span>

<span class="k">with</span> <span class="n">SB</span><span class="p">(</span><span class="n">test</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">uc</span><span class="o">=</span><span class="kc">True</span><span class="p">)</span> <span class="k">as</span> <span class="n">sb</span><span class="p">:</span>
    <span class="n">sb</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s2">&quot;https://google.com/ncr&quot;</span><span class="p">)</span>
    <span class="n">sb</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s1">&#39;[title=&quot;Search&quot;]&#39;</span><span class="p">,</span> <span class="s2">&quot;SeleniumBase GitHub page</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>
    <span class="n">sb</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s1">&#39;[href*=&quot;github.com/seleniumbase/&quot;]&#39;</span><span class="p">)</span>
    <span class="n">sb</span><span class="o">.</span><span class="n">save_screenshot_to_logs</span><span class="p">()</span>  <span class="c1"># ./latest_logs/</span>
    <span class="nb">print</span><span class="p">(</span><span class="n">sb</span><span class="o">.</span><span class="n">get_page_title</span><span class="p">())</span>
</code></pre></div>
<blockquote>
<p><code>python raw_google.py</code></p>
</blockquote>
<p><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/raw_google.py"><img src="https://seleniumbase.github.io/cdn/gif/google_search.gif" alt="SeleniumBase Test" title="SeleniumBase Test" width="480" /></a></p>
<hr />
<p align="left">📗 Here's an example of bypassing Cloudflare's challenge page: <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/raw_gitlab.py">SeleniumBase/examples/cdp_mode/raw_gitlab.py</a></p>

<div class="highlight"><pre><span></span><code><span class="kn">from</span><span class="w"> </span><span class="nn">seleniumbase</span><span class="w"> </span><span class="kn">import</span> <span class="n">SB</span>

<span class="k">with</span> <span class="n">SB</span><span class="p">(</span><span class="n">uc</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">test</span><span class="o">=</span><span class="kc">True</span><span class="p">,</span> <span class="n">locale</span><span class="o">=</span><span class="s2">&quot;en&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">sb</span><span class="p">:</span>
    <span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;https://gitlab.com/users/sign_in&quot;</span>
    <span class="n">sb</span><span class="o">.</span><span class="n">activate_cdp_mode</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
    <span class="n">sb</span><span class="o">.</span><span class="n">uc_gui_click_captcha</span><span class="p">()</span>
    <span class="n">sb</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">2</span><span class="p">)</span>
</code></pre></div>
<p><img src="https://seleniumbase.github.io/other/cf_sec.jpg" title="SeleniumBase" width="332"> <img src="https://seleniumbase.github.io/other/gitlab_bypass.png" title="SeleniumBase" width="288"></p>
<hr />
<p align="left">📗 Here's <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_get_swag.py">test_get_swag.py</a>, which tests an e-commerce site:</p>

<div class="highlight"><pre><span></span><code><span class="kn">from</span><span class="w"> </span><span class="nn">seleniumbase</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseCase</span>
<span class="n">BaseCase</span><span class="o">.</span><span class="n">main</span><span class="p">(</span><span class="vm">__name__</span><span class="p">,</span> <span class="vm">__file__</span><span class="p">)</span>  <span class="c1"># Call pytest</span>

<span class="k">class</span><span class="w"> </span><span class="nc">MyTestClass</span><span class="p">(</span><span class="n">BaseCase</span><span class="p">):</span>
    <span class="k">def</span><span class="w"> </span><span class="nf">test_swag_labs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s2">&quot;https://www.saucedemo.com&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s2">&quot;#user-name&quot;</span><span class="p">,</span> <span class="s2">&quot;standard_user&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s2">&quot;#password&quot;</span><span class="p">,</span> <span class="s2">&quot;secret_sauce</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">assert_element</span><span class="p">(</span><span class="s2">&quot;div.inventory_list&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s1">&#39;button[name*=&quot;backpack&quot;]&#39;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s2">&quot;#shopping_cart_container a&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">assert_text</span><span class="p">(</span><span class="s2">&quot;Backpack&quot;</span><span class="p">,</span> <span class="s2">&quot;div.cart_item&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s2">&quot;button#checkout&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s2">&quot;input#first-name&quot;</span><span class="p">,</span> <span class="s2">&quot;SeleniumBase&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s2">&quot;input#last-name&quot;</span><span class="p">,</span> <span class="s2">&quot;Automation&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s2">&quot;input#postal-code&quot;</span><span class="p">,</span> <span class="s2">&quot;77123&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s2">&quot;input#continue&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s2">&quot;button#finish&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">assert_text</span><span class="p">(</span><span class="s2">&quot;Thank you for your order!&quot;</span><span class="p">)</span>
</code></pre></div>
<blockquote>
<p><code>pytest test_get_swag.py</code></p>
</blockquote>
<p><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_get_swag.py"><img src="https://seleniumbase.github.io/cdn/gif/fast_swag_2.gif" alt="SeleniumBase Test" title="SeleniumBase Test" width="480" /></a></p>
<blockquote>
<p>(The default browser is <code>--chrome</code> if not set.)</p>
</blockquote>
<hr />
<p align="left">📗 Here's <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_coffee_cart.py" target="_blank">test_coffee_cart.py</a>, which verifies an e-commerce site:</p>

<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>test_coffee_cart.py<span class="w"> </span>--demo
</code></pre></div>
<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>

<blockquote>
<p><p>(<code translate="no">--demo</code> mode slows down tests and highlights actions)</p></p>
</blockquote>
<hr />
<p><a id="multiple_examples"></a></p>
<p align="left">📗 Here's <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_demo_site.py" target="_blank">test_demo_site.py</a>, which covers several actions:</p>

<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>test_demo_site.py
</code></pre></div>
<p align="left"><a href="https://seleniumbase.io/demo_page" target="_blank"><img src="https://seleniumbase.github.io/cdn/gif/demo_page_5.gif" width="480" alt="SeleniumBase Example" title="SeleniumBase Example" /></a></p>

<blockquote>
<p>Easy to type, click, select, toggle, drag &amp; drop, and more.</p>
</blockquote>
<p>(For more examples, see the <a href="examples/ReadMe/">SeleniumBase/examples/</a> folder.)</p>
<hr />
<p align="left"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/super_logo_sb3.png" alt="SeleniumBase" title="SeleniumBase" width="232" /></a></p>

<blockquote>
<p dir="auto"><strong>Explore the README:</strong></p>
<ul dir="auto">
<li><a href="#install_seleniumbase"   ><strong>Get Started / Installation</strong></a></li>
<li><a href="#basic_example_and_usage"><strong>Basic Example / Usage</strong></a></li>
<li><a href="#common_methods"         ><strong>Common Test Methods</strong></a></li>
<li><a href="#fun_facts"              ><strong>Fun Facts / Learn More</strong></a></li>
<li><a href="#demo_mode_and_debugging"><strong>Demo Mode / Debugging</strong></a></li>
<li><a href="#command_line_options"   ><strong>Command-line Options</strong></a></li>
<li><a href="#directory_configuration"><strong>Directory Configuration</strong></a></li>
<li><a href="#seleniumbase_dashboard" ><strong>SeleniumBase Dashboard</strong></a></li>
<li><a href="#creating_visual_reports"><strong>Generating Test Reports</strong></a></li>
</ul>
</blockquote>

<hr />
<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 translate="no">pytest</code>, <code translate="no">pynose</code>, and <code translate="no">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>eg. browser selection</i>). With raw Selenium, you would need to set up your own options-parser for configuring tests from the command-line.</p>

<p>💡 SeleniumBase's driver manager gives you more control over automatic driver downloads. (Use <code translate="no">--driver-version=VER</code> with your <code translate="no">pytest</code> run command to specify the version.) By default, SeleniumBase will download a driver version that matches your major browser version if not set.</p>

<p>💡 SeleniumBase automatically detects 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 translate="no">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 <code translate="no">"\n"</code>.<br />With raw Selenium, those actions require multiple method calls.</p>

<p>💡 SeleniumBase uses default timeout values when not set:<br />
✅ <code translate="no">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 translate="no">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 translate="no">self.click("button", timeout=10)</code><br />
With raw Selenium, that requires more code:<br />
❌ <code translate="no">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 translate="no">./latest_logs/</code> folder. Raw <a href="https://www.selenium.dev/documentation/webdriver/" translate="no" 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 <a href="help_docs/commander/" translate="no">SeleniumBase Commander</a> for <code translate="no">pytest</code> and <a href="examples/behave_bdd/ReadMe/" translate="no">SeleniumBase Behave GUI</a> for <code translate="no">behave</code>.</p>

<p>💡 SeleniumBase has its own <a href="help_docs/recorder_mode/">Recorder / Test Generator</a> for creating tests from manual browser actions.</p>

<p>💡 SeleniumBase comes with <a href="help_docs/case_plans/">test case management software, ("CasePlans")</a>, for organizing tests and step descriptions.</p>

<p>💡 SeleniumBase includes tools for <a href="examples/chart_maker/ReadMe/">building data apps, ("ChartMaker")</a>, which can generate JavaScript from Python.</p>

</div>
</details>

<hr />
<p>📚 <b>Learn about different ways of writing tests:</b></p>

<p align="left">📗📝 Here's <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_simple_login.py">test_simple_login.py</a>, which uses <code translate="no"><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py">BaseCase</a></code> class inheritance, and runs with <a href="https://docs.pytest.org/en/latest/how-to/usage.html">pytest</a> or <a href="https://github.com/mdmintz/pynose">pynose</a>. (Use <code translate="no">self.driver</code> to access Selenium's raw <code translate="no">driver</code>.)</p>

<div class="highlight"><pre><span></span><code><span class="kn">from</span><span class="w"> </span><span class="nn">seleniumbase</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseCase</span>
<span class="n">BaseCase</span><span class="o">.</span><span class="n">main</span><span class="p">(</span><span class="vm">__name__</span><span class="p">,</span> <span class="vm">__file__</span><span class="p">)</span>

<span class="k">class</span><span class="w"> </span><span class="nc">TestSimpleLogin</span><span class="p">(</span><span class="n">BaseCase</span><span class="p">):</span>
    <span class="k">def</span><span class="w"> </span><span class="nf">test_simple_login</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s2">&quot;seleniumbase.io/simple/login&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s2">&quot;#username&quot;</span><span class="p">,</span> <span class="s2">&quot;demo_user&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s2">&quot;#password&quot;</span><span class="p">,</span> <span class="s2">&quot;secret_pass&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s1">&#39;a:contains(&quot;Sign in&quot;)&#39;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">assert_exact_text</span><span class="p">(</span><span class="s2">&quot;Welcome!&quot;</span><span class="p">,</span> <span class="s2">&quot;h1&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">assert_element</span><span class="p">(</span><span class="s2">&quot;img#image1&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">highlight</span><span class="p">(</span><span class="s2">&quot;#image1&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">click_link</span><span class="p">(</span><span class="s2">&quot;Sign out&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">assert_text</span><span class="p">(</span><span class="s2">&quot;signed out&quot;</span><span class="p">,</span> <span class="s2">&quot;#top_message&quot;</span><span class="p">)</span>
</code></pre></div>
<p align="left">📘📝 Here's <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/raw_login_sb.py">raw_login_sb.py</a>, which uses the <b><code translate="no">SB</code></b> Context Manager. Runs with pure <code translate="no">python</code>. (Use <code translate="no">sb.driver</code> to access Selenium's raw <code translate="no">driver</code>.)</p>

<div class="highlight"><pre><span></span><code><span class="kn">from</span><span class="w"> </span><span class="nn">seleniumbase</span><span class="w"> </span><span class="kn">import</span> <span class="n">SB</span>

<span class="k">with</span> <span class="n">SB</span><span class="p">()</span> <span class="k">as</span> <span class="n">sb</span><span class="p">:</span>
    <span class="n">sb</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s2">&quot;seleniumbase.io/simple/login&quot;</span><span class="p">)</span>
    <span class="n">sb</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s2">&quot;#username&quot;</span><span class="p">,</span> <span class="s2">&quot;demo_user&quot;</span><span class="p">)</span>
    <span class="n">sb</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s2">&quot;#password&quot;</span><span class="p">,</span> <span class="s2">&quot;secret_pass&quot;</span><span class="p">)</span>
    <span class="n">sb</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s1">&#39;a:contains(&quot;Sign in&quot;)&#39;</span><span class="p">)</span>
    <span class="n">sb</span><span class="o">.</span><span class="n">assert_exact_text</span><span class="p">(</span><span class="s2">&quot;Welcome!&quot;</span><span class="p">,</span> <span class="s2">&quot;h1&quot;</span><span class="p">)</span>
    <span class="n">sb</span><span class="o">.</span><span class="n">assert_element</span><span class="p">(</span><span class="s2">&quot;img#image1&quot;</span><span class="p">)</span>
    <span class="n">sb</span><span class="o">.</span><span class="n">highlight</span><span class="p">(</span><span class="s2">&quot;#image1&quot;</span><span class="p">)</span>
    <span class="n">sb</span><span class="o">.</span><span class="n">click_link</span><span class="p">(</span><span class="s2">&quot;Sign out&quot;</span><span class="p">)</span>
    <span class="n">sb</span><span class="o">.</span><span class="n">assert_text</span><span class="p">(</span><span class="s2">&quot;signed out&quot;</span><span class="p">,</span> <span class="s2">&quot;#top_message&quot;</span><span class="p">)</span>
</code></pre></div>
<p align="left">📙📝 Here's <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/raw_login_driver.py">raw_login_driver.py</a>, which uses the <b><code translate="no">Driver</code></b> Manager. Runs with pure <code translate="no">python</code>. (The <code>driver</code> is an improved version of Selenium's raw <code translate="no">driver</code>, with more methods.)</p>

<div class="highlight"><pre><span></span><code><span class="kn">from</span><span class="w"> </span><span class="nn">seleniumbase</span><span class="w"> </span><span class="kn">import</span> <span class="n">Driver</span>

<span class="n">driver</span> <span class="o">=</span> <span class="n">Driver</span><span class="p">()</span>
<span class="k">try</span><span class="p">:</span>
    <span class="n">driver</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s2">&quot;seleniumbase.io/simple/login&quot;</span><span class="p">)</span>
    <span class="n">driver</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s2">&quot;#username&quot;</span><span class="p">,</span> <span class="s2">&quot;demo_user&quot;</span><span class="p">)</span>
    <span class="n">driver</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s2">&quot;#password&quot;</span><span class="p">,</span> <span class="s2">&quot;secret_pass&quot;</span><span class="p">)</span>
    <span class="n">driver</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s1">&#39;a:contains(&quot;Sign in&quot;)&#39;</span><span class="p">)</span>
    <span class="n">driver</span><span class="o">.</span><span class="n">assert_exact_text</span><span class="p">(</span><span class="s2">&quot;Welcome!&quot;</span><span class="p">,</span> <span class="s2">&quot;h1&quot;</span><span class="p">)</span>
    <span class="n">driver</span><span class="o">.</span><span class="n">assert_element</span><span class="p">(</span><span class="s2">&quot;img#image1&quot;</span><span class="p">)</span>
    <span class="n">driver</span><span class="o">.</span><span class="n">highlight</span><span class="p">(</span><span class="s2">&quot;#image1&quot;</span><span class="p">)</span>
    <span class="n">driver</span><span class="o">.</span><span class="n">click_link</span><span class="p">(</span><span class="s2">&quot;Sign out&quot;</span><span class="p">)</span>
    <span class="n">driver</span><span class="o">.</span><span class="n">assert_text</span><span class="p">(</span><span class="s2">&quot;signed out&quot;</span><span class="p">,</span> <span class="s2">&quot;#top_message&quot;</span><span class="p">)</span>
<span class="k">finally</span><span class="p">:</span>
    <span class="n">driver</span><span class="o">.</span><span class="n">quit</span><span class="p">()</span>
</code></pre></div>
<hr />
<p><a id="python_installation"></a></p>
<h2><img src="https://seleniumbase.github.io/cdn/img/python_logo.png" title="SeleniumBase" width="42" /> Set up Python & Git:</h2>

<p><a href="https://www.python.org/downloads/"><img src="https://img.shields.io/pypi/pyversions/seleniumbase.svg?color=FACE42" title="Supported Python Versions" /></a></p>
<p>🔵 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.</p>
<p>🔵 Using a <a href="help_docs/virtualenv_instructions/">Python virtual env</a> is recommended.</p>
<p><a id="install_seleniumbase"></a></p>
<h2><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Install SeleniumBase:</h2>

<p><strong>You can install <code>seleniumbase</code> from <a href="https://pypi.org/project/seleniumbase/">PyPI</a> or <a href="https://github.com/seleniumbase/SeleniumBase">GitHub</a>:</strong></p>
<p>🔵 <strong>How to install <code>seleniumbase</code> from PyPI:</strong></p>
<div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>seleniumbase
</code></pre></div>
<ul>
<li>(Add <code>--upgrade</code> OR <code>-U</code> to upgrade SeleniumBase.)</li>
<li>(Add <code>--force-reinstall</code> to upgrade indirect packages.)</li>
<li>(Use <code>pip3</code> if multiple versions of Python are present.)</li>
</ul>
<p>🔵 <strong>How to install <code>seleniumbase</code> from a GitHub clone:</strong></p>
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/seleniumbase/SeleniumBase.git
<span class="nb">cd</span><span class="w"> </span>SeleniumBase/
pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
</code></pre></div>
<p>🔵 <strong>How to upgrade an existing install from a GitHub clone:</strong></p>
<div class="highlight"><pre><span></span><code>git<span class="w"> </span>pull
pip<span class="w"> </span>install<span class="w"> </span>-e<span class="w"> </span>.
</code></pre></div>
<p>🔵 <strong>Type <code>seleniumbase</code> or <code>sbase</code> to verify that SeleniumBase was installed successfully:</strong></p>
<div class="highlight"><pre><span></span><code><span class="w"> </span>___<span class="w">      </span>_<span class="w">          </span>_<span class="w">             </span>___<span class="w">              </span>
/<span class="w"> </span>__<span class="p">|</span><span class="w"> </span>___<span class="p">|</span><span class="w"> </span><span class="p">|</span>___<span class="w"> </span>_<span class="w"> </span>_<span class="w"> </span><span class="o">(</span>_<span class="o">)</span>_<span class="w">  </span>_<span class="w"> </span>_<span class="w"> </span>__<span class="w">  </span><span class="p">|</span><span class="w"> </span>_<span class="w"> </span><span class="o">)</span><span class="w"> </span>__<span class="w"> </span>_<span class="w"> </span>______<span class="w"> </span>
<span class="se">\_</span>_<span class="w"> </span><span class="se">\/</span><span class="w"> </span>-_<span class="o">)</span><span class="w"> </span>/<span class="w"> </span>-_<span class="o">)</span><span class="w"> </span><span class="s1">&#39; \| | \| | &#39;</span><span class="w">  </span><span class="se">\ </span><span class="p">|</span><span class="w"> </span>_<span class="w"> </span><span class="se">\/</span><span class="w"> </span>_<span class="sb">`</span><span class="w"> </span><span class="o">(</span>_-&lt;<span class="w"> </span>-_<span class="o">)</span>
<span class="p">|</span>___/<span class="se">\_</span>__<span class="p">|</span>_<span class="se">\_</span>__<span class="p">|</span>_<span class="o">||</span>_<span class="p">|</span>_<span class="p">|</span><span class="se">\_</span>,_<span class="p">|</span>_<span class="p">|</span>_<span class="p">|</span>_<span class="se">\|</span>___/<span class="se">\_</span>_,_/__<span class="p">|</span>___<span class="p">|</span>
----------------------------------------------------

╭──────────────────────────────────────────────────╮
│<span class="w">  </span>*<span class="w"> </span>USAGE:<span class="w"> </span><span class="s2">&quot;seleniumbase [COMMAND] [PARAMETERS]&quot;</span><span class="w">  </span>│
│<span class="w">  </span>*<span class="w">    </span>OR:<span class="w">        </span><span class="s2">&quot;sbase [COMMAND] [PARAMETERS]&quot;</span><span class="w">  </span>│
│<span class="w">                                                  </span>│
│<span class="w"> </span>COMMANDS:<span class="w">        </span>PARAMETERS<span class="w"> </span>/<span class="w"> </span>DESCRIPTIONS:<span class="w">      </span>│
│<span class="w">    </span>get<span class="w"> </span>/<span class="w"> </span>install<span class="w">    </span><span class="o">[</span>DRIVER_NAME<span class="o">]</span><span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w">      </span>│
│<span class="w">    </span>methods<span class="w">          </span><span class="o">(</span>List<span class="w"> </span>common<span class="w"> </span>Python<span class="w"> </span>methods<span class="o">)</span><span class="w"> </span>│
│<span class="w">    </span>options<span class="w">          </span><span class="o">(</span>List<span class="w"> </span>common<span class="w"> </span>pytest<span class="w"> </span>options<span class="o">)</span><span class="w"> </span>│
│<span class="w">    </span>behave-options<span class="w">   </span><span class="o">(</span>List<span class="w"> </span>common<span class="w"> </span>behave<span class="w"> </span>options<span class="o">)</span><span class="w"> </span>│
│<span class="w">    </span>gui<span class="w"> </span>/<span class="w"> </span>commander<span class="w">  </span><span class="o">[</span>OPTIONAL<span class="w"> </span>PATH<span class="w"> </span>or<span class="w"> </span>TEST<span class="w"> </span>FILE<span class="o">]</span><span class="w"> </span>│
│<span class="w">    </span>behave-gui<span class="w">       </span><span class="o">(</span>SBase<span class="w"> </span>Commander<span class="w"> </span><span class="k">for</span><span class="w"> </span>Behave<span class="o">)</span><span class="w"> </span>│
│<span class="w">    </span>caseplans<span class="w">        </span><span class="o">[</span>OPTIONAL<span class="w"> </span>PATH<span class="w"> </span>or<span class="w"> </span>TEST<span class="w"> </span>FILE<span class="o">]</span><span class="w"> </span>│
│<span class="w">    </span>mkdir<span class="w">            </span><span class="o">[</span>DIRECTORY<span class="o">]</span><span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w">        </span>│
│<span class="w">    </span>mkfile<span class="w">           </span><span class="o">[</span>FILE.py<span class="o">]</span><span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w">          </span>│
│<span class="w">    </span>mkrec<span class="w"> </span>/<span class="w"> </span>codegen<span class="w">  </span><span class="o">[</span>FILE.py<span class="o">]</span><span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w">          </span>│
│<span class="w">    </span>recorder<span class="w">         </span><span class="o">(</span>Open<span class="w"> </span>Recorder<span class="w"> </span>Desktop<span class="w"> </span>App.<span class="o">)</span><span class="w"> </span>│
│<span class="w">    </span>record<span class="w">           </span><span class="o">(</span>If<span class="w"> </span>args:<span class="w"> </span>mkrec.<span class="w"> </span>Else:<span class="w"> </span>App.<span class="o">)</span><span class="w"> </span>│
│<span class="w">    </span>mkpres<span class="w">           </span><span class="o">[</span>FILE.py<span class="o">]</span><span class="w"> </span><span class="o">[</span>LANG<span class="o">]</span><span class="w">             </span>│
│<span class="w">    </span>mkchart<span class="w">          </span><span class="o">[</span>FILE.py<span class="o">]</span><span class="w"> </span><span class="o">[</span>LANG<span class="o">]</span><span class="w">             </span>│
│<span class="w">    </span>print<span class="w">            </span><span class="o">[</span>FILE<span class="o">]</span><span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w">             </span>│
│<span class="w">    </span>translate<span class="w">        </span><span class="o">[</span>SB_FILE.py<span class="o">]</span><span class="w"> </span><span class="o">[</span>LANG<span class="o">]</span><span class="w"> </span><span class="o">[</span>ACTION<span class="o">]</span><span class="w"> </span>│
│<span class="w">    </span>convert<span class="w">          </span><span class="o">[</span>WEBDRIVER_UNITTEST_FILE.py<span class="o">]</span><span class="w"> </span>│
│<span class="w">    </span>extract-objects<span class="w">  </span><span class="o">[</span>SB_FILE.py<span class="o">]</span><span class="w">                 </span>│
│<span class="w">    </span>inject-objects<span class="w">   </span><span class="o">[</span>SB_FILE.py<span class="o">]</span><span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w">       </span>│
│<span class="w">    </span>objectify<span class="w">        </span><span class="o">[</span>SB_FILE.py<span class="o">]</span><span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w">       </span>│
│<span class="w">    </span>revert-objects<span class="w">   </span><span class="o">[</span>SB_FILE.py<span class="o">]</span><span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w">       </span>│
│<span class="w">    </span>encrypt<span class="w"> </span>/<span class="w"> </span>obfuscate<span class="w">                           </span>│
│<span class="w">    </span>decrypt<span class="w"> </span>/<span class="w"> </span>unobfuscate<span class="w">                         </span>│
│<span class="w">    </span>proxy<span class="w">            </span><span class="o">(</span>Start<span class="w"> </span>a<span class="w"> </span>basic<span class="w"> </span>proxy<span class="w"> </span>server<span class="o">)</span><span class="w"> </span>│
│<span class="w">    </span>download<span class="w"> </span>server<span class="w">  </span><span class="o">(</span>Get<span class="w"> </span>Selenium<span class="w"> </span>Grid<span class="w"> </span>JAR<span class="w"> </span>file<span class="o">)</span><span class="w"> </span>│
│<span class="w">    </span>grid-hub<span class="w">         </span><span class="o">[</span>start<span class="p">|</span>stop<span class="o">]</span><span class="w"> </span><span class="o">[</span>OPTIONS<span class="o">]</span><span class="w">       </span>│
│<span class="w">    </span>grid-node<span class="w">        </span><span class="o">[</span>start<span class="p">|</span>stop<span class="o">]</span><span class="w"> </span>--hub<span class="o">=[</span>HOST/IP<span class="o">]</span><span class="w"> </span>│
│<span class="w">                                                  </span>│
│<span class="w"> </span>*<span class="w">  </span><span class="nv">EXAMPLE</span><span class="w"> </span><span class="o">=</span>&gt;<span class="w"> </span><span class="s2">&quot;sbase get chromedriver stable&quot;</span><span class="w">    </span>│
│<span class="w"> </span>*<span class="w">  </span>For<span class="w"> </span><span class="nb">command</span><span class="w"> </span><span class="nv">info</span><span class="w"> </span><span class="o">=</span>&gt;<span class="w"> </span><span class="s2">&quot;sbase help [COMMAND]&quot;</span><span class="w">    </span>│
│<span class="w"> </span>*<span class="w">  </span>For<span class="w"> </span>info<span class="w"> </span>on<span class="w"> </span>all<span class="w"> </span><span class="nv">commands</span><span class="w"> </span><span class="o">=</span>&gt;<span class="w"> </span><span class="s2">&quot;sbase --help&quot;</span><span class="w">    </span>│
╰──────────────────────────────────────────────────╯
</code></pre></div>
<h3>🔵 Downloading webdrivers:</h3>

<p>✅ SeleniumBase automatically downloads webdrivers as needed, such as <code>chromedriver</code>.</p>
<div></div>
<details>
<summary> ▶️ Here's sample output from a chromedriver download. (<b>click to expand</b>)</summary>

<div class="highlight"><pre><span></span><code>***<span class="w"> </span>chromedriver<span class="w"> </span>to<span class="w"> </span><span class="nv">download</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="m">131</span>.0.6778.108<span class="w"> </span><span class="o">(</span>Latest<span class="w"> </span>Stable<span class="o">)</span><span class="w"> </span>

Downloading<span class="w"> </span>chromedriver-mac-arm64.zip<span class="w"> </span>from:
https://storage.googleapis.com/chrome-for-testing-public/131.0.6778.108/mac-arm64/chromedriver-mac-arm64.zip<span class="w"> </span>...
Download<span class="w"> </span>Complete!

Extracting<span class="w"> </span><span class="o">[</span><span class="s1">&#39;chromedriver&#39;</span><span class="o">]</span><span class="w"> </span>from<span class="w"> </span>chromedriver-mac-arm64.zip<span class="w"> </span>...
Unzip<span class="w"> </span>Complete!

The<span class="w"> </span>file<span class="w"> </span><span class="o">[</span>chromedriver<span class="o">]</span><span class="w"> </span>was<span class="w"> </span>saved<span class="w"> </span>to:
~/github/SeleniumBase/seleniumbase/drivers/
chromedriver

Making<span class="w"> </span><span class="o">[</span>chromedriver<span class="w"> </span><span class="m">131</span>.0.6778.108<span class="o">]</span><span class="w"> </span>executable<span class="w"> </span>...
<span class="o">[</span>chromedriver<span class="w"> </span><span class="m">131</span>.0.6778.108<span class="o">]</span><span class="w"> </span>is<span class="w"> </span>now<span class="w"> </span>ready<span class="w"> </span><span class="k">for</span><span class="w"> </span>use!
</code></pre></div>

</details>

<p><a id="basic_example_and_usage"></a></p>
<h2><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Basic Example / Usage:</h2>

<p>🔵 If you've cloned SeleniumBase, you can run tests from the <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples">examples/</a> folder.</p>
<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>

<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>examples/
pytest<span class="w"> </span>my_first_test.py
</code></pre></div>
<p><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py"><img src="https://seleniumbase.github.io/cdn/gif/fast_swag_2.gif" alt="SeleniumBase Test" title="SeleniumBase Test" width="480" /></a></p>
<p align="left"><b>Here's the full code for <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py">my_first_test.py</a>:</b></p>

<div class="highlight"><pre><span></span><code><span class="kn">from</span><span class="w"> </span><span class="nn">seleniumbase</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseCase</span>
<span class="n">BaseCase</span><span class="o">.</span><span class="n">main</span><span class="p">(</span><span class="vm">__name__</span><span class="p">,</span> <span class="vm">__file__</span><span class="p">)</span>

<span class="k">class</span><span class="w"> </span><span class="nc">MyTestClass</span><span class="p">(</span><span class="n">BaseCase</span><span class="p">):</span>
    <span class="k">def</span><span class="w"> </span><span class="nf">test_swag_labs</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s2">&quot;https://www.saucedemo.com&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s2">&quot;#user-name&quot;</span><span class="p">,</span> <span class="s2">&quot;standard_user&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s2">&quot;#password&quot;</span><span class="p">,</span> <span class="s2">&quot;secret_sauce</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">assert_element</span><span class="p">(</span><span class="s2">&quot;div.inventory_list&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">assert_exact_text</span><span class="p">(</span><span class="s2">&quot;Products&quot;</span><span class="p">,</span> <span class="s2">&quot;span.title&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s1">&#39;button[name*=&quot;backpack&quot;]&#39;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s2">&quot;#shopping_cart_container a&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">assert_exact_text</span><span class="p">(</span><span class="s2">&quot;Your Cart&quot;</span><span class="p">,</span> <span class="s2">&quot;span.title&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">assert_text</span><span class="p">(</span><span class="s2">&quot;Backpack&quot;</span><span class="p">,</span> <span class="s2">&quot;div.cart_item&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s2">&quot;button#checkout&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s2">&quot;#first-name&quot;</span><span class="p">,</span> <span class="s2">&quot;SeleniumBase&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s2">&quot;#last-name&quot;</span><span class="p">,</span> <span class="s2">&quot;Automation&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s2">&quot;#postal-code&quot;</span><span class="p">,</span> <span class="s2">&quot;77123&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s2">&quot;input#continue&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">assert_text</span><span class="p">(</span><span class="s2">&quot;Checkout: Overview&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">assert_text</span><span class="p">(</span><span class="s2">&quot;Backpack&quot;</span><span class="p">,</span> <span class="s2">&quot;div.cart_item&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">assert_text</span><span class="p">(</span><span class="s2">&quot;29.99&quot;</span><span class="p">,</span> <span class="s2">&quot;div.inventory_item_price&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s2">&quot;button#finish&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">assert_exact_text</span><span class="p">(</span><span class="s2">&quot;Thank you for your order!&quot;</span><span class="p">,</span> <span class="s2">&quot;h2&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">assert_element</span><span class="p">(</span><span class="s1">&#39;img[alt=&quot;Pony Express&quot;]&#39;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">js_click</span><span class="p">(</span><span class="s2">&quot;a#logout_sidebar_link&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">assert_element</span><span class="p">(</span><span class="s2">&quot;div#login_button_container&quot;</span><span class="p">)</span>
</code></pre></div>
<ul>
<li>By default, <strong><a href="https://www.w3schools.com/cssref/css_selectors.asp">CSS Selectors</a></strong> are used for finding page elements.</li>
<li>If you're new to CSS Selectors, games like <a href="http://flukeout.github.io/">CSS Diner</a> can help you learn.</li>
<li>For more reading, <a href="https://developer.mozilla.org/en-US/docs/Web/CSS/Attribute_selectors">here's an advanced guide on CSS attribute selectors</a>.</li>
</ul>
<p><a id="common_methods"></a></p>
<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Here are some common SeleniumBase methods:</h3>

<div class="highlight"><pre><span></span><code><span class="bp">self</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>  <span class="c1"># Navigate the browser window to the URL.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="n">selector</span><span class="p">,</span> <span class="n">text</span><span class="p">)</span>  <span class="c1"># Update the field with the text.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>  <span class="c1"># Click the element with the selector.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">click_link</span><span class="p">(</span><span class="n">link_text</span><span class="p">)</span>  <span class="c1"># Click the link containing text.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">go_back</span><span class="p">()</span>  <span class="c1"># Navigate back to the previous URL.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">select_option_by_text</span><span class="p">(</span><span class="n">dropdown_selector</span><span class="p">,</span> <span class="n">option</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">hover_and_click</span><span class="p">(</span><span class="n">hover_selector</span><span class="p">,</span> <span class="n">click_selector</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">drag_and_drop</span><span class="p">(</span><span class="n">drag_selector</span><span class="p">,</span> <span class="n">drop_selector</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_text</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>  <span class="c1"># Get the text from the element.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_current_url</span><span class="p">()</span>  <span class="c1"># Get the URL of the current page.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_page_source</span><span class="p">()</span>  <span class="c1"># Get the HTML of the current page.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_attribute</span><span class="p">(</span><span class="n">selector</span><span class="p">,</span> <span class="n">attribute</span><span class="p">)</span>  <span class="c1"># Get element attribute.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_title</span><span class="p">()</span>  <span class="c1"># Get the title of the current page.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">switch_to_frame</span><span class="p">(</span><span class="n">frame</span><span class="p">)</span>  <span class="c1"># Switch into the iframe container.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">switch_to_default_content</span><span class="p">()</span>  <span class="c1"># Leave the iframe container.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">open_new_window</span><span class="p">()</span>  <span class="c1"># Open a new window in the same browser.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">switch_to_window</span><span class="p">(</span><span class="n">window</span><span class="p">)</span>  <span class="c1"># Switch to the browser window.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">switch_to_default_window</span><span class="p">()</span>  <span class="c1"># Switch to the original window.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">get_new_driver</span><span class="p">(</span><span class="n">OPTIONS</span><span class="p">)</span>  <span class="c1"># Open a new driver with OPTIONS.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">switch_to_driver</span><span class="p">(</span><span class="n">driver</span><span class="p">)</span>  <span class="c1"># Switch to the browser driver.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">switch_to_default_driver</span><span class="p">()</span>  <span class="c1"># Switch to the original driver.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">wait_for_element</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>  <span class="c1"># Wait until element is visible.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">is_element_visible</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>  <span class="c1"># Return element visibility.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">is_text_visible</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">selector</span><span class="p">)</span>  <span class="c1"># Return text visibility.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="n">seconds</span><span class="p">)</span>  <span class="c1"># Do nothing for the given amount of time.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">save_screenshot</span><span class="p">(</span><span class="n">name</span><span class="p">)</span>  <span class="c1"># Save a screenshot in .png format.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assert_element</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>  <span class="c1"># Verify the element is visible.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assert_text</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">selector</span><span class="p">)</span>  <span class="c1"># Verify text in the element.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assert_exact_text</span><span class="p">(</span><span class="n">text</span><span class="p">,</span> <span class="n">selector</span><span class="p">)</span>  <span class="c1"># Verify text is exact.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assert_title</span><span class="p">(</span><span class="n">title</span><span class="p">)</span>  <span class="c1"># Verify the title of the web page.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assert_downloaded_file</span><span class="p">(</span><span class="n">file</span><span class="p">)</span>  <span class="c1"># Verify file was downloaded.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assert_no_404_errors</span><span class="p">()</span>  <span class="c1"># Verify there are no broken links.</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assert_no_js_errors</span><span class="p">()</span>  <span class="c1"># Verify there are no JS errors.</span>
</code></pre></div>
<p>🔵 For the complete list of SeleniumBase methods, see: <b><a href="help_docs/method_summary/">Method Summary</a></b></p>
<p><a id="fun_facts"></a></p>
<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 customize tests via <a href="help_docs/customizing_test_runs/">command-line options</a>.</p>

<p>✅ SeleniumBase uses simple syntax for commands. Example:</p>

<div class="highlight"><pre><span></span><code><span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s2">&quot;input&quot;</span><span class="p">,</span> <span class="s2">&quot;dogs</span><span class="se">\n</span><span class="s2">&quot;</span><span class="p">)</span>  <span class="c1"># (The &quot;\n&quot; presses ENTER)</span>
</code></pre></div>
<p>Most SeleniumBase scripts can be run with <code translate="no">pytest</code>, <code translate="no">pynose</code>, or pure <code translate="no">python</code>. Not all test runners can run all test formats. For example, tests that use the <code>sb</code> pytest fixture can only be run with <code>pytest</code>. (See <a href="help_docs/syntax_formats/">Syntax Formats</a>) There's also a <a href="https://behave.readthedocs.io/en/stable/gherkin.html#features" target="_blank">Gherkin</a> test format that runs with <a href="examples/behave_bdd/ReadMe/">behave</a>.</p>
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>coffee_cart_tests.py<span class="w"> </span>--rs
pytest<span class="w"> </span>test_sb_fixture.py<span class="w"> </span>--demo
pytest<span class="w"> </span>test_suite.py<span class="w"> </span>--rs<span class="w"> </span>--html<span class="o">=</span>report.html<span class="w"> </span>--dashboard

pynose<span class="w"> </span>basic_test.py<span class="w"> </span>--mobile
pynose<span class="w"> </span>test_suite.py<span class="w"> </span>--headless<span class="w"> </span>--report<span class="w"> </span>--show-report

python<span class="w"> </span>raw_sb.py
python<span class="w"> </span>raw_test_scripts.py

behave<span class="w"> </span>realworld.feature
behave<span class="w"> </span>calculator.feature<span class="w"> </span>-D<span class="w"> </span>rs<span class="w"> </span>-D<span class="w"> </span>dashboard
</code></pre></div>
<p>✅ <code translate="no">pytest</code> includes automatic test discovery. If you don't specify a specific file or folder to run, <code translate="no">pytest</code> will automatically search through all subdirectories for tests to run based on the following criteria:</p>

<ul>
<li>Python files that start with <code>test_</code> or end with <code>_test.py</code>.</li>
<li>Python methods that start with <code>test_</code>.</li>
</ul>
<p>With a SeleniumBase <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/pytest.ini">pytest.ini</a> file present, you can modify default discovery settings. The Python class name can be anything because <code>seleniumbase.BaseCase</code> inherits <code>unittest.TestCase</code> to trigger autodiscovery.</p>
<p>✅ You can do a pre-flight check to see which tests would get discovered by <code translate="no">pytest</code> before the actual run:</p>

<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>--co<span class="w"> </span>-q
</code></pre></div>
<p>✅ You can be more specific when calling <code translate="no">pytest</code> or <code translate="no">pynose</code> on a file:</p>

<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span><span class="o">[</span>FILE_NAME.py<span class="o">]</span>::<span class="o">[</span>CLASS_NAME<span class="o">]</span>::<span class="o">[</span>METHOD_NAME<span class="o">]</span>

pynose<span class="w"> </span><span class="o">[</span>FILE_NAME.py<span class="o">]</span>:<span class="o">[</span>CLASS_NAME<span class="o">]</span>.<span class="o">[</span>METHOD_NAME<span class="o">]</span>
</code></pre></div>
<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 translate="no">time.sleep()</code></span> statements</b> in your scripts.</p>
<p><img src="https://img.shields.io/badge/Flaky%20Tests%3F-%20NO%21-11BBDD.svg" alt="NO MORE FLAKY TESTS!" /></p>
<p>✅ SeleniumBase supports all major browsers and operating systems:</p>
<p><b>Browsers:</b> Chrome, Edge, Firefox, and Safari.</p>
<p><b>Systems:</b> Linux/Ubuntu, macOS, and Windows.</p>

<p>✅ SeleniumBase works on all popular CI/CD platforms:</p>
<p><a href="integrations/github/workflows/ReadMe/"><img alt="GitHub Actions integration" src="https://img.shields.io/badge/GitHub_Actions-12B2C2.svg?logo=GitHubActions&logoColor=CFFFC2" /></a> <a href="integrations/azure/jenkins/ReadMe/"><img alt="Jenkins integration" src="https://img.shields.io/badge/Jenkins-32B242.svg?logo=jenkins&logoColor=white" /></a> <a href="integrations/azure/azure_pipelines/ReadMe/"><img alt="Azure integration" src="https://img.shields.io/badge/Azure-2288EE.svg?logo=AzurePipelines&logoColor=white" /></a> <a href="integrations/google_cloud/ReadMe/"><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="examples/master_qa/ReadMe/">MasterQA</a></b> to speed up manual testing with automation while manual testers handle validation.</p>

<p>✅ SeleniumBase supports <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/offline_examples">running tests while offline</a> (<i>assuming webdrivers have previously been downloaded when online</i>).</p>

<p>✅ For a full list of SeleniumBase features, <a href="help_docs/features_list/">Click Here</a>.</p>

<p><a id="demo_mode_and_debugging"></a></p>
<h2><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Demo Mode / Debugging:</h2>

<p>🔵 <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> to pause the browser briefly between actions, highlight page elements being acted on, and display assertions:</p>
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>my_first_test.py<span class="w"> </span>--demo
</code></pre></div>
<p>🔵 <code>time.sleep(seconds)</code> can be used to make a test wait at a specific spot:</p>
<div class="highlight"><pre><span></span><code><span class="kn">import</span><span class="w"> </span><span class="nn">time</span><span class="p">;</span> <span class="n">time</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mi">3</span><span class="p">)</span>  <span class="c1"># Do nothing for 3 seconds.</span>
</code></pre></div>
<p>🔵 <strong>Debug Mode</strong> with Python's built-in <strong><a href="https://docs.python.org/3/library/pdb.html">pdb</a></strong> library helps you debug tests:</p>
<div class="highlight"><pre><span></span><code><span class="kn">import</span><span class="w"> </span><span class="nn">pdb</span><span class="p">;</span> <span class="n">pdb</span><span class="o">.</span><span class="n">set_trace</span><span class="p">()</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">pytest</span><span class="p">;</span> <span class="n">pytest</span><span class="o">.</span><span class="n">set_trace</span><span class="p">()</span>
<span class="nb">breakpoint</span><span class="p">()</span>  <span class="c1"># Shortcut for &quot;import pdb; pdb.set_trace()&quot;</span>
</code></pre></div>
<blockquote>
<p>(<strong><code>pdb</code></strong> commands: <code>n</code>, <code>c</code>, <code>s</code>, <code>u</code>, <code>d</code> =&gt; <code>next</code>, <code>continue</code>, <code>step</code>, <code>up</code>, <code>down</code>)</p>
</blockquote>
<p>🔵 To pause an active test that throws an exception or error, (<em>and keep the browser window open while </em><em>Debug Mode</em><em> begins in the console</em>), add <strong><code>--pdb</code></strong> as a <code>pytest</code> option:</p>
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>test_fail.py<span class="w"> </span>--pdb
</code></pre></div>
<p>🔵 To start tests in Debug Mode, add <strong><code>--trace</code></strong> as a <code>pytest</code> option:</p>
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>test_coffee_cart.py<span class="w"> </span>--trace
</code></pre></div>
<p><a href="https://github.com/mdmintz/pdbp"><img src="https://seleniumbase.github.io/cdn/gif/coffee_pdbp.gif" alt="SeleniumBase test with the pdbp (Pdb+) debugger" title="SeleniumBase test with the pdbp (Pdb+) debugger" /></a></p>
<p><a id="command_line_options"></a></p>
<h2>🔵 Command-line Options:</h2>

<p><a id="pytest_options"></a>
✅ Here are some useful command-line options that come with <code translate="no">pytest</code>:</p>
<div class="highlight"><pre><span></span><code>-v<span class="w">  </span><span class="c1"># Verbose mode. Prints the full name of each test and shows more details.</span>
-q<span class="w">  </span><span class="c1"># Quiet mode. Print fewer details in the console output when running tests.</span>
-x<span class="w">  </span><span class="c1"># Stop running the tests after the first failure is reached.</span>
--html<span class="o">=</span>report.html<span class="w">  </span><span class="c1"># Creates a detailed pytest-html report after tests finish.</span>
--co<span class="w"> </span><span class="p">|</span><span class="w"> </span>--collect-only<span class="w">  </span><span class="c1"># Show what tests would get run. (Without running them)</span>
--co<span class="w"> </span>-q<span class="w">  </span><span class="c1"># (Both options together!) - Do a dry run with full test names shown.</span>
-n<span class="o">=</span>NUM<span class="w">  </span><span class="c1"># Multithread the tests using that many threads. (Speed up test runs!)</span>
-s<span class="w">  </span><span class="c1"># See print statements. (Should be on by default with pytest.ini present.)</span>
--junit-xml<span class="o">=</span>report.xml<span class="w">  </span><span class="c1"># Creates a junit-xml report after tests finish.</span>
--pdb<span class="w">  </span><span class="c1"># If a test fails, enter Post Mortem Debug Mode. (Don&#39;t use with CI!)</span>
--trace<span class="w">  </span><span class="c1"># Enter Debug Mode at the beginning of each test. (Don&#39;t use with CI!)</span>
-m<span class="o">=</span>MARKER<span class="w">  </span><span class="c1"># Run tests with the specified pytest marker.</span>
</code></pre></div>
<p><a id="new_pytest_options"></a>
✅ SeleniumBase provides additional <code translate="no">pytest</code> command-line options for tests:</p>
<div class="highlight"><pre><span></span><code>--browser<span class="o">=</span>BROWSER<span class="w">  </span><span class="c1"># (The web browser to use. Default: &quot;chrome&quot;.)</span>
--chrome<span class="w">  </span><span class="c1"># (Shortcut for &quot;--browser=chrome&quot;. On by default.)</span>
--edge<span class="w">  </span><span class="c1"># (Shortcut for &quot;--browser=edge&quot;.)</span>
--firefox<span class="w">  </span><span class="c1"># (Shortcut for &quot;--browser=firefox&quot;.)</span>
--safari<span class="w">  </span><span class="c1"># (Shortcut for &quot;--browser=safari&quot;.)</span>
--settings-file<span class="o">=</span>FILE<span class="w">  </span><span class="c1"># (Override default SeleniumBase settings.)</span>
--env<span class="o">=</span>ENV<span class="w">  </span><span class="c1"># (Set the test env. Access with &quot;self.env&quot; in tests.)</span>
--account<span class="o">=</span>STR<span class="w">  </span><span class="c1"># (Set account. Access with &quot;self.account&quot; in tests.)</span>
--data<span class="o">=</span>STRING<span class="w">  </span><span class="c1"># (Extra test data. Access with &quot;self.data&quot; in tests.)</span>
--var1<span class="o">=</span>STRING<span class="w">  </span><span class="c1"># (Extra test data. Access with &quot;self.var1&quot; in tests.)</span>
--var2<span class="o">=</span>STRING<span class="w">  </span><span class="c1"># (Extra test data. Access with &quot;self.var2&quot; in tests.)</span>
--var3<span class="o">=</span>STRING<span class="w">  </span><span class="c1"># (Extra test data. Access with &quot;self.var3&quot; in tests.)</span>
--variables<span class="o">=</span>DICT<span class="w">  </span><span class="c1"># (Extra test data. Access with &quot;self.variables&quot;.)</span>
--user-data-dir<span class="o">=</span>DIR<span class="w">  </span><span class="c1"># (Set the Chrome user data directory to use.)</span>
--protocol<span class="o">=</span>PROTOCOL<span class="w">  </span><span class="c1"># (The Selenium Grid protocol: http|https.)</span>
--server<span class="o">=</span>SERVER<span class="w">  </span><span class="c1"># (The Selenium Grid server/IP used for tests.)</span>
--port<span class="o">=</span>PORT<span class="w">  </span><span class="c1"># (The Selenium Grid port used by the test server.)</span>
--cap-file<span class="o">=</span>FILE<span class="w">  </span><span class="c1"># (The web browser&#39;s desired capabilities to use.)</span>
--cap-string<span class="o">=</span>STRING<span class="w">  </span><span class="c1"># (The web browser&#39;s desired capabilities to use.)</span>
--proxy<span class="o">=</span>SERVER:PORT<span class="w">  </span><span class="c1"># (Connect to a proxy server:port as tests are running)</span>
--proxy<span class="o">=</span>USERNAME:PASSWORD@SERVER:PORT<span class="w">  </span><span class="c1"># (Use an authenticated proxy server)</span>
--proxy-bypass-list<span class="o">=</span>STRING<span class="w"> </span><span class="c1"># (&quot;;&quot;-separated hosts to bypass, Eg &quot;*.foo.com&quot;)</span>
--proxy-pac-url<span class="o">=</span>URL<span class="w">  </span><span class="c1"># (Connect to a proxy server using a PAC_URL.pac file.)</span>
--proxy-pac-url<span class="o">=</span>USERNAME:PASSWORD@URL<span class="w">  </span><span class="c1"># (Authenticated proxy with PAC URL.)</span>
--proxy-driver<span class="w">  </span><span class="c1"># (If a driver download is needed, will use: --proxy=PROXY.)</span>
--multi-proxy<span class="w">  </span><span class="c1"># (Allow multiple authenticated proxies when multi-threaded.)</span>
--agent<span class="o">=</span>STRING<span class="w">  </span><span class="c1"># (Modify the web browser&#39;s User-Agent string.)</span>
--mobile<span class="w">  </span><span class="c1"># (Use the mobile device emulator while running tests.)</span>
--metrics<span class="o">=</span>STRING<span class="w">  </span><span class="c1"># (Set mobile metrics: &quot;CSSWidth,CSSHeight,PixelRatio&quot;.)</span>
--chromium-arg<span class="o">=</span><span class="s2">&quot;ARG=N,ARG2&quot;</span><span class="w">  </span><span class="c1"># (Set Chromium args, &quot;,&quot;-separated, no spaces.)</span>
--firefox-arg<span class="o">=</span><span class="s2">&quot;ARG=N,ARG2&quot;</span><span class="w">  </span><span class="c1"># (Set Firefox args, comma-separated, no spaces.)</span>
--firefox-pref<span class="o">=</span>SET<span class="w">  </span><span class="c1"># (Set a Firefox preference:value set, comma-separated.)</span>
--extension-zip<span class="o">=</span>ZIP<span class="w">  </span><span class="c1"># (Load a Chrome Extension .zip|.crx, comma-separated.)</span>
--extension-dir<span class="o">=</span>DIR<span class="w">  </span><span class="c1"># (Load a Chrome Extension directory, comma-separated.)</span>
--disable-features<span class="o">=</span><span class="s2">&quot;F1,F2&quot;</span><span class="w">  </span><span class="c1"># (Disable features, comma-separated, no spaces.)</span>
--binary-location<span class="o">=</span>PATH<span class="w">  </span><span class="c1"># (Set path of the Chromium browser binary to use.)</span>
--driver-version<span class="o">=</span>VER<span class="w">  </span><span class="c1"># (Set the chromedriver or uc_driver version to use.)</span>
--sjw<span class="w">  </span><span class="c1"># (Skip JS Waits for readyState to be &quot;complete&quot; or Angular to load.)</span>
--wfa<span class="w">  </span><span class="c1"># (Wait for AngularJS to be done loading after specific web actions.)</span>
--pls<span class="o">=</span>PLS<span class="w">  </span><span class="c1"># (Set pageLoadStrategy on Chrome: &quot;normal&quot;, &quot;eager&quot;, or &quot;none&quot;.)</span>
--headless<span class="w">  </span><span class="c1"># (The default headless mode. Linux uses this mode by default.)</span>
--headless1<span class="w">  </span><span class="c1"># (Use Chrome&#39;s old headless mode. Fast, but has limitations.)</span>
--headless2<span class="w">  </span><span class="c1"># (Use Chrome&#39;s new headless mode, which supports extensions.)</span>
--headed<span class="w">  </span><span class="c1"># (Run tests in headed/GUI mode on Linux OS, where not default.)</span>
--xvfb<span class="w">  </span><span class="c1"># (Run tests using the Xvfb virtual display server on Linux OS.)</span>
--xvfb-metrics<span class="o">=</span>STRING<span class="w">  </span><span class="c1"># (Set Xvfb display size on Linux: &quot;Width,Height&quot;.)</span>
--locale<span class="o">=</span>LOCALE_CODE<span class="w">  </span><span class="c1"># (Set the Language Locale Code for the web browser.)</span>
--interval<span class="o">=</span>SECONDS<span class="w">  </span><span class="c1"># (The autoplay interval for presentations &amp; tour steps)</span>
--start-page<span class="o">=</span>URL<span class="w">  </span><span class="c1"># (The starting URL for the web browser when tests begin.)</span>
--archive-logs<span class="w">  </span><span class="c1"># (Archive existing log files instead of deleting them.)</span>
--archive-downloads<span class="w">  </span><span class="c1"># (Archive old downloads instead of deleting them.)</span>
--time-limit<span class="o">=</span>SECONDS<span class="w">  </span><span class="c1"># (Safely fail any test that exceeds the time limit.)</span>
--slow<span class="w">  </span><span class="c1"># (Slow down the automation. Faster than using Demo Mode.)</span>
--demo<span class="w">  </span><span class="c1"># (Slow down and visually see test actions as they occur.)</span>
--demo-sleep<span class="o">=</span>SECONDS<span class="w">  </span><span class="c1"># (Set the wait time after Slow &amp; Demo Mode actions.)</span>
--highlights<span class="o">=</span>NUM<span class="w">  </span><span class="c1"># (Number of highlight animations for Demo Mode actions.)</span>
--message-duration<span class="o">=</span>SECONDS<span class="w">  </span><span class="c1"># (The time length for Messenger alerts.)</span>
--check-js<span class="w">  </span><span class="c1"># (Check for JavaScript errors after page loads.)</span>
--ad-block<span class="w">  </span><span class="c1"># (Block some types of display ads from loading.)</span>
--host-resolver-rules<span class="o">=</span>RULES<span class="w">  </span><span class="c1"># (Set host-resolver-rules, comma-separated.)</span>
--block-images<span class="w">  </span><span class="c1"># (Block images from loading during tests.)</span>
--do-not-track<span class="w">  </span><span class="c1"># (Indicate to websites that you don&#39;t want to be tracked.)</span>
--verify-delay<span class="o">=</span>SECONDS<span class="w">  </span><span class="c1"># (The delay before MasterQA verification checks.)</span>
--ee<span class="w"> </span><span class="p">|</span><span class="w"> </span>--esc-end<span class="w">  </span><span class="c1"># (Lets the user end the current test via the ESC key.)</span>
--recorder<span class="w">  </span><span class="c1"># (Enables the Recorder for turning browser actions into code.)</span>
--rec-behave<span class="w">  </span><span class="c1"># (Same as Recorder Mode, but also generates behave-gherkin.)</span>
--rec-sleep<span class="w">  </span><span class="c1"># (If the Recorder is enabled, also records self.sleep calls.)</span>
--rec-print<span class="w">  </span><span class="c1"># (If the Recorder is enabled, prints output after tests end.)</span>
--disable-cookies<span class="w">  </span><span class="c1"># (Disable Cookies on websites. Pages might break!)</span>
--disable-js<span class="w">  </span><span class="c1"># (Disable JavaScript on websites. Pages might break!)</span>
--disable-csp<span class="w">  </span><span class="c1"># (Disable the Content Security Policy of websites.)</span>
--disable-ws<span class="w">  </span><span class="c1"># (Disable Web Security on Chromium-based browsers.)</span>
--enable-ws<span class="w">  </span><span class="c1"># (Enable Web Security on Chromium-based browsers.)</span>
--enable-sync<span class="w">  </span><span class="c1"># (Enable &quot;Chrome Sync&quot; on websites.)</span>
--uc<span class="w"> </span><span class="p">|</span><span class="w"> </span>--undetected<span class="w">  </span><span class="c1"># (Use undetected-chromedriver to evade bot-detection.)</span>
--uc-cdp-events<span class="w">  </span><span class="c1"># (Capture CDP events when running in &quot;--undetected&quot; mode.)</span>
--log-cdp<span class="w">  </span><span class="c1"># (&quot;goog:loggingPrefs&quot;, {&quot;performance&quot;: &quot;ALL&quot;, &quot;browser&quot;: &quot;ALL&quot;})</span>
--remote-debug<span class="w">  </span><span class="c1"># (Sync to Chrome Remote Debugger chrome://inspect/#devices)</span>
--ftrace<span class="w"> </span><span class="p">|</span><span class="w"> </span>--final-trace<span class="w">  </span><span class="c1"># (Debug Mode after each test. Don&#39;t use with CI!)</span>
--dashboard<span class="w">  </span><span class="c1"># (Enable the SeleniumBase Dashboard. Saved at: dashboard.html)</span>
--dash-title<span class="o">=</span>STRING<span class="w">  </span><span class="c1"># (Set the title shown for the generated dashboard.)</span>
--enable-3d-apis<span class="w">  </span><span class="c1"># (Enables WebGL and 3D APIs.)</span>
--swiftshader<span class="w">  </span><span class="c1"># (Chrome &quot;--use-gl=angle&quot; / &quot;--use-angle=swiftshader-webgl&quot;)</span>
--incognito<span class="w">  </span><span class="c1"># (Enable Chrome&#39;s Incognito mode.)</span>
--guest<span class="w">  </span><span class="c1"># (Enable Chrome&#39;s Guest mode.)</span>
--dark<span class="w">  </span><span class="c1"># (Enable Chrome&#39;s Dark mode.)</span>
--devtools<span class="w">  </span><span class="c1"># (Open Chrome&#39;s DevTools when the browser opens.)</span>
--rs<span class="w"> </span><span class="p">|</span><span class="w"> </span>--reuse-session<span class="w">  </span><span class="c1"># (Reuse browser session for all tests.)</span>
--rcs<span class="w"> </span><span class="p">|</span><span class="w"> </span>--reuse-class-session<span class="w">  </span><span class="c1"># (Reuse session for tests in class.)</span>
--crumbs<span class="w">  </span><span class="c1"># (Delete all cookies between tests reusing a session.)</span>
--disable-beforeunload<span class="w">  </span><span class="c1"># (Disable the &quot;beforeunload&quot; event on Chrome.)</span>
--window-position<span class="o">=</span>X,Y<span class="w">  </span><span class="c1"># (Set the browser&#39;s starting window position.)</span>
--window-size<span class="o">=</span>WIDTH,HEIGHT<span class="w">  </span><span class="c1"># (Set the browser&#39;s starting window size.)</span>
--maximize<span class="w">  </span><span class="c1"># (Start tests with the browser window maximized.)</span>
--screenshot<span class="w">  </span><span class="c1"># (Save a screenshot at the end of each test.)</span>
--no-screenshot<span class="w">  </span><span class="c1"># (No screenshots saved unless tests directly ask it.)</span>
--visual-baseline<span class="w">  </span><span class="c1"># (Set the visual baseline for Visual/Layout tests.)</span>
--wire<span class="w">  </span><span class="c1"># (Use selenium-wire&#39;s webdriver for replacing selenium webdriver.)</span>
--external-pdf<span class="w">  </span><span class="c1"># (Set Chromium &quot;plugins.always_open_pdf_externally&quot;:True.)</span>
--timeout-multiplier<span class="o">=</span>MULTIPLIER<span class="w">  </span><span class="c1"># (Multiplies the default timeout values.)</span>
--list-fail-page<span class="w">  </span><span class="c1"># (After each failing test, list the URL of the failure.)</span>
</code></pre></div>
<p>(See the full list of command-line option definitions <strong><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/plugins/pytest_plugin.py">here</a></strong>. For detailed examples of command-line options, see <strong><a href="help_docs/customizing_test_runs/">customizing_test_runs.md</a></strong>)</p>
<hr />
<p>🔵 During test failures, logs and screenshots from the most recent test run will get saved to the <code>latest_logs/</code> folder. Those logs will get moved to <code>archived_logs/</code> if you add --archive_logs to command-line options, or have <code>ARCHIVE_EXISTING_LOGS</code> set to True in <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py">settings.py</a>, otherwise log files with be cleaned up at the start of the next test run. The <code>test_suite.py</code> collection contains tests that fail on purpose so that you can see how logging works.</p>
<div class="highlight"><pre><span></span><code><span class="nb">cd</span><span class="w"> </span>examples/

pytest<span class="w"> </span>test_suite.py<span class="w"> </span>--chrome

pytest<span class="w"> </span>test_suite.py<span class="w"> </span>--firefox
</code></pre></div>
<p>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 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/custom_settings.py">examples/custom_settings.py</a>)
<code>--settings_file=custom_settings.py</code>
(Settings include default timeout values, a two-factor auth key, DB credentials, S3 credentials, and other important settings used by tests.)</p>
<p>🔵 To pass additional data from the command-line to tests, add <code>--data="ANY STRING"</code>.
Inside your tests, you can use <code>self.data</code> to access that.</p>
<p><a id="directory_configuration"></a></p>
<h2><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Directory Configuration:</h2>

<p>🔵 When running tests with <strong><code>pytest</code></strong>, you'll want a copy of <strong><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/pytest.ini">pytest.ini</a></strong> in your root folders. When running tests with <strong><code>pynose</code></strong>, you'll want a copy of <strong><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/setup.cfg">setup.cfg</a></strong> in your root folders. These files specify default configuration details for tests. Test folders should also include a blank <strong><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/offline_examples/__init__.py"><strong>init</strong>.py</a></strong> file to allow your test files to import other files from that folder.</p>
<p>🔵 <code>sbase mkdir DIR</code> creates a folder with config files and sample tests:</p>
<div class="highlight"><pre><span></span><code>sbase<span class="w"> </span>mkdir<span class="w"> </span>ui_tests
</code></pre></div>
<blockquote>
<p>That new folder will have these files:</p>
</blockquote>
<div class="highlight"><pre><span></span><code>ui_tests/
├──<span class="w"> </span>__init__.py
├──<span class="w"> </span>my_first_test.py
├──<span class="w"> </span>parameterized_test.py
├──<span class="w"> </span>pytest.ini
├──<span class="w"> </span>requirements.txt
├──<span class="w"> </span>setup.cfg
├──<span class="w"> </span>test_demo_site.py
└──<span class="w"> </span>boilerplates/
<span class="w">    </span>├──<span class="w"> </span>__init__.py
<span class="w">    </span>├──<span class="w"> </span>base_test_case.py
<span class="w">    </span>├──<span class="w"> </span>boilerplate_test.py
<span class="w">    </span>├──<span class="w"> </span>classic_obj_test.py
<span class="w">    </span>├──<span class="w"> </span>page_objects.py
<span class="w">    </span>├──<span class="w"> </span>sb_fixture_test.py
<span class="w">    </span>└──<span class="w"> </span>samples/
<span class="w">        </span>├──<span class="w"> </span>__init__.py
<span class="w">        </span>├──<span class="w"> </span>google_objects.py
<span class="w">        </span>├──<span class="w"> </span>google_test.py
<span class="w">        </span>├──<span class="w"> </span>sb_swag_test.py
<span class="w">        </span>└──<span class="w"> </span>swag_labs_test.py
</code></pre></div>
<p><b>ProTip™:</b> You can also create a boilerplate folder without any sample tests in it by adding <code>-b</code> or <code>--basic</code> to the <code>sbase mkdir</code> command:</p>
<div class="highlight"><pre><span></span><code>sbase<span class="w"> </span>mkdir<span class="w"> </span>ui_tests<span class="w"> </span>--basic
</code></pre></div>
<blockquote>
<p>That new folder will have these files:</p>
</blockquote>
<div class="highlight"><pre><span></span><code>ui_tests/
├──<span class="w"> </span>__init__.py
├──<span class="w"> </span>pytest.ini
├──<span class="w"> </span>requirements.txt
└──<span class="w"> </span>setup.cfg
</code></pre></div>
<p>Of those files, the <code>pytest.ini</code> config file is the most important, followed by a blank <code>__init__.py</code> file. There's also a <code>setup.cfg</code> file (for pynose). Finally, the <code>requirements.txt</code> file can be used to help you install seleniumbase into your environments (if it's not already installed).</p>
<hr />
<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Log files from failed tests:</h3>

<p>Let's try an example of a test that fails:</p>
<div class="highlight"><pre><span></span><code><span class="sd">&quot;&quot;&quot; test_fail.py &quot;&quot;&quot;</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">seleniumbase</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseCase</span>
<span class="n">BaseCase</span><span class="o">.</span><span class="n">main</span><span class="p">(</span><span class="vm">__name__</span><span class="p">,</span> <span class="vm">__file__</span><span class="p">)</span>

<span class="k">class</span><span class="w"> </span><span class="nc">MyTestClass</span><span class="p">(</span><span class="n">BaseCase</span><span class="p">):</span>

    <span class="k">def</span><span class="w"> </span><span class="nf">test_find_army_of_robots_on_xkcd_desert_island</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s2">&quot;https://xkcd.com/731/&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">assert_element</span><span class="p">(</span><span class="s2">&quot;div#ARMY_OF_ROBOTS&quot;</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>  <span class="c1"># This should fail</span>
</code></pre></div>
<p>You can run it from the <code>examples/</code> folder like this:</p>
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>test_fail.py
</code></pre></div>
<p>🔵 You'll notice that a logs folder, <code>./latest_logs/</code>, was created to hold information (and screenshots) about the failing test. During test runs, past results get moved to the archived_logs folder if you have ARCHIVE_EXISTING_LOGS set to True in <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/settings.py">settings.py</a>, or if your run tests with <code>--archive-logs</code>. If you choose not to archive existing logs, they will be deleted and replaced by the logs of the latest test run.</p>
<hr />
<p><a id="seleniumbase_dashboard"></a></p>
<h2><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> SeleniumBase Dashboard:</h2>

<p>🔵 The <code>--dashboard</code> option for pytest generates a SeleniumBase Dashboard located at <code>dashboard.html</code>, which updates automatically as tests run and produce results. Example:</p>
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>--dashboard<span class="w"> </span>--rs<span class="w"> </span>--headless
</code></pre></div>
<p><img src="https://seleniumbase.github.io/cdn/img/dashboard_1.png" alt="The SeleniumBase Dashboard" title="The SeleniumBase Dashboard" width="380" /></p>
<p>🔵 Additionally, you can host your own SeleniumBase Dashboard Server on a port of your choice. Here's an example of that using Python's <code>http.server</code>:</p>
<div class="highlight"><pre><span></span><code>python<span class="w"> </span>-m<span class="w"> </span>http.server<span class="w"> </span><span class="m">1948</span>
</code></pre></div>
<p>🔵 Now you can navigate to <code>http://localhost:1948/dashboard.html</code> 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 <kbd>Ctrl+C</kbd> to stop the http server.)</p>
<p>🔵 Here's a full example of what the SeleniumBase Dashboard may look like:</p>
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>test_suite.py<span class="w"> </span>test_image_saving.py<span class="w"> </span>--dashboard<span class="w"> </span>--rs<span class="w"> </span>--headless
</code></pre></div>
<p><img src="https://seleniumbase.github.io/cdn/img/dashboard_2.png" alt="The SeleniumBase Dashboard" title="The SeleniumBase Dashboard" width="520" /></p>
<hr />
<p><a id="creating_visual_reports"></a></p>
<h2><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Generating Test Reports:</h2>

<h3>🔵 <code>pytest</code> HTML Reports:</h3>

<p>✅ Using <code>--html=report.html</code> gives you a fancy report of the name specified after your test suite completes.</p>
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>test_suite.py<span class="w"> </span>--html<span class="o">=</span>report.html
</code></pre></div>
<p><img src="https://seleniumbase.github.io/cdn/img/html_report.png" alt="Example Pytest Report" title="Example Pytest Report" width="520" /></p>
<p>✅ 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: <code>--dashboard --html=dashboard.html</code>), then the Dashboard will become an advanced html report when all the tests complete.</p>
<p>✅ Here's an example of an upgraded html report:</p>
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>test_suite.py<span class="w"> </span>--dashboard<span class="w"> </span>--html<span class="o">=</span>report.html
</code></pre></div>
<p><img src="https://seleniumbase.github.io/cdn/img/dash_report.jpg" alt="Dashboard Pytest HTML Report" title="Dashboard Pytest HTML Report" width="520" /></p>
<p>If viewing pytest html reports in <a href="https://www.jenkins.io/">Jenkins</a>, you may need to <a href="https://stackoverflow.com/a/46197356/7058266">configure Jenkins settings</a> for the html to render correctly. This is due to <a href="https://www.jenkins.io/doc/book/system-administration/security/configuring-content-security-policy/">Jenkins CSP changes</a>.</p>
<p>You can also use <code>--junit-xml=report.xml</code> to get an xml report instead. Jenkins can use this file to display better reporting for your tests.</p>
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>test_suite.py<span class="w"> </span>--junit-xml<span class="o">=</span>report.xml
</code></pre></div>
<h3>🔵 <code>pynose</code> Reports:</h3>

<p>The <code>--report</code> option gives you a fancy report after your test suite completes.</p>
<div class="highlight"><pre><span></span><code>pynose<span class="w"> </span>test_suite.py<span class="w"> </span>--report
</code></pre></div>
<p><img src="https://seleniumbase.github.io/cdn/img/nose_report.png" alt="Example pynose Report" title="Example pynose Report" width="320" /></p>
<p>(NOTE: You can add <code>--show-report</code> to immediately display pynose reports after the test suite completes. Only use <code>--show-report</code> when running tests locally because it pauses the test run.)</p>
<h3>🔵 <code>behave</code> Dashboard & Reports:</h3>

<p>(The <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/behave_bdd">behave_bdd/</a> folder can be found in the <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples">examples/</a> folder.)</p>
<div class="highlight"><pre><span></span><code>behave<span class="w"> </span>behave_bdd/features/<span class="w"> </span>-D<span class="w"> </span>dashboard<span class="w"> </span>-D<span class="w"> </span>headless
</code></pre></div>
<p><img src="https://seleniumbase.github.io/cdn/img/sb_behave_dashboard.png" title="SeleniumBase" width="520"></p>
<p>You can also use <code>--junit</code> to get <code>.xml</code> reports for each <code translate="no">behave</code> feature. Jenkins can use these files to display better reporting for your tests.</p>
<div class="highlight"><pre><span></span><code>behave<span class="w"> </span>behave_bdd/features/<span class="w"> </span>--junit<span class="w"> </span>-D<span class="w"> </span>rs<span class="w"> </span>-D<span class="w"> </span>headless
</code></pre></div>
<h3>🔵 Allure Reports:</h3>

<p>See: <a href="https://allurereport.org/docs/pytest/">https://allurereport.org/docs/pytest/</a></p>
<p>SeleniumBase no longer includes <code>allure-pytest</code> as part of installed dependencies. If you want to use it, install it first:</p>
<div class="highlight"><pre><span></span><code>pip<span class="w"> </span>install<span class="w"> </span>allure-pytest
</code></pre></div>
<p>Now your tests can create Allure results files, which can be processed by Allure Reports.</p>
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>test_suite.py<span class="w"> </span>--alluredir<span class="o">=</span>allure_results
</code></pre></div>
<hr />
<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Using a Proxy Server:</h3>

<p>If you wish to use a proxy server for your browser tests (Chromium or Firefox), you can add <code>--proxy=IP_ADDRESS:PORT</code> as an argument on the command line.</p>
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>proxy_test.py<span class="w"> </span>--proxy<span class="o">=</span>IP_ADDRESS:PORT
</code></pre></div>
<p>If the proxy server that you wish to use requires authentication, you can do the following (Chromium only):</p>
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>proxy_test.py<span class="w"> </span>--proxy<span class="o">=</span>USERNAME:PASSWORD@IP_ADDRESS:PORT
</code></pre></div>
<p>SeleniumBase also supports SOCKS4 and SOCKS5 proxies:</p>
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>proxy_test.py<span class="w"> </span>--proxy<span class="o">=</span><span class="s2">&quot;socks4://IP_ADDRESS:PORT&quot;</span>

pytest<span class="w"> </span>proxy_test.py<span class="w"> </span>--proxy<span class="o">=</span><span class="s2">&quot;socks5://IP_ADDRESS:PORT&quot;</span>
</code></pre></div>
<p>To make things easier, you can add your frequently-used proxies to PROXY_LIST in <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/config/proxy_list.py">proxy_list.py</a>, and then use <code>--proxy=KEY_FROM_PROXY_LIST</code> to use the IP_ADDRESS:PORT of that key.</p>
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>proxy_test.py<span class="w"> </span>--proxy<span class="o">=</span>proxy1
</code></pre></div>
<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Changing the User-Agent:</h3>

<p>🔵 If you wish to change the User-Agent for your browser tests (Chromium and Firefox only), you can add <code>--agent="USER AGENT STRING"</code> as an argument on the command-line.</p>
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>user_agent_test.py<span class="w"> </span>--agent<span class="o">=</span><span class="s2">&quot;Mozilla/5.0 (Nintendo 3DS; U; ; en) Version/1.7412.EU&quot;</span>
</code></pre></div>
<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Handling Pop-Up Alerts:</h3>

<p>🔵 <code translate="no">self.accept_alert()</code> automatically waits for and accepts alert pop-ups. <code translate="no">self.dismiss_alert()</code> automatically waits for and dismisses alert pop-ups. On occasion, some methods like <code translate="no">self.click(SELECTOR)</code> might dismiss a pop-up on its own because they call JavaScript to make sure that the <code translate="no">readyState</code> of the page is <code translate="no">complete</code> before advancing. If you're trying to accept a pop-up that got dismissed this way, use this workaround: Call <code translate="no">self.find_element(SELECTOR).click()</code> instead, (which will let the pop-up remain on the screen), and then use <code translate="no">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.</p>
<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Building Guided Tours for Websites:</h3>

<p>🔵 Learn about <a href="examples/tour_examples/ReadMe/">SeleniumBase Interactive Walkthroughs</a> (in the <code>examples/tour_examples/</code> folder). It's great for prototyping a website onboarding experience.</p>
<p><a id="utilizing_advanced_features"></a></p>
<hr />
<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="integrations/azure/jenkins/ReadMe/">SeleniumBase Jenkins example on Azure</a> or the <a href="integrations/google_cloud/ReadMe/">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="seleniumbase/utilities/selenium_grid/ReadMe/">Selenium Grid ReadMe</a> to help you get started.</li>

<li>If you're using the <a href="help_docs/mysql_installation/">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 translate="no">--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:

<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span><span class="o">[</span>YOUR_TEST_FILE.py<span class="o">]</span><span class="w"> </span>--with-db-reporting<span class="w"> </span>--with-s3-logging
</code></pre></div>

</details>

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

<p>🔵 <strong>Navigating to a web page: (and related commands)</strong></p>
<div class="highlight"><pre><span></span><code><span class="bp">self</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s2">&quot;https://xkcd.com/378/&quot;</span><span class="p">)</span>  <span class="c1"># This method opens the specified page.</span>

<span class="bp">self</span><span class="o">.</span><span class="n">go_back</span><span class="p">()</span>  <span class="c1"># This method navigates the browser to the previous page.</span>

<span class="bp">self</span><span class="o">.</span><span class="n">go_forward</span><span class="p">()</span>  <span class="c1"># This method navigates the browser forward in history.</span>

<span class="bp">self</span><span class="o">.</span><span class="n">refresh_page</span><span class="p">()</span>  <span class="c1"># This method reloads the current page.</span>

<span class="bp">self</span><span class="o">.</span><span class="n">get_current_url</span><span class="p">()</span>  <span class="c1"># This method returns the current page URL.</span>

<span class="bp">self</span><span class="o">.</span><span class="n">get_page_source</span><span class="p">()</span>  <span class="c1"># This method returns the current page source.</span>
</code></pre></div>
<p><b>ProTip™:</b> You can use the <code translate="no">self.get_page_source()</code> method with Python's <code translate="no">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>.)</p>
<div class="highlight"><pre><span></span><code><span class="n">source</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_page_source</span><span class="p">()</span>
<span class="n">head_open_tag</span> <span class="o">=</span> <span class="n">source</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">&#39;&lt;head&gt;&#39;</span><span class="p">)</span>
<span class="n">head_close_tag</span> <span class="o">=</span> <span class="n">source</span><span class="o">.</span><span class="n">find</span><span class="p">(</span><span class="s1">&#39;&lt;/head&gt;&#39;</span><span class="p">,</span> <span class="n">head_open_tag</span><span class="p">)</span>
<span class="n">everything_inside_head</span> <span class="o">=</span> <span class="n">source</span><span class="p">[</span><span class="n">head_open_tag</span><span class="o">+</span><span class="nb">len</span><span class="p">(</span><span class="s1">&#39;&lt;head&gt;&#39;</span><span class="p">):</span><span class="n">head_close_tag</span><span class="p">]</span>
</code></pre></div>
<p>🔵 <strong>Clicking:</strong></p>
<p>To click an element on the page:</p>
<div class="highlight"><pre><span></span><code><span class="bp">self</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s2">&quot;div#my_id&quot;</span><span class="p">)</span>
</code></pre></div>
<p><strong>ProTip™:</strong> In most web browsers, you can right-click on a page and select <code>Inspect Element</code> to see the CSS selector details that you'll need to create your own scripts.</p>
<p>🔵 <strong>Typing Text:</strong></p>
<p><code translate="no">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:</p>
<div class="highlight"><pre><span></span><code><span class="bp">self</span><span class="o">.</span><span class="n">type</span><span class="p">(</span><span class="s2">&quot;input#id_value&quot;</span><span class="p">,</span> <span class="s2">&quot;2012&quot;</span><span class="p">)</span>
</code></pre></div>
<p>You can also use <code translate="no">self.add_text()</code> or the <a href="https://www.selenium.dev/documentation/webdriver/" target="_blank">WebDriver</a> <code translate="no">.send_keys()</code> command, but those won't clear the text box first if there's already text inside.</p>
<p>🔵 <strong>Getting the text from an element on a page:</strong></p>
<div class="highlight"><pre><span></span><code><span class="n">text</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_text</span><span class="p">(</span><span class="s2">&quot;header h2&quot;</span><span class="p">)</span>
</code></pre></div>
<p>🔵 <strong>Getting the attribute value from an element on a page:</strong></p>
<div class="highlight"><pre><span></span><code><span class="n">attribute</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_attribute</span><span class="p">(</span><span class="s2">&quot;#comic img&quot;</span><span class="p">,</span> <span class="s2">&quot;title&quot;</span><span class="p">)</span>
</code></pre></div>
<p>🔵 <strong>Asserting existence of an element on a page within some number of seconds:</strong></p>
<div class="highlight"><pre><span></span><code><span class="bp">self</span><span class="o">.</span><span class="n">wait_for_element_present</span><span class="p">(</span><span class="s2">&quot;div.my_class&quot;</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">10</span><span class="p">)</span>
</code></pre></div>
<p>(NOTE: You can also use: <code>self.assert_element_present(ELEMENT)</code>)</p>
<p>🔵 <strong>Asserting visibility of an element on a page within some number of seconds:</strong></p>
<div class="highlight"><pre><span></span><code><span class="bp">self</span><span class="o">.</span><span class="n">wait_for_element_visible</span><span class="p">(</span><span class="s2">&quot;a.my_class&quot;</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span>
</code></pre></div>
<p>(NOTE: The short versions of that are <code>self.find_element(ELEMENT)</code> and <code>self.assert_element(ELEMENT)</code>. The <code>find_element()</code> version returns the element.)</p>
<p>Since the line above returns the element, you can combine that with <code>.click()</code> as shown below:</p>
<div class="highlight"><pre><span></span><code><span class="bp">self</span><span class="o">.</span><span class="n">find_element</span><span class="p">(</span><span class="s2">&quot;a.my_class&quot;</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">5</span><span class="p">)</span><span class="o">.</span><span class="n">click</span><span class="p">()</span>

<span class="c1"># But you&#39;re better off using the following statement, which does the same thing</span>
<span class="bp">self</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s2">&quot;a.my_class&quot;</span><span class="p">)</span>  <span class="c1"># DO IT THIS WAY!</span>
</code></pre></div>
<p><strong>ProTip™:</strong> You can use dots to signify class names (Ex: <code>div.class_name</code>) as a simplified version of <code>div[class="class_name"]</code> within a CSS selector. </p>
<p>You can also use <code>*=</code> to search for any partial value in a CSS selector as shown below:</p>
<div class="highlight"><pre><span></span><code><span class="bp">self</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s1">&#39;a[name*=&quot;partial_name&quot;]&#39;</span><span class="p">)</span>
</code></pre></div>
<p>🔵 <strong>Asserting visibility of text inside an element on a page within some number of seconds:</strong></p>
<div class="highlight"><pre><span></span><code><span class="bp">self</span><span class="o">.</span><span class="n">assert_text</span><span class="p">(</span><span class="s2">&quot;Make it so!&quot;</span><span class="p">,</span> <span class="s2">&quot;div#trek div.picard div.quotes&quot;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">assert_text</span><span class="p">(</span><span class="s2">&quot;Tea. Earl Grey. Hot.&quot;</span><span class="p">,</span> <span class="s2">&quot;div#trek div.picard div.quotes&quot;</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="mi">3</span><span class="p">)</span>
</code></pre></div>
<p>(NOTE: <code>self.find_text(TEXT, ELEMENT)</code> and <code>self.wait_for_text(TEXT, ELEMENT)</code> also do this. For backwards compatibility, older method names were kept, but the default timeout may be different.)</p>
<p>🔵 <strong>Asserting Anything:</strong></p>
<div class="highlight"><pre><span></span><code><span class="bp">self</span><span class="o">.</span><span class="n">assert_true</span><span class="p">(</span><span class="n">var1</span> <span class="o">==</span> <span class="n">var2</span><span class="p">)</span>

<span class="bp">self</span><span class="o">.</span><span class="n">assert_false</span><span class="p">(</span><span class="n">var1</span> <span class="o">==</span> <span class="n">var2</span><span class="p">)</span>

<span class="bp">self</span><span class="o">.</span><span class="n">assert_equal</span><span class="p">(</span><span class="n">var1</span><span class="p">,</span> <span class="n">var2</span><span class="p">)</span>
</code></pre></div>
<p>🔵 <strong>Useful Conditional Statements: (with creative examples)</strong></p>
<p>❓ <code>is_element_visible(selector):</code>  (visible on the page)</p>
<div class="highlight"><pre><span></span><code><span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_element_visible</span><span class="p">(</span><span class="s1">&#39;div#warning&#39;</span><span class="p">):</span>
    <span class="nb">print</span><span class="p">(</span><span class="s2">&quot;Red Alert: Something bad might be happening!&quot;</span><span class="p">)</span>
</code></pre></div>
<p>❓ <code>is_element_present(selector):</code>  (present in the HTML)</p>
<div class="highlight"><pre><span></span><code><span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_element_present</span><span class="p">(</span><span class="s1">&#39;div#top_secret img.tracking_cookie&#39;</span><span class="p">):</span>
    <span class="bp">self</span><span class="o">.</span><span class="n">contact_cookie_monster</span><span class="p">()</span>  <span class="c1"># Not a real SeleniumBase method</span>
<span class="k">else</span><span class="p">:</span>
    <span class="n">current_url</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_current_url</span><span class="p">()</span>
    <span class="bp">self</span><span class="o">.</span><span class="n">contact_the_nsa</span><span class="p">(</span><span class="n">url</span><span class="o">=</span><span class="n">current_url</span><span class="p">,</span> <span class="n">message</span><span class="o">=</span><span class="s2">&quot;Dark Zone Found&quot;</span><span class="p">)</span>  <span class="c1"># Not a real SeleniumBase method</span>
</code></pre></div>
<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">is_there_a_cloaked_klingon_ship_on_this_page</span><span class="p">():</span>
    <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_element_present</span><span class="p">(</span><span class="s2">&quot;div.ships div.klingon&quot;</span><span class="p">):</span>
        <span class="k">return</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_element_visible</span><span class="p">(</span><span class="s2">&quot;div.ships div.klingon&quot;</span><span class="p">)</span>
    <span class="k">return</span> <span class="kc">False</span>
</code></pre></div>
<p>❓ <code>is_text_visible(text, selector):</code>  (text visible on element)</p>
<div class="highlight"><pre><span></span><code><span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_text_visible</span><span class="p">(</span><span class="s2">&quot;You Shall Not Pass!&quot;</span><span class="p">,</span> <span class="s2">&quot;h1&quot;</span><span class="p">):</span>
    <span class="bp">self</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s2">&quot;https://www.youtube.com/watch?v=3xYXUeSmb-Y&quot;</span><span class="p">)</span>
</code></pre></div>
<div></div>
<details>
<summary> ▶️ Click for a longer example of <code translate="no">is_text_visible():</code></summary>

<div class="highlight"><pre><span></span><code><span class="k">def</span><span class="w"> </span><span class="nf">get_mirror_universe_captain_picard_superbowl_ad</span><span class="p">(</span><span class="n">superbowl_year</span><span class="p">):</span>
    <span class="n">selector</span> <span class="o">=</span> <span class="s2">&quot;div.superbowl_</span><span class="si">%s</span><span class="s2"> div.commercials div.transcript div.picard&quot;</span> <span class="o">%</span> <span class="n">superbowl_year</span>
    <span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_text_visible</span><span class="p">(</span><span class="s2">&quot;Yes, it was I who summoned you all here.&quot;</span><span class="p">,</span> <span class="n">selector</span><span class="p">):</span>
        <span class="k">return</span> <span class="s2">&quot;Picard Paramount+ Superbowl Ad 2020&quot;</span>
    <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_text_visible</span><span class="p">(</span><span class="s2">&quot;Commander, signal the following: Our Network is Secure!&quot;</span><span class="p">):</span>
        <span class="k">return</span> <span class="s2">&quot;Picard Mirror Universe iboss Superbowl Ad 2018&quot;</span>
    <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_text_visible</span><span class="p">(</span><span class="s2">&quot;For the Love of Marketing and Earl Grey Tea!&quot;</span><span class="p">,</span> <span class="n">selector</span><span class="p">):</span>
        <span class="k">return</span> <span class="s2">&quot;Picard Mirror Universe HubSpot Superbowl Ad 2015&quot;</span>
    <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_text_visible</span><span class="p">(</span><span class="s2">&quot;Delivery Drones... Engage&quot;</span><span class="p">,</span> <span class="n">selector</span><span class="p">):</span>
        <span class="k">return</span> <span class="s2">&quot;Picard Mirror Universe Amazon Superbowl Ad 2015&quot;</span>
    <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_text_visible</span><span class="p">(</span><span class="s2">&quot;Bing it on Screen!&quot;</span><span class="p">,</span> <span class="n">selector</span><span class="p">):</span>
        <span class="k">return</span> <span class="s2">&quot;Picard Mirror Universe Microsoft Superbowl Ad 2015&quot;</span>
    <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_text_visible</span><span class="p">(</span><span class="s2">&quot;OK Glass, Make it So!&quot;</span><span class="p">,</span> <span class="n">selector</span><span class="p">):</span>
        <span class="k">return</span> <span class="s2">&quot;Picard Mirror Universe Google Superbowl Ad 2015&quot;</span>
    <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_text_visible</span><span class="p">(</span><span class="s2">&quot;Number One, I&#39;ve Never Seen Anything Like It.&quot;</span><span class="p">,</span> <span class="n">selector</span><span class="p">):</span>
        <span class="k">return</span> <span class="s2">&quot;Picard Mirror Universe Tesla Superbowl Ad 2015&quot;</span>
    <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_text_visible</span><span class="p">(</span><span class="s2">&quot;Let us make sure history never forgets the name ... Facebook&quot;</span><span class="p">,</span> <span class="n">selector</span><span class="p">):</span>
        <span class="k">return</span> <span class="s2">&quot;Picard Mirror Universe Facebook Superbowl Ad 2015&quot;</span>
    <span class="k">elif</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_text_visible</span><span class="p">(</span><span class="s2">&quot;&quot;&quot;With the first link, the chain is forged.</span>
<span class="s2">                              The first speech censored, the first thought forbidden,</span>
<span class="s2">                              the first freedom denied, chains us all irrevocably.&quot;&quot;&quot;</span><span class="p">,</span> <span class="n">selector</span><span class="p">):</span>
        <span class="k">return</span> <span class="s2">&quot;Picard Mirror Universe Wikimedia Superbowl Ad 2015&quot;</span>
    <span class="k">else</span><span class="p">:</span>
        <span class="k">raise</span> <span class="ne">Exception</span><span class="p">(</span><span class="s2">&quot;Reports of my assimilation are greatly exaggerated.&quot;</span><span class="p">)</span>
</code></pre></div>

</details>

<p>❓ <code>is_link_text_visible(link_text):</code></p>
<div class="highlight"><pre><span></span><code><span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">is_link_text_visible</span><span class="p">(</span><span class="s2">&quot;Stop! Hammer time!&quot;</span><span class="p">):</span>
    <span class="bp">self</span><span class="o">.</span><span class="n">click_link</span><span class="p">(</span><span class="s2">&quot;Stop! Hammer time!&quot;</span><span class="p">)</span>
</code></pre></div>
<h3>🔵 Switching Tabs:</h3>

<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 translate="no">about:blank</code> URLs.)</p>

<div class="highlight"><pre><span></span><code><span class="bp">self</span><span class="o">.</span><span class="n">switch_to_window</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span>  <span class="c1"># This switches to the new tab (0 is the first one)</span>
</code></pre></div>
<h3>🔵 How to handle iframes:</h3>

<p>🔵 <b>iframes</b> follow the same principle as new windows: You must first switch to the iframe if you want to perform actions in there:</p>
<div class="highlight"><pre><span></span><code><span class="bp">self</span><span class="o">.</span><span class="n">switch_to_frame</span><span class="p">(</span><span class="s2">&quot;iframe&quot;</span><span class="p">)</span>
<span class="c1"># ... Now perform actions inside the iframe</span>
<span class="bp">self</span><span class="o">.</span><span class="n">switch_to_parent_frame</span><span class="p">()</span>  <span class="c1"># Exit the current iframe</span>
</code></pre></div>
<p>To exit from multiple iframes, use <code>self.switch_to_default_content()</code>. (If inside a single iframe, this has the same effect as <code>self.switch_to_parent_frame()</code>.)</p>
<div class="highlight"><pre><span></span><code><span class="bp">self</span><span class="o">.</span><span class="n">switch_to_frame</span><span class="p">(</span><span class="s1">&#39;iframe[name=&quot;frame1&quot;]&#39;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">switch_to_frame</span><span class="p">(</span><span class="s1">&#39;iframe[name=&quot;frame2&quot;]&#39;</span><span class="p">)</span>
<span class="c1"># ... Now perform actions inside the inner iframe</span>
<span class="bp">self</span><span class="o">.</span><span class="n">switch_to_default_content</span><span class="p">()</span>  <span class="c1"># Back to the main page</span>
</code></pre></div>
<p>🔵 You can also use a context manager to act inside iframes:</p>
<div class="highlight"><pre><span></span><code><span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">frame_switch</span><span class="p">(</span><span class="s2">&quot;iframe&quot;</span><span class="p">):</span>
    <span class="c1"># ... Now perform actions while inside the code block</span>
<span class="c1"># You have left the iframe</span>
</code></pre></div>
<p>This also works with nested iframes:</p>
<div class="highlight"><pre><span></span><code><span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">frame_switch</span><span class="p">(</span><span class="s1">&#39;iframe[name=&quot;frame1&quot;]&#39;</span><span class="p">):</span>
    <span class="k">with</span> <span class="bp">self</span><span class="o">.</span><span class="n">frame_switch</span><span class="p">(</span><span class="s1">&#39;iframe[name=&quot;frame2&quot;]&#39;</span><span class="p">):</span>
        <span class="c1"># ... Now perform actions while inside the code block</span>
    <span class="c1"># You are now back inside the first iframe</span>
<span class="c1"># You have left all the iframes</span>
</code></pre></div>
<h3>🔵 How to execute custom jQuery scripts:</h3>

<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>

<div class="highlight"><pre><span></span><code><span class="p">&lt;</span><span class="nt">script</span> <span class="na">src</span><span class="o">=</span><span class="s">&quot;https://ajax.googleapis.com/ajax/libs/jquery/3.6.3/jquery.min.js&quot;</span><span class="p">&gt;&lt;/</span><span class="nt">script</span><span class="p">&gt;</span>
</code></pre></div>
<p>🔵 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:</p>
<div class="highlight"><pre><span></span><code><span class="bp">self</span><span class="o">.</span><span class="n">activate_jquery</span><span class="p">()</span>
</code></pre></div>
<div></div>
<details>
<summary> ▶️ Here are some examples of using jQuery in your scripts. (<b>click to expand</b>)</summary>

<div class="highlight"><pre><span></span><code><span class="bp">self</span><span class="o">.</span><span class="n">execute_script</span><span class="p">(</span><span class="s2">&quot;jQuery, window.scrollTo(0, 600)&quot;</span><span class="p">)</span>  <span class="c1"># Scrolling the page</span>

<span class="bp">self</span><span class="o">.</span><span class="n">execute_script</span><span class="p">(</span><span class="s2">&quot;jQuery(&#39;#annoying-widget&#39;).hide()&quot;</span><span class="p">)</span>  <span class="c1"># Hiding elements on a page</span>

<span class="bp">self</span><span class="o">.</span><span class="n">execute_script</span><span class="p">(</span><span class="s2">&quot;jQuery(&#39;#hidden-widget&#39;).show(0)&quot;</span><span class="p">)</span>  <span class="c1"># Showing hidden elements on a page</span>

<span class="bp">self</span><span class="o">.</span><span class="n">execute_script</span><span class="p">(</span><span class="s2">&quot;jQuery(&#39;#annoying-button a&#39;).remove()&quot;</span><span class="p">)</span>  <span class="c1"># Removing elements on a page</span>

<span class="bp">self</span><span class="o">.</span><span class="n">execute_script</span><span class="p">(</span><span class="s2">&quot;jQuery(&#39;</span><span class="si">%s</span><span class="s2">&#39;).mouseover()&quot;</span> <span class="o">%</span> <span class="p">(</span><span class="n">mouse_over_item</span><span class="p">))</span>  <span class="c1"># Mouse-over elements on a page</span>

<span class="bp">self</span><span class="o">.</span><span class="n">execute_script</span><span class="p">(</span><span class="s2">&quot;jQuery(&#39;input#the_id&#39;).val(&#39;my_text&#39;)&quot;</span><span class="p">)</span>  <span class="c1"># Fast text input on a page</span>

<span class="bp">self</span><span class="o">.</span><span class="n">execute_script</span><span class="p">(</span><span class="s2">&quot;jQuery(&#39;div#dropdown a.link&#39;).click()&quot;</span><span class="p">)</span>  <span class="c1"># Click elements on a page</span>

<span class="bp">self</span><span class="o">.</span><span class="n">execute_script</span><span class="p">(</span><span class="s2">&quot;return jQuery(&#39;div#amazing&#39;)[0].text&quot;</span><span class="p">)</span>  <span class="c1"># Returns the css &quot;text&quot; of the element given</span>

<span class="bp">self</span><span class="o">.</span><span class="n">execute_script</span><span class="p">(</span><span class="s2">&quot;return jQuery(&#39;textarea&#39;)[2].value&quot;</span><span class="p">)</span>  <span class="c1"># Returns the css &quot;value&quot; of the 3rd textarea element on the page</span>
</code></pre></div>

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

</details>

<h3>🔵 How to handle a restrictive CSP:</h3>

<p>❗ Some websites have a restrictive <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP">Content Security Policy</a> to prevent users from loading jQuery and other external libraries onto their websites. If you need to use jQuery or another JS library on those websites, add <code>--disable-csp</code> as a <code>pytest</code> command-line option to load a Chromium extension that bypasses the CSP.</p>
<h3>🔵 More JavaScript fun:</h3>

<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>

<div class="highlight"><pre><span></span><code><span class="n">start_page</span> <span class="o">=</span> <span class="s2">&quot;https://xkcd.com/465/&quot;</span>
<span class="n">destination_page</span> <span class="o">=</span> <span class="s2">&quot;https://github.com/seleniumbase/SeleniumBase&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">start_page</span><span class="p">)</span>
<span class="n">referral_link</span> <span class="o">=</span> <span class="s1">&#39;&#39;&#39;&lt;a class=&#39;analytics test&#39; href=&#39;</span><span class="si">%s</span><span class="s1">&#39;&gt;Free-Referral Button!&lt;/a&gt;&#39;&#39;&#39;</span> <span class="o">%</span> <span class="n">destination_page</span>
<span class="bp">self</span><span class="o">.</span><span class="n">execute_script</span><span class="p">(</span><span class="s1">&#39;&#39;&#39;document.body.innerHTML = </span><span class="se">\&quot;</span><span class="si">%s</span><span class="se">\&quot;</span><span class="s1">&#39;&#39;&#39;</span> <span class="o">%</span> <span class="n">referral_link</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s2">&quot;a.analytics&quot;</span><span class="p">)</span>  <span class="c1"># Clicks the generated button</span>
</code></pre></div>

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

</details>

<h3>🔵 How to use deferred asserts:</h3>

<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 an example:</p>

<div class="highlight"><pre><span></span><code><span class="kn">from</span><span class="w"> </span><span class="nn">seleniumbase</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseCase</span>
<span class="n">BaseCase</span><span class="o">.</span><span class="n">main</span><span class="p">(</span><span class="vm">__name__</span><span class="p">,</span> <span class="vm">__file__</span><span class="p">)</span>

<span class="k">class</span><span class="w"> </span><span class="nc">DeferredAssertTests</span><span class="p">(</span><span class="n">BaseCase</span><span class="p">):</span>
    <span class="k">def</span><span class="w"> </span><span class="nf">test_deferred_asserts</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="s2">&quot;https://xkcd.com/993/&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">wait_for_element</span><span class="p">(</span><span class="s2">&quot;#comic&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">deferred_assert_element</span><span class="p">(</span><span class="s1">&#39;img[alt=&quot;Brand Identity&quot;]&#39;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">deferred_assert_element</span><span class="p">(</span><span class="s1">&#39;img[alt=&quot;Rocket Ship&quot;]&#39;</span><span class="p">)</span>  <span class="c1"># Will Fail</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">deferred_assert_element</span><span class="p">(</span><span class="s2">&quot;#comicmap&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">deferred_assert_text</span><span class="p">(</span><span class="s2">&quot;Fake Item&quot;</span><span class="p">,</span> <span class="s2">&quot;ul.comicNav&quot;</span><span class="p">)</span>  <span class="c1"># Will Fail</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">deferred_assert_text</span><span class="p">(</span><span class="s2">&quot;Random&quot;</span><span class="p">,</span> <span class="s2">&quot;ul.comicNav&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">deferred_assert_element</span><span class="p">(</span><span class="s1">&#39;a[name=&quot;Super Fake !!!&quot;]&#39;</span><span class="p">)</span>  <span class="c1"># Will Fail</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">deferred_assert_exact_text</span><span class="p">(</span><span class="s2">&quot;Brand Identity&quot;</span><span class="p">,</span> <span class="s2">&quot;#ctitle&quot;</span><span class="p">)</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">deferred_assert_exact_text</span><span class="p">(</span><span class="s2">&quot;Fake Food&quot;</span><span class="p">,</span> <span class="s2">&quot;#comic&quot;</span><span class="p">)</span>  <span class="c1"># Will Fail</span>
        <span class="bp">self</span><span class="o">.</span><span class="n">process_deferred_asserts</span><span class="p">()</span>
</code></pre></div>
<p><code translate="no">deferred_assert_element()</code> and <code translate="no">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 translate="no">self.process_deferred_asserts()</code> at the end of your test method. If your test hits multiple pages, you can call <code translate="no">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.</p>
<h3>🔵 How to access raw <a href="https://www.selenium.dev/documentation/webdriver/" target="_blank">WebDriver</a>:</h3>

<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>

<div class="highlight"><pre><span></span><code><span class="bp">self</span><span class="o">.</span><span class="n">driver</span><span class="o">.</span><span class="n">delete_all_cookies</span><span class="p">()</span>
<span class="n">capabilities</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">driver</span><span class="o">.</span><span class="n">capabilities</span>
<span class="bp">self</span><span class="o">.</span><span class="n">driver</span><span class="o">.</span><span class="n">find_elements</span><span class="p">(</span><span class="s2">&quot;partial link text&quot;</span><span class="p">,</span> <span class="s2">&quot;GitHub&quot;</span><span class="p">)</span>
</code></pre></div>
<p>(In general, you'll want to use the SeleniumBase versions of methods when available.)</p>
<h3>🔵 How to retry failing tests automatically:</h3>

<p>You can use <code translate="no">pytest --reruns=NUM</code> to retry failing tests that many times. Add <code translate="no">--reruns-delay=SECONDS</code> to wait that many seconds between retries. Example:</p>

<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>--reruns<span class="o">=</span><span class="m">1</span><span class="w"> </span>--reruns-delay<span class="o">=</span><span class="m">1</span>
</code></pre></div>
<p>You can use the <code translate="no">@retry_on_exception()</code> decorator to retry failing methods. (First import: <code translate="no">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>

<hr />
<blockquote>
<p>"Catch bugs in QA before deploying code to Production!"</p>
</blockquote>
<p align="left"><a href="https://seleniumbase.io/error_page" target="_blank"><img src="https://seleniumbase.github.io/cdn/gif/error_page.gif" alt="Catch bugs in QA before deploying code to Production!" title="Catch bugs in QA before deploying code to Production!" /></a></p>

<hr />
<h3><img src="https://seleniumbase.github.io/img/logo7.png" title="SeleniumBase" width="32" /> Wrap-Up</h3>

<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 align="left"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/sb_logo_10t.png" alt="SeleniumBase" title="SeleniumBase" width="274" /></a></p>

<p><a href="https://pypi.org/project/seleniumbase/" target="_blank"><img src="https://img.shields.io/pypi/pyversions/seleniumbase.svg?color=22AAEE&logo=python&logoColor=FEDC54" title="Supported Python Versions" /></a></p>
<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="70" /></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="64" /></a></span>
<span><a href="https://discord.gg/EdhQTn3EyE"><img src="https://seleniumbase.github.io/other/discord_icon.png" title="SeleniumBase on Discord" alt="SeleniumBase on Discord" width="66" /></a></span>
<span><a href="https://www.facebook.com/SeleniumBase"><img src="https://seleniumbase.io/img/social/share_facebook.svg" title="SeleniumBase on Facebook" alt="SeleniumBase on Facebook" width="62" /></a></span>
</div></p>

<p><div><b><a href="https://github.com/mdmintz">https://github.com/mdmintz</a></b></div></p>

<div><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/super_logo_sb3.png" title="SeleniumBase" width="274" /></a></div>
<div><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://img.shields.io/badge/✅%20View%20Code-on%20GitHub%20🌎-02A79E.svg" alt="SeleniumBase on GitHub" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" title="SeleniumBase" /></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> <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>
<div><a href="https://hellogithub.com/repository/c6be2d0f1969448697683d11a4ff915e" target="_blank"><img src="https://abroad.hellogithub.com/v1/widgets/recommend.svg?rid=c6be2d0f1969448697683d11a4ff915e&claim_uid=xcrm4p9j3d6JCO5&theme=small" alt="Featured｜HelloGitHub" /></a> <a href="https://discord.gg/EdhQTn3EyE" target="_blank"><img src="https://img.shields.io/discord/727927627830001734?color=7289DA&label=Discord&logo=discord&logoColor=white"/></a></div>
<div><a href="https://pepy.tech/projects/seleniumbase?timeRange=threeMonths&category=version&includeCIDownloads=true&granularity=daily&viewType=line&versions=*" target="_blank"><img src="https://static.pepy.tech/badge/seleniumbase" alt="SeleniumBase PyPI downloads" /></a> <img src="https://views.whatilearened.today/views/github/seleniumbase/SeleniumBase.svg" width="98px" height="20px" alt="Views" /></div>
<div align="left"></div>


              </article>
            </div>
          
          
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
        </div>
        
          <button type="button" class="md-top md-icon" data-md-component="top" hidden>
  
  <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
  Back to top
</button>
        
      </main>
      
        <footer class="md-footer">
  
  <div class="md-footer-meta md-typeset">
    <div class="md-footer-meta__inner md-grid">
      <div class="md-copyright">
  
    <div class="md-copyright__highlight">
      Copyright &copy; 2014 - 2024 Michael Mintz
    </div>
  
  
    Made with
    <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
      Material for MkDocs
    </a>
  
</div>
      
    </div>
  </div>
</footer>
      
    </div>
    <div class="md-dialog" data-md-component="dialog">
      <div class="md-dialog__inner md-typeset"></div>
    </div>
    
    
      <script id="__config" type="application/json">{"base": ".", "features": ["toc.hide", "toc.follow", "navigation.sections", "navigation.top", "navigation.tracking", "navigation.instant"], "search": "assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
    
    
      <script src="assets/javascripts/bundle.13a4f30d.min.js"></script>
      
    
  </body>
</html>