forked from microsoft/playwright-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path_generated.py
More file actions
10491 lines (8868 loc) · 411 KB
/
_generated.py
File metadata and controls
10491 lines (8868 loc) · 411 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._impl._accessibility import Accessibility as AccessibilityImpl
from playwright._impl._api_structures import (
Cookie,
FilePayload,
FloatRect,
Geolocation,
HttpCredentials,
PdfMargins,
Position,
ProxySettings,
ResourceTiming,
SourceLocation,
StorageState,
ViewportSize,
)
from playwright._impl._browser import Browser as BrowserImpl
from playwright._impl._browser_context import BrowserContext as BrowserContextImpl
from playwright._impl._browser_type import BrowserType as BrowserTypeImpl
from playwright._impl._cdp_session import CDPSession as CDPSessionImpl
from playwright._impl._chromium_browser_context import (
ChromiumBrowserContext as ChromiumBrowserContextImpl,
)
from playwright._impl._console_message import ConsoleMessage as ConsoleMessageImpl
from playwright._impl._dialog import Dialog as DialogImpl
from playwright._impl._download import Download as DownloadImpl
from playwright._impl._element_handle import ElementHandle as ElementHandleImpl
from playwright._impl._file_chooser import FileChooser as FileChooserImpl
from playwright._impl._frame import Frame as FrameImpl
from playwright._impl._input import Keyboard as KeyboardImpl
from playwright._impl._input import Mouse as MouseImpl
from playwright._impl._input import Touchscreen as TouchscreenImpl
from playwright._impl._js_handle import JSHandle as JSHandleImpl
from playwright._impl._logger import log_api
from playwright._impl._network import Request as RequestImpl
from playwright._impl._network import Response as ResponseImpl
from playwright._impl._network import Route as RouteImpl
from playwright._impl._network import WebSocket as WebSocketImpl
from playwright._impl._page import BindingCall as BindingCallImpl
from playwright._impl._page import Page as PageImpl
from playwright._impl._page import Worker as WorkerImpl
from playwright._impl._playwright import Playwright as PlaywrightImpl
from playwright._impl._selectors import Selectors as SelectorsImpl
from playwright._impl._sync_base import EventContextManager, SyncBase, mapping
from playwright._impl._video import Video as VideoImpl
NoneType = type(None)
class Request(SyncBase):
def __init__(self, obj: RequestImpl):
super().__init__(obj)
@property
def url(self) -> str:
"""Request.url
URL of the request.
Returns
-------
str
"""
return mapping.from_maybe_impl(self._impl_obj.url)
@property
def resource_type(self) -> str:
"""Request.resource_type
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.resource_type)
@property
def method(self) -> str:
"""Request.method
Request's method (GET, POST, etc.)
Returns
-------
str
"""
return mapping.from_maybe_impl(self._impl_obj.method)
@property
def post_data(self) -> typing.Union[str, NoneType]:
"""Request.post_data
Request's post body, if any.
Returns
-------
Union[str, NoneType]
"""
return mapping.from_maybe_impl(self._impl_obj.post_data)
@property
def post_data_json(self) -> typing.Union[typing.Any, NoneType]:
"""Request.post_data_json
Returns parsed request's body for `form-urlencoded` and JSON as a fallback if any.
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
-------
Union[Any, NoneType]
"""
return mapping.from_maybe_impl(self._impl_obj.post_data_json)
@property
def post_data_buffer(self) -> typing.Union[bytes, NoneType]:
"""Request.post_data_buffer
Request's post body in a binary form, if any.
Returns
-------
Union[bytes, NoneType]
"""
return mapping.from_maybe_impl(self._impl_obj.post_data_buffer)
@property
def headers(self) -> typing.Dict[str, str]:
"""Request.headers
An object with HTTP headers associated with the request. All header names are lower-case.
Returns
-------
Dict[str, str]
"""
return mapping.from_maybe_impl(self._impl_obj.headers)
@property
def frame(self) -> "Frame":
"""Request.frame
Returns the `Frame` that initiated this request.
Returns
-------
Frame
"""
return mapping.from_impl(self._impl_obj.frame)
@property
def redirected_from(self) -> typing.Union["Request", NoneType]:
"""Request.redirected_from
Request that was redirected by the server to this one, if any.
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`:
```py
response = page.goto(\"http://example.com\")
print(response.request.redirected_from.url) # \"http://example.com\"
```
If the website `https://google.com` has no redirects:
```py
response = page.goto(\"https://google.com\")
print(response.request.redirected_from) # None
```
Returns
-------
Union[Request, NoneType]
"""
return mapping.from_impl_nullable(self._impl_obj.redirected_from)
@property
def redirected_to(self) -> typing.Union["Request", NoneType]:
"""Request.redirected_to
New request issued by the browser if the server responded with redirect.
This method is the opposite of `request.redirected_from()`:
```py
assert request.redirected_from.redirected_to == request
```
Returns
-------
Union[Request, NoneType]
"""
return mapping.from_impl_nullable(self._impl_obj.redirected_to)
@property
def failure(self) -> typing.Union[str, 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:
```py
page.on(\"requestfailed\", lambda request: print(request.url + \" \" + request.failure))
```
Returns
-------
Union[str, NoneType]
"""
return mapping.from_maybe_impl(self._impl_obj.failure)
@property
def timing(self) -> ResourceTiming:
"""Request.timing
Returns resource timing information for given request. Most of the timing values become available upon the response,
`responseEnd` becomes available when request finishes. Find more information at
[Resource Timing API](https://developer.mozilla.org/en-US/docs/Web/API/PerformanceResourceTiming).
```py
with page.expect_event(\"requestfinished\") as request_info:
page.goto(\"http://example.com\")
request = request_info.value
print(request.timing)
```
Returns
-------
{startTime: float, domainLookupStart: float, domainLookupEnd: float, connectStart: float, secureConnectionStart: float, connectEnd: float, requestStart: float, responseStart: float, responseEnd: float}
"""
return mapping.from_impl(self._impl_obj.timing)
def response(self) -> typing.Union["Response", NoneType]:
"""Request.response
Returns the matching `Response` object, or `null` if the response was not received due to error.
Returns
-------
Union[Response, NoneType]
"""
try:
log_api("=> request.response started")
result = mapping.from_impl_nullable(self._sync(self._impl_obj.response()))
log_api("<= request.response succeded")
return result
except Exception as e:
log_api("<= request.response failed")
raise e
def is_navigation_request(self) -> bool:
"""Request.is_navigation_request
Whether this request is driving frame's navigation.
Returns
-------
bool
"""
try:
log_api("=> request.is_navigation_request started")
result = mapping.from_maybe_impl(self._impl_obj.is_navigation_request())
log_api("<= request.is_navigation_request succeded")
return result
except Exception as e:
log_api("<= request.is_navigation_request failed")
raise e
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 status_text(self) -> str:
"""Response.status_text
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.status_text)
@property
def headers(self) -> typing.Dict[str, str]:
"""Response.headers
Returns the object with HTTP headers associated with the response. All header names are lower-case.
Returns
-------
Dict[str, str]
"""
return mapping.from_maybe_impl(self._impl_obj.headers)
@property
def request(self) -> "Request":
"""Response.request
Returns the matching `Request` object.
Returns
-------
Request
"""
return mapping.from_impl(self._impl_obj.request)
@property
def frame(self) -> "Frame":
"""Response.frame
Returns the `Frame` that initiated this response.
Returns
-------
Frame
"""
return mapping.from_impl(self._impl_obj.frame)
def finished(self) -> typing.Union[str, NoneType]:
"""Response.finished
Waits for this response to finish, returns failure error if request failed.
Returns
-------
Union[str, NoneType]
"""
try:
log_api("=> response.finished started")
result = mapping.from_maybe_impl(self._sync(self._impl_obj.finished()))
log_api("<= response.finished succeded")
return result
except Exception as e:
log_api("<= response.finished failed")
raise e
def body(self) -> bytes:
"""Response.body
Returns the buffer with response body.
Returns
-------
bytes
"""
try:
log_api("=> response.body started")
result = mapping.from_maybe_impl(self._sync(self._impl_obj.body()))
log_api("<= response.body succeded")
return result
except Exception as e:
log_api("<= response.body failed")
raise e
def text(self) -> str:
"""Response.text
Returns the text representation of response body.
Returns
-------
str
"""
try:
log_api("=> response.text started")
result = mapping.from_maybe_impl(self._sync(self._impl_obj.text()))
log_api("<= response.text succeded")
return result
except Exception as e:
log_api("<= response.text failed")
raise e
def json(self) -> typing.Any:
"""Response.json
Returns the JSON representation of response body.
This method will throw if the response body is not parsable via `JSON.parse`.
Returns
-------
Any
"""
try:
log_api("=> response.json started")
result = mapping.from_maybe_impl(self._sync(self._impl_obj.json()))
log_api("<= response.json succeded")
return result
except Exception as e:
log_api("<= response.json failed")
raise e
mapping.register(ResponseImpl, Response)
class Route(SyncBase):
def __init__(self, obj: RouteImpl):
super().__init__(obj)
@property
def request(self) -> "Request":
"""Route.request
A request to be routed.
Returns
-------
Request
"""
return mapping.from_impl(self._impl_obj.request)
def abort(self, error_code: str = None) -> NoneType:
"""Route.abort
Aborts the route's request.
Parameters
----------
error_code : Union[str, NoneType]
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.
"""
try:
log_api("=> route.abort started")
result = mapping.from_maybe_impl(
self._sync(self._impl_obj.abort(errorCode=error_code))
)
log_api("<= route.abort succeded")
return result
except Exception as e:
log_api("<= route.abort failed")
raise e
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,
content_type: str = None,
) -> NoneType:
"""Route.fulfill
Fulfills route's request with given response.
An example of fulfilling all requests with 404 responses:
```py
page.route(\"**/*\", lambda route: route.fulfill(
status=404,
content_type=\"text/plain\",
body=\"not found!\"))
```
An example of serving static file:
```py
page.route(\"**/xhr_endpoint\", lambda route: route.fulfill(path=\"mock_data.json\"))
```
Parameters
----------
status : Union[int, NoneType]
Response status code, defaults to `200`.
headers : Union[Dict[str, str], NoneType]
Response headers. Header values will be converted to a string.
body : Union[bytes, str, NoneType]
Response body.
path : Union[pathlib.Path, str, NoneType]
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 the current working directory.
content_type : Union[str, NoneType]
If set, equals to setting `Content-Type` response header.
"""
try:
log_api("=> route.fulfill started")
result = mapping.from_maybe_impl(
self._sync(
self._impl_obj.fulfill(
status=status,
headers=mapping.to_impl(headers),
body=body,
path=path,
contentType=content_type,
)
)
)
log_api("<= route.fulfill succeded")
return result
except Exception as e:
log_api("<= route.fulfill failed")
raise e
def continue_(
self,
url: str = None,
method: str = None,
headers: typing.Union[typing.Dict[str, str]] = None,
post_data: typing.Union[str, bytes] = None,
) -> NoneType:
"""Route.continue_
Continues route's request with optional overrides.
```py
def handle(route, request):
# override headers
headers = {
**request.headers,
\"foo\": \"bar\" # set \"foo\" header
\"origin\": None # remove \"origin\" header
}
route.continue(headers=headers)
}
page.route(\"**/*\", handle)
```
Parameters
----------
url : Union[str, NoneType]
If set changes the request URL. New URL must have same protocol as original one.
method : Union[str, NoneType]
If set changes the request method (e.g. GET or POST)
headers : Union[Dict[str, str], NoneType]
If set changes the request HTTP headers. Header values will be converted to a string.
post_data : Union[bytes, str, NoneType]
If set changes the post data of request
"""
try:
log_api("=> route.continue_ started")
result = mapping.from_maybe_impl(
self._sync(
self._impl_obj.continue_(
url=url,
method=method,
headers=mapping.to_impl(headers),
postData=post_data,
)
)
)
log_api("<= route.continue_ succeded")
return result
except Exception as e:
log_api("<= route.continue_ failed")
raise e
mapping.register(RouteImpl, Route)
class WebSocket(SyncBase):
def __init__(self, obj: WebSocketImpl):
super().__init__(obj)
@property
def url(self) -> str:
"""WebSocket.url
Contains the URL of the WebSocket.
Returns
-------
str
"""
return mapping.from_maybe_impl(self._impl_obj.url)
def expect_event(
self, event: str, predicate: typing.Callable = None, timeout: float = None
) -> EventContextManager:
"""WebSocket.expect_event
Waits for event to fire and passes its value into the predicate function. Returns when the predicate returns truthy
value. Will throw an error if the webSocket is closed before the event is fired. Returns the event data value.
Parameters
----------
event : str
Event name, same one would pass into `webSocket.on(event)`.
predicate : Union[Callable, NoneType]
Receives the event data and resolves to truthy value when the waiting should resolve.
timeout : Union[float, NoneType]
Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default
value can be changed by using the `browser_context.set_default_timeout()`.
Returns
-------
EventContextManager
"""
return EventContextManager(
self,
self._impl_obj.expect_event(
event=event, predicate=self._wrap_handler(predicate), timeout=timeout
).future,
)
def wait_for_event(
self, event: str, predicate: typing.Callable = None, timeout: float = None
) -> typing.Any:
"""WebSocket.wait_for_event
> NOTE: In most cases, you should use `web_socket.expect_event()`.
Waits for given `event` to fire. If predicate is provided, it passes event's value into the `predicate` function and
waits for `predicate(event)` to return a truthy value. Will throw an error if the socket is closed before the `event` is
fired.
Parameters
----------
event : str
Event name, same one typically passed into `*.on(event)`.
predicate : Union[Callable, NoneType]
Receives the event data and resolves to truthy value when the waiting should resolve.
timeout : Union[float, NoneType]
Maximum time to wait for in milliseconds. Defaults to `30000` (30 seconds). Pass `0` to disable timeout. The default
value can be changed by using the `browser_context.set_default_timeout()`.
Returns
-------
Any
"""
try:
log_api("=> web_socket.wait_for_event started")
result = mapping.from_maybe_impl(
self._sync(
self._impl_obj.wait_for_event(
event=event,
predicate=self._wrap_handler(predicate),
timeout=timeout,
)
)
)
log_api("<= web_socket.wait_for_event succeded")
return result
except Exception as e:
log_api("<= web_socket.wait_for_event failed")
raise e
def is_closed(self) -> bool:
"""WebSocket.is_closed
Indicates that the web socket has been closed.
Returns
-------
bool
"""
try:
log_api("=> web_socket.is_closed started")
result = mapping.from_maybe_impl(self._impl_obj.is_closed())
log_api("<= web_socket.is_closed succeded")
return result
except Exception as e:
log_api("<= web_socket.is_closed failed")
raise e
mapping.register(WebSocketImpl, WebSocket)
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](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key)
value or a single character to generate the text for. A superset of the `key` values can be found
[here](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values). 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 supported: `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](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/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`.
"""
try:
log_api("=> keyboard.down started")
result = mapping.from_maybe_impl(self._sync(self._impl_obj.down(key=key)))
log_api("<= keyboard.down succeded")
return result
except Exception as e:
log_api("<= keyboard.down failed")
raise e
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`.
"""
try:
log_api("=> keyboard.up started")
result = mapping.from_maybe_impl(self._sync(self._impl_obj.up(key=key)))
log_api("<= keyboard.up succeded")
return result
except Exception as e:
log_api("<= keyboard.up failed")
raise e
def insert_text(self, text: str) -> NoneType:
"""Keyboard.insert_text
Dispatches only `input` event, does not emit the `keydown`, `keyup` or `keypress` events.
```py
page.keyboard.insert_text(\"嗨\")
```
> 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.
"""
try:
log_api("=> keyboard.insert_text started")
result = mapping.from_maybe_impl(
self._sync(self._impl_obj.insert_text(text=text))
)
log_api("<= keyboard.insert_text succeded")
return result
except Exception as e:
log_api("<= keyboard.insert_text failed")
raise e
def type(self, text: str, delay: float = 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()`.
```py
page.keyboard.type(\"Hello\") # types instantly
page.keyboard.type(\"World\", delay=100) # types slower, like a user
```
> 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 : Union[float, NoneType]
Time to wait between key presses in milliseconds. Defaults to 0.
"""
try:
log_api("=> keyboard.type started")
result = mapping.from_maybe_impl(
self._sync(self._impl_obj.type(text=text, delay=delay))
)
log_api("<= keyboard.type succeded")
return result
except Exception as e:
log_api("<= keyboard.type failed")
raise e
def press(self, key: str, delay: float = None) -> NoneType:
"""Keyboard.press
`key` can specify the intended [keyboardEvent.key](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key)
value or a single character to generate the text for. A superset of the `key` values can be found
[here](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values). 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 supported: `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.
```py
page = browser.new_page()
page.goto(\"https://keycode.info\")
page.keyboard.press(\"a\")
page.screenshot(path=\"a.png\")
page.keyboard.press(\"ArrowLeft\")
page.screenshot(path=\"arrow_left.png\")
page.keyboard.press(\"Shift+O\")
page.screenshot(path=\"o.png\")
browser.close()
```
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 : Union[float, NoneType]
Time to wait between `keydown` and `keyup` in milliseconds. Defaults to 0.
"""
try:
log_api("=> keyboard.press started")
result = mapping.from_maybe_impl(
self._sync(self._impl_obj.press(key=key, delay=delay))
)
log_api("<= keyboard.press succeded")
return result
except Exception as e:
log_api("<= keyboard.press failed")
raise e
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 : Union[int, NoneType]
defaults to 1. Sends intermediate `mousemove` events.
"""
try:
log_api("=> mouse.move started")
result = mapping.from_maybe_impl(
self._sync(self._impl_obj.move(x=x, y=y, steps=steps))
)
log_api("<= mouse.move succeded")
return result
except Exception as e:
log_api("<= mouse.move failed")
raise e
def down(
self, button: Literal["left", "middle", "right"] = None, click_count: int = None
) -> NoneType:
"""Mouse.down
Dispatches a `mousedown` event.
Parameters
----------
button : Union["left", "middle", "right", NoneType]
Defaults to `left`.
click_count : Union[int, NoneType]
defaults to 1. See [UIEvent.detail].
"""
try:
log_api("=> mouse.down started")
result = mapping.from_maybe_impl(
self._sync(self._impl_obj.down(button=button, clickCount=click_count))
)
log_api("<= mouse.down succeded")
return result
except Exception as e:
log_api("<= mouse.down failed")
raise e
def up(