Skip to content

Commit dfb814c

Browse files
committed
Update the docs
1 parent b3047e6 commit dfb814c

File tree

2 files changed

+34
-48
lines changed

2 files changed

+34
-48
lines changed

examples/cdp_mode/ReadMe.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -203,7 +203,7 @@ with SB(uc=True, test=True, locale="en", ad_block=True) as sb:
203203
card_info = 'div[data-booking-status="BOOKABLE"] [class*="HotelCard_info"]'
204204
hotels = sb.cdp.select_all(card_info)
205205
print("Hyatt Hotels in %s:" % location)
206-
print("(" + sb.cdp.get_text("ul.b-color_text-white") + ")")
206+
print("(" + sb.cdp.get_text('span[class*="summary_destination"]') + ")")
207207
if len(hotels) == 0:
208208
print("No availability over the selected dates!")
209209
for hotel in hotels:
@@ -331,12 +331,13 @@ with SB(uc=True, test=True, locale="en", pls="none") as sb:
331331
url = "https://www.nike.com/"
332332
sb.activate_cdp_mode(url)
333333
sb.sleep(2.5)
334-
sb.cdp.click('div[data-testid="user-tools-container"]')
334+
sb.click('[data-testid="user-tools-container"] search')
335335
sb.sleep(1.5)
336336
search = "Nike Air Force 1"
337-
sb.cdp.press_keys('input[type="search"]', search)
337+
sb.press_keys('input[type="search"]', search)
338338
sb.sleep(4)
339-
elements = sb.cdp.select_all('ul[data-testid*="products"] figure .details')
339+
details = 'ul[data-testid*="products"] figure .details'
340+
elements = sb.select_all(details)
340341
if elements:
341342
print('**** Found results for "%s": ****' % search)
342343
for element in elements:
@@ -528,6 +529,7 @@ sb.cdp.assert_in(first, second)
528529
sb.cdp.assert_not_in(first, second)
529530
sb.cdp.scroll_into_view(selector)
530531
sb.cdp.scroll_to_y(y)
532+
sb.cdp.scroll_by_y(y)
531533
sb.cdp.scroll_to_top()
532534
sb.cdp.scroll_to_bottom()
533535
sb.cdp.scroll_up(amount=25)

help_docs/method_summary.md

