Module `appium.webdriver.extensions.clipboard`

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.

import base64
from typing import Optional, TypeVar

from selenium import webdriver

from appium.webdriver.clipboard_content_type import ClipboardContentType

from ..mobilecommand import MobileCommand as Command

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


class Clipboard(webdriver.Remote):

    def set_clipboard(self, content: bytes, content_type: str = ClipboardContentType.PLAINTEXT,
                      label: Optional[str] = None) -> T:
        """Set the content of the system clipboard

        Args:
            content (bytes): The content to be set as bytearray string
            content_type (str): One of ClipboardContentType items. Only ClipboardContentType.PLAINTEXT
                is supported on Android
            label (:obj:`str`, optional): label argument, which only works for Android

        Returns:
            `appium.webdriver.webdriver.WebDriver`
        """
        options = {
            'content': base64.b64encode(content).decode('UTF-8'),
            'contentType': content_type,
        }
        if label:
            options['label'] = label
        self.execute(Command.SET_CLIPBOARD, options)
        return self

    def set_clipboard_text(self, text: str, label: Optional[str] = None) -> T:
        """Copies the given text to the system clipboard

        Args:
            text (str): The text to be set
            label (:obj:`str`, optional):label argument, which only works for Android

        Returns:
            `appium.webdriver.webdriver.WebDriver`
        """

        self.set_clipboard(bytes(str(text), 'UTF-8'), ClipboardContentType.PLAINTEXT, label)
        return self

    def get_clipboard(self, content_type: str = ClipboardContentType.PLAINTEXT) -> bytes:
        """Receives the content of the system clipboard

        Args:
            content_type (str): One of ClipboardContentType items. Only ClipboardContentType.PLAINTEXT
                is supported on Android

        Returns:
            base64-encoded string: Clipboard content. Or return an empty string if the clipboard is empty
        """
        base64_str = self.execute(Command.GET_CLIPBOARD, {
            'contentType': content_type
        })['value']
        return base64.b64decode(base64_str)

    def get_clipboard_text(self) -> str:
        """Receives the text of the system clipboard

        Return:
            str: The actual clipboard text or an empty string if the clipboard is empty
        """
        return self.get_clipboard(ClipboardContentType.PLAINTEXT).decode('UTF-8')

    # pylint: disable=protected-access

    def _addCommands(self) -> None:
        self.command_executor._commands[Command.SET_CLIPBOARD] = \
            ('POST', '/session/$sessionId/appium/device/set_clipboard')
        self.command_executor._commands[Command.GET_CLIPBOARD] = \
            ('POST', '/session/$sessionId/appium/device/get_clipboard')

Classes

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

    def set_clipboard(self, content: bytes, content_type: str = ClipboardContentType.PLAINTEXT,
                      label: Optional[str] = None) -> T:
        """Set the content of the system clipboard

        Args:
            content (bytes): The content to be set as bytearray string
            content_type (str): One of ClipboardContentType items. Only ClipboardContentType.PLAINTEXT
                is supported on Android
            label (:obj:`str`, optional): label argument, which only works for Android

        Returns:
            `appium.webdriver.webdriver.WebDriver`
        """
        options = {
            'content': base64.b64encode(content).decode('UTF-8'),
            'contentType': content_type,
        }
        if label:
            options['label'] = label
        self.execute(Command.SET_CLIPBOARD, options)
        return self

    def set_clipboard_text(self, text: str, label: Optional[str] = None) -> T:
        """Copies the given text to the system clipboard

        Args:
            text (str): The text to be set
            label (:obj:`str`, optional):label argument, which only works for Android

        Returns:
            `appium.webdriver.webdriver.WebDriver`
        """

        self.set_clipboard(bytes(str(text), 'UTF-8'), ClipboardContentType.PLAINTEXT, label)
        return self

    def get_clipboard(self, content_type: str = ClipboardContentType.PLAINTEXT) -> bytes:
        """Receives the content of the system clipboard

        Args:
            content_type (str): One of ClipboardContentType items. Only ClipboardContentType.PLAINTEXT
                is supported on Android

        Returns:
            base64-encoded string: Clipboard content. Or return an empty string if the clipboard is empty
        """
        base64_str = self.execute(Command.GET_CLIPBOARD, {
            'contentType': content_type
        })['value']
        return base64.b64decode(base64_str)

    def get_clipboard_text(self) -> str:
        """Receives the text of the system clipboard

        Return:
            str: The actual clipboard text or an empty string if the clipboard is empty
        """
        return self.get_clipboard(ClipboardContentType.PLAINTEXT).decode('UTF-8')

    # pylint: disable=protected-access

    def _addCommands(self) -> None:
        self.command_executor._commands[Command.SET_CLIPBOARD] = \
            ('POST', '/session/$sessionId/appium/device/set_clipboard')
        self.command_executor._commands[Command.GET_CLIPBOARD] = \
            ('POST', '/session/$sessionId/appium/device/get_clipboard')

