Skip to content

Commit c75b256

Browse files
mdmintzmdmintz
committed
Update the docs
1 parent 8b2f22a commit c75b256

File tree

4 files changed

+98
-62
lines changed

4 files changed

+98
-62
lines changed

‎help_docs/method_summary/index.html

Lines changed: 42 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3579,6 +3579,44 @@ <h2 id="seleniumbase-methods-api-reference"><a href="https://github.com/selenium
35793579

35803580
<span class="bp">self</span><span class="o">.</span><span class="n">_print</span><span class="p">(</span><span class="n">TEXT</span><span class="p">)</span> <span class="c1"># Calls Python&#39;s print() / Allows for translations</span>
35813581

3582+
<span class="c1">############</span>
3583+
3584+
<span class="c1"># **** UC Mode methods. (uc=True / --uc) ****</span>
3585+
3586+
<span class="c1"># (Mainly for CDP Mode) - (For all CDP methods, see the CDP Mode Docs)</span>
3587+
3588+
<span class="bp">self</span><span class="o">.</span><span class="n">activate_cdp_mode</span><span class="p">(</span><span class="n">url</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="c1"># Activate CDP Mode on the given URL</span>
3589+
3590+
<span class="bp">self</span><span class="o">.</span><span class="n">reconnect</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="mf">0.1</span><span class="p">)</span> <span class="c1"># disconnect() + sleep(timeout) + connect()</span>
3591+
3592+
<span class="bp">self</span><span class="o">.</span><span class="n">disconnect</span><span class="p">()</span> <span class="c1"># Stops the webdriver service to prevent detection</span>
3593+
3594+
<span class="bp">self</span><span class="o">.</span><span class="n">connect</span><span class="p">()</span> <span class="c1"># Starts the webdriver service to allow actions again</span>
3595+
3596+
<span class="c1"># (For regular UC Mode)</span>
3597+
3598+
<span class="bp">self</span><span class="o">.</span><span class="n">uc_open</span><span class="p">(</span><span class="n">url</span><span class="p">)</span> <span class="c1"># (Open in same tab with default reconnect_time)</span>
3599+
3600+
<span class="bp">self</span><span class="o">.</span><span class="n">uc_open_with_tab</span><span class="p">(</span><span class="n">url</span><span class="p">)</span> <span class="c1"># (New tab with default reconnect_time)</span>
3601+
3602+
<span class="bp">self</span><span class="o">.</span><span class="n">uc_open_with_reconnect</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">reconnect_time</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="c1"># (New tab)</span>
3603+
3604+
<span class="bp">self</span><span class="o">.</span><span class="n">uc_open_with_disconnect</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="c1"># New tab + sleep()</span>
3605+
3606+
<span class="bp">self</span><span class="o">.</span><span class="n">uc_click</span><span class="p">(</span><span class="n">selector</span><span class="p">)</span> <span class="c1"># A stealthy click for evading bot-detection</span>
3607+
3608+
<span class="bp">self</span><span class="o">.</span><span class="n">uc_gui_press_key</span><span class="p">(</span><span class="n">key</span><span class="p">)</span> <span class="c1"># Use PyAutoGUI to press the keyboard key</span>
3609+
3610+
<span class="bp">self</span><span class="o">.</span><span class="n">uc_gui_press_keys</span><span class="p">(</span><span class="n">keys</span><span class="p">)</span> <span class="c1"># Use PyAutoGUI to press a list of keys</span>
3611+
3612+
<span class="bp">self</span><span class="o">.</span><span class="n">uc_gui_write</span><span class="p">(</span><span class="n">text</span><span class="p">)</span> <span class="c1"># Similar to uc_gui_press_keys(), but faster</span>
3613+
3614+
<span class="bp">self</span><span class="o">.</span><span class="n">uc_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> <span class="n">timeframe</span><span class="o">=</span><span class="mf">0.25</span><span class="p">)</span> <span class="c1"># PyAutoGUI click screen</span>
3615+
3616+
<span class="bp">self</span><span class="o">.</span><span class="n">uc_gui_click_captcha</span><span class="p">(</span><span class="n">frame</span><span class="o">=</span><span class="s2">&quot;iframe&quot;</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">blind</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
3617+
3618+
<span class="bp">self</span><span class="o">.</span><span class="n">uc_gui_handle_captcha</span><span class="p">(</span><span class="n">frame</span><span class="o">=</span><span class="s2">&quot;iframe&quot;</span><span class="p">)</span>
3619+
35823620
<span class="c1">############ # &quot;driver&quot;-specific methods added (or modified) by SeleniumBase</span>
35833621
<span class="n">driver</span><span class="o">.</span><span class="n">default_get</span><span class="p">(</span><span class="n">url</span><span class="p">)</span> <span class="c1"># Because driver.get(url) works differently in UC Mode</span>
35843622

@@ -3681,7 +3719,9 @@ <h2 id="seleniumbase-methods-api-reference"><a href="https://github.com/selenium
36813719

36823720
<span class="n">driver</span><span class="o">.</span><span class="n">uc_open_with_disconnect</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">timeout</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="c1"># New tab + sleep()</span>
36833721

3684-
<span class="n">driver</span><span class="o">.</span><span class="n">reconnect</span><span class="p">(</span><span class="n">timeout</span><span class="p">)</span> <span class="c1"># disconnect() + sleep(timeout) + connect()</span>
3722+
<span class="n">driver</span><span class="o">.</span><span class="n">uc_activate_cdp_mode</span><span class="p">(</span><span class="n">url</span><span class="o">=</span><span class="kc">None</span><span class="p">)</span> <span class="c1"># Activate CDP Mode on the given URL</span>
3723+
3724+
<span class="n">driver</span><span class="o">.</span><span class="n">reconnect</span><span class="p">(</span><span class="n">timeout</span><span class="o">=</span><span class="mf">0.1</span><span class="p">)</span> <span class="c1"># disconnect() + sleep(timeout) + connect()</span>
36853725

36863726
<span class="n">driver</span><span class="o">.</span><span class="n">disconnect</span><span class="p">()</span> <span class="c1"># Stops the webdriver service to prevent detection</span>
36873727

@@ -3698,12 +3738,8 @@ <h2 id="seleniumbase-methods-api-reference"><a href="https://github.com/selenium
36983738
<span class="n">driver</span><span class="o">.</span><span class="n">uc_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> <span class="n">timeframe</span><span class="o">=</span><span class="mf">0.25</span><span class="p">)</span> <span class="c1"># PyAutoGUI click screen</span>
36993739

