Module appium.webdriver.extensions.android.activities

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 TypeVar

from selenium import webdriver
from selenium.common.exceptions import TimeoutException
from selenium.webdriver.support.ui import WebDriverWait

from appium.webdriver.mobilecommand import MobileCommand as Command

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


class Activities(webdriver.Remote):
    def start_activity(self, app_package: str, app_activity: str, **opts: str) -> T:
        """Opens an arbitrary activity during a test. If the activity belongs to
        another application, that application is started and the activity is opened.

        This is an Android-only method.

        Args:
            app_package (str): The package containing the activity to start.
            app_activity (str): The activity to start.

        Keyword Args:
            app_wait_package (str): Begin automation after this package starts.
            app_wait_activity (str): Begin automation after this activity starts.
            intent_action (str): Intent to start.
            intent_category (str): Intent category to start.
            intent_flags (str): Flags to send to the intent.
            optional_intent_arguments (str): Optional arguments to the intent.
            dont_stop_app_on_reset (str): Should the app be stopped on reset?
        """
        data = {
            'appPackage': app_package,
            'appActivity': app_activity
        }
        arguments = {
            'app_wait_package': 'appWaitPackage',
            'app_wait_activity': 'appWaitActivity',
            'intent_action': 'intentAction',
            'intent_category': 'intentCategory',
            'intent_flags': 'intentFlags',
            'optional_intent_arguments': 'optionalIntentArguments',
            'dont_stop_app_on_reset': 'dontStopAppOnReset'
        }
        for key, value in arguments.items():
            if key in opts:
                data[value] = opts[key]
        self.execute(Command.START_ACTIVITY, data)
        return self

    @property
    def current_activity(self) -> str:
        """Retrieves the current activity running on the device.

        Returns:
            str: The current activity name running on the device
        """
        return self.execute(Command.GET_CURRENT_ACTIVITY)['value']

    def wait_activity(self, activity: str, timeout: int, interval: int = 1) -> bool:
        """Wait for an activity: block until target activity presents or time out.

        This is an Android-only method.

        Args:
            activity (str): target activity
            timeout (int): max wait time, in seconds
            interval (int): sleep interval between retries, in seconds

        Returns:
            bool: `True` if the target activity is shown
        """
        try:
            WebDriverWait(self, timeout, interval).until(
                lambda d: d.current_activity == activity)
            return True
        except TimeoutException:
            return False

    # pylint: disable=protected-access

    def _addCommands(self) -> None:
        self.command_executor._commands[Command.GET_CURRENT_ACTIVITY] = \
            ('GET', '/session/$sessionId/appium/device/current_activity')
        self.command_executor._commands[Command.START_ACTIVITY] = \
            ('POST', '/session/$sessionId/appium/device/start_activity')

Classes

