-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Expand file tree
/
Copy pathsb_cdp.py
More file actions
3226 lines (2981 loc) · 125 KB
/
sb_cdp.py
File metadata and controls
3226 lines (2981 loc) · 125 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""Add CDP methods to extend the driver"""
import asyncio
import fasteners
import mycdp
import os
import random
import re
import sys
import time
from contextlib import suppress
from filelock import FileLock
from seleniumbase import config as sb_config
from seleniumbase.config import settings
from seleniumbase.fixtures import constants
from seleniumbase.fixtures import js_utils
from seleniumbase.fixtures import page_utils
from seleniumbase.fixtures import shared_utils
from seleniumbase.undetected.cdp_driver import cdp_util
from seleniumbase.undetected.cdp_driver import tab as cdp_tab
class CDPMethods():
def __init__(self, loop, page, driver):
self.loop = loop
self.page = page
self.driver = driver
def _swap_driver(self, driver):
self.driver = driver
self.page = driver.cdp.page
self.loop = driver.cdp.loop
def __slow_mode_pause_if_set(self):
if (
(hasattr(sb_config, "demo_mode") and sb_config.demo_mode)
or "--demo" in sys.argv
):
time.sleep(0.48)
elif (
(hasattr(sb_config, "slow_mode") and sb_config.slow_mode)
or "--slow" in sys.argv
):
time.sleep(0.24)
def __add_light_pause(self):
time.sleep(0.007)
def __convert_to_css_if_xpath(self, selector):
if page_utils.is_xpath_selector(selector):
with suppress(Exception):
css = js_utils.convert_to_css_selector(selector, "xpath")
if css:
return css
return selector
def __add_sync_methods(self, element):
if not element:
return element
element.clear_input = lambda: self.__clear_input(element)
element.click = lambda: self.__click(element)
element.flash = lambda *args, **kwargs: self.__flash(
element, *args, **kwargs
)
element.focus = lambda: self.__focus(element)
element.gui_click = (
lambda *args, **kwargs: self.__gui_click(element, *args, **kwargs)
)
element.highlight_overlay = lambda: self.__highlight_overlay(element)
element.mouse_click = lambda: self.__mouse_click(element)
element.click_with_offset = (
lambda *args, **kwargs: self.__mouse_click_with_offset_async(
element, *args, **kwargs
)
)
element.mouse_drag = (
lambda destination: self.__mouse_drag(element, destination)
)
element.mouse_move = lambda: self.__mouse_move(element)
element.press_keys = lambda text: self.__press_keys(element, text)
element.query_selector = (
lambda selector: self.__query_selector(element, selector)
)
element.querySelector = element.query_selector
element.query_selector_all = (
lambda selector: self.__query_selector_all(element, selector)
)
element.querySelectorAll = element.query_selector_all
element.remove_from_dom = lambda: self.__remove_from_dom(element)
element.save_screenshot = (
lambda *args, **kwargs: self.__save_screenshot(
element, *args, **kwargs)
)
element.save_to_dom = lambda: self.__save_to_dom(element)
element.scroll_into_view = lambda: self.__scroll_into_view(element)
element.select_option = lambda: self.__select_option(element)
element.send_file = (
lambda *file_paths: self.__send_file(element, *file_paths)
)
element.send_keys = lambda text: self.__send_keys(element, text)
element.set_text = lambda value: self.__set_text(element, value)
element.set_value = lambda value: self.__set_value(element, value)
element.type = lambda text: self.__type(element, text)
element.get_position = lambda: self.__get_position(element)
element.get_html = lambda: self.__get_html(element)
element.get_js_attributes = lambda: self.__get_js_attributes(element)
element.get_attribute = (
lambda attribute: self.__get_attribute(element, attribute)
)
# element.get_parent() should come last
element.get_parent = lambda: self.__get_parent(element)
return element
def get(self, url, **kwargs):
url = shared_utils.fix_url_as_needed(url)
driver = self.driver
if hasattr(driver, "cdp_base"):
driver = driver.cdp_base
load_timeout = 60.0
wait_timeout = 30.0
if hasattr(sb_config, "_cdp_proxy") and sb_config._cdp_proxy:
load_timeout = 90.0
wait_timeout = 45.0
try:
task = self.page.get(url, **kwargs)
self.loop.run_until_complete(
asyncio.wait_for(task, timeout=load_timeout)
)
except asyncio.TimeoutError:
print("Timeout loading %s" % url)
url_protocol = url.split(":")[0]
safe_url = True
if url_protocol not in ["about", "data", "chrome"]:
safe_url = False
if not safe_url:
time.sleep(constants.UC.CDP_MODE_OPEN_WAIT)
if shared_utils.is_windows():
time.sleep(constants.UC.EXTRA_WINDOWS_WAIT)
else:
time.sleep(0.012)
self.__slow_mode_pause_if_set()
try:
self.loop.run_until_complete(
asyncio.wait_for(self.page.wait(), timeout=wait_timeout)
)
except asyncio.TimeoutError:
pass
except Exception:
pass
def open(self, url, **kwargs):
self.get(url, **kwargs)
def reload(self, ignore_cache=True, script_to_evaluate_on_load=None):
self.loop.run_until_complete(
self.page.reload(
ignore_cache=ignore_cache,
script_to_evaluate_on_load=script_to_evaluate_on_load,
)
)
def refresh(self, *args, **kwargs):
self.reload(*args, **kwargs)
def get_event_loop(self):
return self.loop
def get_rd_host(self):
"""Returns the remote-debugging host (likely 127.0.0.1)"""
driver = self.driver
if hasattr(driver, "cdp_base"):
driver = driver.cdp_base
return driver.config.host
def get_rd_port(self):
"""Returns the remote-debugging port (commonly 9222)"""
driver = self.driver
if hasattr(driver, "cdp_base"):
driver = driver.cdp_base
return driver.config.port
def get_rd_url(self):
"""Returns the remote-debugging URL, which is used for
allowing the Playwright integration to launch stealthy,
and also applies nest-asyncio for nested event loops so
that SeleniumBase methods can be called from Playwright
without encountering event loop error messages such as:
Cannot run the event loop while another loop is running.
Also sets an environment variable to hide this warning:
Deprecation: "url.parse() behavior is not standardized".
(github.com/microsoft/playwright-python/issues/3016)"""
import nest_asyncio
nest_asyncio.apply()
os.environ["NODE_NO_WARNINGS"] = "1"
driver = self.driver
if hasattr(driver, "cdp_base"):
driver = driver.cdp_base
host = driver.config.host
port = driver.config.port
return f"http://{host}:{port}"
def get_endpoint_url(self):
"""Same as get_rd_url(), which returns the remote-debugging URL."""
return self.get_rd_url()
def get_port(self):
"""Same as get_rd_port(), which returns the remote-debugging port."""
return self.get_rd_port()
def get_websocket_url(self):
"""Returns the websocket URL of the active tab.
The websocket URL starts with `ws://`."""
return self.get_active_tab().websocket_url
def add_handler(self, event, handler):
self.page.add_handler(event, handler)
def find_element(self, selector, best_match=False, timeout=None):
"""Similar to select(), but also finds elements by text content.
When using text-based searches, if best_match=False, then will
find the first element with the text. If best_match=True, then
if multiple elements have that text, then will use the element
with the closest text-length to the text being searched for."""
if not timeout:
timeout = settings.SMALL_TIMEOUT
self.__add_light_pause()
selector = self.__convert_to_css_if_xpath(selector)
early_failure = False
if (":contains(") in selector:
selector, _ = page_utils.recalculate_selector(
selector, by="css selector", xp_ok=True
)
failure = False
try:
if early_failure:
raise Exception("Failed!")
if (
"contains(" not in selector
and not page_utils.is_xpath_selector(selector)
and not re.findall(r"\.\s", selector)
and not re.findall(r"\.$", selector)
and not re.findall(r"#\s", selector)
and not re.findall(r"#$", selector)
and (
selector in ["html", "body"]
or "[" in selector
or re.findall(r"\.\S", selector)
or re.findall(r"#\S", selector)
or " > " in selector
)
):
element = self.loop.run_until_complete(
self.page.select(selector, timeout=timeout)
)
else:
element = self.loop.run_until_complete(
self.page.find(
selector, best_match=best_match, timeout=timeout
)
)
except Exception:
failure = True
plural = "s"
if timeout == 1:
plural = ""
message = "\n Element {%s} was not found after %s second%s!" % (
selector,
timeout,
plural,
)
if failure:
raise Exception(message)
element = self.__add_sync_methods(element)
self.__slow_mode_pause_if_set()
return element
def find_element_by_text(self, text, tag_name=None, timeout=None):
"""Returns an element by matching text.
Optionally, provide a tag_name to narrow down the search to an
element with the given tag. (Eg: a, button, div, script, span)"""
if not timeout:
timeout = settings.SMALL_TIMEOUT
if tag_name:
try:
return self.find_element(
'%s:contains("%s")' % (tag_name, text), timeout=timeout
)
except Exception:
pass # The exception will be raised later
else:
self.__add_light_pause()
self.assert_text(text, timeout=timeout)
elements = self.loop.run_until_complete(
self.page.find_elements_by_text(text=text)
)
for element in elements:
if element:
element = self.__add_sync_methods(element)
return self.__add_sync_methods(element)
plural = "s"
if timeout == 1:
plural = ""
raise Exception(
"Text {%s} with tag {%s} was not found after %s second%s!"
% (text, tag_name, timeout, plural)
)
def find_all(self, selector, timeout=None):
if not timeout:
timeout = settings.SMALL_TIMEOUT
self.__add_light_pause()
selector = self.__convert_to_css_if_xpath(selector)
elements = self.loop.run_until_complete(
self.page.find_all(selector, timeout=timeout)
)
updated_elements = []
for element in elements:
element = self.__add_sync_methods(element)
updated_elements.append(element)
return updated_elements
def find_elements_by_text(self, text, tag_name=None):
"""Returns a list of elements by matching text.
Optionally, provide a tag_name to narrow down the search to only
elements with the given tag. (Eg: a, button, div, script, span)"""
self.__add_light_pause()
elements = self.loop.run_until_complete(
self.page.find_elements_by_text(text=text)
)
updated_elements = []
if tag_name:
tag_name = tag_name.lower().strip()
for element in elements:
if element and not tag_name:
element = self.__add_sync_methods(element)
if element not in updated_elements:
updated_elements.append(element)
elif (
element
and tag_name in element.tag_name.lower()
and text.strip() in element.text
):
element = self.__add_sync_methods(element)
if element not in updated_elements:
updated_elements.append(element)
elif (
element
and element.parent
and tag_name in element.parent.tag_name.lower()
and text.strip() in element.parent.text
):
element = self.__add_sync_methods(element.parent)
if element not in updated_elements:
updated_elements.append(element)
elif (
element
and element.parent
and element.parent.parent
and tag_name in element.parent.parent.tag_name.lower()
and text.strip() in element.parent.parent.text
):
element = self.__add_sync_methods(element.parent.parent)
if element not in updated_elements:
updated_elements.append(element)
return updated_elements
def select(self, selector, timeout=None):
"""Similar to find_element()."""
if not timeout:
timeout = settings.SMALL_TIMEOUT
self.__add_light_pause()
selector = self.__convert_to_css_if_xpath(selector)
if (":contains(" in selector):
return self.find_element(selector, timeout=timeout)
failure = False
try:
element = self.loop.run_until_complete(
self.page.select(selector, timeout=timeout)
)
except Exception:
failure = True
plural = "s"
if timeout == 1:
plural = ""
msg = "\n Element {%s} was not found after %s second%s!"
message = msg % (selector, timeout, plural)
if failure:
raise Exception(message)
element = self.__add_sync_methods(element)
self.__slow_mode_pause_if_set()
return element
def select_all(self, selector, timeout=None):
if not timeout:
timeout = settings.SMALL_TIMEOUT
self.__add_light_pause()
selector = self.__convert_to_css_if_xpath(selector)
if not self.is_element_present(selector):
self.sleep(1)
timeout = timeout - 1
if timeout < 1:
timeout = 1
try:
self.select(selector, timeout=timeout)
except Exception:
return []
elements = self.loop.run_until_complete(
self.page.select_all(selector, timeout=0.1)
)
updated_elements = []
for element in elements:
element = self.__add_sync_methods(element)
updated_elements.append(element)
return updated_elements
def find_elements(self, selector, timeout=None):
if not timeout:
timeout = settings.SMALL_TIMEOUT
return self.select_all(selector, timeout=timeout)
def find_visible_elements(self, selector, timeout=None):
if not timeout:
timeout = settings.SMALL_TIMEOUT
visible_elements = []
elements = self.select_all(selector, timeout=timeout)
for element in elements:
with suppress(Exception):
position = element.get_position()
if (position.width != 0 or position.height != 0):
visible_elements.append(element)
return visible_elements
def click_nth_element(self, selector, number):
elements = self.select_all(selector)
if len(elements) < number:
raise Exception(
"Not enough matching {%s} elements to "
"click number %s!" % (selector, number)
)
number = number - 1
if number < 0:
number = 0
element = elements[number]
element.scroll_into_view()
element.click()
def click_nth_visible_element(self, selector, number):
"""Finds all matching page elements and clicks the nth visible one.
Example: self.click_nth_visible_element('[type="checkbox"]', 5)
(Clicks the 5th visible checkbox on the page.)"""
elements = self.find_visible_elements(selector)
if len(elements) < number:
raise Exception(
"Not enough matching {%s} elements to "
"click number %s!" % (selector, number)
)
number = number - 1
if number < 0:
number = 0
element = elements[number]
element.scroll_into_view()
element.click()
def click_link(self, link_text):
self.find_elements_by_text(link_text, "a")[0].click()
def go_back(self):
self.loop.run_until_complete(self.page.back())
def go_forward(self):
self.loop.run_until_complete(self.page.forward())
def get_navigation_history(self):
return self.loop.run_until_complete(self.page.get_navigation_history())
def __clear_input(self, element):
return (
self.loop.run_until_complete(element.clear_input_async())
)
def __click(self, element):
result = (
self.loop.run_until_complete(element.click_async())
)
self.loop.run_until_complete(self.page.wait(0.2))
return result
def __flash(self, element, *args, **kwargs):
element.scroll_into_view()
if len(args) < 3 and "x_offset" not in kwargs:
x_offset = self.__get_x_scroll_offset()
kwargs["x_offset"] = x_offset
if len(args) < 3 and "y_offset" not in kwargs:
y_offset = self.__get_y_scroll_offset()
kwargs["y_offset"] = y_offset
return (
self.loop.run_until_complete(
element.flash_async(*args, **kwargs)
)
)
def __focus(self, element):
return (
self.loop.run_until_complete(element.focus_async())
)
def __gui_click(self, element, timeframe=None):
element.scroll_into_view()
self.__add_light_pause()
position = element.get_position()
x = position.x
y = position.y
e_width = position.width
e_height = position.height
# Relative to window
element_rect = {"height": e_height, "width": e_width, "x": x, "y": y}
window_rect = self.get_window_rect()
w_bottom_y = window_rect["y"] + window_rect["height"]
viewport_height = window_rect["innerHeight"]
x = window_rect["x"] + element_rect["x"]
y = w_bottom_y - viewport_height + element_rect["y"]
y_scroll_offset = window_rect["pageYOffset"]
y = y - y_scroll_offset
x = x + window_rect["scrollX"]
y = y + window_rect["scrollY"]
# Relative to screen
element_rect = {"height": e_height, "width": e_width, "x": x, "y": y}
e_width = element_rect["width"]
e_height = element_rect["height"]
e_x = element_rect["x"]
e_y = element_rect["y"]
x, y = ((e_x + e_width / 2.0) + 0.5), ((e_y + e_height / 2.0) + 0.5)
if not timeframe or not isinstance(timeframe, (int, float)):
timeframe = 0.25
if timeframe > 3:
timeframe = 3
self.gui_click_x_y(x, y, timeframe=timeframe)
return self.loop.run_until_complete(self.page.wait(0.2))
def __highlight_overlay(self, element):
return (
self.loop.run_until_complete(element.highlight_overlay_async())
)
def __mouse_click(self, element):
result = (
self.loop.run_until_complete(element.mouse_click_async())
)
self.loop.run_until_complete(self.page.wait(0.2))
return result
def __mouse_click_with_offset_async(self, element, *args, **kwargs):
result = (
self.loop.run_until_complete(
element.mouse_click_with_offset_async(*args, **kwargs)
)
)
self.loop.run_until_complete(self.page.wait(0.2))
return result
def __mouse_drag(self, element, destination):
return (
self.loop.run_until_complete(element.mouse_drag_async(destination))
)
def __mouse_move(self, element):
return (
self.loop.run_until_complete(element.mouse_move_async())
)
def __press_keys(self, element, text):
element.scroll_into_view()
submit = False
if text.endswith("\n") or text.endswith("\r"):
submit = True
text = text[:-1]
for key in text:
element.send_keys(key)
time.sleep(float(0.042 + (random.random() / 110.0)))
if submit:
element.send_keys("\r\n")
time.sleep(0.044)
self.__slow_mode_pause_if_set()
return self.loop.run_until_complete(self.page.sleep(0.025))
def __query_selector(self, element, selector):
selector = self.__convert_to_css_if_xpath(selector)
element2 = self.loop.run_until_complete(
element.query_selector_async(selector)
)
element2 = self.__add_sync_methods(element2)
return element2
def __query_selector_all(self, element, selector):
selector = self.__convert_to_css_if_xpath(selector)
elements = self.loop.run_until_complete(
element.query_selector_all_async(selector)
)
updated_elements = []
for element in elements:
element = self.__add_sync_methods(element)
updated_elements.append(element)
self.__slow_mode_pause_if_set()
return updated_elements
def __remove_from_dom(self, element):
return (
self.loop.run_until_complete(element.remove_from_dom_async())
)
def __save_screenshot(self, element, *args, **kwargs):
return (
self.loop.run_until_complete(
element.save_screenshot_async(*args, **kwargs)
)
)
def __save_to_dom(self, element):
return (
self.loop.run_until_complete(element.save_to_dom_async())
)
def __scroll_into_view(self, element):
self.loop.run_until_complete(element.scroll_into_view_async())
self.__add_light_pause()
return None
def __select_option(self, element):
return (
self.loop.run_until_complete(element.select_option_async())
)
def __send_file(self, element, *file_paths):
return (
self.loop.run_until_complete(element.send_file_async(*file_paths))
)
def __send_keys(self, element, text):
return (
self.loop.run_until_complete(element.send_keys_async(text))
)
def __set_text(self, element, value):
return (
self.loop.run_until_complete(element.set_text_async(value))
)
def __set_value(self, element, value):
return (
self.loop.run_until_complete(element.set_value_async(value))
)
def __type(self, element, text):
with suppress(Exception):
element.clear_input()
element.send_keys(text)
def __get_position(self, element):
return (
self.loop.run_until_complete(element.get_position_async())
)
def __get_html(self, element):
return (
self.loop.run_until_complete(element.get_html_async())
)
def __get_js_attributes(self, element):
return (
self.loop.run_until_complete(element.get_js_attributes_async())
)
def __get_attribute(self, element, attribute):
try:
return element.get_js_attributes()[attribute]
except Exception:
if not attribute:
raise
try:
attribute_str = element.get_js_attributes()
locate = ' %s="' % attribute
if locate in attribute_str.outerHTML:
outer_html = attribute_str.outerHTML
attr_start = outer_html.find(locate) + len(locate)
attr_end = outer_html.find('"', attr_start)
value = outer_html[attr_start:attr_end]
return value
except Exception:
pass
return None
def __get_parent(self, element):
return self.__add_sync_methods(element.parent)
def __get_x_scroll_offset(self):
x_scroll_offset = self.loop.run_until_complete(
self.page.evaluate("window.pageXOffset")
)
return x_scroll_offset or 0
def __get_y_scroll_offset(self):
y_scroll_offset = self.loop.run_until_complete(
self.page.evaluate("window.pageYOffset")
)
return y_scroll_offset or 0
def tile_windows(self, windows=None, max_columns=0):
"""Tile windows and return the grid of tiled windows."""
driver = self.driver
if hasattr(driver, "cdp_base"):
driver = driver.cdp_base
return self.loop.run_until_complete(
driver.tile_windows(windows, max_columns)
)
def grant_permissions(self, permissions, origin=None):
"""Grant specific permissions to the current window.
Applies to all origins if no origin is specified."""
driver = self.driver
if hasattr(driver, "cdp_base"):
driver = driver.cdp_base
return self.loop.run_until_complete(
driver.grant_permissions(permissions, origin)
)
def grant_all_permissions(self):
"""Grant all permissions to the current window for all origins."""
driver = self.driver
if hasattr(driver, "cdp_base"):
driver = driver.cdp_base
return self.loop.run_until_complete(driver.grant_all_permissions())
def reset_permissions(self):
"""Reset permissions for all origins on the current window."""
driver = self.driver
if hasattr(driver, "cdp_base"):
driver = driver.cdp_base
return self.loop.run_until_complete(driver.reset_permissions())
def get_all_cookies(self, *args, **kwargs):
driver = self.driver
if hasattr(driver, "cdp_base"):
driver = driver.cdp_base
return self.loop.run_until_complete(
driver.cookies.get_all(*args, **kwargs)
)
def set_all_cookies(self, *args, **kwargs):
driver = self.driver
if hasattr(driver, "cdp_base"):
driver = driver.cdp_base
return self.loop.run_until_complete(
driver.cookies.set_all(*args, **kwargs)
)
def save_cookies(self, *args, **kwargs):
driver = self.driver
if hasattr(driver, "cdp_base"):
driver = driver.cdp_base
return self.loop.run_until_complete(
driver.cookies.save(*args, **kwargs)
)
def load_cookies(self, *args, **kwargs):
driver = self.driver
if hasattr(driver, "cdp_base"):
driver = driver.cdp_base
return self.loop.run_until_complete(
driver.cookies.load(*args, **kwargs)
)
def clear_cookies(self):
driver = self.driver
if hasattr(driver, "cdp_base"):
driver = driver.cdp_base
return self.loop.run_until_complete(driver.cookies.clear())
def sleep(self, seconds):
time.sleep(seconds)
def bring_active_window_to_front(self):
self.loop.run_until_complete(self.page.bring_to_front())
self.__add_light_pause()
def get_active_element(self):
return self.loop.run_until_complete(
self.page.js_dumps("document.activeElement")
)
def get_active_element_css(self):
from seleniumbase.js_code import active_css_js
js_code = active_css_js.get_active_element_css
js_code = js_code.replace("return getBestSelector", "getBestSelector")
return self.loop.run_until_complete(self.page.evaluate(js_code))
def click(self, selector, timeout=None):
if not timeout:
timeout = settings.SMALL_TIMEOUT
self.__slow_mode_pause_if_set()
element = self.find_element(selector, timeout=timeout)
element.scroll_into_view()
tag_name = element.tag_name
if tag_name:
tag_name = tag_name.lower().strip()
if (
tag_name in [
"a", "button", "canvas", "div", "input", "li", "span", "label"
]
and "contains(" not in selector
):
try:
element.mouse_click() # Simulated click (NOT PyAutoGUI)
except Exception:
element.click() # Standard CDP click
else:
element.click() # Standard CDP click
self.__slow_mode_pause_if_set()
self.loop.run_until_complete(self.page.wait(0.2))
def click_active_element(self):
self.loop.run_until_complete(
self.page.evaluate("document.activeElement.click()")
)
self.__slow_mode_pause_if_set()
self.loop.run_until_complete(self.page.wait(0.2))
def click_if_visible(self, selector, timeout=0):
if self.is_element_visible(selector):
with suppress(Exception):
self.click(selector, timeout=1)
elif timeout == 0:
return
else:
with suppress(Exception):
self.find_element(selector, timeout=timeout)
if self.is_element_visible(selector):
3360
self.click(selector, timeout=1)
def click_visible_elements(self, selector, limit=0):
"""Finds all matching page elements and clicks visible ones in order.
If a click reloads or opens a new page, the clicking will stop.
If no matching elements appear, an Exception will be raised.
If "limit" is set and > 0, will only click that many elements.
Also clicks elements that become visible from previous clicks.
Works best for actions such as clicking all checkboxes on a page.
Example: self.click_visible_elements('input[type="checkbox"]')"""
elements = self.select_all(selector)
click_count = 0
for element in elements:
if limit and limit > 0 and click_count >= limit:
return
try:
width = 0
height = 0
try:
position = element.get_position()
width = position.width
height = position.height
except Exception:
continue
if (width != 0 or height != 0):
element.scroll_into_view()
element.click()
click_count += 1
time.sleep(0.044)
self.__slow_mode_pause_if_set()
self.loop.run_until_complete(self.page.wait(0.2))
except Exception:
break
def mouse_click(self, selector, timeout=None):
"""(Attempt simulating a mouse click)"""
if not timeout:
timeout = settings.SMALL_TIMEOUT
self.__slow_mode_pause_if_set()
element = self.find_element(selector, timeout=timeout)
element.scroll_into_view()
element.mouse_click()
self.__slow_mode_pause_if_set()
self.loop.run_until_complete(self.page.wait(0.2))
def nested_click(self, parent_selector, selector):
"""
Find parent element and click on child element inside it.
(This can be used to click on elements inside an iframe.)
"""
element = self.find_element(parent_selector)
element.query_selector(selector).mouse_click()
self.__slow_mode_pause_if_set()
self.loop.run_until_complete(self.page.wait(0.2))
def get_nested_element(self, parent_selector, selector):
"""(Can be used to find an element inside an iframe)"""
element = self.find_element(parent_selector)
return element.query_selector(selector)
def select_option_by_text(self, dropdown_selector, option):
element = self.find_element(dropdown_selector)
element.scroll_into_view()
options = element.query_selector_all("option")
for found_option in options:
if found_option.text.strip() == option.strip():
found_option.select_option()
return
raise Exception(
"Unable to find text option {%s} in dropdown {%s}!"
% (dropdown_selector, option)
)
def select_option_by_index(self, dropdown_selector, option):
element = self.find_element(dropdown_selector)
element.scroll_into_view()
options = element.query_selector_all("option")
count = 0
for found_option in options:
if count == int(option):
found_option.select_option()
return
count += 1
raise Exception(
"Unable to find index option {%s} in dropdown {%s}!"
% (dropdown_selector, option)
)
def select_option_by_value(self, dropdown_selector, option):
element = self.find_element(dropdown_selector)
element.scroll_into_view()
options = element.query_selector_all("option")
for found_option in options:
if (
"value" in found_option.attrs
and str(found_option.attrs["value"]) == str(option)
):
found_option.select_option()
return
raise Exception(
"Unable to find value option {%s} in dropdown {%s}!"
% (dropdown_selector, option)
)
def flash(
self,
selector, # The CSS Selector to flash
duration=1, # (seconds) flash duration
color="44CC88", # RGB hex flash color
pause=0, # (seconds) If 0, the next action starts during flash
):
"""Paint a quickly-vanishing dot over an element."""
selector = self.__convert_to_css_if_xpath(selector)
element = self.find_element(selector)
element.scroll_into_view()
x_offset = self.__get_x_scroll_offset()
y_offset = self.__get_y_scroll_offset()
element.flash(duration, color, x_offset, y_offset)
if pause and isinstance(pause, (int, float)):
time.sleep(pause)
def highlight(self, selector):
"""Highlight an element with multi-colors."""
selector = self.__convert_to_css_if_xpath(selector)
element = self.find_element(selector)
element.scroll_into_view()
x_offset = self.__get_x_scroll_offset()
y_offset = self.__get_y_scroll_offset()
element.flash(0.46, "44CC88", x_offset, y_offset)
time.sleep(0.15)
element.flash(0.42, "8844CC", x_offset, y_offset)
time.sleep(0.15)
element.flash(0.38, "CC8844", x_offset, y_offset)
time.sleep(0.15)
element.flash(0.30, "44CC88", x_offset, y_offset)
time.sleep(0.30)
def focus(self, selector):
element = self.find_element(selector)
element.scroll_into_view()
element.focus()
def highlight_overlay(self, selector):
self.find_element(selector).highlight_overlay()
def get_parent(self, element):
if isinstance(element, str):
element = self.select(element)
return self.__add_sync_methods(element.parent)
def remove_element(self, selector):
self.select(selector).remove_from_dom()
def remove_from_dom(self, selector):
self.select(selector).remove_from_dom()
def remove_elements(self, selector):
"""Remove all elements on the page that match the selector."""
css_selector = self.__convert_to_css_if_xpath(selector)
css_selector = re.escape(css_selector) # Add "\\" to special chars
css_selector = js_utils.escape_quotes_if_needed(css_selector)
js_code = (
"""var $elements = document.querySelectorAll('%s');
var index = 0, length = $elements.length;