37003740
<span class="n">driver</span><span class="o">.</span><span class="n">uc_gui_click_captcha</span><span class="p">(</span><span class="n">frame</span><span class="o">=</span><span class="s2">&quot;iframe&quot;</span><span class="p">,</span> <span class="n">retry</span><span class="o">=</span><span class="kc">False</span><span class="p">,</span> <span class="n">blind</span><span class="o">=</span><span class="kc">False</span><span class="p">)</span>
3701-
<span class="c1"># driver.uc_gui_click_cf(frame=&quot;iframe&quot;, retry=False, blind=False)</span>
3702-
<span class="c1"># driver.uc_gui_click_rc(frame=&quot;iframe&quot;, retry=False, blind=False)</span>
37033741

3704-
<span class="n">driver</span><span class="o">.</span><span class="n">uc_gui_handle_captcha</span><span class="p">(</span><span class="n">frame</span><span class="o">=</span><span class="s2">&quot;iframe&quot;</span><span class="p">)</span> <span class="c1"># (Auto-detects the CAPTCHA)</span>
3705-
<span class="c1"># driver.uc_gui_handle_cf(frame=&quot;iframe&quot;) # PyAutoGUI click CF Turnstile</span>
3706-
<span class="c1"># driver.uc_gui_handle_rc(frame=&quot;iframe&quot;) # PyAutoGUI click G. reCAPTCHA</span>
3742+
<span class="n">driver</span><span class="o">.</span><span class="n">uc_gui_handle_captcha</span><span class="p">(</span><span class="n">frame</span><span class="o">=</span><span class="s2">&quot;iframe&quot;</span><span class="p">)</span>
37073743
</code></pre></div>
37083744
<hr />
37093745
<h2>🔵 Examples</h2>

‎help_docs/recorder_mode/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2669,7 +2669,7 @@ <h2 id="recorder-mode"><a href="https://github.com/seleniumbase/SeleniumBase/"><
26692669

