Skip to content

Commit cc8e5a6

Browse files
mdmintzmdmintz
committed
Update method_summary
1 parent 9ac6870 commit cc8e5a6

File tree

1 file changed

+105
-50
lines changed

1 file changed

+105
-50
lines changed

‎help_docs/method_summary.md

Lines changed: 105 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/SeleniumBaseText_F.png" title="SeleniumBase" height="32">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
1+
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/SeleniumBaseText_F.png" title="SeleniumBase" align="center" height="38">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
22
## Method Summary
33

44
Here's a summary of SeleniumBase method definitions, which are defined in [base_case.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py)
@@ -14,21 +14,29 @@ self.get(url)
1414

1515
self.visit(url)
1616

17-
self.click(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT, delay=0)
17+
self.click(selector, by=By.CSS_SELECTOR,
18+
timeout=settings.SMALL_TIMEOUT, delay=0)
1819

19-
self.slow_click(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
20+
self.slow_click(selector, by=By.CSS_SELECTOR,
21+
timeout=settings.SMALL_TIMEOUT)
2022

21-
self.double_click(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
23+
self.double_click(selector, by=By.CSS_SELECTOR,
24+
timeout=settings.SMALL_TIMEOUT)
2225

23-
self.click_chain(selectors_list, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT, spacing=0)
26+
self.click_chain(selectors_list, by=By.CSS_SELECTOR,
27+
timeout=settings.SMALL_TIMEOUT, spacing=0)
2428

25-
self.type(selector, text, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT, retry=False)
29+
self.type(selector, text, by=By.CSS_SELECTOR,
30+
timeout=settings.SMALL_TIMEOUT, retry=False)
2631

27-
self.update_text(selector, new_value, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT, retry=False)
32+
self.update_text(selector, new_value, by=By.CSS_SELECTOR,
33+
timeout=settings.SMALL_TIMEOUT, retry=False)
2834

29-
self.add_text(selector, text, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
35+
self.add_text(selector, text, by=By.CSS_SELECTOR,
36+
timeout=settings.SMALL_TIMEOUT)
3037

31-
self.send_keys(selector, text, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
38+
self.send_keys(selector, text, by=By.CSS_SELECTOR,
39+
timeout=settings.SMALL_TIMEOUT)
3240

3341
self.submit(selector, by=By.CSS_SELECTOR)
3442

@@ -76,15 +84,26 @@ self.click_partial_link_text(partial_link_text, timeout=settings.SMALL_TIMEOUT)
7684

7785
self.get_text(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
7886

79-
self.get_attribute(selector, attribute, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
87+
self.get_attribute(selector, attribute, by=By.CSS_SELECTOR,
88+
timeout=settings.SMALL_TIMEOUT)
8089

81-
self.set_attribute(selector, attribute, value, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
90+
self.set_attribute(selector, attribute, value, by=By.CSS_SELECTOR,
91+
timeout=settings.SMALL_TIMEOUT)
8292

83-
self.remove_attribute(selector, attribute, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
93+
self.set_attributes(selector, attribute, value, by=By.CSS_SELECTOR)
8494

85-
self.get_property_value(selector, property, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
95+
self.set_attribute_all(selector, attribute, value, by=By.CSS_SELECTOR)
8696

87-
self.get_image_url(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
97+
self.remove_attribute(selector, attribute, by=By.CSS_SELECTOR,
98+
timeout=settings.SMALL_TIMEOUT)
99+
100+
self.remove_attributes(selector, attribute, by=By.CSS_SELECTOR)
101+
102+
self.get_property_value(selector, property, by=By.CSS_SELECTOR,
103+
timeout=settings.SMALL_TIMEOUT)
104+
105+
self.get_image_url(selector, by=By.CSS_SELECTOR,
106+
timeout=settings.SMALL_TIMEOUT)
88107

89108
self.find_elements(selector, by=By.CSS_SELECTOR, limit=0)
90109

@@ -101,19 +120,24 @@ self.switch_to_frame_of_element(selector, by=By.CSS_SELECTOR)
101120
self.hover_on_element(selector, by=By.CSS_SELECTOR)
102121

103122
self.hover_and_click(hover_selector, click_selector,
104-
hover_by=By.CSS_SELECTOR, click_by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
123+
hover_by=By.CSS_SELECTOR, click_by=By.CSS_SELECTOR,
124+
timeout=settings.SMALL_TIMEOUT)
105125

106126
self.hover_and_double_click(hover_selector, click_selector,
107-
hover_by=By.CSS_SELECTOR, click_by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
127+
hover_by=By.CSS_SELECTOR, click_by=By.CSS_SELECTOR,
128+
timeout=settings.SMALL_TIMEOUT)
108129

109130
self.select_option_by_text(dropdown_selector, option,
110-
dropdown_by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
131+
dropdown_by=By.CSS_SELECTOR,
132+
timeout=settings.SMALL_TIMEOUT)
111133

112134
self.select_option_by_index(dropdown_selector, option,
113-
dropdown_by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
135+
dropdown_by=By.CSS_SELECTOR,
136+
timeout=settings.SMALL_TIMEOUT)
114137

115138
self.select_option_by_value(dropdown_selector, option,
116-
dropdown_by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
139+
dropdown_by=By.CSS_SELECTOR,
140+
timeout=settings.SMALL_TIMEOUT)
117141

118142
self.execute_script(script)
119143

@@ -194,7 +218,8 @@ self.print_unique_links_with_status_codes()
194218

195219
self.create_folder(folder)
196220

197-
self.choose_file(selector, file_path, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
221+
self.choose_file(selector, file_path, by=By.CSS_SELECTOR,
222+
timeout=settings.SMALL_TIMEOUT)
198223

199224
self.save_element_as_image_file(selector, file_name, folder=None)
200225

@@ -230,11 +255,14 @@ self.convert_xpath_to_css(xpath)
230255

231256
self.convert_to_css_selector(selector, by)
232257

233-
self.set_value(selector, new_value, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
258+
self.set_value(selector, new_value, by=By.CSS_SELECTOR,
259+
timeout=settings.SMALL_TIMEOUT)
234260

235-
self.js_update_text(selector, new_value, by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
261+
self.js_update_text(selector, new_value, by=By.CSS_SELECTOR,
262+
timeout=settings.LARGE_TIMEOUT)
236263

237-
self.jquery_update_text(selector, new_value, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
264+
self.jquery_update_text(selector, new_value, by=By.CSS_SELECTOR,
265+
timeout=settings.SMALL_TIMEOUT)
238266

239267
########
240268

@@ -260,7 +288,8 @@ self.create_hopscotch_tour(name=None)
260288

261289
self.create_introjs_tour(name=None)
262290

263-
self.add_tour_step(message, selector=None, name=None, title=None, theme=None, alignment=None)
291+
self.add_tour_step(message, selector=None, name=None,
292+
title=None, theme=None, alignment=None)
264293

265294
self.play_tour(name=None)
266295

@@ -276,7 +305,8 @@ self.post_success_message(message, duration=None, pause=True)
276305

277306
self.post_error_message(message, duration=None, pause=True)
278307

279-
self.set_messenger_theme(theme="default", location="default", max_messages="default")
308+
self.set_messenger_theme(theme="default", location="default",
309+
max_messages="default")
280310

281311
########
282312

@@ -290,43 +320,59 @@ self.generate_traffic_chain(pages, loops=1)
290320

291321
########
292322

293-
self.wait_for_element_present(selector, by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
323+
self.wait_for_element_present(selector, by=By.CSS_SELECTOR,
324+
timeout=settings.LARGE_TIMEOUT)
294325

295-
self.wait_for_element_visible(selector, by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
326+
self.wait_for_element_visible(selector, by=By.CSS_SELECTOR,
327+
timeout=settings.LARGE_TIMEOUT)
296328

297-
self.wait_for_element(selector, by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
329+
self.wait_for_element(selector, by=By.CSS_SELECTOR,
330+
timeout=settings.LARGE_TIMEOUT)
298331

299-
self.get_element(selector, by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
332+
self.get_element(selector, by=By.CSS_SELECTOR,
333+
timeout=settings.LARGE_TIMEOUT)
300334

301-
self.assert_element_present(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
335+
self.assert_element_present(selector, by=By.CSS_SELECTOR,
336+
timeout=settings.SMALL_TIMEOUT)
302337

303-
self.find_element(selector, by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
338+
self.find_element(selector, by=By.CSS_SELECTOR,
339+
timeout=settings.LARGE_TIMEOUT)
304340

305-
self.assert_element(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
341+
self.assert_element(selector, by=By.CSS_SELECTOR,
342+
timeout=settings.SMALL_TIMEOUT)
306343

307-
self.assert_element_visible(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
344+
self.assert_element_visible(selector, by=By.CSS_SELECTOR,
345+
timeout=settings.SMALL_TIMEOUT)
308346

309347
########
310348

311-
self.wait_for_text_visible(text, selector="html", by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
349+
self.wait_for_text_visible(text, selector="html", by=By.CSS_SELECTOR,
350+
timeout=settings.LARGE_TIMEOUT)
312351

313-
self.wait_for_exact_text_visible(text, selector="html", by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
352+
self.wait_for_exact_text_visible(text, selector="html", by=By.CSS_SELECTOR,
353+
timeout=settings.LARGE_TIMEOUT)
314354

315-
self.wait_for_text(text, selector="html", by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
355+
self.wait_for_text(text, selector="html", by=By.CSS_SELECTOR,
356+
timeout=settings.LARGE_TIMEOUT)
316357

317-
self.find_text(text, selector="html", by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
358+
self.find_text(text, selector="html", by=By.CSS_SELECTOR,
359+
timeout=settings.LARGE_TIMEOUT)
318360

319-
self.assert_text_visible(text, selector="html", by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
361+
self.assert_text_visible(text, selector="html", by=By.CSS_SELECTOR,
362+
timeout=settings.SMALL_TIMEOUT)
320363

321-
self.assert_text(text, selector="html", by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
364+
self.assert_text(text, selector="html", by=By.CSS_SELECTOR,
365+
timeout=settings.SMALL_TIMEOUT)
322366

323-
self.assert_exact_text(text, selector="html", by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
367+
self.assert_exact_text(text, selector="html", by=By.CSS_SELECTOR,
368+
timeout=settings.SMALL_TIMEOUT)
324369

325370
########
326371

327372
self.wait_for_link_text_present(link_text, timeout=settings.SMALL_TIMEOUT)
328373

329-
self.wait_for_partial_link_text_present(link_text, timeout=settings.SMALL_TIMEOUT)
374+
self.wait_for_partial_link_text_present(link_text,
375+
timeout=settings.SMALL_TIMEOUT)
330376

331377
self.wait_for_link_text_visible(link_text, timeout=settings.LARGE_TIMEOUT)
332378

@@ -338,23 +384,30 @@ self.assert_link_text(link_text, timeout=settings.SMALL_TIMEOUT)
338384

339385
########
340386

341-
self.wait_for_partial_link_text(partial_link_text, timeout=settings.LARGE_TIMEOUT)
387+
self.wait_for_partial_link_text(partial_link_text,
388+
timeout=settings.LARGE_TIMEOUT)
342389

343-
self.find_partial_link_text(partial_link_text, timeout=settings.LARGE_TIMEOUT)
390+
self.find_partial_link_text(partial_link_text,
391+
timeout=settings.LARGE_TIMEOUT)
344392

345-
self.assert_partial_link_text(partial_link_text, timeout=settings.SMALL_TIMEOUT)
393+
self.assert_partial_link_text(partial_link_text,
394+
timeout=settings.SMALL_TIMEOUT)
346395

347396
########
348397

349-
self.wait_for_element_absent(selector, by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
398+
self.wait_for_element_absent(selector, by=By.CSS_SELECTOR,
399+
timeout=settings.LARGE_TIMEOUT)
350400

351-
self.assert_element_absent(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
401+
self.assert_element_absent(selector, by=By.CSS_SELECTOR,
402+
timeout=settings.SMALL_TIMEOUT)
352403

353404
########
354405

355-
self.wait_for_element_not_visible(selector, by=By.CSS_SELECTOR, timeout=settings.LARGE_TIMEOUT)
406+
self.wait_for_element_not_visible(selector, by=By.CSS_SELECTOR,
407+
timeout=settings.LARGE_TIMEOUT)
356408

357-
self.assert_element_not_visible(selector, by=By.CSS_SELECTOR, timeout=settings.SMALL_TIMEOUT)
409+
self.assert_element_not_visible(selector, by=By.CSS_SELECTOR,
410+
timeout=settings.SMALL_TIMEOUT)
358411

359412
########
360413

@@ -370,9 +423,11 @@ self.check_window(name="default", level=0, baseline=False)
370423

371424
########
372425

373-
self.delayed_assert_element(selector, by=By.CSS_SELECTOR, timeout=settings.MINI_TIMEOUT)
426+
self.delayed_assert_element(selector, by=By.CSS_SELECTOR,
427+
timeout=settings.MINI_TIMEOUT)
374428

375-
self.delayed_assert_text(text, selector="html", by=By.CSS_SELECTOR, timeout=settings.MINI_TIMEOUT)
429+
self.delayed_assert_text(text, selector="html", by=By.CSS_SELECTOR,
430+
timeout=settings.MINI_TIMEOUT)
376431

377432
self.process_delayed_asserts()
378433
```

0 commit comments

Comments
 (0)