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
|
# 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.
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from typing import TypedDict
class JSONTimeouts(TypedDict, total=False):
implicit: int
pageLoad: int
script: int
else:
from typing import Dict
JSONTimeouts = Dict[str, int]
class _TimeoutsDescriptor:
"""Get or set the value of the attributes listed below.
_implicit_wait _page_load _script
This does not set the value on the remote end.
"""
def __init__(self, name):
self.name = name
def __get__(self, obj, cls) -> float:
return getattr(obj, self.name) / 1000
def __set__(self, obj, value) -> None:
converted_value = getattr(obj, "_convert")(value)
setattr(obj, self.name, converted_value)
class Timeouts:
def __init__(self, implicit_wait: float = 0, page_load: float = 0, script: float = 0) -> None:
"""Create a new Timeouts object.
This implements https://w3c.github.io/webdriver/#timeouts.
:Args:
- implicit_wait - Either an int or a float. Set how many
seconds to wait when searching for elements before
throwing an error.
- page_load - Either an int or a float. Set how many seconds
to wait for a page load to complete before throwing
an error.
- script - Either an int or a float. Set how many seconds to
wait for an asynchronous script to finish execution
before throwing an error.
"""
self._implicit_wait = self._convert(implicit_wait)
self._page_load = self._convert(page_load)
self._script = self._convert(script)
# Creating descriptor objects
implicit_wait = _TimeoutsDescriptor("_implicit_wait")
"""Get or set how many seconds to wait when searching for elements.
This does not set the value on the remote end.
Usage
-----
- Get
- `self.implicit_wait`
- Set
- `self.implicit_wait` = `value`
Parameters
----------
`value`: `float`
"""
page_load = _TimeoutsDescriptor("_page_load")
"""Get or set how many seconds to wait for the page to load.
This does not set the value on the remote end.
Usage
-----
- Get
- `self.page_load`
- Set
- `self.page_load` = `value`
Parameters
----------
`value`: `float`
"""
script = _TimeoutsDescriptor("_script")
"""Get or set how many seconds to wait for an asynchronous script to finish
execution.
This does not set the value on the remote end.
Usage
------
- Get
- `self.script`
- Set
- `self.script` = `value`
Parameters
-----------
`value`: `float`
"""
def _convert(self, timeout: float) -> int:
if isinstance(timeout, (int, float)):
return int(float(timeout) * 1000)
raise TypeError("Timeouts can only be an int or a float")
def _to_json(self) -> JSONTimeouts:
timeouts: JSONTimeouts = {}
if self._implicit_wait:
timeouts["implicit"] = self._implicit_wait
if self._page_load:
timeouts["pageLoad"] = self._page_load
if self._script:
timeouts["script"] = self._script
return timeouts
|