109 lines
3.9 KiB
Python
109 lines
3.9 KiB
Python
|
# 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 selenium.common.exceptions import WebDriverException
|
||
|
|
from selenium.webdriver.remote.webdriver import WebDriver as RemoteWebDriver
|
||
|
|
|
||
|
|
from ..common.driver_finder import DriverFinder
|
||
|
|
from .options import Options
|
||
|
|
from .remote_connection import SafariRemoteConnection
|
||
|
|
from .service import Service
|
||
|
|
|
||
|
|
|
||
|
|
class WebDriver(RemoteWebDriver):
|
||
|
|
"""Controls the SafariDriver and allows you to drive the browser."""
|
||
|
|
|
||
|
|
def __init__(
|
||
|
|
self,
|
||
|
|
keep_alive=True,
|
||
|
|
options: Options = None,
|
||
|
|
service: Service = None,
|
||
|
|
) -> None:
|
||
|
|
"""Creates a new Safari driver instance and launches or finds a running
|
||
|
|
safaridriver service.
|
||
|
|
|
||
|
|
:Args:
|
||
|
|
- keep_alive - Whether to configure SafariRemoteConnection to use
|
||
|
|
HTTP keep-alive. Defaults to True.
|
||
|
|
- options - Instance of ``options.Options``.
|
||
|
|
- service - Service object for handling the browser driver if you need to pass extra details
|
||
|
|
"""
|
||
|
|
self.service = service if service else Service()
|
||
|
|
options = options if options else Options()
|
||
|
|
|
||
|
|
self.service.path = DriverFinder(self.service, options).get_driver_path()
|
||
|
|
|
||
|
|
if not self.service.reuse_service:
|
||
|
|
self.service.start()
|
||
|
|
|
||
|
|
executor = SafariRemoteConnection(
|
||
|
|
remote_server_addr=self.service.service_url,
|
||
|
|
keep_alive=keep_alive,
|
||
|
|
ignore_proxy=options._ignore_local_proxy,
|
||
|
|
)
|
||
|
|
|
||
|
|
try:
|
||
|
|
super().__init__(command_executor=executor, options=options)
|
||
|
|
except Exception:
|
||
|
|
self.quit()
|
||
|
|
raise
|
||
|
|
|
||
|
|
self._is_remote = False
|
||
|
|
|
||
|
|
def quit(self):
|
||
|
|
"""Closes the browser and shuts down the SafariDriver executable."""
|
||
|
|
try:
|
||
|
|
super().quit()
|
||
|
|
except Exception:
|
||
|
|
# We don't care about the message because something probably has gone wrong
|
||
|
|
pass
|
||
|
|
finally:
|
||
|
|
if not self.service.reuse_service:
|
||
|
|
self.service.stop()
|
||
|
|
|
||
|
|
# safaridriver extension commands. The canonical command support matrix is here:
|
||
|
|
# https://developer.apple.com/library/content/documentation/NetworkingInternetWeb/Conceptual/WebDriverEndpointDoc/Commands/Commands.html
|
||
|
|
|
||
|
|
# First available in Safari 11.1 and Safari Technology Preview 41.
|
||
|
|
def set_permission(self, permission, value):
|
||
|
|
if not isinstance(value, bool):
|
||
|
|
raise WebDriverException("Value of a session permission must be set to True or False.")
|
||
|
|
|
||
|
|
payload = {permission: value}
|
||
|
|
self.execute("SET_PERMISSIONS", {"permissions": payload})
|
||
|
|
|
||
|
|
# First available in Safari 11.1 and Safari Technology Preview 41.
|
||
|
|
def get_permission(self, permission):
|
||
|
|
payload = self.execute("GET_PERMISSIONS")["value"]
|
||
|
|
permissions = payload["permissions"]
|
||
|
|
if not permissions:
|
||
|
|
return None
|
||
|
|
|
||
|
|
if permission not in permissions:
|
||
|
|
return None
|
||
|
|
|
||
|
|
value = permissions[permission]
|
||
|
|
if not isinstance(value, bool):
|
||
|
|
return None
|
||
|
|
|
||
|
|
return value
|
||
|
|
|
||
|
|
# First available in Safari 11.1 and Safari Technology Preview 42.
|
||
|
|
def debug(self):
|
||
|
|
self.execute("ATTACH_DEBUGGER")
|
||
|
|
self.execute_script("debugger;")
|