Module `appium.webdriver.extensions.session`

Expand source code

#!/usr/bin/env python

# Licensed 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 Any, Dict, List

from selenium import webdriver

from appium.common.logger import logger

from ..mobilecommand import MobileCommand as Command


class Session(webdriver.Remote):
    @property
    def session(self) -> Dict[str, Any]:
        """ Retrieves session information from the current session

        Usage:
            session = driver.session

        Returns:
            `dict`: containing information from the current session
        """
        return self.execute(Command.GET_SESSION)['value']

    @property
    def all_sessions(self) -> List[Dict[str, Any]]:
        """ Retrieves all sessions that are open

        Usage:
            sessions = driver.all_sessions

        Returns:
            :obj:`list` of :obj:`dict`: containing all open sessions
        """
        return self.execute(Command.GET_ALL_SESSIONS)['value']

    @property
    def events(self) -> Dict:
        """ Retrieves events information from the current session

        Usage:
            events = driver.events

        Returns:
            `dict`:  containing events timing information from the current session
        """
        try:
            session = self.session
            return session['events']
        except Exception as e:
            logger.warning('Could not find events information in the session. Error:', e)
            return {}

    # pylint: disable=protected-access

    def _addCommands(self) -> None:
        self.command_executor._commands[Command.GET_SESSION] = \
            ('GET', '/session/$sessionId')
        self.command_executor._commands[Command.GET_ALL_SESSIONS] = \
            ('GET', '/sessions')

Classes

class Session (command_executor='http://127.0.0.1:4444/wd/hub', desired_capabilities=None, browser_profile=None, proxy=None, keep_alive=False, file_detector=None, options=None)

Controls a browser by sending commands to a remote server. This server is expected to be running the WebDriver wire protocol as defined at https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol

:Attributes: - session_id - String ID of the browser session started and controlled by this WebDriver. - capabilities - Dictionaty of effective capabilities of this browser session as returned by the remote server. See https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities - command_executor - remote_connection.RemoteConnection object used to execute commands. - error_handler - errorhandler.ErrorHandler object used to handle errors.

Create a new driver that will issue commands using the wire protocol.

:Args: - command_executor - Either a string representing URL of the remote server or a custom remote_connection.RemoteConnection object. Defaults to 'http://127.0.0.1:4444/wd/hub'. - desired_capabilities - A dictionary of capabilities to request when starting the browser session. Required parameter. - browser_profile - A selenium.webdriver.firefox.firefox_profile.FirefoxProfile object. Only used if Firefox is requested. Optional. - proxy - A selenium.webdriver.common.proxy.Proxy object. The browser session will be started with given proxy settings, if possible. Optional. - keep_alive - Whether to configure remote_connection.RemoteConnection to use HTTP keep-alive. Defaults to False. - file_detector - Pass custom file detector object during instantiation. If None, then default LocalFileDetector() will be used. - options - instance of a driver options.Options class

Expand source code

class Session(webdriver.Remote):
    @property
    def session(self) -> Dict[str, Any]:
        """ Retrieves session information from the current session

        Usage:
            session = driver.session

        Returns:
            `dict`: containing information from the current session
        """
        return self.execute(Command.GET_SESSION)['value']

    @property
    def all_sessions(self) -> List[Dict[str, Any]]:
        """ Retrieves all sessions that are open

        Usage:
            sessions = driver.all_sessions

        Returns:
            :obj:`list` of :obj:`dict`: containing all open sessions
        """
        return self.execute(Command.GET_ALL_SESSIONS)['value']

    @property
    def events(self) -> Dict:
        """ Retrieves events information from the current session

        Usage:
            events = driver.events

        Returns:
            `dict`:  containing events timing information from the current session
        """
        try:
            session = self.session
            return session['events']
        except Exception as e:
            logger.warning('Could not find events information in the session. Error:', e)
            return {}

    # pylint: disable=protected-access

    def _addCommands(self) -> None:
        self.command_executor._commands[Command.GET_SESSION] = \
            ('GET', '/session/$sessionId')
        self.command_executor._commands[Command.GET_ALL_SESSIONS] = \
            ('GET', '/sessions')

Ancestors

selenium.webdriver.remote.webdriver.WebDriver

Subclasses

WebDriver

Instance variables

var all_sessions

Retrieves all sessions that are open

Usage

sessions = driver.all_sessions

Returns

:obj:list of :obj:dict: containing all open sessions

Expand source code

@property
def all_sessions(self) -> List[Dict[str, Any]]:
    """ Retrieves all sessions that are open

    Usage:
        sessions = driver.all_sessions

    Returns:
        :obj:`list` of :obj:`dict`: containing all open sessions
    """
    return self.execute(Command.GET_ALL_SESSIONS)['value']

var events

Retrieves events information from the current session

Usage

events = driver.events

Returns

dict: containing events timing information from the current session

Expand source code

@property
def events(self) -> Dict:
    """ Retrieves events information from the current session

    Usage:
        events = driver.events

    Returns:
        `dict`:  containing events timing information from the current session
    """
    try:
        session = self.session
        return session['events']
    except Exception as e:
        logger.warning('Could not find events information in the session. Error:', e)
        return {}

var session

Retrieves session information from the current session

Usage

session = driver.session

Returns

dict: containing information from the current session

Expand source code

@property
def session(self) -> Dict[str, Any]:
    """ Retrieves session information from the current session

    Usage:
        session = driver.session

    Returns:
        `dict`: containing information from the current session
    """
    return self.execute(Command.GET_SESSION)['value']