Skip to content

Commit f6347b7

Browse files
committed
Update the docs
1 parent 4fd4bdc commit f6347b7

File tree

6 files changed

+75
-67
lines changed

6 files changed

+75
-67
lines changed

examples/cdp_mode/ReadMe/index.html

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3090,19 +3090,22 @@ <h3 id="cdp-mode-api-methods">🐙 CDP Mode API / Methods<a class="headerlink" h
30903090
<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="n">selector</span><span class="p">)</span>
30913091
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">click_active_element</span><span class="p">()</span>
30923092
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">click_if_visible</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
3093+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">click_visible_elements</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
30933094
<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="n">selector</span><span class="p">)</span>
30943095
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">nested_click</span><span class="p">(</span><span class="n">parent_selector</span><span class="p">,</span> <span class="n">selector</span><span class="p">)</span>
30953096
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">get_nested_element</span><span class="p">(</span><span class="n">parent_selector</span><span class="p">,</span> <span class="n">selector</span><span class="p">)</span>
3096-
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">flash</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
3097+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</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>
3098+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">flash</span><span class="p">(</span><span class="n">selector</span><span class="p">,</span> <span class="n">duration</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">color</span><span class="o">=</span><span class="s2">&quot;44CC88&quot;</span><span class="p">,</span> <span class="n">pause</span><span class="o">=</span><span class="mi">0</span><span class="p">)</span>
3099+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">highlight</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
30973100
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">focus</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
30983101
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">highlight_overlay</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
30993102
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">remove_element</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
31003103
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">remove_from_dom</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
31013104
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">remove_elements</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
3102-
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">scroll_into_view</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
31033105
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">send_keys</span><span class="p">(</span><span class="n">selector</span><span class="p">,</span> <span class="n">text</span><span class="p">)</span>
31043106
<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="n">selector</span><span class="p">,</span> <span class="n">text</span><span class="p">)</span>
31053107
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</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>
3108+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">set_value</span><span class="p">(</span><span class="n">selector</span><span class="p">,</span> <span class="n">text</span><span class="p">)</span>
31063109
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">evaluate</span><span class="p">(</span><span class="n">expression</span><span class="p">)</span>
31073110
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">js_dumps</span><span class="p">(</span><span class="n">obj_name</span><span class="p">)</span>
31083111
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">maximize</span><span class="p">()</span>
@@ -3140,6 +3143,11 @@ <h3 id="cdp-mode-api-methods">🐙 CDP Mode API / Methods<a class="headerlink" h
31403143
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">gui_write</span><span class="p">(</span><span class="n">text</span><span class="p">)</span>
31413144
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">gui_click_x_y</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">)</span>
31423145
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">gui_click_element</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
3146+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">gui_drag_drop_points</span><span class="p">(</span><span class="n">x1</span><span class="p">,</span> <span class="n">y1</span><span class="p">,</span> <span class="n">x2</span><span class="p">,</span> <span class="n">y2</span><span class="p">)</span>
3147+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">gui_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>
3148+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">gui_hover_x_y</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">)</span>
3149+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">gui_hover_element</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
3150+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">gui_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>
31433151
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">internalize_links</span><span class="p">()</span>
31443152
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">is_checked</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
31453153
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">is_selected</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
@@ -3149,12 +3157,20 @@ <h3 id="cdp-mode-api-methods">🐙 CDP Mode API / Methods<a class="headerlink" h
31493157
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">unselect_if_selected</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
31503158
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">is_element_present</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
31513159
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</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>
3152-
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">assert_element</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
31533160
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">assert_element_present</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
3161+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">assert_element_absent</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
3162+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">assert_element</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
3163+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">assert_element_visible</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
3164+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">assert_element_not_visible</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
3165+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">assert_title</span><span class="p">(</span><span class="n">title</span><span class="p">)</span>
31543166
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</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="o">=</span><span class="s2">&quot;html&quot;</span><span class="p">)</span>
31553167
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</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="o">=</span><span class="s2">&quot;html&quot;</span><span class="p">)</span>
3156-
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">scroll_down</span><span class="p">(</span><span class="n">amount</span><span class="o">=</span><span class="mi">25</span><span class="p">)</span>
3168+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">scroll_into_view</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span>
3169+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">scroll_to_y</span><span class="p">(</span><span class="n">y</span><span class="p">)</span>
3170+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">scroll_to_top</span><span class="p">()</span>
3171+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">scroll_to_bottom</span><span class="p">()</span>
31573172
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">scroll_up</span><span class="p">(</span><span class="n">amount</span><span class="o">=</span><span class="mi">25</span><span class="p">)</span>
3173+
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</span><span class="o">.</span><span class="n">scroll_down</span><span class="p">(</span><span class="n">amount</span><span class="o">=</span><span class="mi">25</span><span class="p">)</span>
31583174
<span class="n">sb</span><span class="o">.</span><span class="n">cdp</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="n">folder</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">selector</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span>
31593175
</code></pre></div>
31603176
<hr />

