Skip to content

Commit f25b748

Browse files
committed
Update the docs
1 parent 202f2f1 commit f25b748

File tree

7 files changed

+81
-85
lines changed

7 files changed

+81
-85
lines changed

docs/examples/cdp_mode/ReadMe/index.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2860,7 +2860,7 @@ <h3 id="cdp-mode-usage">🐙 <b translate="no">CDP Mode</b> Usage<a class="heade
28602860
<p>Simple example: (<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/raw_gitlab.py">SeleniumBase/examples/cdp_mode/raw_gitlab.py</a>)</p>
28612861
<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>
28622862

2863-
<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_code</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>
2863+
<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>
28642864
<span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;https://gitlab.com/users/sign_in&quot;</span>
28652865
<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>
28662866
<span class="n">sb</span><span class="o">.</span><span class="n">uc_gui_click_captcha</span><span class="p">()</span>
@@ -2921,7 +2921,7 @@ <h3 id="cdp-mode-examples-seleniumbaseexamplescdp_mode">🐙 <b translate="no">C
29212921

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

2924-
<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_code</span><span class="o">=</span><span class="s2">&quot;en&quot;</span><span class="p">,</span> <span class="n">ad_block</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>
2924+
<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="n">ad_block</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>
29252925
<span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;https://www.pokemon.com/us&quot;</span>
29262926
<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>
29272927
<span class="n">sb</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">3.2</span><span class="p">)</span>
@@ -2979,7 +2979,7 @@ <h3 id="cdp-mode-examples-seleniumbaseexamplescdp_mode">🐙 <b translate="no">C
29792979

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

2982-
<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_code</span><span class="o">=</span><span class="s2">&quot;en&quot;</span><span class="p">,</span> <span class="n">ad_block</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>
2982+
<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="n">ad_block</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>
29832983
<span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;https://www.hyatt.com/&quot;</span>
29842984
<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>
29852985
<span class="n">sb</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">2.5</span><span class="p">)</span>
@@ -3025,7 +3025,7 @@ <h3 id="cdp-mode-examples-seleniumbaseexamplescdp_mode">🐙 <b translate="no">C
30253025

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

3028-
<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_code</span><span class="o">=</span><span class="s2">&quot;en&quot;</span><span class="p">,</span> <span class="n">ad_block</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>
3028+
<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="n">ad_block</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>
30293029
<span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;https://www.bestwestern.com/en_US.html&quot;</span>
30303030
<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>
30313031
<span class="n">sb</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">2.5</span><span class="p">)</span>
@@ -3115,11 +3115,11 @@ <h3 id="cdp-mode-examples-seleniumbaseexamplescdp_mode">🐙 <b translate="no">C
31153115

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

3118-
<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_code</span><span class="o">=</span><span class="s2">&quot;en&quot;</span><span class="p">,</span> <span class="n">pls</span><span class="o">=</span><span class="s2">&quot;none&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">sb</span><span class="p">:</span>
3118+
<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="n">pls</span><span class="o">=</span><span class="s2">&quot;none&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">sb</span><span class="p">:</span>
31193119
<span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;https://www.nike.com/&quot;</span>
31203120
<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>
31213121
<span class="n">sb</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">2.5</span><span class="p">)</span>
3122-
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">mouse_click</span><span class="p">(</span><span class="s1">&#39;div[data-testid=&quot;user-tools-container&quot;]&#39;</span><span class="p">)</span>
3122+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s1">&#39;div[data-testid=&quot;user-tools-container&quot;]&#39;</span><span class="p">)</span>
31233123
<span class="n">sb</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">1.5</span><span class="p">)</span>
31243124
<span class="n">search</span> <span class="o">=</span> <span class="s2">&quot;Nike Air Force 1&quot;</span>
31253125
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">press_keys</span><span class="p">(</span><span class="s1">&#39;input[type=&quot;search&quot;]&#39;</span><span class="p">,</span> <span class="n">search</span><span class="p">)</span>

docs/help_docs/syntax_formats/index.html

Lines changed: 10 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -2689,7 +2689,7 @@ <h3>🔠 SeleniumBase supports multiple ways of structuring tests:</h3>
26892689
<li><a href="#sb_sf_22"><strong>22. The driver manager (via context manager)</strong></a></li>
26902690
<li><a href="#sb_sf_23"><strong>23. The driver manager (via direct import)</strong></a></li>
26912691
<li><a href="#sb_sf_24"><strong>24. CDP driver (async/await API. No Selenium)</strong></a></li>
2692-
<li><a href="#sb_sf_25"><strong>25. CDP driver (SB-CDP sync API. No Selenium)</strong></a></li>
2692+
<li><a href="#sb_sf_25"><strong>25. CDP driver (SB CDP Sync API. No Selenium)</strong></a></li>
26932693
</ul>
26942694
</blockquote>
26952695

@@ -3532,14 +3532,13 @@ <h2><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase
35323532
<p>This format provides a pure CDP way of using SeleniumBase (without Selenium or a test runner). The async/await API is used. Here's an example:</p>
35333533
<div class="highlight"><pre><span></span><code><span class="kn">import</span><span class="w"> </span><span class="nn">asyncio</span>
35343534
<span class="kn">import</span><span class="w"> </span><span class="nn">time</span>
3535-
<span class="kn">from</span><span class="w"> </span><span class="nn">seleniumbase.undetected</span><span class="w"> </span><span class="kn">import</span> <span class="n">cdp_driver</span>
3535+
<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">cdp_driver</span>
35363536

35373537

35383538
<span class="k">async</span> <span class="k">def</span><span class="w"> </span><span class="nf">main</span><span class="p">():</span>
3539-
<span class="n">driver</span> <span class="o">=</span> <span class="k">await</span> <span class="n">cdp_driver</span><span class="o">.</span><span class="n">cdp_util</span><span class="o">.</span><span class="n">start_async</span><span class="p">()</span>
3540-
<span class="n">page</span> <span class="o">=</span> <span class="k">await</span> <span class="n">driver</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;about:blank&quot;</span><span class="p">)</span>
3541-
<span class="k">await</span> <span class="n">page</span><span class="o">.</span><span class="n">set_locale</span><span class="p">(</span><span class="s2">&quot;en&quot;</span><span class="p">)</span>
3542-
<span class="k">await</span> <span class="n">page</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;https://www.priceline.com/&quot;</span><span class="p">)</span>
3539+
<span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;https://www.priceline.com/&quot;</span>
3540+
<span class="n">driver</span> <span class="o">=</span> <span class="k">await</span> <span class="n">cdp_driver</span><span class="o">.</span><span class="n">start_async</span><span class="p">(</span><span class="n">lang</span><span class="o">=</span><span class="s2">&quot;en&quot;</span><span class="p">)</span>
3541+
<span class="n">page</span> <span class="o">=</span> <span class="k">await</span> <span class="n">driver</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">url</span><span class="p">)</span>
35433542
<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>
35443543
<span class="nb">print</span><span class="p">(</span><span class="k">await</span> <span class="n">page</span><span class="o">.</span><span class="n">evaluate</span><span class="p">(</span><span class="s2">&quot;document.title&quot;</span><span class="p">))</span>
35453544
<span class="n">element</span> <span class="o">=</span> <span class="k">await</span> <span class="n">page</span><span class="o">.</span><span class="n">select</span><span class="p">(</span><span class="s1">&#39;[data-testid*=&quot;endLocation&quot;]&#39;</span><span class="p">)</span>
@@ -3554,23 +3553,15 @@ <h2><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase
35543553
</code></pre></div>
35553554
<p>(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/cdp_mode/raw_async.py">examples/cdp_mode/raw_async.py</a> for the test.)</p>
35563555
<p><a id="sb_sf_25"></a></p>
3557-
<h2><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 25. CDP driver (SB-CDP sync API. No Selenium)</h2>
3556+
<h2><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 25. CDP driver (SB CDP Sync API. No Selenium)</h2>
35583557

3559-
<p>This format provides a pure CDP way of using SeleniumBase (without Selenium or a test runner). The expanded SB-CDP sync API is used. Here's an example:</p>
3560-
<div class="highlight"><pre><span></span><code><span class="kn">import</span><span class="w"> </span><span class="nn">asyncio</span>
3561-
<span class="kn">from</span><span class="w"> </span><span class="nn">seleniumbase.core</span><span class="w"> </span><span class="kn">import</span> <span class="n">sb_cdp</span>
3562-
<span class="kn">from</span><span class="w"> </span><span class="nn">seleniumbase.undetected</span><span class="w"> </span><span class="kn">import</span> <span class="n">cdp_driver</span>
3558+
<p>This format provides a pure CDP way of using SeleniumBase (without Selenium or a test runner). The expanded SB CDP Sync API is used. Here's an example:</p>
3559+
<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_cdp</span>
35633560

35643561

35653562
<span class="k">def</span><span class="w"> </span><span class="nf">main</span><span class="p">():</span>
3566-
<span class="n">url0</span> <span class="o">=</span> <span class="s2">&quot;about:blank&quot;</span> <span class="c1"># Set Locale code from here first</span>
3567-
<span class="n">url1</span> <span class="o">=</span> <span class="s2">&quot;https://www.priceline.com/&quot;</span> <span class="c1"># (The &quot;real&quot; URL)</span>
3568-
<span class="n">loop</span> <span class="o">=</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">new_event_loop</span><span class="p">()</span>
3569-
<span class="n">driver</span> <span class="o">=</span> <span class="n">cdp_driver</span><span class="o">.</span><span class="n">cdp_util</span><span class="o">.</span><span class="n">start_sync</span><span class="p">()</span>
3570-
<span class="n">page</span> <span class="o">=</span> <span class="n">loop</span><span class="o">.</span><span class="n">run_until_complete</span><span class="p">(</span><span class="n">driver</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="n">url0</span><span class="p">))</span>
3571-
<span class="n">sb</span> <span class="o">=</span> <span class="n">sb_cdp</span><span class="o">.</span><span class="n">CDPMethods</span><span class="p">(</span><span class="n">loop</span><span class="p">,</span> <span class="n">page</span><span class="p">,</span> <span class="n">driver</span><span class="p">)</span>
3572-
<span class="n">sb</span><span class="o">.</span><span class="n">set_locale</span><span class="p">(</span><span class="s2">&quot;en&quot;</span><span class="p">)</span> <span class="c1"># This test expects English locale</span>
3573-
<span class="n">sb</span><span class="o">.</span><span class="n">open</span><span class="p">(</span><span class="n">url1</span><span class="p">)</span>
3563+
<span class="n">url</span> <span class="o">=</span> <span class="s2">&quot;https://www.priceline.com/&quot;</span>
3564+
<span class="n">sb</span> <span class="o">=</span> <span class="n">sb_cdp</span><span class="o">.</span><span class="n">Chrome</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">lang</span><span class="o">=</span><span class="s2">&quot;en&quot;</span><span class="p">)</span>
35743565
<span class="n">sb</span><span class="o">.</span><span class="n">sleep</span><span class="p">(</span><span class="mf">2.5</span><span class="p">)</span>
35753566
<span class="n">sb</span><span class="o">.</span><span class="n">internalize_links</span><span class="p">()</span> <span class="c1"># Don&#39;t open links in a new tab</span>
35763567
<span class="n">sb</span><span class="o">.</span><span class="n">click</span><span class="p">(</span><span class="s2">&quot;#link_header_nav_experiences&quot;</span><span class="p">)</span>

0 commit comments

Comments
 (0)