Module appium.webdriver.extensions.android.common

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, TypeVar

from selenium import webdriver

from appium.webdriver.mobilecommand import MobileCommand as Command

T = TypeVar('T', bound='Common')


class Common(webdriver.Remote):

    def end_test_coverage(self, intent: str, path: str) -> Any:  # TODO Check return type
        """Ends the coverage collection and pull the coverage.ec file from the device.

        Android only.
        See https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/android/android-coverage.md

        Args:
            intent (str): description of operation to be performed
            path (str): path to coverage.ec file to be pulled from the device

        Returns:
            TODO
        """
        data = {
            'intent': intent,
            'path': path,
        }
        return self.execute(Command.END_TEST_COVERAGE, data)['value']

    def open_notifications(self) -> T:
        """Open notification shade in Android (API Level 18 and above)

        Returns:
            `appium.webdriver.webdriver.WebDriver`
        """
        self.execute(Command.OPEN_NOTIFICATIONS, {})
        return self

    @property
    def current_package(self) -> str:
        """Retrieves the current package running on the device.
        """
        return self.execute(Command.GET_CURRENT_PACKAGE)['value']

    def _addCommands(self) -> None:
        self.command_executor._commands[Command.GET_CURRENT_PACKAGE] = \
            ('GET', '/session/$sessionId/appium/device/current_package')
        self.command_executor._commands[Command.END_TEST_COVERAGE] = \
            ('POST', '/session/$sessionId/appium/app/end_test_coverage')
        self.command_executor._commands[Command.OPEN_NOTIFICATIONS] = \
            ('POST', '/session/$sessionId/appium/device/open_notifications')

Classes

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

    def end_test_coverage(self, intent: str, path: str) -> Any:  # TODO Check return type
        """Ends the coverage collection and pull the coverage.ec file from the device.

        Android only.
        See https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/android/android-coverage.md

        Args:
            intent (str): description of operation to be performed
            path (str): path to coverage.ec file to be pulled from the device

        Returns:
            TODO
        """
        data = {
            'intent': intent,
            'path': path,
        }
        return self.execute(Command.END_TEST_COVERAGE, data)['value']

    def open_notifications(self) -> T:
        """Open notification shade in Android (API Level 18 and above)

        Returns:
            `appium.webdriver.webdriver.WebDriver`
        """
        self.execute(Command.OPEN_NOTIFICATIONS, {})
        return self

    @property
    def current_package(self) -> str:
        """Retrieves the current package running on the device.
        """
        return self.execute(Command.GET_CURRENT_PACKAGE)['value']

    def _addCommands(self) -> None:
        self.command_executor._commands[Command.GET_CURRENT_PACKAGE] = \
            ('GET', '/session/$sessionId/appium/device/current_package')
        self.command_executor._commands[Command.END_TEST_COVERAGE] = \
            ('POST', '/session/$sessionId/appium/app/end_test_coverage')
        self.command_executor._commands[Command.OPEN_NOTIFICATIONS] = \
            ('POST', '/session/$sessionId/appium/device/open_notifications')

Ancestors

  • selenium.webdriver.remote.webdriver.WebDriver

Subclasses

Instance variables

var current_package

Retrieves the current package running on the device.

Expand source code 
@property
def current_package(self) -> str:
    """Retrieves the current package running on the device.
    """
    return self.execute(Command.GET_CURRENT_PACKAGE)['value']

Methods

def end_test_coverage(self, intent, path)

Ends the coverage collection and pull the coverage.ec file from the device.

Android only. See https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/android/android-coverage.md

Args

intent : str
description of operation to be performed
path : str
path to coverage.ec file to be pulled from the device

Returns

TODO
 
Expand source code 
def end_test_coverage(self, intent: str, path: str) -> Any:  # TODO Check return type
    """Ends the coverage collection and pull the coverage.ec file from the device.

    Android only.
    See https://github.com/appium/appium/blob/master/docs/en/writing-running-appium/android/android-coverage.md

    Args:
        intent (str): description of operation to be performed
        path (str): path to coverage.ec file to be pulled from the device

    Returns:
        TODO
    """
    data = {
        'intent': intent,
        'path': path,
    }
    return self.execute(Command.END_TEST_COVERAGE, data)['value']
def open_notifications(self)

Open notification shade in Android (API Level 18 and above)

Returns

WebDriver

Expand source code 
def open_notifications(self) -> T:
    """Open notification shade in Android (API Level 18 and above)

    Returns:
        `appium.webdriver.webdriver.WebDriver`
    """
    self.execute(Command.OPEN_NOTIFICATIONS, {})
    return self