forked from microsoft/playwright-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsync_api.py
More file actions
6281 lines (5338 loc) · 264 KB
/
sync_api.py
File metadata and controls
6281 lines (5338 loc) · 264 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
# Copyright (c) Microsoft Corporation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import pathlib
import sys
import typing
if sys.version_info >= (3, 8): # pragma: no cover
from typing import Literal
else: # pragma: no cover
from typing_extensions import Literal
from playwright.accessibility import Accessibility as AccessibilityImpl
from playwright.browser import Browser as BrowserImpl
from playwright.browser_context import BrowserContext as BrowserContextImpl
from playwright.browser_type import BrowserType as BrowserTypeImpl
from playwright.cdp_session import CDPSession as CDPSessionImpl
from playwright.chromium_browser_context import (
ChromiumBrowserContext as ChromiumBrowserContextImpl,
)
from playwright.console_message import ConsoleMessage as ConsoleMessageImpl
from playwright.dialog import Dialog as DialogImpl
from playwright.download import Download as DownloadImpl
from playwright.element_handle import ElementHandle as ElementHandleImpl
from playwright.file_chooser import FileChooser as FileChooserImpl
from playwright.frame import Frame as FrameImpl
from playwright.helper import (
ConsoleMessageLocation,
Credentials,
DeviceDescriptor,
Error,
FilePayload,
FloatRect,
Geolocation,
IntSize,
MousePosition,
PdfMargins,
ProxyServer,
RequestFailure,
SelectOption,
Viewport,
)
from playwright.input import Keyboard as KeyboardImpl
from playwright.input import Mouse as MouseImpl
from playwright.js_handle import JSHandle as JSHandleImpl
from playwright.network import Request as RequestImpl
from playwright.network import Response as ResponseImpl
from playwright.network import Route as RouteImpl
from playwright.page import BindingCall as BindingCallImpl
from playwright.page import Page as PageImpl
from playwright.page import Worker as WorkerImpl
from playwright.playwright import Playwright as PlaywrightImpl
from playwright.selectors import Selectors as SelectorsImpl
from playwright.sync_base import EventContextManager, SyncBase, mapping
NoneType = type(None)
class Request(SyncBase):
def __init__(self, obj: RequestImpl):
super().__init__(obj)
@property
def url(self) -> str:
"""Request.url
Returns
-------
str
URL of the request.
"""
return mapping.from_maybe_impl(self._impl_obj.url)
@property
def resourceType(self) -> str:
"""Request.resourceType
Contains the request's resource type as it was perceived by the rendering engine.
ResourceType will be one of the following: `document`, `stylesheet`, `image`, `media`, `font`, `script`, `texttrack`, `xhr`, `fetch`, `eventsource`, `websocket`, `manifest`, `other`.
Returns
-------
str
"""
return mapping.from_maybe_impl(self._impl_obj.resourceType)
@property
def method(self) -> str:
"""Request.method
Returns
-------
str
Request's method (GET, POST, etc.)
"""
return mapping.from_maybe_impl(self._impl_obj.method)
@property
def postData(self) -> typing.Union[str, NoneType]:
"""Request.postData
Returns
-------
Optional[str]
Request's post body, if any.
"""
return mapping.from_maybe_impl(self._impl_obj.postData)
@property
def postDataJSON(self) -> typing.Union[typing.Dict, NoneType]:
"""Request.postDataJSON
When the response is `application/x-www-form-urlencoded` then a key/value object of the values will be returned. Otherwise it will be parsed as JSON.
Returns
-------
Optional[Dict]
Parsed request's body for `form-urlencoded` and JSON as a fallback if any.
"""
return mapping.from_maybe_impl(self._impl_obj.postDataJSON)
@property
def postDataBuffer(self) -> typing.Union[bytes, NoneType]:
"""Request.postDataBuffer
Returns
-------
Optional[bytes]
Request's post body in a binary form, if any.
"""
return mapping.from_maybe_impl(self._impl_obj.postDataBuffer)
@property
def headers(self) -> typing.Dict[str, str]:
"""Request.headers
Returns
-------
Dict[str, str]
An object with HTTP headers associated with the request. All header names are lower-case.
"""
return mapping.from_maybe_impl(self._impl_obj.headers)
@property
def frame(self) -> "Frame":
"""Request.frame
Returns
-------
Frame
A Frame that initiated this request.
"""
return mapping.from_impl(self._impl_obj.frame)
@property
def redirectedFrom(self) -> typing.Union["Request", NoneType]:
"""Request.redirectedFrom
When the server responds with a redirect, Playwright creates a new Request object. The two requests are connected by `redirectedFrom()` and `redirectedTo()` methods. When multiple server redirects has happened, it is possible to construct the whole redirect chain by repeatedly calling `redirectedFrom()`.
For example, if the website `http://example.com` redirects to `https://example.com`:
If the website `https://google.com` has no redirects:
Returns
-------
Optional[Request]
Request that was redirected by the server to this one, if any.
"""
return mapping.from_impl_nullable(self._impl_obj.redirectedFrom)
@property
def redirectedTo(self) -> typing.Union["Request", NoneType]:
"""Request.redirectedTo
This method is the opposite of request.redirectedFrom():
Returns
-------
Optional[Request]
New request issued by the browser if the server responded with redirect.
"""
return mapping.from_impl_nullable(self._impl_obj.redirectedTo)
@property
def failure(self) -> typing.Union[RequestFailure, NoneType]:
"""Request.failure
The method returns `null` unless this request has failed, as reported by
`requestfailed` event.
Example of logging of all the failed requests:
Returns
-------
Optional[{"errorText": str}]
Object describing request failure, if any
"""
return mapping.from_maybe_impl(self._impl_obj.failure)
def response(self) -> typing.Union["Response", NoneType]:
"""Request.response
Returns
-------
Optional[Response]
A matching Response object, or `null` if the response was not received due to error.
"""
return mapping.from_impl_nullable(self._sync(self._impl_obj.response()))
def isNavigationRequest(self) -> bool:
"""Request.isNavigationRequest
Whether this request is driving frame's navigation.
Returns
-------
bool
"""
return mapping.from_maybe_impl(self._impl_obj.isNavigationRequest())
mapping.register(RequestImpl, Request)
class Response(SyncBase):
def __init__(self, obj: ResponseImpl):
super().__init__(obj)
@property
def url(self) -> str:
"""Response.url
Contains the URL of the response.
Returns
-------
str
"""
return mapping.from_maybe_impl(self._impl_obj.url)
@property
def ok(self) -> bool:
"""Response.ok
Contains a boolean stating whether the response was successful (status in the range 200-299) or not.
Returns
-------
bool
"""
return mapping.from_maybe_impl(self._impl_obj.ok)
@property
def status(self) -> int:
"""Response.status
Contains the status code of the response (e.g., 200 for a success).
Returns
-------
int
"""
return mapping.from_maybe_impl(self._impl_obj.status)
@property
def statusText(self) -> str:
"""Response.statusText
Contains the status text of the response (e.g. usually an "OK" for a success).
Returns
-------
str
"""
return mapping.from_maybe_impl(self._impl_obj.statusText)
@property
def headers(self) -> typing.Dict[str, str]:
"""Response.headers
Returns
-------
Dict[str, str]
An object with HTTP headers associated with the response. All header names are lower-case.
"""
return mapping.from_maybe_impl(self._impl_obj.headers)
@property
def request(self) -> "Request":
"""Response.request
Returns
-------
Request
A matching Request object.
"""
return mapping.from_impl(self._impl_obj.request)
@property
def frame(self) -> "Frame":
"""Response.frame
Returns
-------
Frame
A Frame that initiated this response.
"""
return mapping.from_impl(self._impl_obj.frame)
def finished(self) -> typing.Union[Error, NoneType]:
"""Response.finished
Returns
-------
Optional[Error]
Waits for this response to finish, returns failure error if request failed.
"""
return mapping.from_maybe_impl(self._sync(self._impl_obj.finished()))
def body(self) -> bytes:
"""Response.body
Returns
-------
bytes
Promise which resolves to a buffer with response body.
"""
return mapping.from_maybe_impl(self._sync(self._impl_obj.body()))
def text(self) -> str:
"""Response.text
Returns
-------
str
Promise which resolves to a text representation of response body.
"""
return mapping.from_maybe_impl(self._sync(self._impl_obj.text()))
def json(self) -> typing.Union[typing.Dict, typing.List]:
"""Response.json
This method will throw if the response body is not parsable via `JSON.parse`.
Returns
-------
Union[Dict, List]
Promise which resolves to a JSON representation of response body.
"""
return mapping.from_maybe_impl(self._sync(self._impl_obj.json()))
mapping.register(ResponseImpl, Response)
class Route(SyncBase):
def __init__(self, obj: RouteImpl):
super().__init__(obj)
@property
def request(self) -> "Request":
"""Route.request
Returns
-------
Request
A request to be routed.
"""
return mapping.from_impl(self._impl_obj.request)
def abort(self, errorCode: str = None) -> NoneType:
"""Route.abort
Aborts the route's request.
Parameters
----------
errorCode : Optional[str]
Optional error code. Defaults to `failed`, could be
one of the following:
- `'aborted'` - An operation was aborted (due to user action)
- `'accessdenied'` - Permission to access a resource, other than the network, was denied
- `'addressunreachable'` - The IP address is unreachable. This usually means
- that there is no route to the specified host or network.
- `'blockedbyclient'` - The client chose to block the request.
- `'blockedbyresponse'` - The request failed because the response was delivered along with requirements which are not met ('X-Frame-Options' and 'Content-Security-Policy' ancestor checks, for instance).
- `'connectionaborted'` - A connection timed out as a result of not receiving an ACK for data sent.
- `'connectionclosed'` - A connection was closed (corresponding to a TCP FIN).
- `'connectionfailed'` - A connection attempt failed.
- `'connectionrefused'` - A connection attempt was refused.
- `'connectionreset'` - A connection was reset (corresponding to a TCP RST).
- `'internetdisconnected'` - The Internet connection has been lost.
- `'namenotresolved'` - The host name could not be resolved.
- `'timedout'` - An operation timed out.
- `'failed'` - A generic failure occurred.
"""
return mapping.from_maybe_impl(
self._sync(self._impl_obj.abort(errorCode=errorCode))
)
def fulfill(
self,
status: int = None,
headers: typing.Union[typing.Dict[str, str]] = None,
body: typing.Union[str, bytes] = None,
path: typing.Union[str, pathlib.Path] = None,
contentType: str = None,
) -> NoneType:
"""Route.fulfill
Fulfills route's request with given response.
An example of fulfilling all requests with 404 responses:
An example of serving static file:
Parameters
----------
status : Optional[int]
Response status code, defaults to `200`.
headers : Optional[Dict[str, str]]
Optional response headers. Header values will be converted to a string.
body : Union[str, bytes, NoneType]
Optional response body.
path : Union[str, pathlib.Path, NoneType]
Optional file path to respond with. The content type will be inferred from file extension. If `path` is a relative path, then it is resolved relative to current working directory.
contentType : Optional[str]
If set, equals to setting `Content-Type` response header.
"""
return mapping.from_maybe_impl(
self._sync(
self._impl_obj.fulfill(
status=status,
headers=mapping.to_impl(headers),
body=body,
path=path,
contentType=contentType,
)
)
)
def continue_(
self,
method: str = None,
headers: typing.Union[typing.Dict[str, str]] = None,
postData: typing.Union[str, bytes] = None,
) -> NoneType:
"""Route.continue_
Continues route's request with optional overrides.
Parameters
----------
method : Optional[str]
If set changes the request method (e.g. GET or POST)
headers : Optional[Dict[str, str]]
If set changes the request HTTP headers. Header values will be converted to a string.
postData : Union[str, bytes, NoneType]
If set changes the post data of request
"""
return mapping.from_maybe_impl(
self._sync(
self._impl_obj.continue_(
method=method, headers=mapping.to_impl(headers), postData=postData
)
)
)
mapping.register(RouteImpl, Route)
class Keyboard(SyncBase):
def __init__(self, obj: KeyboardImpl):
super().__init__(obj)
def down(self, key: str) -> NoneType:
"""Keyboard.down
Dispatches a `keydown` event.
`key` can specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of the `key` values can be found here. Examples of the keys are:
`F1` - `F12`, `Digit0`- `Digit9`, `KeyA`- `KeyZ`, `Backquote`, `Minus`, `Equal`, `Backslash`, `Backspace`, `Tab`, `Delete`, `Escape`, `ArrowDown`, `End`, `Enter`, `Home`, `Insert`, `PageDown`, `PageUp`, `ArrowRight`, `ArrowUp`, etc.
Following modification shortcuts are also suported: `Shift`, `Control`, `Alt`, `Meta`, `ShiftLeft`.
Holding down `Shift` will type the text that corresponds to the `key` in the upper case.
If `key` is a single character, it is case-sensitive, so the values `a` and `A` will generate different respective texts.
If `key` is a modifier key, `Shift`, `Meta`, `Control`, or `Alt`, subsequent key presses will be sent with that modifier active. To release the modifier key, use `keyboard.up`.
After the key is pressed once, subsequent calls to `keyboard.down` will have repeat set to true. To release the key, use `keyboard.up`.
**NOTE** Modifier keys DO influence `keyboard.down`. Holding down `Shift` will type the text in upper case.
Parameters
----------
key : str
Name of the key to press or a character to generate, such as `ArrowLeft` or `a`.
"""
return mapping.from_maybe_impl(self._sync(self._impl_obj.down(key=key)))
def up(self, key: str) -> NoneType:
"""Keyboard.up
Dispatches a `keyup` event.
Parameters
----------
key : str
Name of the key to press or a character to generate, such as `ArrowLeft` or `a`.
"""
return mapping.from_maybe_impl(self._sync(self._impl_obj.up(key=key)))
def insertText(self, text: str) -> NoneType:
"""Keyboard.insertText
Dispatches only `input` event, does not emit the `keydown`, `keyup` or `keypress` events.
**NOTE** Modifier keys DO NOT effect `keyboard.insertText`. Holding down `Shift` will not type the text in upper case.
Parameters
----------
text : str
Sets input to the specified text value.
"""
return mapping.from_maybe_impl(self._sync(self._impl_obj.insertText(text=text)))
def type(self, text: str, delay: int = None) -> NoneType:
"""Keyboard.type
Sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text.
To press a special key, like `Control` or `ArrowDown`, use `keyboard.press`.
**NOTE** Modifier keys DO NOT effect `keyboard.type`. Holding down `Shift` will not type the text in upper case.
Parameters
----------
text : str
A text to type into a focused element.
delay : Optional[int]
Time to wait between key presses in milliseconds. Defaults to 0.
"""
return mapping.from_maybe_impl(
self._sync(self._impl_obj.type(text=text, delay=delay))
)
def press(self, key: str, delay: int = None) -> NoneType:
"""Keyboard.press
`key` can specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of the `key` values can be found here. Examples of the keys are:
`F1` - `F12`, `Digit0`- `Digit9`, `KeyA`- `KeyZ`, `Backquote`, `Minus`, `Equal`, `Backslash`, `Backspace`, `Tab`, `Delete`, `Escape`, `ArrowDown`, `End`, `Enter`, `Home`, `Insert`, `PageDown`, `PageUp`, `ArrowRight`, `ArrowUp`, etc.
Following modification shortcuts are also suported: `Shift`, `Control`, `Alt`, `Meta`, `ShiftLeft`.
Holding down `Shift` will type the text that corresponds to the `key` in the upper case.
If `key` is a single character, it is case-sensitive, so the values `a` and `A` will generate different respective texts.
Shortcuts such as `key: "Control+o"` or `key: "Control+Shift+T"` are supported as well. When speficied with the modifier, modifier is pressed and being held while the subsequent key is being pressed.
Shortcut for `keyboard.down` and `keyboard.up`.
Parameters
----------
key : str
Name of the key to press or a character to generate, such as `ArrowLeft` or `a`.
delay : Optional[int]
Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0.
"""
return mapping.from_maybe_impl(
self._sync(self._impl_obj.press(key=key, delay=delay))
)
mapping.register(KeyboardImpl, Keyboard)
class Mouse(SyncBase):
def __init__(self, obj: MouseImpl):
super().__init__(obj)
def move(self, x: float, y: float, steps: int = None) -> NoneType:
"""Mouse.move
Dispatches a `mousemove` event.
Parameters
----------
x : float
y : float
steps : Optional[int]
defaults to 1. Sends intermediate `mousemove` events.
"""
return mapping.from_maybe_impl(
self._sync(self._impl_obj.move(x=x, y=y, steps=steps))
)
def down(
self, button: Literal["left", "middle", "right"] = None, clickCount: int = None
) -> NoneType:
"""Mouse.down
Dispatches a `mousedown` event.
Parameters
----------
button : Optional[Literal['left', 'middle', 'right']]
Defaults to `left`.
clickCount : Optional[int]
defaults to 1. See UIEvent.detail.
"""
return mapping.from_maybe_impl(
self._sync(self._impl_obj.down(button=button, clickCount=clickCount))
)
def up(
self, button: Literal["left", "middle", "right"] = None, clickCount: int = None
) -> NoneType:
"""Mouse.up
Dispatches a `mouseup` event.
Parameters
----------
button : Optional[Literal['left', 'middle', 'right']]
Defaults to `left`.
clickCount : Optional[int]
defaults to 1. See UIEvent.detail.
"""
return mapping.from_maybe_impl(
self._sync(self._impl_obj.up(button=button, clickCount=clickCount))
)
def click(
self,
x: float,
y: float,
delay: int = None,
button: Literal["left", "middle", "right"] = None,
clickCount: int = None,
) -> NoneType:
"""Mouse.click
Shortcut for `mouse.move`, `mouse.down` and `mouse.up`.
Parameters
----------
x : float
y : float
delay : Optional[int]
Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
button : Optional[Literal['left', 'middle', 'right']]
Defaults to `left`.
clickCount : Optional[int]
defaults to 1. See UIEvent.detail.
"""
return mapping.from_maybe_impl(
self._sync(
self._impl_obj.click(
x=x, y=y, delay=delay, button=button, clickCount=clickCount
)
)
)
def dblclick(
self,
x: float,
y: float,
delay: int = None,
button: Literal["left", "middle", "right"] = None,
) -> NoneType:
"""Mouse.dblclick
Shortcut for `mouse.move`, `mouse.down`, `mouse.up`, `mouse.down` and `mouse.up`.
Parameters
----------
x : float
y : float
delay : Optional[int]
Time to wait between `mousedown` and `mouseup` in milliseconds. Defaults to 0.
button : Optional[Literal['left', 'middle', 'right']]
Defaults to `left`.
"""
return mapping.from_maybe_impl(
self._sync(self._impl_obj.dblclick(x=x, y=y, delay=delay, button=button))
)
mapping.register(MouseImpl, Mouse)
class JSHandle(SyncBase):
def __init__(self, obj: JSHandleImpl):
super().__init__(obj)
def evaluate(
self, expression: str, arg: typing.Any = None, force_expr: bool = None
) -> typing.Any:
"""JSHandle.evaluate
This method passes this handle as the first argument to `pageFunction`.
If `pageFunction` returns a Promise, then `handle.evaluate` would wait for the promise to resolve and return its value.
Examples:
Parameters
----------
expression : str
Function to be evaluated in browser context
force_expr : bool
Whether to treat given expression as JavaScript evaluate expression, even though it looks like an arrow function
arg : Optional[Any]
Optional argument to pass to `pageFunction`
Returns
-------
Any
Promise which resolves to the return value of `pageFunction`
"""
return mapping.from_maybe_impl(
self._sync(
self._impl_obj.evaluate(
expression=expression,
arg=mapping.to_impl(arg),
force_expr=force_expr,
)
)
)
def evaluateHandle(
self, expression: str, arg: typing.Any = None, force_expr: bool = None
) -> "JSHandle":
"""JSHandle.evaluateHandle
This method passes this handle as the first argument to `pageFunction`.
The only difference between `jsHandle.evaluate` and `jsHandle.evaluateHandle` is that `jsHandle.evaluateHandle` returns in-page object (JSHandle).
If the function passed to the `jsHandle.evaluateHandle` returns a Promise, then `jsHandle.evaluateHandle` would wait for the promise to resolve and return its value.
See page.evaluateHandle() for more details.
Parameters
----------
expression : str
Function to be evaluated
force_expr : bool
Whether to treat given expression as JavaScript evaluate expression, even though it looks like an arrow function
arg : Optional[Any]
Optional argument to pass to `pageFunction`
Returns
-------
JSHandle
Promise which resolves to the return value of `pageFunction` as in-page object (JSHandle)
"""
return mapping.from_impl(
self._sync(
self._impl_obj.evaluateHandle(
expression=expression,
arg=mapping.to_impl(arg),
force_expr=force_expr,
)
)
)
def getProperty(self, propertyName: str) -> "JSHandle":
"""JSHandle.getProperty
Fetches a single property from the referenced object.
Parameters
----------
propertyName : str
property to get
Returns
-------
JSHandle
"""
return mapping.from_impl(
self._sync(self._impl_obj.getProperty(propertyName=propertyName))
)
def getProperties(self) -> typing.Dict[str, "JSHandle"]:
"""JSHandle.getProperties
The method returns a map with **own property names** as keys and JSHandle instances for the property values.
Returns
-------
Dict[str, JSHandle]
"""
return mapping.from_impl_dict(self._sync(self._impl_obj.getProperties()))
def asElement(self) -> typing.Union["ElementHandle", NoneType]:
"""JSHandle.asElement
Returns either `null` or the object handle itself, if the object handle is an instance of ElementHandle.
Returns
-------
Optional[ElementHandle]
"""
return mapping.from_impl_nullable(self._impl_obj.asElement())
def dispose(self) -> NoneType:
"""JSHandle.dispose
The `jsHandle.dispose` method stops referencing the element handle.
"""
return mapping.from_maybe_impl(self._sync(self._impl_obj.dispose()))
def jsonValue(self) -> typing.Any:
"""JSHandle.jsonValue
Returns a JSON representation of the object. If the object has a
`toJSON`
function, it **will not be called**.
**NOTE** The method will return an empty JSON object if the referenced object is not stringifiable. It will throw an error if the object has circular references.
Returns
-------
Any
"""
return mapping.from_maybe_impl(self._sync(self._impl_obj.jsonValue()))
mapping.register(JSHandleImpl, JSHandle)
class ElementHandle(JSHandle):
def __init__(self, obj: ElementHandleImpl):
super().__init__(obj)
def toString(self) -> str:
"""ElementHandle.toString
Returns
-------
str
"""
return mapping.from_maybe_impl(self._impl_obj.toString())
def asElement(self) -> typing.Union["ElementHandle", NoneType]:
"""ElementHandle.asElement
Returns either `null` or the object handle itself, if the object handle is an instance of ElementHandle.
Returns
-------
Optional[ElementHandle]
"""
return mapping.from_impl_nullable(self._impl_obj.asElement())
def ownerFrame(self) -> typing.Union["Frame", NoneType]:
"""ElementHandle.ownerFrame
Returns
-------
Optional[Frame]
Returns the frame containing the given element.
"""
return mapping.from_impl_nullable(self._sync(self._impl_obj.ownerFrame()))
def contentFrame(self) -> typing.Union["Frame", NoneType]:
"""ElementHandle.contentFrame
Returns
-------
Optional[Frame]
Resolves to the content frame for element handles referencing iframe nodes, or `null` otherwise
"""
return mapping.from_impl_nullable(self._sync(self._impl_obj.contentFrame()))
def getAttribute(self, name: str) -> typing.Union[str, NoneType]:
"""ElementHandle.getAttribute
Returns element attribute value.
Parameters
----------
name : str
Attribute name to get the value for.
Returns
-------
Optional[str]
"""
return mapping.from_maybe_impl(
self._sync(self._impl_obj.getAttribute(name=name))
)
def textContent(self) -> typing.Union[str, NoneType]:
"""ElementHandle.textContent
Returns
-------
Optional[str]
Resolves to the `node.textContent`.
"""
return mapping.from_maybe_impl(self._sync(self._impl_obj.textContent()))
def innerText(self) -> str:
"""ElementHandle.innerText
Returns
-------
str
Resolves to the `element.innerText`.
"""
return mapping.from_maybe_impl(self._sync(self._impl_obj.innerText()))
def innerHTML(self) -> str:
"""ElementHandle.innerHTML
Returns
-------
str
Resolves to the `element.innerHTML`.
"""
return mapping.from_maybe_impl(self._sync(self._impl_obj.innerHTML()))
def dispatchEvent(self, type: str, eventInit: typing.Dict = None) -> NoneType:
"""ElementHandle.dispatchEvent
The snippet below dispatches the `click` event on the element. Regardless of the visibility state of the elment, `click` is dispatched. This is equivalend to calling `element.click()`.
Under the hood, it creates an instance of an event based on the given `type`, initializes it with `eventInit` properties and dispatches it on the element. Events are `composed`, `cancelable` and bubble by default.
Since `eventInit` is event-specific, please refer to the events documentation for the lists of initial properties:
DragEvent
FocusEvent
KeyboardEvent
MouseEvent
PointerEvent
TouchEvent
Event
You can also specify `JSHandle` as the property value if you want live objects to be passed into the event:
Parameters
----------
type : str
DOM event type: `"click"`, `"dragstart"`, etc.
eventInit : Optional[Dict]
event-specific initialization properties.
"""
return mapping.from_maybe_impl(
self._sync(
self._impl_obj.dispatchEvent(
type=type, eventInit=mapping.to_impl(eventInit)
)
)
)
def scrollIntoViewIfNeeded(self, timeout: int = None) -> NoneType:
"""ElementHandle.scrollIntoViewIfNeeded
This method waits for actionability checks, then tries to scroll element into view, unless it is completely visible as defined by IntersectionObserver's `ratio`.
Throws when `elementHandle` does not point to an element connected to a Document or a ShadowRoot.
Parameters
----------
timeout : Optional[int]
Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
"""
return mapping.from_maybe_impl(
self._sync(self._impl_obj.scrollIntoViewIfNeeded(timeout=timeout))
)
def hover(
self,
modifiers: typing.Union[
typing.List[Literal["Alt", "Control", "Meta", "Shift"]]
] = None,
position: MousePosition = None,
timeout: int = None,
force: bool = None,
) -> NoneType:
"""ElementHandle.hover
This method hovers over the element by performing the following steps:
Wait for actionability checks on the element, unless `force` option is set.
Scroll the element into view if needed.
Use page.mouse to hover over the center of the element, or the specified `position`.
Wait for initiated navigations to either succeed or fail, unless `noWaitAfter` option is set.
If the element is detached from the DOM at any moment during the action, this method rejects.
When all steps combined have not finished during the specified `timeout`, this method rejects with a TimeoutError. Passing zero timeout disables this.
Parameters
----------
modifiers : Optional[List[Literal['Alt', 'Control', 'Meta', 'Shift']]]
Modifier keys to press. Ensures that only these modifiers are pressed during the hover, and then restores current modifiers back. If not specified, currently pressed modifiers are used.
position : Optional[{"x": float, "y": float}]
A point to hover relative to the top-left corner of element padding box. If not specified, hovers over some visible point of the element.
timeout : Optional[int]
Maximum time in milliseconds, defaults to 30 seconds, pass `0` to disable timeout. The default value can be changed by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.
force : Optional[bool]
Whether to bypass the actionability checks. Defaults to `false`.
"""
return mapping.from_maybe_impl(