/
options.py
447 lines (353 loc) · 11 KB
/
options.py
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
# Licensed to the Software Freedom Conservancy (SFC) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The SFC licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
import typing
from abc import ABCMeta
from abc import abstractmethod
from enum import Enum
from selenium.common.exceptions import InvalidArgumentException
from selenium.webdriver.common.proxy import Proxy
class PageLoadStrategy(str, Enum):
"""Enum of possible page load strategies.
Selenium support following strategies:
* normal (default) - waits for all resources to download
* eager - DOM access is ready, but other resources like images may still be loading
* none - does not block `WebDriver` at all
Docs: https://www.selenium.dev/documentation/webdriver/drivers/options/#pageloadstrategy.
"""
normal = "normal"
eager = "eager"
none = "none"
class _BaseOptionsDescriptor:
def __init__(self, name):
self.name = name
def __get__(self, obj, cls):
if self.name in ("acceptInsecureCerts", "strictFileInteractability", "setWindowRect", "se:downloadsEnabled"):
return obj._caps.get(self.name, False)
return obj._caps.get(self.name)
def __set__(self, obj, value):
obj.set_capability(self.name, value)
class _PageLoadStrategyDescriptor:
"""Determines the point at which a navigation command is returned:
https://w3c.github.io/webdriver/#dfn-table-of-page-load-strategies.
:param strategy: the strategy corresponding to a document readiness state
"""
def __init__(self, name):
self.name = name
def __get__(self, obj, cls):
return obj._caps.get(self.name)
def __set__(self, obj, value):
if value in ("normal", "eager", "none"):
obj.set_capability(self.name, value)
else:
raise ValueError("Strategy can only be one of the following: normal, eager, none")
class _UnHandledPromptBehaviorDescriptor:
"""How the driver should respond when an alert is present and the:
command sent is not handling the alert:
https://w3c.github.io/webdriver/#dfn-table-of-page-load-strategies:
:param behavior: behavior to use when an alert is encountered
:returns: Values for implicit timeout, pageLoad timeout and script timeout if set (in milliseconds)
"""
def __init__(self, name):
self.name = name
def __get__(self, obj, cls):
return obj._caps.get(self.name)
def __set__(self, obj, value):
if value in ("dismiss", "accept", "dismiss and notify", "accept and notify", "ignore"):
obj.set_capability(self.name, value)
else:
raise ValueError(
"Behavior can only be one of the following: dismiss, accept, dismiss and notify, "
"accept and notify, ignore"
)
class _TimeoutsDescriptor:
"""How long the driver should wait for actions to complete before:
returning an error https://w3c.github.io/webdriver/#timeouts:
:param timeouts: values in milliseconds for implicit wait, page load and script timeout
:returns: Values for implicit timeout, pageLoad timeout and script timeout if set (in milliseconds)
"""
def __init__(self, name):
self.name = name
def __get__(self, obj, cls):
return obj._caps.get(self.name)
def __set__(self, obj, value):
if all(x in ("implicit", "pageLoad", "script") for x in value.keys()):
obj.set_capability(self.name, value)
else:
raise ValueError("Timeout keys can only be one of the following: implicit, pageLoad, script")
class _ProxyDescriptor:
""":Returns: Proxy if set, otherwise None."""
def __init__(self, name):
self.name = name
def __get__(self, obj, cls):
return obj._proxy
def __set__(self, obj, value):
if not isinstance(value, Proxy):
raise InvalidArgumentException("Only Proxy objects can be passed in.")
obj._proxy = value
obj._caps[self.name] = value.to_capabilities()
class BaseOptions(metaclass=ABCMeta):
"""Base class for individual browser options."""
browser_version = _BaseOptionsDescriptor("browserVersion")
"""Gets and Sets the version of the browser.
Usage
-----
- Get
- `self.browser_version`
- Set
- `self.browser_version` = `value`
Parameters
----------
`value`: `str`
Returns
-------
- Get
- `str`
- Set
- `None`
"""
platform_name = _BaseOptionsDescriptor("platformName")
"""Gets and Sets name of the platform.
Usage
-----
- Get
- `self.platform_name`
- Set
- `self.platform_name` = `value`
Parameters
----------
`value`: `str`
Returns
-------
- Get
- `str`
- Set
- `None`
"""
accept_insecure_certs = _BaseOptionsDescriptor("acceptInsecureCerts")
"""Gets and Set whether the session accepts insecure certificates.
Usage
-----
- Get
- `self.accept_insecure_certs`
- Set
- `self.accept_insecure_certs` = `value`
Parameters
----------
`value`: `bool`
Returns
-------
- Get
- `bool`
- Set
- `None`
"""
strict_file_interactability = _BaseOptionsDescriptor("strictFileInteractability")
"""Gets and Sets whether session is about file interactability.
Usage
-----
- Get
- `self.strict_file_interactability`
- Set
- `self.strict_file_interactability` = `value`
Parameters
----------
`value`: `bool`
Returns
-------
- Get
- `bool`
- Set
- `None`
"""
set_window_rect = _BaseOptionsDescriptor("setWindowRect")
"""Gets and Sets window size and position.
Usage
-----
- Get
- `self.set_window_rect`
- Set
- `self.set_window_rect` = `value`
Parameters
----------
`value`: `bool`
Returns
-------
- Get
- `bool`
- Set
- `None`
"""
page_load_strategy = _PageLoadStrategyDescriptor("pageLoadStrategy")
""":Gets and Sets page load strategy, the default is "normal".
Usage
-----
- Get
- `self.page_load_strategy`
- Set
- `self.page_load_strategy` = `value`
Parameters
----------
`value`: `str`
Returns
-------
- Get
- `str`
- Set
- `None`
"""
unhandled_prompt_behavior = _UnHandledPromptBehaviorDescriptor("unhandledPromptBehavior")
""":Gets and Sets unhandled prompt behavior, the default is "dismiss and
notify".
Usage
-----
- Get
- `self.unhandled_prompt_behavior`
- Set
- `self.unhandled_prompt_behavior` = `value`
Parameters
----------
`value`: `str`
Returns
-------
- Get
- `str`
- Set
- `None`
"""
timeouts = _TimeoutsDescriptor("timeouts")
""":Gets and Sets implicit timeout, pageLoad timeout and script timeout if
set (in milliseconds)
Usage
-----
- Get
- `self.timeouts`
- Set
- `self.timeouts` = `value`
Parameters
----------
`value`: `dict`
Returns
-------
- Get
- `dict`
- Set
- `None`
"""
proxy = _ProxyDescriptor("proxy")
"""Sets and Gets Proxy.
Usage
-----
- Get
- `self.proxy`
- Set
- `self.proxy` = `value`
Parameters
----------
`value`: `Proxy`
Returns
-------
- Get
- `Proxy`
- Set
- `None`
"""
enable_downloads = _BaseOptionsDescriptor("se:downloadsEnabled")
"""Gets and Sets whether session can download files.
Usage
-----
- Get
- `self.enable_downloads`
- Set
- `self.enable_downloads` = `value`
Parameters
----------
`value`: `bool`
Returns
-------
- Get
- `bool`
- Set
- `None`
"""
def __init__(self) -> None:
super().__init__()
self._caps = self.default_capabilities
self._proxy = None
self.set_capability("pageLoadStrategy", PageLoadStrategy.normal)
self.mobile_options = None
self._ignore_local_proxy = False
@property
def capabilities(self):
return self._caps
def set_capability(self, name, value) -> None:
"""Sets a capability."""
self._caps[name] = value
def enable_mobile(
self,
android_package: typing.Optional[str] = None,
android_activity: typing.Optional[str] = None,
device_serial: typing.Optional[str] = None,
) -> None:
"""Enables mobile browser use for browsers that support it.
:Args:
android_activity: The name of the android package to start
"""
if not android_package:
raise AttributeError("android_package must be passed in")
self.mobile_options = {"androidPackage": android_package}
if android_activity:
self.mobile_options["androidActivity"] = android_activity
if device_serial:
self.mobile_options["androidDeviceSerial"] = device_serial
@abstractmethod
def to_capabilities(self):
"""Convert options into capabilities dictionary."""
@property
@abstractmethod
def default_capabilities(self):
"""Return minimal capabilities necessary as a dictionary."""
def ignore_local_proxy_environment_variables(self) -> None:
"""By calling this you will ignore HTTP_PROXY and HTTPS_PROXY from
being picked up and used."""
self._ignore_local_proxy = True
class ArgOptions(BaseOptions):
BINARY_LOCATION_ERROR = "Binary Location Must be a String"
def __init__(self) -> None:
super().__init__()
self._arguments = []
@property
def arguments(self):
""":Returns: A list of arguments needed for the browser."""
return self._arguments
def add_argument(self, argument) -> None:
"""Adds an argument to the list.
:Args:
- Sets the arguments
"""
if argument:
self._arguments.append(argument)
else:
raise ValueError("argument can not be null")
def ignore_local_proxy_environment_variables(self) -> None:
"""By calling this you will ignore HTTP_PROXY and HTTPS_PROXY from
being picked up and used."""
super().ignore_local_proxy_environment_variables()
def to_capabilities(self):
return self._caps
@property
def default_capabilities(self):
return {}