Module appium.webdriver.extensions.keyboard

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

from selenium import webdriver

from ..mobilecommand import MobileCommand as Command

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


class Keyboard(webdriver.Remote):

    def hide_keyboard(self, key_name: Optional[str] = None, key: Optional[str]
                      = None, strategy: Optional[str] = None) -> T:
        """Hides the software keyboard on the device.

        In iOS, use `key_name` to press
        a particular key, or `strategy`. In Android, no parameters are used.

        Args:
            key_name (:obj:`str`, optional): key to press
            key (:obj:`str`, optional):
            strategy (:obj:`str`, optional): strategy for closing the keyboard (e.g., `tapOutside`)
        """
        data: Dict[str, Optional[str]] = {}
        if key_name is not None:
            data['keyName'] = key_name
        elif key is not None:
            data['key'] = key
        elif strategy is None:
            strategy = 'tapOutside'
        data['strategy'] = strategy
        self.execute(Command.HIDE_KEYBOARD, data)
        return self

    def is_keyboard_shown(self) -> bool:
        """Attempts to detect whether a software keyboard is present

        Returns:
            bool: `True` if keyboard is shown
        """
        return self.execute(Command.IS_KEYBOARD_SHOWN)['value']

    def keyevent(self, keycode: int, metastate: Optional[int] = None) -> T:
        """Sends a keycode to the device.

        Android only.
        Possible keycodes can be found in http://developer.android.com/reference/android/view/KeyEvent.html.

        Args:
            keycode (int): the keycode to be sent to the device
            metastate (:obj:`int`, optional): meta information about the keycode being sent

        Returns:
            `appium.webdriver.webdriver.WebDriver`
        """
        data = {
            'keycode': keycode,
        }
        if metastate is not None:
            data['metastate'] = metastate
        self.execute(Command.KEY_EVENT, data)
        return self

    def press_keycode(self, keycode: int, metastate: Optional[int] = None, flags: Optional[int] = None) -> T:
        """Sends a keycode to the device.

        Android only. Possible keycodes can be found in http://developer.android.com/reference/android/view/KeyEvent.html.

        Args:
            keycode (int): the keycode to be sent to the device
            metastate (:obj:`int`, optional): meta information about the keycode being sent
            flags (:obj:`int`, optional): the set of key event flags

        Returns:
            `appium.webdriver.webdriver.WebDriver`
        """
        data = {
            'keycode': keycode,
        }
        if metastate is not None:
            data['metastate'] = metastate
        if flags is not None:
            data['flags'] = flags
        self.execute(Command.PRESS_KEYCODE, data)
        return self

    def long_press_keycode(self, keycode: int, metastate: Optional[int] = None, flags: Optional[int] = None) -> T:
        """Sends a long press of keycode to the device.

        Android only. Possible keycodes can be found in http://developer.android.com/reference/android/view/KeyEvent.html.

        Args:
            keycode (int): the keycode to be sent to the device
            metastate (:obj:`int`, optional): meta information about the keycode being sent
            flags (:obj:`int`, optional): the set of key event flags

        Returns:
            `appium.webdriver.webdriver.WebDriver`
        """
        data = {
            'keycode': keycode
        }
        if metastate is not None:
            data['metastate'] = metastate
        if flags is not None:
            data['flags'] = flags
        self.execute(Command.LONG_PRESS_KEYCODE, data)
        return self

    # pylint: disable=protected-access

    def _addCommands(self) -> None:
        self.command_executor._commands[Command.HIDE_KEYBOARD] = \
            ('POST', '/session/$sessionId/appium/device/hide_keyboard')
        self.command_executor._commands[Command.IS_KEYBOARD_SHOWN] = \
            ('GET', '/session/$sessionId/appium/device/is_keyboard_shown')
        self.command_executor._commands[Command.KEY_EVENT] = \
            ('POST', '/session/$sessionId/appium/device/keyevent')
        self.command_executor._commands[Command.PRESS_KEYCODE] = \
            ('POST', '/session/$sessionId/appium/device/press_keycode')
        self.command_executor._commands[Command.LONG_PRESS_KEYCODE] = \
            ('POST', '/session/$sessionId/appium/device/long_press_keycode')