class Activities (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 Activities(webdriver.Remote):
    def start_activity(self, app_package: str, app_activity: str, **opts: str) -> T:
        """Opens an arbitrary activity during a test. If the activity belongs to
        another application, that application is started and the activity is opened.

        This is an Android-only method.

        Args:
            app_package (str): The package containing the activity to start.
            app_activity (str): The activity to start.

        Keyword Args:
            app_wait_package (str): Begin automation after this package starts.
            app_wait_activity (str): Begin automation after this activity starts.
            intent_action (str): Intent to start.
            intent_category (str): Intent category to start.
            intent_flags (str): Flags to send to the intent.
            optional_intent_arguments (str): Optional arguments to the intent.
            dont_stop_app_on_reset (str): Should the app be stopped on reset?
        """
        data = {
            'appPackage': app_package,
            'appActivity': app_activity
        }
        arguments = {
            'app_wait_package': 'appWaitPackage',
            'app_wait_activity': 'appWaitActivity',
            'intent_action': 'intentAction',
            'intent_category': 'intentCategory',
            'intent_flags': 'intentFlags',
            'optional_intent_arguments': 'optionalIntentArguments',
            'dont_stop_app_on_reset': 'dontStopAppOnReset'
        }
        for key, value in arguments.items():
            if key in opts:
                data[value] = opts[key]
        self.execute(Command.START_ACTIVITY, data)
        return self

    @property
    def current_activity(self) -> str:
        """Retrieves the current activity running on the device.

        Returns:
            str: The current activity name running on the device
        """
        return self.execute(Command.GET_CURRENT_ACTIVITY)['value']

    def wait_activity(self, activity: str, timeout: int, interval: int = 1) -> bool:
        """Wait for an activity: block until target activity presents or time out.

        This is an Android-only method.

        Args:
            activity (str): target activity
            timeout (int): max wait time, in seconds
            interval (int): sleep interval between retries, in seconds

        Returns:
            bool: `True` if the target activity is shown
        """
        try:
            WebDriverWait(self, timeout, interval).until(
                lambda d: d.current_activity == activity)
            return True
        except TimeoutException:
            return False

    # pylint: disable=protected-access

    def _addCommands(self) -> None:
        self.command_executor._commands[Command.GET_CURRENT_ACTIVITY] = \
            ('GET', '/session/$sessionId/appium/device/current_activity')
        self.command_executor._commands[Command.START_ACTIVITY] = \
            ('POST', '/session/$sessionId/appium/device/start_activity')

Ancestors

  • selenium.webdriver.remote.webdriver.WebDriver

Subclasses

Instance variables

var current_activity

Retrieves the current activity running on the device.

Returns

str
The current activity name running on the device
Expand source code 
@property
def current_activity(self) -> str:
    """Retrieves the current activity running on the device.

    Returns:
        str: The current activity name running on the device
    """
    return self.execute(Command.GET_CURRENT_ACTIVITY)['value']

Methods

def start_activity(self, app_package, app_activity, **opts)

Opens an arbitrary activity during a test. If the activity belongs to another application, that application is started and the activity is opened.

This is an Android-only method.

Args

app_package : str
The package containing the activity to start.
app_activity : str
The activity to start.

Keyword Args: app_wait_package (str): Begin automation after this package starts. app_wait_activity (str): Begin automation after this activity starts. intent_action (str): Intent to start. intent_category (str): Intent category to start. intent_flags (str): Flags to send to the intent. optional_intent_arguments (str): Optional arguments to the intent. dont_stop_app_on_reset (str): Should the app be stopped on reset?

Expand source code 
def start_activity(self, app_package: str, app_activity: str, **opts: str) -> T:
    """Opens an arbitrary activity during a test. If the activity belongs to
    another application, that application is started and the activity is opened.

    This is an Android-only method.

    Args:
        app_package (str): The package containing the activity to start.
        app_activity (str): The activity to start.

    Keyword Args:
        app_wait_package (str): Begin automation after this package starts.
        app_wait_activity (str): Begin automation after this activity starts.
        intent_action (str): Intent to start.
        intent_category (str): Intent category to start.
        intent_flags (str): Flags to send to the intent.
        optional_intent_arguments (str): Optional arguments to the intent.
        dont_stop_app_on_reset (str): Should the app be stopped on reset?
    """
    data = {
        'appPackage': app_package,
        'appActivity': app_activity
    }
    arguments = {
        'app_wait_package': 'appWaitPackage',
        'app_wait_activity': 'appWaitActivity',
        'intent_action': 'intentAction',
        'intent_category': 'intentCategory',
        'intent_flags': 'intentFlags',
        'optional_intent_arguments': 'optionalIntentArguments',
        'dont_stop_app_on_reset': 'dontStopAppOnReset'
    }
    for key, value in arguments.items():
        if key in opts:
            data[value] = opts[key]
    self.execute(Command.START_ACTIVITY, data)
    return self
def wait_activity(self, activity, timeout, interval=1)

Wait for an activity: block until target activity presents or time out.

This is an Android-only method.

Args

activity : str
target activity
timeout : int
max wait time, in seconds
interval : int
sleep interval between retries, in seconds

Returns

bool
True if the target activity is shown
Expand source code 
def wait_activity(self, activity: str, timeout: int, interval: int = 1) -> bool:
    """Wait for an activity: block until target activity presents or time out.

    This is an Android-only method.

    Args:
        activity (str): target activity
        timeout (int): max wait time, in seconds
        interval (int): sleep interval between retries, in seconds

    Returns:
        bool: `True` if the target activity is shown
    """
    try:
        WebDriverWait(self, timeout, interval).until(
            lambda d: d.current_activity == activity)
        return True
    except TimeoutException:
        return False