Lines changed: 28 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -37,14 +37,12 @@ self.submit(selector, by="css selector")
3737
self.clear(selector, by="css selector", timeout=None)
3838
self.focus(selector, by="css selector", timeout=None)
3939
self.refresh()
40-
# Duplicates:
41-
# self.refresh_page(), self.reload_page(), self.reload()
40+
# Duplicates: self.refresh_page(), self.reload_page(), self.reload()
4241
self.get_current_url()
4342
self.get_origin()
4443
self.get_page_source()
4544
self.get_title()
46-
# Duplicates:
47-
# self.get_page_title()
45+
# Duplicates: self.get_page_title()
4846
self.get_user_agent()
4947
self.get_locale_code()
5048
self.go_back()
@@ -159,7 +157,9 @@ self.set_window_rect(x, y, width, height)
159157
self.set_window_size(width, height)
160158
self.set_window_position(x, y)
161159
self.maximize_window()
160+
# Duplicates: self.maximize()
162161
self.minimize_window()
162+
# Duplicates: self.minimize()
163163
self.reset_window_size()
164164
self.switch_to_frame(frame="iframe", timeout=None, invisible=False)
165165
self.switch_to_default_content()
@@ -168,23 +168,17 @@ with self.frame_switch(frame, timeout=None):
168168
# Indented Code Block for Context Manager (Must use "with")
169169
self.set_content_to_frame(frame, timeout=None)
170170
self.set_content_to_default(nested=False)
171-
# Duplicates:
172-
# self.set_content_to_default_content(nested=False)
171+
# Duplicates: self.set_content_to_default_content(nested=False)
173172
self.set_content_to_parent()
174-
# Duplicates:
175-
# self.set_content_to_parent_frame()
173+
# Duplicates: self.set_content_to_parent_frame()
176174
self.open_new_window(switch_to=True)
177-
# Duplicates:
178-
# self.open_new_tab(switch_to=True)
175+
# Duplicates: self.open_new_tab(switch_to=True)
179176
self.switch_to_window(window, timeout=None)
180-
# Duplicates:
181-
# self.switch_to_tab(tab, timeout=None)
177+
# Duplicates: self.switch_to_tab(tab, timeout=None)
182178
self.switch_to_default_window()
183-
# Duplicates:
184-
# self.switch_to_default_tab()
179+
# Duplicates: self.switch_to_default_tab()
185180
self.switch_to_newest_window()
186-
# Duplicates:
187-
# self.switch_to_newest_tab()
181+
# Duplicates: self.switch_to_newest_tab()
188182
self.get_new_driver(
189183
browser=None,
190184
headless=None,
@@ -252,13 +246,11 @@ self.save_data_to_logs(data, file_name=None)
252246
self.append_data_to_logs(data, file_name=None)
253247
self.save_page_source_to_logs(name=None)
254248
self.save_page_source(name, folder=None)
255-
# Duplicates:
256-
# self.save_as_html(name, folder=None)
249+
# Duplicates: self.save_as_html(name, folder=None)
257250
self.save_cookies(name="cookies.txt")
258251
self.load_cookies(name="cookies.txt", expiry=False)
259252
self.delete_all_cookies()
260-
# Duplicates:
261-
# self.clear_all_cookies()
253+
# Duplicates: self.clear_all_cookies()
262254
self.delete_saved_cookies(name="cookies.txt")
263255
self.get_saved_cookies(name="cookies.txt")
264256
self.get_cookie(name)
@@ -269,8 +261,7 @@ self.add_cookies(cookies, expiry=False)
269261
self.wait_for_ready_state_complete(timeout=None)
270262
self.wait_for_angularjs(timeout=None)
271263
self.sleep(seconds)
272-
# Duplicates:
273-
# self.wait(seconds)
264+
# Duplicates: self.wait(seconds)
274265
self.install_addon(xpi_file)
275266
self.activate_jquery()
276267
self.activate_demo_mode()
@@ -302,6 +293,10 @@ self.slow_scroll_to(selector, by="css selector", timeout=None)
302293
self.scroll_into_view(selector, by="css selector", timeout=None)
303294
self.scroll_to_top()
304295
self.scroll_to_bottom()
296+
self.scroll_to_y(y)
297+
self.scroll_by_y(y)
298+
self.scroll_up(amount=25)
299+
self.scroll_down(amount=25)
305300
self.click_xpath(xpath)
306301
self.js_click(selector, by="css selector", all_matches=False, timeout=None, scroll=True)
307302
self.js_click_if_present(selector, by="css selector", timeout=0)
@@ -316,8 +311,7 @@ self.show_elements(selector, by="css selector")
316311
self.remove_element(selector, by="css selector")
317312
self.remove_elements(selector, by="css selector")
318313
self.ad_block()
319-
# Duplicates:
320-
# self.block_ads()
314+
# Duplicates: self.block_ads()
321315
self.show_file_choosers()
322316
self.disable_beforeunload()
323317
self.get_domain_url(url)
@@ -345,8 +339,7 @@ self.save_data_as(data, file_name, destination_folder=None)
345339
self.append_data_to_file(data, file_name, destination_folder=None)
346340
self.get_file_data(file_name, folder=None)
347341
self.print_to_pdf(name, folder=None)
348-
# Duplicates:
349-
# self.save_as_pdf(name, folder=None)
342+
# Duplicates: self.save_as_pdf(name, folder=None)
350343
self.get_downloads_folder()
351344
self.get_browser_downloads_folder()
352345
self.get_downloaded_files(regex=None, browser=False)
@@ -355,8 +348,7 @@ self.get_data_from_downloaded_file(file, timeout=None, browser=False)
355348
self.is_downloaded_file_present(file, browser=False)
356349
self.is_downloaded_file_regex_present(regex, browser=False)
357350
self.delete_downloaded_file_if_present(file, browser=False)
358-
# Duplicates:
359-
# self.delete_downloaded_file(file, browser=False)
351+
# Duplicates: self.delete_downloaded_file(file, browser=False)
360352
self.assert_downloaded_file(file, timeout=None, browser=False)
361353
self.assert_downloaded_file_regex(regex, timeout=None, browser=False)
362354
self.assert_data_in_downloaded_file(data, file, timeout=None, browser=False)
@@ -423,16 +415,14 @@ self.set_local_storage_item(key, value)
423415
self.get_local_storage_item(key)
424416
self.remove_local_storage_item(key)
425417
self.clear_local_storage()
426-
# Duplicates:
427-
# self.delete_local_storage()
418+
# Duplicates: self.delete_local_storage()
428419
self.get_local_storage_keys()
429420
self.get_local_storage_items()
430421
self.set_session_storage_item(key, value)
431422
self.get_session_storage_item(key)
432423
self.remove_session_storage_item(key)
433424
self.clear_session_storage()
434-
# Duplicates:
435-
# self.delete_session_storage()
425+
# Duplicates: self.delete_session_storage()
436426
self.get_session_storage_keys()
437427
self.get_session_storage_items()
438428

@@ -496,8 +486,7 @@ self.create_introjs_tour(name=None)
496486
self.set_introjs_colors(theme_color=None, hover_color=None)
497487
self.add_tour_step(message, selector=None, name=None, title=None, theme=None, alignment=None)
498488
self.play_tour(name=None, interval=0)
499-
# Duplicates:
500-
# self.start_tour(name=None, interval=0):
489+
# Duplicates: self.start_tour(name=None, interval=0):
501490
self.export_tour(name=None, filename="my_tour.js", url=None)
502491

503492
############
@@ -584,8 +573,7 @@ self.find_link_text(link_text, timeout=None)
584573
# self.wait_for_link_text(link_text, timeout=None)
585574
# self.wait_for_link_text_visible(link_text, timeout=None)
586575
self.assert_link_text(link_text, timeout=None)
587-
# Duplicates:
588-
# self.assert_link(link_text, timeout=None)
576+
# Duplicates: self.assert_link(link_text, timeout=None)
589577

590578
############
591579

@@ -630,14 +618,11 @@ self.assert_attribute_not_present(
630618
############
631619

632620
self.accept_alert(timeout=None)
633-
# Duplicates:
634-
# self.wait_for_and_accept_alert(timeout=None)
621+
# Duplicates: self.wait_for_and_accept_alert(timeout=None)
635622
self.dismiss_alert(timeout=None)
636-
# Duplicates:
637-
# self.wait_for_and_dismiss_alert(timeout=None)
623+
# Duplicates: self.wait_for_and_dismiss_alert(timeout=None)
638624
self.switch_to_alert(timeout=None)
639-
# Duplicates:
640-
# self.wait_for_and_switch_to_alert(timeout=None)
625+
# Duplicates: self.wait_for_and_switch_to_alert(timeout=None)
641626

642627
############
643628

@@ -678,8 +663,7 @@ self.deferred_check_window(
678663
# name="default", level=0, baseline=False,
679664
# check_domain=True, full_diff=False, fs=False)
680665
self.process_deferred_asserts(print_only=False)
681-
# Duplicates:
682-
# self.process_delayed_asserts(print_only=False)
666+
# Duplicates: self.process_delayed_asserts(print_only=False)
683667

684668
############
685669

0 commit comments

Comments
 (0)