Classes

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

    def hide_keyboard(self, key_name: Optional[str] = None, key: Optional[str]
                      = None, strategy: Optional[str] = None) -> T:
        """Hides the software keyboard on the device.

        In iOS, use `key_name` to press
        a particular key, or `strategy`. In Android, no parameters are used.

        Args:
            key_name (:obj:`str`, optional): key to press
            key (:obj:`str`, optional):
            strategy (:obj:`str`, optional): strategy for closing the keyboard (e.g., `tapOutside`)
        """
        data: Dict[str, Optional[str]] = {}
        if key_name is not None:
            data['keyName'] = key_name
        elif key is not None:
            data['key'] = key
        elif strategy is None:
            strategy = 'tapOutside'
        data['strategy'] = strategy
        self.execute(Command.HIDE_KEYBOARD, data)
        return self

    def is_keyboard_shown(self) -> bool:
        """Attempts to detect whether a software keyboard is present

        Returns:
            bool: `True` if keyboard is shown
        """
        return self.execute(Command.IS_KEYBOARD_SHOWN)['value']

    def keyevent(self, keycode: int, metastate: Optional[int] = None) -> T:
        """Sends a keycode to the device.

        Android only.
        Possible keycodes can be found in http://developer.android.com/reference/android/view/KeyEvent.html.

        Args:
            keycode (int): the keycode to be sent to the device
            metastate (:obj:`int`, optional): meta information about the keycode being sent

        Returns:
            `appium.webdriver.webdriver.WebDriver`
        """
        data = {
            'keycode': keycode,
        }
        if metastate is not None:
            data['metastate'] = metastate
        self.execute(Command.KEY_EVENT, data)
        return self

    def press_keycode(self, keycode: int, metastate: Optional[int] = None, flags: Optional[int] = None) -> T:
        """Sends a keycode to the device.

        Android only. Possible keycodes can be found in http://developer.android.com/reference/android/view/KeyEvent.html.

        Args:
            keycode (int): the keycode to be sent to the device
            metastate (:obj:`int`, optional): meta information about the keycode being sent
            flags (:obj:`int`, optional): the set of key event flags

        Returns:
            `appium.webdriver.webdriver.WebDriver`
        """
        data = {
            'keycode': keycode,
        }
        if metastate is not None:
            data['metastate'] = metastate
        if flags is not None:
            data['flags'] = flags
        self.execute(Command.PRESS_KEYCODE, data)
        return self

    def long_press_keycode(self, keycode: int, metastate: Optional[int] = None, flags: Optional[int] = None) -> T:
        """Sends a long press of keycode to the device.

        Android only. Possible keycodes can be found in http://developer.android.com/reference/android/view/KeyEvent.html.

        Args:
            keycode (int): the keycode to be sent to the device
            metastate (:obj:`int`, optional): meta information about the keycode being sent
            flags (:obj:`int`, optional): the set of key event flags

        Returns:
            `appium.webdriver.webdriver.WebDriver`
        """
        data = {
            'keycode': keycode
        }
        if metastate is not None:
            data['metastate'] = metastate
        if flags is not None:
            data['flags'] = flags
        self.execute(Command.LONG_PRESS_KEYCODE, data)
        return self

    # pylint: disable=protected-access

    def _addCommands(self) -> None:
        self.command_executor._commands[Command.HIDE_KEYBOARD] = \
            ('POST', '/session/$sessionId/appium/device/hide_keyboard')
        self.command_executor._commands[Command.IS_KEYBOARD_SHOWN] = \
            ('GET', '/session/$sessionId/appium/device/is_keyboard_shown')
        self.command_executor._commands[Command.KEY_EVENT] = \
            ('POST', '/session/$sessionId/appium/device/keyevent')
        self.command_executor._commands[Command.PRESS_KEYCODE] = \
            ('POST', '/session/$sessionId/appium/device/press_keycode')
        self.command_executor._commands[Command.LONG_PRESS_KEYCODE] = \
            ('POST', '/session/$sessionId/appium/device/long_press_keycode')

Ancestors

  • selenium.webdriver.remote.webdriver.WebDriver

Subclasses

Methods

def hide_keyboard(self, key_name=None, key=None, strategy=None)

Hides the software keyboard on the device.

In iOS, use key_name to press a particular key, or strategy. In Android, no parameters are used.

Args

key_name (:obj:str, optional): key to press key (:obj:str, optional): strategy (:obj:str, optional): strategy for closing the keyboard (e.g., tapOutside)