26702670
cp<span class="w"> </span>./recordings/TEST_NAME_rec.py<span class="w"> </span>./TEST_NAME.py
26712671
</code></pre></div>
2672-
<p>The first command creates a boilerplate test with a breakpoint; the second command runs the test with the Recorder activated; the third command prints the completed test to the console; and the fourth command replaces the initial boilerplate with the completed test. If you're just experimenting with the Recorder, you can run the second command as many times as you want, and it'll override previous recordings saved to <code>./recordings/TEST_NAME_rec.py</code>. (Note that <code>-s</code> is needed to allow breakpoints, unless you already have a <code>pytest.ini</code> file present with <code>addopts = --capture=no</code> in it. The <code>-q</code> is optional, which shortens <code>pytest</code> console output.)</p>
2672+
<p>The first command creates a boilerplate test with a breakpoint; the second command runs the test with the Recorder activated; the third command prints the completed test to the console; and the fourth command replaces the initial boilerplate with the completed test. If you're just experimenting with the Recorder, you can run the second command as many times as you want, and it'll override previous recordings saved to <code>./recordings/TEST_NAME_rec.py</code>. (Note that <code>-s</code> is needed to allow breakpoints, unless you already have a <code>pytest.ini</code> file present where you set it. The <code>-q</code> is optional, which shortens <code>pytest</code> console output.)</p>
26732673
<p>⏺️ You can also use the Recorder to add code to an existing test. To do that, you'll first need to create a breakpoint in your code to insert manual browser actions:</p>
26742674
<div class="highlight"><pre><span></span><code><span class="kn">import</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>
26752675
</code></pre></div>

‎search/search_index.json

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