Ancestors

selenium.webdriver.remote.webdriver.WebDriver

Subclasses

WebDriver

Methods

def get_clipboard(self, content_type='plaintext')

Receives the content of the system clipboard

Args

content_type : str: One of ClipboardContentType items. Only ClipboardContentType.PLAINTEXT is supported on Android

Returns

base64-encoded string: Clipboard content. Or return an empty string if the clipboard is empty

Expand source code

def get_clipboard(self, content_type: str = ClipboardContentType.PLAINTEXT) -> bytes:
    """Receives the content of the system clipboard

    Args:
        content_type (str): One of ClipboardContentType items. Only ClipboardContentType.PLAINTEXT
            is supported on Android

    Returns:
        base64-encoded string: Clipboard content. Or return an empty string if the clipboard is empty
    """
    base64_str = self.execute(Command.GET_CLIPBOARD, {
        'contentType': content_type
    })['value']
    return base64.b64decode(base64_str)

def get_clipboard_text(self)

Receives the text of the system clipboard

Return

str: The actual clipboard text or an empty string if the clipboard is empty

Expand source code

def get_clipboard_text(self) -> str:
    """Receives the text of the system clipboard

    Return:
        str: The actual clipboard text or an empty string if the clipboard is empty
    """
    return self.get_clipboard(ClipboardContentType.PLAINTEXT).decode('UTF-8')

def set_clipboard(self, content, content_type='plaintext', label=None)

Set the content of the system clipboard

Args

content : bytes: The content to be set as bytearray string
content_type : str: One of ClipboardContentType items. Only ClipboardContentType.PLAINTEXT is supported on Android

label (:obj:str, optional): label argument, which only works for Android

Returns

WebDriver

Expand source code

def set_clipboard(self, content: bytes, content_type: str = ClipboardContentType.PLAINTEXT,
                  label: Optional[str] = None) -> T:
    """Set the content of the system clipboard

    Args:
        content (bytes): The content to be set as bytearray string
        content_type (str): One of ClipboardContentType items. Only ClipboardContentType.PLAINTEXT
            is supported on Android
        label (:obj:`str`, optional): label argument, which only works for Android

    Returns:
        `appium.webdriver.webdriver.WebDriver`
    """
    options = {
        'content': base64.b64encode(content).decode('UTF-8'),
        'contentType': content_type,
    }
    if label:
        options['label'] = label
    self.execute(Command.SET_CLIPBOARD, options)
    return self

def set_clipboard_text(self, text, label=None)

Copies the given text to the system clipboard

Args

text : str: The text to be set

label (:obj:str, optional):label argument, which only works for Android

Returns

WebDriver

Expand source code

def set_clipboard_text(self, text: str, label: Optional[str] = None) -> T:
    """Copies the given text to the system clipboard

    Args:
        text (str): The text to be set
        label (:obj:`str`, optional):label argument, which only works for Android

    Returns:
        `appium.webdriver.webdriver.WebDriver`
    """

    self.set_clipboard(bytes(str(text), 'UTF-8'), ClipboardContentType.PLAINTEXT, label)
    return self