Module `appium.webdriver.extensions.android.performance`

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 Dict, List, Union

from selenium import webdriver

from appium.webdriver.mobilecommand import MobileCommand as Command


class Performance(webdriver.Remote):

    def get_performance_data(self, package_name: str, data_type: str, data_read_timeout: int = None) -> List[List[str]]:
        """Returns the information of the system state
        which is supported to read as like cpu, memory, network traffic, and battery.

        Android only.

        Args:
            package_name (str): The package name of the application
            data_type (str): The type of system state which wants to read.
                It should be one of the supported performance data types.
                Check :func:`.get_performance_data_types` for supported types
            data_read_timeout (:obj:`int`, optional): The number of attempts to read

        Usage:
            self.driver.get_performance_data('my.app.package', 'cpuinfo', 5)

        Returns:
            list: The data along to `data_type`
        """
        data: Dict[str, Union[str, int]] = {'packageName': package_name, 'dataType': data_type}
        if data_read_timeout is not None:
            data['dataReadTimeout'] = data_read_timeout
        return self.execute(Command.GET_PERFORMANCE_DATA, data)['value']

    def get_performance_data_types(self) -> List:
        """Returns the information types of the system state
        which is supported to read as like cpu, memory, network traffic, and battery.
        Android only.

        Usage:
            self.driver.get_performance_data_types()

        Returns:
            list: Available data types
        """
        return self.execute(Command.GET_PERFORMANCE_DATA_TYPES)['value']

    # pylint: disable=protected-access

    def _addCommands(self) -> None:
        self.command_executor._commands[Command.GET_PERFORMANCE_DATA] = \
            ('POST', '/session/$sessionId/appium/getPerformanceData')
        self.command_executor._commands[Command.GET_PERFORMANCE_DATA_TYPES] = \
            ('POST', '/session/$sessionId/appium/performanceData/types')

Classes

class Performance (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 Performance(webdriver.Remote):

    def get_performance_data(self, package_name: str, data_type: str, data_read_timeout: int = None) -> List[List[str]]:
        """Returns the information of the system state
        which is supported to read as like cpu, memory, network traffic, and battery.

        Android only.

        Args:
            package_name (str): The package name of the application
            data_type (str): The type of system state which wants to read.
                It should be one of the supported performance data types.
                Check :func:`.get_performance_data_types` for supported types
            data_read_timeout (:obj:`int`, optional): The number of attempts to read

        Usage:
            self.driver.get_performance_data('my.app.package', 'cpuinfo', 5)

        Returns:
            list: The data along to `data_type`
        """
        data: Dict[str, Union[str, int]] = {'packageName': package_name, 'dataType': data_type}
        if data_read_timeout is not None:
            data['dataReadTimeout'] = data_read_timeout
        return self.execute(Command.GET_PERFORMANCE_DATA, data)['value']

    def get_performance_data_types(self) -> List:
        """Returns the information types of the system state
        which is supported to read as like cpu, memory, network traffic, and battery.
        Android only.

        Usage:
            self.driver.get_performance_data_types()

        Returns:
            list: Available data types
        """
        return self.execute(Command.GET_PERFORMANCE_DATA_TYPES)['value']

    # pylint: disable=protected-access

    def _addCommands(self) -> None:
        self.command_executor._commands[Command.GET_PERFORMANCE_DATA] = \
            ('POST', '/session/$sessionId/appium/getPerformanceData')
        self.command_executor._commands[Command.GET_PERFORMANCE_DATA_TYPES] = \
            ('POST', '/session/$sessionId/appium/performanceData/types')

Ancestors

selenium.webdriver.remote.webdriver.WebDriver

Subclasses

WebDriver

Methods

def get_performance_data(self, package_name, data_type, data_read_timeout=None)

Returns the information of the system state which is supported to read as like cpu, memory, network traffic, and battery.

Android only.

Args

package_name : str: The package name of the application
data_type : str: The type of system state which wants to read. It should be one of the supported performance data types. Check :func:.get_performance_data_types for supported types

data_read_timeout (:obj:int, optional): The number of attempts to read

Usage

self.driver.get_performance_data('my.app.package', 'cpuinfo', 5)

Returns

list: The data along to data_type

Expand source code

def get_performance_data(self, package_name: str, data_type: str, data_read_timeout: int = None) -> List[List[str]]:
    """Returns the information of the system state
    which is supported to read as like cpu, memory, network traffic, and battery.

    Android only.

    Args:
        package_name (str): The package name of the application
        data_type (str): The type of system state which wants to read.
            It should be one of the supported performance data types.
            Check :func:`.get_performance_data_types` for supported types
        data_read_timeout (:obj:`int`, optional): The number of attempts to read

    Usage:
        self.driver.get_performance_data('my.app.package', 'cpuinfo', 5)

    Returns:
        list: The data along to `data_type`
    """
    data: Dict[str, Union[str, int]] = {'packageName': package_name, 'dataType': data_type}
    if data_read_timeout is not None:
        data['dataReadTimeout'] = data_read_timeout
    return self.execute(Command.GET_PERFORMANCE_DATA, data)['value']

def get_performance_data_types(self)

Returns the information types of the system state which is supported to read as like cpu, memory, network traffic, and battery. Android only.

Usage

self.driver.get_performance_data_types()

Returns

list: Available data types

Expand source code

def get_performance_data_types(self) -> List:
    """Returns the information types of the system state
    which is supported to read as like cpu, memory, network traffic, and battery.
    Android only.

    Usage:
        self.driver.get_performance_data_types()

    Returns:
        list: Available data types
    """
    return self.execute(Command.GET_PERFORMANCE_DATA_TYPES)['value']