-
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathwebdriver.html
More file actions
1689 lines (1519 loc) · 186 KB
/
Copy pathwebdriver.html
File metadata and controls
1689 lines (1519 loc) · 186 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
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>webdriver package — Python client 1.1 1.1 documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=56dcb7b8"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="webdriver.common package" href="webdriver.common.html" />
<link rel="prev" title="Appium python client documentation" href="index.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
Python client 1.1
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">webdriver package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.common.html">webdriver.common package</a></li>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.html">webdriver.extensions package</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="#module-webdriver.appium_connection">webdriver.appium_connection module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.appium_connection.AppiumConnection"><code class="docutils literal notranslate"><span class="pre">AppiumConnection</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.appium_connection.AppiumConnection.extra_headers"><code class="docutils literal notranslate"><span class="pre">AppiumConnection.extra_headers</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.appium_connection.AppiumConnection.get_remote_connection_headers"><code class="docutils literal notranslate"><span class="pre">AppiumConnection.get_remote_connection_headers()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.appium_connection.AppiumConnection.user_agent"><code class="docutils literal notranslate"><span class="pre">AppiumConnection.user_agent</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-webdriver.appium_service">webdriver.appium_service module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.appium_service.AppiumService"><code class="docutils literal notranslate"><span class="pre">AppiumService</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.appium_service.AppiumService.is_listening"><code class="docutils literal notranslate"><span class="pre">AppiumService.is_listening</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.appium_service.AppiumService.is_running"><code class="docutils literal notranslate"><span class="pre">AppiumService.is_running</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.appium_service.AppiumService.start"><code class="docutils literal notranslate"><span class="pre">AppiumService.start()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.appium_service.AppiumService.stop"><code class="docutils literal notranslate"><span class="pre">AppiumService.stop()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.appium_service.AppiumServiceError"><code class="docutils literal notranslate"><span class="pre">AppiumServiceError</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.appium_service.AppiumStartupError"><code class="docutils literal notranslate"><span class="pre">AppiumStartupError</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.appium_service.find_executable"><code class="docutils literal notranslate"><span class="pre">find_executable()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.appium_service.get_main_script"><code class="docutils literal notranslate"><span class="pre">get_main_script()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.appium_service.get_node"><code class="docutils literal notranslate"><span class="pre">get_node()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.appium_service.get_npm"><code class="docutils literal notranslate"><span class="pre">get_npm()</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.appium_service.is_service_listening"><code class="docutils literal notranslate"><span class="pre">is_service_listening()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-webdriver.applicationstate">webdriver.applicationstate module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.applicationstate.ApplicationState"><code class="docutils literal notranslate"><span class="pre">ApplicationState</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.applicationstate.ApplicationState.NOT_INSTALLED"><code class="docutils literal notranslate"><span class="pre">ApplicationState.NOT_INSTALLED</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.applicationstate.ApplicationState.NOT_RUNNING"><code class="docutils literal notranslate"><span class="pre">ApplicationState.NOT_RUNNING</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.applicationstate.ApplicationState.RUNNING_IN_BACKGROUND"><code class="docutils literal notranslate"><span class="pre">ApplicationState.RUNNING_IN_BACKGROUND</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.applicationstate.ApplicationState.RUNNING_IN_BACKGROUND_SUSPENDED"><code class="docutils literal notranslate"><span class="pre">ApplicationState.RUNNING_IN_BACKGROUND_SUSPENDED</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.applicationstate.ApplicationState.RUNNING_IN_FOREGROUND"><code class="docutils literal notranslate"><span class="pre">ApplicationState.RUNNING_IN_FOREGROUND</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-webdriver.client_config">webdriver.client_config module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.client_config.AppiumClientConfig"><code class="docutils literal notranslate"><span class="pre">AppiumClientConfig</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.client_config.AppiumClientConfig.direct_connection"><code class="docutils literal notranslate"><span class="pre">AppiumClientConfig.direct_connection</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-webdriver.clipboard_content_type">webdriver.clipboard_content_type module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.clipboard_content_type.ClipboardContentType"><code class="docutils literal notranslate"><span class="pre">ClipboardContentType</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.clipboard_content_type.ClipboardContentType.IMAGE"><code class="docutils literal notranslate"><span class="pre">ClipboardContentType.IMAGE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.clipboard_content_type.ClipboardContentType.PLAINTEXT"><code class="docutils literal notranslate"><span class="pre">ClipboardContentType.PLAINTEXT</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.clipboard_content_type.ClipboardContentType.URL"><code class="docutils literal notranslate"><span class="pre">ClipboardContentType.URL</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-webdriver.command_method">webdriver.command_method module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.command_method.CommandMethod"><code class="docutils literal notranslate"><span class="pre">CommandMethod</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.command_method.CommandMethod.CONNECT"><code class="docutils literal notranslate"><span class="pre">CommandMethod.CONNECT</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.command_method.CommandMethod.DELETE"><code class="docutils literal notranslate"><span class="pre">CommandMethod.DELETE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.command_method.CommandMethod.GET"><code class="docutils literal notranslate"><span class="pre">CommandMethod.GET</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.command_method.CommandMethod.HEAD"><code class="docutils literal notranslate"><span class="pre">CommandMethod.HEAD</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.command_method.CommandMethod.OPTIONS"><code class="docutils literal notranslate"><span class="pre">CommandMethod.OPTIONS</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.command_method.CommandMethod.PATCH"><code class="docutils literal notranslate"><span class="pre">CommandMethod.PATCH</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.command_method.CommandMethod.POST"><code class="docutils literal notranslate"><span class="pre">CommandMethod.POST</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.command_method.CommandMethod.PUT"><code class="docutils literal notranslate"><span class="pre">CommandMethod.PUT</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.command_method.CommandMethod.TRACE"><code class="docutils literal notranslate"><span class="pre">CommandMethod.TRACE</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-webdriver.connectiontype">webdriver.connectiontype module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.connectiontype.ConnectionType"><code class="docutils literal notranslate"><span class="pre">ConnectionType</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.connectiontype.ConnectionType.AIRPLANE_MODE"><code class="docutils literal notranslate"><span class="pre">ConnectionType.AIRPLANE_MODE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.connectiontype.ConnectionType.ALL_NETWORK_ON"><code class="docutils literal notranslate"><span class="pre">ConnectionType.ALL_NETWORK_ON</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.connectiontype.ConnectionType.DATA_ONLY"><code class="docutils literal notranslate"><span class="pre">ConnectionType.DATA_ONLY</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.connectiontype.ConnectionType.NO_CONNECTION"><code class="docutils literal notranslate"><span class="pre">ConnectionType.NO_CONNECTION</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.connectiontype.ConnectionType.WIFI_ONLY"><code class="docutils literal notranslate"><span class="pre">ConnectionType.WIFI_ONLY</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-webdriver.errorhandler">webdriver.errorhandler module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.errorhandler.MobileErrorHandler"><code class="docutils literal notranslate"><span class="pre">MobileErrorHandler</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.errorhandler.MobileErrorHandler.check_response"><code class="docutils literal notranslate"><span class="pre">MobileErrorHandler.check_response()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.errorhandler.format_stacktrace"><code class="docutils literal notranslate"><span class="pre">format_stacktrace()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-webdriver.locator_converter">webdriver.locator_converter module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.locator_converter.AppiumLocatorConverter"><code class="docutils literal notranslate"><span class="pre">AppiumLocatorConverter</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.locator_converter.AppiumLocatorConverter.convert"><code class="docutils literal notranslate"><span class="pre">AppiumLocatorConverter.convert()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-webdriver.mobilecommand">webdriver.mobilecommand module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand"><code class="docutils literal notranslate"><span class="pre">MobileCommand</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.ACTIVATE_APP"><code class="docutils literal notranslate"><span class="pre">MobileCommand.ACTIVATE_APP</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.BACKGROUND"><code class="docutils literal notranslate"><span class="pre">MobileCommand.BACKGROUND</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.CLEAR"><code class="docutils literal notranslate"><span class="pre">MobileCommand.CLEAR</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.COMPARE_IMAGES"><code class="docutils literal notranslate"><span class="pre">MobileCommand.COMPARE_IMAGES</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.CONTEXTS"><code class="docutils literal notranslate"><span class="pre">MobileCommand.CONTEXTS</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.EXECUTE_DRIVER"><code class="docutils literal notranslate"><span class="pre">MobileCommand.EXECUTE_DRIVER</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.FINGER_PRINT"><code class="docutils literal notranslate"><span class="pre">MobileCommand.FINGER_PRINT</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_APP_STRINGS"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_APP_STRINGS</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_AVAILABLE_LOG_TYPES"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_AVAILABLE_LOG_TYPES</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_CAPABILITIES"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_CAPABILITIES</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_CLIPBOARD"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_CLIPBOARD</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_CURRENT_ACTIVITY"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_CURRENT_ACTIVITY</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_CURRENT_CONTEXT"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_CURRENT_CONTEXT</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_CURRENT_PACKAGE"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_CURRENT_PACKAGE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_DEVICE_TIME_GET"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_DEVICE_TIME_GET</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_DEVICE_TIME_POST"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_DEVICE_TIME_POST</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_DISPLAY_DENSITY"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_DISPLAY_DENSITY</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_EVENTS"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_EVENTS</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_LOCATION"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_LOCATION</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_LOG"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_LOG</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_NETWORK_CONNECTION"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_NETWORK_CONNECTION</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_PERFORMANCE_DATA"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_PERFORMANCE_DATA</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_PERFORMANCE_DATA_TYPES"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_PERFORMANCE_DATA_TYPES</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_SCREEN_ORIENTATION"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_SCREEN_ORIENTATION</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_SESSION"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_SESSION</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_SETTINGS"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_SETTINGS</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_STATUS"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_STATUS</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.GET_SYSTEM_BARS"><code class="docutils literal notranslate"><span class="pre">MobileCommand.GET_SYSTEM_BARS</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.HIDE_KEYBOARD"><code class="docutils literal notranslate"><span class="pre">MobileCommand.HIDE_KEYBOARD</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.INSTALL_APP"><code class="docutils literal notranslate"><span class="pre">MobileCommand.INSTALL_APP</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.IS_APP_INSTALLED"><code class="docutils literal notranslate"><span class="pre">MobileCommand.IS_APP_INSTALLED</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.IS_ELEMENT_DISPLAYED"><code class="docutils literal notranslate"><span class="pre">MobileCommand.IS_ELEMENT_DISPLAYED</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.IS_KEYBOARD_SHOWN"><code class="docutils literal notranslate"><span class="pre">MobileCommand.IS_KEYBOARD_SHOWN</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.IS_LOCKED"><code class="docutils literal notranslate"><span class="pre">MobileCommand.IS_LOCKED</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.KEY_EVENT"><code class="docutils literal notranslate"><span class="pre">MobileCommand.KEY_EVENT</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.LOCATION_IN_VIEW"><code class="docutils literal notranslate"><span class="pre">MobileCommand.LOCATION_IN_VIEW</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.LOCK"><code class="docutils literal notranslate"><span class="pre">MobileCommand.LOCK</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.LOG_EVENT"><code class="docutils literal notranslate"><span class="pre">MobileCommand.LOG_EVENT</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.LONG_PRESS_KEYCODE"><code class="docutils literal notranslate"><span class="pre">MobileCommand.LONG_PRESS_KEYCODE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.MAKE_GSM_CALL"><code class="docutils literal notranslate"><span class="pre">MobileCommand.MAKE_GSM_CALL</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.OPEN_NOTIFICATIONS"><code class="docutils literal notranslate"><span class="pre">MobileCommand.OPEN_NOTIFICATIONS</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.PRESS_KEYCODE"><code class="docutils literal notranslate"><span class="pre">MobileCommand.PRESS_KEYCODE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.PULL_FILE"><code class="docutils literal notranslate"><span class="pre">MobileCommand.PULL_FILE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.PULL_FOLDER"><code class="docutils literal notranslate"><span class="pre">MobileCommand.PULL_FOLDER</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.PUSH_FILE"><code class="docutils literal notranslate"><span class="pre">MobileCommand.PUSH_FILE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.QUERY_APP_STATE"><code class="docutils literal notranslate"><span class="pre">MobileCommand.QUERY_APP_STATE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.REMOVE_APP"><code class="docutils literal notranslate"><span class="pre">MobileCommand.REMOVE_APP</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.SEND_SMS"><code class="docutils literal notranslate"><span class="pre">MobileCommand.SEND_SMS</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.SET_CLIPBOARD"><code class="docutils literal notranslate"><span class="pre">MobileCommand.SET_CLIPBOARD</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.SET_GSM_SIGNAL"><code class="docutils literal notranslate"><span class="pre">MobileCommand.SET_GSM_SIGNAL</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.SET_GSM_VOICE"><code class="docutils literal notranslate"><span class="pre">MobileCommand.SET_GSM_VOICE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.SET_LOCATION"><code class="docutils literal notranslate"><span class="pre">MobileCommand.SET_LOCATION</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.SET_NETWORK_CONNECTION"><code class="docutils literal notranslate"><span class="pre">MobileCommand.SET_NETWORK_CONNECTION</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.SET_NETWORK_SPEED"><code class="docutils literal notranslate"><span class="pre">MobileCommand.SET_NETWORK_SPEED</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.SET_POWER_AC"><code class="docutils literal notranslate"><span class="pre">MobileCommand.SET_POWER_AC</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.SET_POWER_CAPACITY"><code class="docutils literal notranslate"><span class="pre">MobileCommand.SET_POWER_CAPACITY</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.SET_SCREEN_ORIENTATION"><code class="docutils literal notranslate"><span class="pre">MobileCommand.SET_SCREEN_ORIENTATION</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.SHAKE"><code class="docutils literal notranslate"><span class="pre">MobileCommand.SHAKE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.START_RECORDING_SCREEN"><code class="docutils literal notranslate"><span class="pre">MobileCommand.START_RECORDING_SCREEN</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.STOP_RECORDING_SCREEN"><code class="docutils literal notranslate"><span class="pre">MobileCommand.STOP_RECORDING_SCREEN</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.SWITCH_TO_CONTEXT"><code class="docutils literal notranslate"><span class="pre">MobileCommand.SWITCH_TO_CONTEXT</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.TERMINATE_APP"><code class="docutils literal notranslate"><span class="pre">MobileCommand.TERMINATE_APP</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.TOGGLE_LOCATION_SERVICES"><code class="docutils literal notranslate"><span class="pre">MobileCommand.TOGGLE_LOCATION_SERVICES</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.TOGGLE_TOUCH_ID_ENROLLMENT"><code class="docutils literal notranslate"><span class="pre">MobileCommand.TOGGLE_TOUCH_ID_ENROLLMENT</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.TOGGLE_WIFI"><code class="docutils literal notranslate"><span class="pre">MobileCommand.TOGGLE_WIFI</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.TOUCH_ID"><code class="docutils literal notranslate"><span class="pre">MobileCommand.TOUCH_ID</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.UNLOCK"><code class="docutils literal notranslate"><span class="pre">MobileCommand.UNLOCK</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.mobilecommand.MobileCommand.UPDATE_SETTINGS"><code class="docutils literal notranslate"><span class="pre">MobileCommand.UPDATE_SETTINGS</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-webdriver.switch_to">webdriver.switch_to module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.switch_to.MobileSwitchTo"><code class="docutils literal notranslate"><span class="pre">MobileSwitchTo</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.switch_to.MobileSwitchTo.context"><code class="docutils literal notranslate"><span class="pre">MobileSwitchTo.context()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-webdriver.webdriver">webdriver.webdriver module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.webdriver.ExtensionBase"><code class="docutils literal notranslate"><span class="pre">ExtensionBase</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.webdriver.ExtensionBase.add_command"><code class="docutils literal notranslate"><span class="pre">ExtensionBase.add_command()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.webdriver.ExtensionBase.execute"><code class="docutils literal notranslate"><span class="pre">ExtensionBase.execute()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.webdriver.ExtensionBase.method_name"><code class="docutils literal notranslate"><span class="pre">ExtensionBase.method_name()</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.webdriver.WebDriver"><code class="docutils literal notranslate"><span class="pre">WebDriver</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.webdriver.WebDriver.assert_extension_exists"><code class="docutils literal notranslate"><span class="pre">WebDriver.assert_extension_exists()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.webdriver.WebDriver.create_web_element"><code class="docutils literal notranslate"><span class="pre">WebDriver.create_web_element()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.webdriver.WebDriver.delete_extensions"><code class="docutils literal notranslate"><span class="pre">WebDriver.delete_extensions()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.webdriver.WebDriver.get_status"><code class="docutils literal notranslate"><span class="pre">WebDriver.get_status()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.webdriver.WebDriver.mark_extension_absence"><code class="docutils literal notranslate"><span class="pre">WebDriver.mark_extension_absence()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.webdriver.WebDriver.orientation"><code class="docutils literal notranslate"><span class="pre">WebDriver.orientation</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.webdriver.WebDriver.start_session"><code class="docutils literal notranslate"><span class="pre">WebDriver.start_session()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.webdriver.WebDriver.switch_to"><code class="docutils literal notranslate"><span class="pre">WebDriver.switch_to</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-webdriver.webelement">webdriver.webelement module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#webdriver.webelement.WebElement"><code class="docutils literal notranslate"><span class="pre">WebElement</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.webelement.WebElement.clear"><code class="docutils literal notranslate"><span class="pre">WebElement.clear()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.webelement.WebElement.get_attribute"><code class="docutils literal notranslate"><span class="pre">WebElement.get_attribute()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.webelement.WebElement.is_displayed"><code class="docutils literal notranslate"><span class="pre">WebElement.is_displayed()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.webelement.WebElement.location_in_view"><code class="docutils literal notranslate"><span class="pre">WebElement.location_in_view</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#webdriver.webelement.WebElement.send_keys"><code class="docutils literal notranslate"><span class="pre">WebElement.send_keys()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="#module-webdriver">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">Python client 1.1</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">webdriver package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/webdriver.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="webdriver-package">
<h1>webdriver package<a class="headerlink" href="#webdriver-package" title="Link to this heading"></a></h1>
<section id="subpackages">
<h2>Subpackages<a class="headerlink" href="#subpackages" title="Link to this heading"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="webdriver.common.html">webdriver.common package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="webdriver.common.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.common.html#module-webdriver.common.appiumby">webdriver.common.appiumby module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.common.html#webdriver.common.appiumby.AppiumBy"><code class="docutils literal notranslate"><span class="pre">AppiumBy</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.common.html#webdriver.common.appiumby.AppiumBy.ACCESSIBILITY_ID"><code class="docutils literal notranslate"><span class="pre">AppiumBy.ACCESSIBILITY_ID</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.common.html#webdriver.common.appiumby.AppiumBy.ANDROID_DATA_MATCHER"><code class="docutils literal notranslate"><span class="pre">AppiumBy.ANDROID_DATA_MATCHER</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.common.html#webdriver.common.appiumby.AppiumBy.ANDROID_UIAUTOMATOR"><code class="docutils literal notranslate"><span class="pre">AppiumBy.ANDROID_UIAUTOMATOR</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.common.html#webdriver.common.appiumby.AppiumBy.ANDROID_VIEWTAG"><code class="docutils literal notranslate"><span class="pre">AppiumBy.ANDROID_VIEWTAG</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.common.html#webdriver.common.appiumby.AppiumBy.ANDROID_VIEW_MATCHER"><code class="docutils literal notranslate"><span class="pre">AppiumBy.ANDROID_VIEW_MATCHER</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.common.html#webdriver.common.appiumby.AppiumBy.CUSTOM"><code class="docutils literal notranslate"><span class="pre">AppiumBy.CUSTOM</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.common.html#webdriver.common.appiumby.AppiumBy.FLUTTER_INTEGRATION_KEY"><code class="docutils literal notranslate"><span class="pre">AppiumBy.FLUTTER_INTEGRATION_KEY</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.common.html#webdriver.common.appiumby.AppiumBy.FLUTTER_INTEGRATION_SEMANTICS_LABEL"><code class="docutils literal notranslate"><span class="pre">AppiumBy.FLUTTER_INTEGRATION_SEMANTICS_LABEL</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.common.html#webdriver.common.appiumby.AppiumBy.FLUTTER_INTEGRATION_TEXT"><code class="docutils literal notranslate"><span class="pre">AppiumBy.FLUTTER_INTEGRATION_TEXT</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.common.html#webdriver.common.appiumby.AppiumBy.FLUTTER_INTEGRATION_TEXT_CONTAINING"><code class="docutils literal notranslate"><span class="pre">AppiumBy.FLUTTER_INTEGRATION_TEXT_CONTAINING</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.common.html#webdriver.common.appiumby.AppiumBy.FLUTTER_INTEGRATION_TYPE"><code class="docutils literal notranslate"><span class="pre">AppiumBy.FLUTTER_INTEGRATION_TYPE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.common.html#webdriver.common.appiumby.AppiumBy.IMAGE"><code class="docutils literal notranslate"><span class="pre">AppiumBy.IMAGE</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.common.html#webdriver.common.appiumby.AppiumBy.IOS_CLASS_CHAIN"><code class="docutils literal notranslate"><span class="pre">AppiumBy.IOS_CLASS_CHAIN</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.common.html#webdriver.common.appiumby.AppiumBy.IOS_PREDICATE"><code class="docutils literal notranslate"><span class="pre">AppiumBy.IOS_PREDICATE</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.common.html#module-webdriver.common">Module contents</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="webdriver.extensions.html">webdriver.extensions package</a><ul>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#subpackages">Subpackages</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.android.html">webdriver.extensions.android package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.android.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.android.html#module-webdriver.extensions.android.activities">webdriver.extensions.android.activities module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.android.html#module-webdriver.extensions.android.common">webdriver.extensions.android.common module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.android.html#module-webdriver.extensions.android.display">webdriver.extensions.android.display module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.android.html#module-webdriver.extensions.android.gsm">webdriver.extensions.android.gsm module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.android.html#module-webdriver.extensions.android.nativekey">webdriver.extensions.android.nativekey module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.android.html#module-webdriver.extensions.android.network">webdriver.extensions.android.network module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.android.html#module-webdriver.extensions.android.performance">webdriver.extensions.android.performance module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.android.html#module-webdriver.extensions.android.power">webdriver.extensions.android.power module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.android.html#module-webdriver.extensions.android.sms">webdriver.extensions.android.sms module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.android.html#module-webdriver.extensions.android.system_bars">webdriver.extensions.android.system_bars module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.android.html#module-webdriver.extensions.android">Module contents</a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.flutter_integration.html">webdriver.extensions.flutter_integration package</a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.flutter_integration.html#submodules">Submodules</a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.flutter_integration.html#module-webdriver.extensions.flutter_integration.flutter_commands">webdriver.extensions.flutter_integration.flutter_commands module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.flutter_integration.html#module-webdriver.extensions.flutter_integration.flutter_finder">webdriver.extensions.flutter_integration.flutter_finder module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.flutter_integration.html#module-webdriver.extensions.flutter_integration.scroll_directions">webdriver.extensions.flutter_integration.scroll_directions module</a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.flutter_integration.html#module-webdriver.extensions.flutter_integration">Module contents</a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#submodules">Submodules</a></li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#module-webdriver.extensions.action_helpers">webdriver.extensions.action_helpers module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.action_helpers.ActionHelpers"><code class="docutils literal notranslate"><span class="pre">ActionHelpers</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.action_helpers.ActionHelpers.drag_and_drop"><code class="docutils literal notranslate"><span class="pre">ActionHelpers.drag_and_drop()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.action_helpers.ActionHelpers.flick"><code class="docutils literal notranslate"><span class="pre">ActionHelpers.flick()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.action_helpers.ActionHelpers.scroll"><code class="docutils literal notranslate"><span class="pre">ActionHelpers.scroll()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.action_helpers.ActionHelpers.swipe"><code class="docutils literal notranslate"><span class="pre">ActionHelpers.swipe()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.action_helpers.ActionHelpers.tap"><code class="docutils literal notranslate"><span class="pre">ActionHelpers.tap()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#module-webdriver.extensions.applications">webdriver.extensions.applications module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.applications.Applications"><code class="docutils literal notranslate"><span class="pre">Applications</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.applications.Applications.activate_app"><code class="docutils literal notranslate"><span class="pre">Applications.activate_app()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.applications.Applications.app_strings"><code class="docutils literal notranslate"><span class="pre">Applications.app_strings()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.applications.Applications.background_app"><code class="docutils literal notranslate"><span class="pre">Applications.background_app()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.applications.Applications.install_app"><code class="docutils literal notranslate"><span class="pre">Applications.install_app()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.applications.Applications.is_app_installed"><code class="docutils literal notranslate"><span class="pre">Applications.is_app_installed()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.applications.Applications.query_app_state"><code class="docutils literal notranslate"><span class="pre">Applications.query_app_state()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.applications.Applications.remove_app"><code class="docutils literal notranslate"><span class="pre">Applications.remove_app()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.applications.Applications.terminate_app"><code class="docutils literal notranslate"><span class="pre">Applications.terminate_app()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#module-webdriver.extensions.clipboard">webdriver.extensions.clipboard module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.clipboard.Clipboard"><code class="docutils literal notranslate"><span class="pre">Clipboard</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.clipboard.Clipboard.get_clipboard"><code class="docutils literal notranslate"><span class="pre">Clipboard.get_clipboard()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.clipboard.Clipboard.get_clipboard_text"><code class="docutils literal notranslate"><span class="pre">Clipboard.get_clipboard_text()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.clipboard.Clipboard.set_clipboard"><code class="docutils literal notranslate"><span class="pre">Clipboard.set_clipboard()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.clipboard.Clipboard.set_clipboard_text"><code class="docutils literal notranslate"><span class="pre">Clipboard.set_clipboard_text()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#module-webdriver.extensions.context">webdriver.extensions.context module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.context.Context"><code class="docutils literal notranslate"><span class="pre">Context</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.context.Context.context"><code class="docutils literal notranslate"><span class="pre">Context.context</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.context.Context.contexts"><code class="docutils literal notranslate"><span class="pre">Context.contexts</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.context.Context.current_context"><code class="docutils literal notranslate"><span class="pre">Context.current_context</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#module-webdriver.extensions.device_time">webdriver.extensions.device_time module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.device_time.DeviceTime"><code class="docutils literal notranslate"><span class="pre">DeviceTime</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.device_time.DeviceTime.device_time"><code class="docutils literal notranslate"><span class="pre">DeviceTime.device_time</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.device_time.DeviceTime.get_device_time"><code class="docutils literal notranslate"><span class="pre">DeviceTime.get_device_time()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#module-webdriver.extensions.execute_driver">webdriver.extensions.execute_driver module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.execute_driver.ExecuteDriver"><code class="docutils literal notranslate"><span class="pre">ExecuteDriver</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.execute_driver.ExecuteDriver.execute_driver"><code class="docutils literal notranslate"><span class="pre">ExecuteDriver.execute_driver()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#module-webdriver.extensions.execute_mobile_command">webdriver.extensions.execute_mobile_command module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.execute_mobile_command.ExecuteMobileCommand"><code class="docutils literal notranslate"><span class="pre">ExecuteMobileCommand</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.execute_mobile_command.ExecuteMobileCommand.battery_info"><code class="docutils literal notranslate"><span class="pre">ExecuteMobileCommand.battery_info</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.execute_mobile_command.ExecuteMobileCommand.press_button"><code class="docutils literal notranslate"><span class="pre">ExecuteMobileCommand.press_button()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#module-webdriver.extensions.hw_actions">webdriver.extensions.hw_actions module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.hw_actions.HardwareActions"><code class="docutils literal notranslate"><span class="pre">HardwareActions</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.hw_actions.HardwareActions.finger_print"><code class="docutils literal notranslate"><span class="pre">HardwareActions.finger_print()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.hw_actions.HardwareActions.is_locked"><code class="docutils literal notranslate"><span class="pre">HardwareActions.is_locked()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.hw_actions.HardwareActions.lock"><code class="docutils literal notranslate"><span class="pre">HardwareActions.lock()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.hw_actions.HardwareActions.shake"><code class="docutils literal notranslate"><span class="pre">HardwareActions.shake()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.hw_actions.HardwareActions.toggle_touch_id_enrollment"><code class="docutils literal notranslate"><span class="pre">HardwareActions.toggle_touch_id_enrollment()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.hw_actions.HardwareActions.touch_id"><code class="docutils literal notranslate"><span class="pre">HardwareActions.touch_id()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.hw_actions.HardwareActions.unlock"><code class="docutils literal notranslate"><span class="pre">HardwareActions.unlock()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#module-webdriver.extensions.images_comparison">webdriver.extensions.images_comparison module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.images_comparison.ImagesComparison"><code class="docutils literal notranslate"><span class="pre">ImagesComparison</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.images_comparison.ImagesComparison.find_image_occurrence"><code class="docutils literal notranslate"><span class="pre">ImagesComparison.find_image_occurrence()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.images_comparison.ImagesComparison.get_images_similarity"><code class="docutils literal notranslate"><span class="pre">ImagesComparison.get_images_similarity()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.images_comparison.ImagesComparison.match_images_features"><code class="docutils literal notranslate"><span class="pre">ImagesComparison.match_images_features()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#module-webdriver.extensions.keyboard">webdriver.extensions.keyboard module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.keyboard.Keyboard"><code class="docutils literal notranslate"><span class="pre">Keyboard</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.keyboard.Keyboard.hide_keyboard"><code class="docutils literal notranslate"><span class="pre">Keyboard.hide_keyboard()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.keyboard.Keyboard.is_keyboard_shown"><code class="docutils literal notranslate"><span class="pre">Keyboard.is_keyboard_shown()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.keyboard.Keyboard.keyevent"><code class="docutils literal notranslate"><span class="pre">Keyboard.keyevent()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.keyboard.Keyboard.long_press_keycode"><code class="docutils literal notranslate"><span class="pre">Keyboard.long_press_keycode()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.keyboard.Keyboard.press_keycode"><code class="docutils literal notranslate"><span class="pre">Keyboard.press_keycode()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#module-webdriver.extensions.location">webdriver.extensions.location module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.location.Location"><code class="docutils literal notranslate"><span class="pre">Location</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.location.Location.location"><code class="docutils literal notranslate"><span class="pre">Location.location</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.location.Location.set_location"><code class="docutils literal notranslate"><span class="pre">Location.set_location()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.location.Location.toggle_location_services"><code class="docutils literal notranslate"><span class="pre">Location.toggle_location_services()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#module-webdriver.extensions.log_event">webdriver.extensions.log_event module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.log_event.LogEvent"><code class="docutils literal notranslate"><span class="pre">LogEvent</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.log_event.LogEvent.get_events"><code class="docutils literal notranslate"><span class="pre">LogEvent.get_events()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.log_event.LogEvent.log_event"><code class="docutils literal notranslate"><span class="pre">LogEvent.log_event()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#module-webdriver.extensions.logs">webdriver.extensions.logs module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.logs.Logs"><code class="docutils literal notranslate"><span class="pre">Logs</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.logs.Logs.get_log"><code class="docutils literal notranslate"><span class="pre">Logs.get_log()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.logs.Logs.log_types"><code class="docutils literal notranslate"><span class="pre">Logs.log_types</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#module-webdriver.extensions.remote_fs">webdriver.extensions.remote_fs module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.remote_fs.RemoteFS"><code class="docutils literal notranslate"><span class="pre">RemoteFS</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.remote_fs.RemoteFS.pull_file"><code class="docutils literal notranslate"><span class="pre">RemoteFS.pull_file()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.remote_fs.RemoteFS.pull_folder"><code class="docutils literal notranslate"><span class="pre">RemoteFS.pull_folder()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.remote_fs.RemoteFS.push_file"><code class="docutils literal notranslate"><span class="pre">RemoteFS.push_file()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#module-webdriver.extensions.screen_record">webdriver.extensions.screen_record module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.screen_record.ScreenRecord"><code class="docutils literal notranslate"><span class="pre">ScreenRecord</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.screen_record.ScreenRecord.start_recording_screen"><code class="docutils literal notranslate"><span class="pre">ScreenRecord.start_recording_screen()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.screen_record.ScreenRecord.stop_recording_screen"><code class="docutils literal notranslate"><span class="pre">ScreenRecord.stop_recording_screen()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#module-webdriver.extensions.session">webdriver.extensions.session module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.session.Session"><code class="docutils literal notranslate"><span class="pre">Session</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.session.Session.events"><code class="docutils literal notranslate"><span class="pre">Session.events</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#module-webdriver.extensions.settings">webdriver.extensions.settings module</a><ul>
<li class="toctree-l3"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.settings.Settings"><code class="docutils literal notranslate"><span class="pre">Settings</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.settings.Settings.get_settings"><code class="docutils literal notranslate"><span class="pre">Settings.get_settings()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="webdriver.extensions.html#webdriver.extensions.settings.Settings.update_settings"><code class="docutils literal notranslate"><span class="pre">Settings.update_settings()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="webdriver.extensions.html#module-webdriver.extensions">Module contents</a></li>
</ul>
</li>
</ul>
</div>
</section>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading"></a></h2>
</section>
<section id="module-webdriver.appium_connection">
<span id="webdriver-appium-connection-module"></span><h2>webdriver.appium_connection module<a class="headerlink" href="#module-webdriver.appium_connection" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="webdriver.appium_connection.AppiumConnection">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AppiumConnection</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">remote_server_addr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keep_alive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_proxy</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ignore_certificates</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">init_args_for_pool_manager</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">client_config</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ClientConfig</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#webdriver.appium_connection.AppiumConnection" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">RemoteConnection</span></code></p>
<p>A subclass of selenium.webdriver.remote.remote_connection.Remoteconnection.</p>
<p>The changes are</p>
<ul class="simple">
<li><p>The default user agent</p></li>
<li><dl class="simple">
<dt>Adds ‘X-Idempotency-Key’ header in a new session request to avoid proceeding</dt><dd><p>the same request multiple times in the Appium server side.
* <a class="reference external" href="https://github.com/appium/appium-base-driver/pull/400">https://github.com/appium/appium-base-driver/pull/400</a></p>
</dd>
</dl>
</li>
</ul>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.appium_connection.AppiumConnection.extra_headers">
<span class="sig-name descname"><span class="pre">extra_headers</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">{}</span></em><a class="headerlink" href="#webdriver.appium_connection.AppiumConnection.extra_headers" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="webdriver.appium_connection.AppiumConnection.get_remote_connection_headers">
<em class="property"><span class="k"><span class="pre">classmethod</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">get_remote_connection_headers</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">parsed_url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">ParseResult</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">keep_alive</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">True</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#webdriver.appium_connection.AppiumConnection.get_remote_connection_headers" title="Link to this definition"></a></dt>
<dd><p>Override get_remote_connection_headers in RemoteConnection to control the extra headers.
This method will be used in sending a request method in this class.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.appium_connection.AppiumConnection.user_agent">
<span class="sig-name descname"><span class="pre">user_agent</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'appium/5.2.0</span> <span class="pre">(selenium/4.33.0</span> <span class="pre">(python</span> <span class="pre">linux))'</span></em><a class="headerlink" href="#webdriver.appium_connection.AppiumConnection.user_agent" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-webdriver.appium_service">
<span id="webdriver-appium-service-module"></span><h2>webdriver.appium_service module<a class="headerlink" href="#module-webdriver.appium_service" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="webdriver.appium_service.AppiumService">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AppiumService</span></span><a class="headerlink" href="#webdriver.appium_service.AppiumService" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py property">
<dt class="sig sig-object py" id="webdriver.appium_service.AppiumService.is_listening">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_listening</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#webdriver.appium_service.AppiumService.is_listening" title="Link to this definition"></a></dt>
<dd><p>Check if the service is listening on the given/default host/port.</p>
<p>The fact, that the service is running, does not always mean it is listening.
The default host/port/base path values can be customized by providing
–address/–port/–base-path command line arguments while starting the service.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>True</cite> if the service is running and listening on the given/default host/port</p>
</dd>
</dl>
</dd></dl>
<dl class="py property">
<dt class="sig sig-object py" id="webdriver.appium_service.AppiumService.is_running">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">is_running</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#webdriver.appium_service.AppiumService.is_running" title="Link to this definition"></a></dt>
<dd><p>Check if the service is running.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p><cite>True</cite> if the service is running</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="webdriver.appium_service.AppiumService.start">
<span class="sig-name descname"><span class="pre">start</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Any</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Popen</span></span></span><a class="headerlink" href="#webdriver.appium_service.AppiumService.start" title="Link to this definition"></a></dt>
<dd><p>Starts Appium service with given arguments.</p>
<p>If you use the service to start Appium 1.x
then consider providing [’–base-path’, ‘/wd/hub’] arguments. By default,
the service assumes Appium server listens on ‘/’ path, which is the default path
for Appium 2.</p>
<p>The service will be forcefully restarted if it is already running.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>env</strong> (<em>dict</em>) – Environment variables mapping. The default system environment,
which is inherited from the parent process, is assigned by default.</p></li>
<li><p><strong>node</strong> (<em>str</em>) – The full path to the main NodeJS executable. The service will try
to retrieve it automatically if not provided.</p></li>
<li><p><strong>npm</strong> (<em>str</em>) – The full path to the Node Package Manager (npm) script. The service will try
to retrieve it automatically if not provided.</p></li>
<li><p><strong>stdout</strong> (<em>int</em>) – Check the documentation for subprocess.Popen for more details.
The default value is subprocess.DEVNULL on Windows and subprocess.PIPE on other platforms.</p></li>
<li><p><strong>stderr</strong> (<em>int</em>) – Check the documentation for subprocess.Popen for more details.
The default value is subprocess.DEVNULL on Windows and subprocess.PIPE on other platforms.</p></li>
<li><p><strong>timeout_ms</strong> (<em>int</em>) – The maximum time to wait until Appium process starts listening
for HTTP connections. If set to zero or a negative number then no wait will be applied.
60000 ms by default.</p></li>
<li><p><strong>main_script</strong> (<em>str</em>) – The full path to the main Appium executable
(usually located at build/lib/main.js). If not set
then the service tries to detect the path automatically.</p></li>
<li><p><strong>args</strong> (<em>str</em>) – List of Appium arguments (all must be strings). Check
<a class="reference external" href="https://appium.io/docs/en/writing-running-appium/server-args/">https://appium.io/docs/en/writing-running-appium/server-args/</a> for more details
about possible arguments and their values.</p></li>
</ul>
</dd>
</dl>
<dl class="simple">
<dt>Returns: You can use Popen.communicate interface or stderr/stdout properties</dt><dd><p>of the instance (stdout/stderr must not be set to None in such case) in order to retrieve the actual process
output.</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="webdriver.appium_service.AppiumService.stop">
<span class="sig-name descname"><span class="pre">stop</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">5.5</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#webdriver.appium_service.AppiumService.stop" title="Link to this definition"></a></dt>
<dd><p>Stops Appium service if it is running.</p>
<p>The call will be ignored if the service is not running
or has been already stopped.</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>timeout</strong> – The maximum time in float seconds to wait for the server process to terminate</p>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p><cite>True</cite> if the service was running before being stopped</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="webdriver.appium_service.AppiumServiceError">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AppiumServiceError</span></span><a class="headerlink" href="#webdriver.appium_service.AppiumServiceError" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">RuntimeError</span></code></p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="webdriver.appium_service.AppiumStartupError">
<em class="property"><span class="k"><span class="pre">exception</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AppiumStartupError</span></span><a class="headerlink" href="#webdriver.appium_service.AppiumStartupError" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">RuntimeError</span></code></p>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="webdriver.appium_service.find_executable">
<span class="sig-name descname"><span class="pre">find_executable</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">executable</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#webdriver.appium_service.find_executable" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="webdriver.appium_service.get_main_script">
<span class="sig-name descname"><span class="pre">get_main_script</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">node</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">npm</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#webdriver.appium_service.get_main_script" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="webdriver.appium_service.get_node">
<span class="sig-name descname"><span class="pre">get_node</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#webdriver.appium_service.get_node" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="webdriver.appium_service.get_npm">
<span class="sig-name descname"><span class="pre">get_npm</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">str</span></span></span><a class="headerlink" href="#webdriver.appium_service.get_npm" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="webdriver.appium_service.is_service_listening">
<span class="sig-name descname"><span class="pre">is_service_listening</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">url</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">float</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">5</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">custom_validator</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Callable</span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">[</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">None</span><span class="p"><span class="pre">]</span></span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">bool</span></span></span><a class="headerlink" href="#webdriver.appium_service.is_service_listening" title="Link to this definition"></a></dt>
<dd><p>Check if the service is running</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>url</strong> – Full server url</p></li>
<li><p><strong>timeout</strong> – Timeout in float seconds</p></li>
<li><p><strong>custom_validator</strong> – Custom callable method to be executed upon each validation loop before the timeout happens</p></li>
</ul>
</dd>
<dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>True if Appium server is running before the timeout</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-webdriver.applicationstate">
<span id="webdriver-applicationstate-module"></span><h2>webdriver.applicationstate module<a class="headerlink" href="#module-webdriver.applicationstate" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="webdriver.applicationstate.ApplicationState">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ApplicationState</span></span><a class="headerlink" href="#webdriver.applicationstate.ApplicationState" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.applicationstate.ApplicationState.NOT_INSTALLED">
<span class="sig-name descname"><span class="pre">NOT_INSTALLED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#webdriver.applicationstate.ApplicationState.NOT_INSTALLED" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.applicationstate.ApplicationState.NOT_RUNNING">
<span class="sig-name descname"><span class="pre">NOT_RUNNING</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#webdriver.applicationstate.ApplicationState.NOT_RUNNING" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.applicationstate.ApplicationState.RUNNING_IN_BACKGROUND">
<span class="sig-name descname"><span class="pre">RUNNING_IN_BACKGROUND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">3</span></em><a class="headerlink" href="#webdriver.applicationstate.ApplicationState.RUNNING_IN_BACKGROUND" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.applicationstate.ApplicationState.RUNNING_IN_BACKGROUND_SUSPENDED">
<span class="sig-name descname"><span class="pre">RUNNING_IN_BACKGROUND_SUSPENDED</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#webdriver.applicationstate.ApplicationState.RUNNING_IN_BACKGROUND_SUSPENDED" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.applicationstate.ApplicationState.RUNNING_IN_FOREGROUND">
<span class="sig-name descname"><span class="pre">RUNNING_IN_FOREGROUND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#webdriver.applicationstate.ApplicationState.RUNNING_IN_FOREGROUND" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-webdriver.client_config">
<span id="webdriver-client-config-module"></span><h2>webdriver.client_config module<a class="headerlink" href="#module-webdriver.client_config" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="webdriver.client_config.AppiumClientConfig">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AppiumClientConfig</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">remote_server_addr</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#webdriver.client_config.AppiumClientConfig" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ClientConfig</span></code></p>
<p>ClientConfig class for Appium Python client.
This class inherits selenium.webdriver.remote.client_config.ClientConfig.</p>
<dl class="py property">
<dt class="sig sig-object py" id="webdriver.client_config.AppiumClientConfig.direct_connection">
<em class="property"><span class="k"><span class="pre">property</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">direct_connection</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">bool</span></em><a class="headerlink" href="#webdriver.client_config.AppiumClientConfig.direct_connection" title="Link to this definition"></a></dt>
<dd><p>//github.com/appium/python-client?tab=readme-ov-file#direct-connect-urls)
is enabled.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Return if [directConnect](https</p>
</dd>
</dl>
</dd></dl>
</dd></dl>
</section>
<section id="module-webdriver.clipboard_content_type">
<span id="webdriver-clipboard-content-type-module"></span><h2>webdriver.clipboard_content_type module<a class="headerlink" href="#module-webdriver.clipboard_content_type" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="webdriver.clipboard_content_type.ClipboardContentType">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ClipboardContentType</span></span><a class="headerlink" href="#webdriver.clipboard_content_type.ClipboardContentType" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.clipboard_content_type.ClipboardContentType.IMAGE">
<span class="sig-name descname"><span class="pre">IMAGE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'image'</span></em><a class="headerlink" href="#webdriver.clipboard_content_type.ClipboardContentType.IMAGE" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.clipboard_content_type.ClipboardContentType.PLAINTEXT">
<span class="sig-name descname"><span class="pre">PLAINTEXT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'plaintext'</span></em><a class="headerlink" href="#webdriver.clipboard_content_type.ClipboardContentType.PLAINTEXT" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.clipboard_content_type.ClipboardContentType.URL">
<span class="sig-name descname"><span class="pre">URL</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'url'</span></em><a class="headerlink" href="#webdriver.clipboard_content_type.ClipboardContentType.URL" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-webdriver.command_method">
<span id="webdriver-command-method-module"></span><h2>webdriver.command_method module<a class="headerlink" href="#module-webdriver.command_method" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="webdriver.command_method.CommandMethod">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CommandMethod</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">values</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#webdriver.command_method.CommandMethod" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Enum</span></code></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.command_method.CommandMethod.CONNECT">
<span class="sig-name descname"><span class="pre">CONNECT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CONNECT'</span></em><a class="headerlink" href="#webdriver.command_method.CommandMethod.CONNECT" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.command_method.CommandMethod.DELETE">
<span class="sig-name descname"><span class="pre">DELETE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'DELETE'</span></em><a class="headerlink" href="#webdriver.command_method.CommandMethod.DELETE" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.command_method.CommandMethod.GET">
<span class="sig-name descname"><span class="pre">GET</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'GET'</span></em><a class="headerlink" href="#webdriver.command_method.CommandMethod.GET" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.command_method.CommandMethod.HEAD">
<span class="sig-name descname"><span class="pre">HEAD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'HEAD'</span></em><a class="headerlink" href="#webdriver.command_method.CommandMethod.HEAD" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.command_method.CommandMethod.OPTIONS">
<span class="sig-name descname"><span class="pre">OPTIONS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'OPTIONS'</span></em><a class="headerlink" href="#webdriver.command_method.CommandMethod.OPTIONS" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.command_method.CommandMethod.PATCH">
<span class="sig-name descname"><span class="pre">PATCH</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PATCH'</span></em><a class="headerlink" href="#webdriver.command_method.CommandMethod.PATCH" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.command_method.CommandMethod.POST">
<span class="sig-name descname"><span class="pre">POST</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'POST'</span></em><a class="headerlink" href="#webdriver.command_method.CommandMethod.POST" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.command_method.CommandMethod.PUT">
<span class="sig-name descname"><span class="pre">PUT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'PUT'</span></em><a class="headerlink" href="#webdriver.command_method.CommandMethod.PUT" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.command_method.CommandMethod.TRACE">
<span class="sig-name descname"><span class="pre">TRACE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'TRACE'</span></em><a class="headerlink" href="#webdriver.command_method.CommandMethod.TRACE" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-webdriver.connectiontype">
<span id="webdriver-connectiontype-module"></span><h2>webdriver.connectiontype module<a class="headerlink" href="#module-webdriver.connectiontype" title="Link to this heading"></a></h2>
<dl>
<dt>Connection types are specified here:</dt><dd><p><a class="reference external" href="https://code.google.com/p/selenium/source/browse/spec-draft.md?repo=mobile#120">https://code.google.com/p/selenium/source/browse/spec-draft.md?repo=mobile#120</a></p>
<table class="docutils align-default">
<thead>
<tr class="row-odd"><th class="head"><p>Value (Alias)</p></th>
<th class="head"><p>Data</p></th>
<th class="head"><p>Wifi</p></th>
<th class="head"><p>Airplane Mode</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>0 (None)</p></td>
<td><p>0</p></td>
<td><p>0</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-odd"><td><p>1 (Airplane Mode)</p></td>
<td><p>0</p></td>
<td><p>0</p></td>
<td><p>1</p></td>
</tr>
<tr class="row-even"><td><p>2 (Wifi only)</p></td>
<td><p>0</p></td>
<td><p>1</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-odd"><td><p>4 (Data only)</p></td>
<td><p>1</p></td>
<td><p>0</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-even"><td><p>6 (All network on)</p></td>
<td><p>1</p></td>
<td><p>1</p></td>
<td><p>0</p></td>
</tr>
</tbody>
</table>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="webdriver.connectiontype.ConnectionType">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ConnectionType</span></span><a class="headerlink" href="#webdriver.connectiontype.ConnectionType" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.connectiontype.ConnectionType.AIRPLANE_MODE">
<span class="sig-name descname"><span class="pre">AIRPLANE_MODE</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">1</span></em><a class="headerlink" href="#webdriver.connectiontype.ConnectionType.AIRPLANE_MODE" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.connectiontype.ConnectionType.ALL_NETWORK_ON">
<span class="sig-name descname"><span class="pre">ALL_NETWORK_ON</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">6</span></em><a class="headerlink" href="#webdriver.connectiontype.ConnectionType.ALL_NETWORK_ON" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.connectiontype.ConnectionType.DATA_ONLY">
<span class="sig-name descname"><span class="pre">DATA_ONLY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">4</span></em><a class="headerlink" href="#webdriver.connectiontype.ConnectionType.DATA_ONLY" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.connectiontype.ConnectionType.NO_CONNECTION">
<span class="sig-name descname"><span class="pre">NO_CONNECTION</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">0</span></em><a class="headerlink" href="#webdriver.connectiontype.ConnectionType.NO_CONNECTION" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.connectiontype.ConnectionType.WIFI_ONLY">
<span class="sig-name descname"><span class="pre">WIFI_ONLY</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">2</span></em><a class="headerlink" href="#webdriver.connectiontype.ConnectionType.WIFI_ONLY" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-webdriver.errorhandler">
<span id="webdriver-errorhandler-module"></span><h2>webdriver.errorhandler module<a class="headerlink" href="#module-webdriver.errorhandler" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="webdriver.errorhandler.MobileErrorHandler">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">MobileErrorHandler</span></span><a class="headerlink" href="#webdriver.errorhandler.MobileErrorHandler" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">ErrorHandler</span></code></p>
<dl class="py method">
<dt class="sig sig-object py" id="webdriver.errorhandler.MobileErrorHandler.check_response">
<span class="sig-name descname"><span class="pre">check_response</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">response</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">Dict</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">Any</span><span class="p"><span class="pre">]</span></span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#webdriver.errorhandler.MobileErrorHandler.check_response" title="Link to this definition"></a></dt>
<dd><p><a class="reference external" href="https://www.w3.org/TR/webdriver/#errors">https://www.w3.org/TR/webdriver/#errors</a></p>
</dd></dl>
</dd></dl>
<dl class="py function">
<dt class="sig sig-object py" id="webdriver.errorhandler.format_stacktrace">
<span class="sig-name descname"><span class="pre">format_stacktrace</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">original</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">None</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">Sequence</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#webdriver.errorhandler.format_stacktrace" title="Link to this definition"></a></dt>
<dd></dd></dl>
</section>
<section id="module-webdriver.locator_converter">
<span id="webdriver-locator-converter-module"></span><h2>webdriver.locator_converter module<a class="headerlink" href="#module-webdriver.locator_converter" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="webdriver.locator_converter.AppiumLocatorConverter">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">AppiumLocatorConverter</span></span><a class="headerlink" href="#webdriver.locator_converter.AppiumLocatorConverter" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">LocatorConverter</span></code></p>
<p>A custom locator converter in Appium.</p>
<p>Appium supports locators which are not defined in W3C WebDriver,
so Appium Python client wants to keep the given locators
to the Appium server as-is.</p>
<dl class="py method">
<dt class="sig sig-object py" id="webdriver.locator_converter.AppiumLocatorConverter.convert">
<span class="sig-name descname"><span class="pre">convert</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">by</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">value</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Tuple</span><span class="p"><span class="pre">[</span></span><span class="pre">str</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">str</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#webdriver.locator_converter.AppiumLocatorConverter.convert" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-webdriver.mobilecommand">
<span id="webdriver-mobilecommand-module"></span><h2>webdriver.mobilecommand module<a class="headerlink" href="#module-webdriver.mobilecommand" title="Link to this heading"></a></h2>
<dl class="py class">
<dt class="sig sig-object py" id="webdriver.mobilecommand.MobileCommand">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">MobileCommand</span></span><a class="headerlink" href="#webdriver.mobilecommand.MobileCommand" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.mobilecommand.MobileCommand.ACTIVATE_APP">
<span class="sig-name descname"><span class="pre">ACTIVATE_APP</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'activateApp'</span></em><a class="headerlink" href="#webdriver.mobilecommand.MobileCommand.ACTIVATE_APP" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.mobilecommand.MobileCommand.BACKGROUND">
<span class="sig-name descname"><span class="pre">BACKGROUND</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'background'</span></em><a class="headerlink" href="#webdriver.mobilecommand.MobileCommand.BACKGROUND" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.mobilecommand.MobileCommand.CLEAR">
<span class="sig-name descname"><span class="pre">CLEAR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'clear'</span></em><a class="headerlink" href="#webdriver.mobilecommand.MobileCommand.CLEAR" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.mobilecommand.MobileCommand.COMPARE_IMAGES">
<span class="sig-name descname"><span class="pre">COMPARE_IMAGES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'compareImages'</span></em><a class="headerlink" href="#webdriver.mobilecommand.MobileCommand.COMPARE_IMAGES" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.mobilecommand.MobileCommand.CONTEXTS">
<span class="sig-name descname"><span class="pre">CONTEXTS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'getContexts'</span></em><a class="headerlink" href="#webdriver.mobilecommand.MobileCommand.CONTEXTS" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.mobilecommand.MobileCommand.EXECUTE_DRIVER">
<span class="sig-name descname"><span class="pre">EXECUTE_DRIVER</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'executeDriver'</span></em><a class="headerlink" href="#webdriver.mobilecommand.MobileCommand.EXECUTE_DRIVER" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.mobilecommand.MobileCommand.FINGER_PRINT">
<span class="sig-name descname"><span class="pre">FINGER_PRINT</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'fingerPrint'</span></em><a class="headerlink" href="#webdriver.mobilecommand.MobileCommand.FINGER_PRINT" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.mobilecommand.MobileCommand.GET_APP_STRINGS">
<span class="sig-name descname"><span class="pre">GET_APP_STRINGS</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'getAppStrings'</span></em><a class="headerlink" href="#webdriver.mobilecommand.MobileCommand.GET_APP_STRINGS" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.mobilecommand.MobileCommand.GET_AVAILABLE_LOG_TYPES">
<span class="sig-name descname"><span class="pre">GET_AVAILABLE_LOG_TYPES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'getAvailableLogTypes'</span></em><a class="headerlink" href="#webdriver.mobilecommand.MobileCommand.GET_AVAILABLE_LOG_TYPES" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.mobilecommand.MobileCommand.GET_CAPABILITIES">
<span class="sig-name descname"><span class="pre">GET_CAPABILITIES</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'getCapabilities'</span></em><a class="headerlink" href="#webdriver.mobilecommand.MobileCommand.GET_CAPABILITIES" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="webdriver.mobilecommand.MobileCommand.GET_CLIPBOARD">
<span class="sig-name descname"><span class="pre">GET_CLIPBOARD</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'getClipboard'</span></em><a class="headerlink" href="#webdriver.mobilecommand.MobileCommand.GET_CLIPBOARD" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">