help_docs/customizing_test_runs/index.html

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2967,9 +2967,6 @@ <h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="Selenium
29672967
<p>Here's how to connect to a Sauce Labs Selenium Grid server for running tests:</p>
29682968
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>test_demo_site.py<span class="w"> </span>--server<span class="o">=</span>USERNAME:[email protected]<span class="w"> </span>--port<span class="o">=</span><span class="m">443</span><span class="w"> </span>--protocol<span class="o">=</span>https
29692969
</code></pre></div>
2970-
<p>Here's how to connect to a CrossBrowserTesting Selenium Grid server for running tests:</p>
2971-
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>test_demo_site.py<span class="w"> </span>--server<span class="o">=</span>USERNAME:[email protected]<span class="w"> </span>--port<span class="o">=</span><span class="m">80</span>
2972-
</code></pre></div>
29732970
<p>🌐 Or you can create your own Selenium Grid for test distribution. (<a href="../../seleniumbase/utilities/selenium_grid/ReadMe/">See this ReadMe for details</a>)</p>
29742971
<p>🌐 To use a server on the <code>https</code> protocol, add <code>--protocol=https</code>: (<em>Now automatic if the port is 443.</em>)</p>
29752972
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>test_demo_site.py<span class="w"> </span>--protocol<span class="o">=</span>https<span class="w"> </span>--server<span class="o">=</span>IP_ADDRESS<span class="w"> </span>--port<span class="o">=</span>PORT

help_docs/uc_mode/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2945,7 +2945,7 @@ <h3 id="here-are-the-seleniumbase-uc-mode-methods-uc-uctrue">👤 Here are the S
29452945
<p><img src="https://seleniumbase.github.io/other/me_se_conf.jpg" title="SeleniumBase" width="370"></p>
29462946
<p>As an ethical hacker / cybersecurity researcher who builds bots that bypass CAPTCHAs for sport, <b>the CAPTCHA service that I personally recommend</b> for keeping bots out is <b translate="no">Google reCAPTCHA</b>:</p>
29472947
<p><img src="https://seleniumbase.github.io/other/g_recaptcha.png" title="SeleniumBase" width="315"></p>
2948-
<p>Since Google makes Chrome, Google's own <b translate="no">reCAPTCHA</b> service has access to more data than other CAPTCHA services (eg. hCaptcha, CloudFlare, DataDome, etc.), and can therefore use that data to make better decisions about whether or not web activity is coming from real humans or automated bots.</p>
2948+
<p>Since Google makes Chrome, Google's own <b translate="no">reCAPTCHA</b> service has access to more data than other CAPTCHA services, and can therefore use that data to make better decisions about whether or not web activity is coming from real humans or automated bots.</p>
29492949
<hr />
29502950
<p>⚖️ <b>Legal implications of web-scraping</b>:</p>
29512951
<p>Based on the following article, https://nubela.co/blog/meta-lost-the-scraping-legal-battle-to-bright-data/, (which outlines a court case where social-networking company: Meta lost the legal battle to data-scraping company: Bright Data), it was determined that web scraping is 100% legal in the eyes of the courts as long as:

search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

seleniumbase/utilities/selenium_grid/ReadMe/index.html

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2585,11 +2585,6 @@ <h4><img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase"
25852585
</ul>
25862586
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>test_demo_site.py<span class="w"> </span>--server<span class="o">=</span>USERNAME:[email protected]<span class="w"> </span>--port<span class="o">=</span><span class="m">443</span><span class="w"> </span>--protocol<span class="o">=</span>https
25872587
</code></pre></div>
2588-
<ul>
2589-
<li><a href="https://help.crossbrowsertesting.com/selenium-testing/getting-started/python/">CrossBrowserTesting</a> Selenium Grid:</li>
2590-
</ul>
2591-
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>test_demo_site.py<span class="w"> </span>--server<span class="o">=</span>USERNAME:[email protected]<span class="w"> </span>--port<span class="o">=</span><span class="m">80</span>
2592-
</code></pre></div>
25932588
<p>To use a server on the <code>https</code> protocol, add <code>--protocol=https</code>:
25942589
(<i>SeleniumBase 1.65.2 and newer uses <code>https</code> automatically for <code>--port=443</code>.</i>)</p>
25952590
<div class="highlight"><pre><span></span><code>pytest<span class="w"> </span>test_demo_site.py<span class="w"> </span>--protocol<span class="o">=</span>https<span class="w"> </span>--server<span class="o">=</span>IP_ADDRESS<span class="w"> </span>--port<span class="o">=</span>PORT

0 commit comments

Comments
 (0)