‎sitemap.xml

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -2,218 +2,218 @@
22
<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
33
<url>
44
<loc>https://seleniumbase.io/</loc>
5-
<lastmod>2024-12-03</lastmod>
5+
<lastmod>2024-12-06</lastmod>
66
</url>
77
<url>
88
<loc>https://seleniumbase.io/examples/ReadMe/</loc>
9-
<lastmod>2024-12-03</lastmod>
9+
<lastmod>2024-12-06</lastmod>
1010
</url>
1111
<url>
1212
<loc>https://seleniumbase.io/examples/case_summary/</loc>
13-
<lastmod>2024-12-03</lastmod>
13+
<lastmod>2024-12-06</lastmod>
1414
</url>
1515
<url>
1616
<loc>https://seleniumbase.io/examples/behave_bdd/ReadMe/</loc>
17-
<lastmod>2024-12-03</lastmod>
17+
<lastmod>2024-12-06</lastmod>
1818
</url>
1919
<url>
2020
<loc>https://seleniumbase.io/examples/cdp_mode/ReadMe/</loc>
21-
<lastmod>2024-12-03</lastmod>
21+
<lastmod>2024-12-06</lastmod>
2222
</url>
2323
<url>
2424
<loc>https://seleniumbase.io/examples/chart_maker/ReadMe/</loc>
25-
<lastmod>2024-12-03</lastmod>
25+
<lastmod>2024-12-06</lastmod>
2626
</url>
2727
<url>
2828
<loc>https://seleniumbase.io/examples/dialog_boxes/ReadMe/</loc>
29-
<lastmod>2024-12-03</lastmod>
29+
<lastmod>2024-12-06</lastmod>
3030
</url>
3131
<url>
3232
<loc>https://seleniumbase.io/examples/example_logs/ReadMe/</loc>
33-
<lastmod>2024-12-03</lastmod>
33+
<lastmod>2024-12-06</lastmod>
3434
</url>
3535
<url>
3636
<loc>https://seleniumbase.io/examples/master_qa/ReadMe/</loc>
37-
<lastmod>2024-12-03</lastmod>
37+
<lastmod>2024-12-06</lastmod>
3838
</url>
3939
<url>
4040
<loc>https://seleniumbase.io/examples/migration/raw_selenium/ReadMe/</loc>
41-
<lastmod>2024-12-03</lastmod>
41+
<lastmod>2024-12-06</lastmod>
4242
</url>
4343
<url>
4444
<loc>https://seleniumbase.io/examples/presenter/ReadMe/</loc>
45-
<lastmod>2024-12-03</lastmod>
45+
<lastmod>2024-12-06</lastmod>
4646
</url>
4747
<url>
4848
<loc>https://seleniumbase.io/examples/tour_examples/ReadMe/</loc>
49-
<lastmod>2024-12-03</lastmod>
49+
<lastmod>2024-12-06</lastmod>
5050
</url>
5151
<url>
5252
<loc>https://seleniumbase.io/examples/visual_testing/ReadMe/</loc>
53-
<lastmod>2024-12-03</lastmod>
53+
<lastmod>2024-12-06</lastmod>
5454
</url>
5555
<url>
5656
<loc>https://seleniumbase.io/help_docs/ReadMe/</loc>
57-
<lastmod>2024-12-03</lastmod>
57+
<lastmod>2024-12-06</lastmod>
5858
</url>
5959
<url>
6060
<loc>https://seleniumbase.io/help_docs/behave_gui/</loc>
61-
<lastmod>2024-12-03</lastmod>
61+
<lastmod>2024-12-06</lastmod>
6262
</url>
6363
<url>
6464
<loc>https://seleniumbase.io/help_docs/case_plans/</loc>
65-
<lastmod>2024-12-03</lastmod>
65+
<lastmod>2024-12-06</lastmod>
6666
</url>
6767
<url>
6868
<loc>https://seleniumbase.io/help_docs/chinese/</loc>
69-
<lastmod>2024-12-03</lastmod>
69+
<lastmod>2024-12-06</lastmod>
7070
</url>
7171
<url>
7272
<loc>https://seleniumbase.io/help_docs/commander/</loc>
73-
<lastmod>2024-12-03</lastmod>
73+
<lastmod>2024-12-06</lastmod>
7474
</url>
7575
<url>
7676
<loc>https://seleniumbase.io/help_docs/customizing_test_runs/</loc>
77-
<lastmod>2024-12-03</lastmod>
77+
<lastmod>2024-12-06</lastmod>
7878
</url>
7979
<url>
8080
<loc>https://seleniumbase.io/help_docs/demo_mode/</loc>
81-
<lastmod>2024-12-03</lastmod>
81+
<lastmod>2024-12-06</lastmod>
8282
</url>
8383
<url>
8484
<loc>https://seleniumbase.io/help_docs/desired_capabilities/</loc>
85-
<lastmod>2024-12-03</lastmod>
85+
<lastmod>2024-12-06</lastmod>
8686
</url>
8787
<url>
8888
<loc>https://seleniumbase.io/help_docs/features_list/</loc>
89-
<lastmod>2024-12-03</lastmod>
89+
<lastmod>2024-12-06</lastmod>
9090
</url>
9191
<url>
9292
<loc>https://seleniumbase.io/help_docs/handling_iframes/</loc>
93-
<lastmod>2024-12-03</lastmod>
93+
<lastmod>2024-12-06</lastmod>
9494
</url>
9595
<url>
9696
<loc>https://seleniumbase.io/help_docs/happy_customers/</loc>
97-
<lastmod>2024-12-03</lastmod>
97+
<lastmod>2024-12-06</lastmod>
9898
</url>
9999
<url>
100100
<loc>https://seleniumbase.io/help_docs/hidden_files_info/</loc>
101-
<lastmod>2024-12-03</lastmod>
101+
<lastmod>2024-12-06</lastmod>
102102
</url>
103103
<url>
104104
<loc>https://seleniumbase.io/help_docs/how_it_works/</loc>
105-
<lastmod>2024-12-03</lastmod>
105+
<lastmod>2024-12-06</lastmod>
106106
</url>
107107
<url>
108108
<loc>https://seleniumbase.io/help_docs/html_inspector/</loc>
109-
<lastmod>2024-12-03</lastmod>
109+
<lastmod>2024-12-06</lastmod>
110110
</url>
111111
<url>
112112
<loc>https://seleniumbase.io/help_docs/install/</loc>
113-
<lastmod>2024-12-03</lastmod>
113+
<lastmod>2024-12-06</lastmod>
114114
</url>
115115
<url>
116116
<loc>https://seleniumbase.io/help_docs/install_python_pip_git/</loc>
117-
<lastmod>2024-12-03</lastmod>
117+
<lastmod>2024-12-06</lastmod>
118118
</url>
119119
<url>
120120
<loc>https://seleniumbase.io/help_docs/js_package_manager/</loc>
121-
<lastmod>2024-12-03</lastmod>
121+
<lastmod>2024-12-06</lastmod>
122122
</url>
123123
<url>
124124
<loc>https://seleniumbase.io/help_docs/locale_codes/</loc>
125-
<lastmod>2024-12-03</lastmod>
125+
<lastmod>2024-12-06</lastmod>
126126
</url>
127127
<url>
128128
<loc>https://seleniumbase.io/help_docs/method_summary/</loc>
129-
<lastmod>2024-12-03</lastmod>
129+
<lastmod>2024-12-06</lastmod>
130130
</url>
131131
<url>
132132
<loc>https://seleniumbase.io/help_docs/mobile_testing/</loc>
133-
<lastmod>2024-12-03</lastmod>
133+
<lastmod>2024-12-06</lastmod>
134134
</url>
135135
<url>
136136
<loc>https://seleniumbase.io/help_docs/mysql_installation/</loc>
137-
<lastmod>2024-12-03</lastmod>
137+
<lastmod>2024-12-06</lastmod>
138138
</url>
139139
<url>
140140
<loc>https://seleniumbase.io/help_docs/recorder_mode/</loc>
141-
<lastmod>2024-12-03</lastmod>
141+
<lastmod>2024-12-06</lastmod>
142142
</url>
143143
<url>
144144
<loc>https://seleniumbase.io/help_docs/shadow_dom/</loc>
145-
<lastmod>2024-12-03</lastmod>
145+
<lastmod>2024-12-06</lastmod>
146146
</url>
147147
<url>
148148
<loc>https://seleniumbase.io/help_docs/syntax_formats/</loc>
149-
<lastmod>2024-12-03</lastmod>
149+
<lastmod>2024-12-06</lastmod>
150150
</url>
151151
<url>
152152
<loc>https://seleniumbase.io/help_docs/thank_you/</loc>
153-
<lastmod>2024-12-03</lastmod>
153+
<lastmod>2024-12-06</lastmod>
154154
</url>
155155
<url>
156156
<loc>https://seleniumbase.io/help_docs/translations/</loc>
157-
<lastmod>2024-12-03</lastmod>
157+
<lastmod>2024-12-06</lastmod>
158158
</url>
159159
<url>
160160
<loc>https://seleniumbase.io/help_docs/uc_mode/</loc>
161-
<lastmod>2024-12-03</lastmod>
161+
<lastmod>2024-12-06</lastmod>
162162
</url>
163163
<url>
164164
<loc>https://seleniumbase.io/help_docs/useful_grep_commands/</loc>
165-
<lastmod>2024-12-03</lastmod>
165+
<lastmod>2024-12-06</lastmod>
166166
</url>
167167
<url>
168168
<loc>https://seleniumbase.io/help_docs/using_safari_driver/</loc>
169-
<lastmod>2024-12-03</lastmod>
169+
<lastmod>2024-12-06</lastmod>
170170
</url>
171171
<url>
172172
<loc>https://seleniumbase.io/help_docs/verify_webdriver/</loc>
173-
<lastmod>2024-12-03</lastmod>
173+
<lastmod>2024-12-06</lastmod>
174174
</url>
175175
<url>
176176
<loc>https://seleniumbase.io/help_docs/virtualenv_instructions/</loc>
177-
<lastmod>2024-12-03</lastmod>
177+
<lastmod>2024-12-06</lastmod>
178178
</url>
179179
<url>
180180
<loc>https://seleniumbase.io/help_docs/webdriver_installation/</loc>
181-
<lastmod>2024-12-03</lastmod>
181+
<lastmod>2024-12-06</lastmod>
182182
</url>
183183
<url>
184184
<loc>https://seleniumbase.io/integrations/azure/azure_pipelines/ReadMe/</loc>
185-
<lastmod>2024-12-03</lastmod>
185+
<lastmod>2024-12-06</lastmod>
186186
</url>
187187
<url>
188188
<loc>https://seleniumbase.io/integrations/azure/jenkins/ReadMe/</loc>
189-
<lastmod>2024-12-03</lastmod>
189+
<lastmod>2024-12-06</lastmod>
190190
</url>
191191
<url>
192192
<loc>https://seleniumbase.io/integrations/docker/ReadMe/</loc>
193-
<lastmod>2024-12-03</lastmod>
193+
<lastmod>2024-12-06</lastmod>
194194
</url>
195195
<url>
196196
<loc>https://seleniumbase.io/integrations/github/workflows/ReadMe/</loc>
197-
<lastmod>2024-12-03</lastmod>
197+
<lastmod>2024-12-06</lastmod>
198198
</url>
199199
<url>
200200
<loc>https://seleniumbase.io/integrations/google_cloud/ReadMe/</loc>
201-
<lastmod>2024-12-03</lastmod>
201+
<lastmod>2024-12-06</lastmod>
202202
</url>
203203
<url>
204204
<loc>https://seleniumbase.io/seleniumbase/common/ReadMe/</loc>
205-
<lastmod>2024-12-03</lastmod>
205+
<lastmod>2024-12-06</lastmod>
206206
</url>
207207
<url>
208208
<loc>https://seleniumbase.io/seleniumbase/console_scripts/ReadMe/</loc>
209-
<lastmod>2024-12-03</lastmod>
209+
<lastmod>2024-12-06</lastmod>
210210
</url>
211211
<url>
212212
<loc>https://seleniumbase.io/seleniumbase/masterqa/ReadMe/</loc>
213-
<lastmod>2024-12-03</lastmod>
213+
<lastmod>2024-12-06</lastmod>
214214
</url>
215215
<url>
216216
<loc>https://seleniumbase.io/seleniumbase/utilities/selenium_grid/ReadMe/</loc>
217-
<lastmod>2024-12-03</lastmod>
217+
<lastmod>2024-12-06</lastmod>
218218
</url>
219219
</urlset>

0 commit comments

Comments
 (0)