Expand source code 
def hide_keyboard(self, key_name: Optional[str] = None, key: Optional[str]
                  = None, strategy: Optional[str] = None) -> T:
    """Hides the software keyboard on the device.

    In iOS, use `key_name` to press
    a particular key, or `strategy`. In Android, no parameters are used.

    Args:
        key_name (:obj:`str`, optional): key to press
        key (:obj:`str`, optional):
        strategy (:obj:`str`, optional): strategy for closing the keyboard (e.g., `tapOutside`)
    """
    data: Dict[str, Optional[str]] = {}
    if key_name is not None:
        data['keyName'] = key_name
    elif key is not None:
        data['key'] = key
    elif strategy is None:
        strategy = 'tapOutside'
    data['strategy'] = strategy
    self.execute(Command.HIDE_KEYBOARD, data)
    return self
def is_keyboard_shown(self)

Attempts to detect whether a software keyboard is present

Returns

bool
True if keyboard is shown
Expand source code 
def is_keyboard_shown(self) -> bool:
    """Attempts to detect whether a software keyboard is present

    Returns:
        bool: `True` if keyboard is shown
    """
    return self.execute(Command.IS_KEYBOARD_SHOWN)['value']
def keyevent(self, keycode, metastate=None)

Sends a keycode to the device.

Android only. Possible keycodes can be found in http://developer.android.com/reference/android/view/KeyEvent.html.

Args

keycode : int
the keycode to be sent to the device

metastate (:obj:int, optional): meta information about the keycode being sent

Returns

WebDriver

Expand source code 
def keyevent(self, keycode: int, metastate: Optional[int] = None) -> T:
    """Sends a keycode to the device.

    Android only.
    Possible keycodes can be found in http://developer.android.com/reference/android/view/KeyEvent.html.

    Args:
        keycode (int): the keycode to be sent to the device
        metastate (:obj:`int`, optional): meta information about the keycode being sent

    Returns:
        `appium.webdriver.webdriver.WebDriver`
    """
    data = {
        'keycode': keycode,
    }
    if metastate is not None:
        data['metastate'] = metastate
    self.execute(Command.KEY_EVENT, data)
    return self
def long_press_keycode(self, keycode, metastate=None, flags=None)

Sends a long press of keycode to the device.

Android only. Possible keycodes can be found in http://developer.android.com/reference/android/view/KeyEvent.html.

Args

keycode : int
the keycode to be sent to the device

metastate (:obj:int, optional): meta information about the keycode being sent flags (:obj:int, optional): the set of key event flags

Returns

WebDriver

Expand source code 
def long_press_keycode(self, keycode: int, metastate: Optional[int] = None, flags: Optional[int] = None) -> T:
    """Sends a long press of keycode to the device.

    Android only. Possible keycodes can be found in http://developer.android.com/reference/android/view/KeyEvent.html.

    Args:
        keycode (int): the keycode to be sent to the device
        metastate (:obj:`int`, optional): meta information about the keycode being sent
        flags (:obj:`int`, optional): the set of key event flags

    Returns:
        `appium.webdriver.webdriver.WebDriver`
    """
    data = {
        'keycode': keycode
    }
    if metastate is not None:
        data['metastate'] = metastate
    if flags is not None:
        data['flags'] = flags
    self.execute(Command.LONG_PRESS_KEYCODE, data)
    return self
def press_keycode(self, keycode, metastate=None, flags=None)

Sends a keycode to the device.

Android only. Possible keycodes can be found in http://developer.android.com/reference/android/view/KeyEvent.html.

Args

keycode : int
the keycode to be sent to the device

metastate (:obj:int, optional): meta information about the keycode being sent flags (:obj:int, optional): the set of key event flags

Returns

WebDriver

Expand source code 
def press_keycode(self, keycode: int, metastate: Optional[int] = None, flags: Optional[int] = None) -> T:
    """Sends a keycode to the device.

    Android only. Possible keycodes can be found in http://developer.android.com/reference/android/view/KeyEvent.html.

    Args:
        keycode (int): the keycode to be sent to the device
        metastate (:obj:`int`, optional): meta information about the keycode being sent
        flags (:obj:`int`, optional): the set of key event flags

    Returns:
        `appium.webdriver.webdriver.WebDriver`
    """
    data = {
        'keycode': keycode,
    }
    if metastate is not None:
        data['metastate'] = metastate
    if flags is not None:
        data['flags'] = flags
    self.execute(Command.PRESS_KEYCODE, data)
    return self