Source code for selenium.webdriver.safari.webdriver

# 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 http.client as http_client
import warnings

from selenium.common.exceptions import WebDriverException
from selenium.webdriver.common.desired_capabilities import DesiredCapabilities
from selenium.webdriver.remote.webdriver import WebDriver as RemoteWebDriver

from .options import Options
from .remote_connection import SafariRemoteConnection
from .service import Service

DEFAULT_SAFARI_CAPS = DesiredCapabilities.SAFARI.copy()


[docs]class WebDriver(RemoteWebDriver): """Controls the SafariDriver and allows you to drive the browser.""" def __init__( self, reuse_service=False, 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: - reuse_service - If True, do not spawn a safaridriver instance; instead, connect to an already-running service that was launched externally. - 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 """ if reuse_service: warnings.warn( "reuse_service has been deprecated, please use the Service class to set it", DeprecationWarning, stacklevel=2, ) self.service = service if service else Service() self.options = options if options else Options() self.keep_alive = keep_alive self._reuse_service = reuse_service and self.service.reuse_service if not self._reuse_service: self.service.start() executor = SafariRemoteConnection( remote_server_addr=self.service.service_url, keep_alive=self.keep_alive, ignore_proxy=self.options._ignore_local_proxy, ) super().__init__(command_executor=executor, options=self.options) self._is_remote = False
[docs] def quit(self): """Closes the browser and shuts down the SafariDriver executable that is started when starting the SafariDriver.""" try: super().quit() except http_client.BadStatusLine: pass finally: if not self._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.
[docs] 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.
[docs] 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.
[docs] def debug(self): self.execute("ATTACH_DEBUGGER") self.execute_script("debugger;")