Module appium.webdriver.extensions.remote_fs

Classes

class RemoteFS (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 RemoteFS(webdriver.Remote):
    def pull_file(self, path: str) -> str:
        """Retrieves the file at `path`.

        Args:
            path (str): the path to the file on the device

        Returns:
            str: The file's contents encoded as Base64.
        """
        data = {
            'path': path,
        }
        return self.execute(Command.PULL_FILE, data)['value']

    def pull_folder(self, path: str) -> str:
        """Retrieves a folder at `path`.

        Args:
            path (str): the path to the folder on the device

        Returns:
            str: The folder's contents zipped and encoded as Base64.
        """
        data = {
            'path': path,
        }
        return self.execute(Command.PULL_FOLDER, data)['value']

    def push_file(self, destination_path: str,
                  base64data: Optional[str] = None, source_path: Optional[str] = None) -> T:
        """Puts the data from the file at `source_path`, encoded as Base64, in the file specified as `path`.

        Specify either `base64data` or `source_path`, if both specified default to `source_path`

        Args:
            destination_path (str): the location on the device/simulator where the local file contents should be saved
            base64data (:obj:`str`, optional): file contents, encoded as Base64, to be written to the file on the device/simulator
            source_path (:obj:`str`, optional): local file path for the file to be loaded on device

        Returns:
            `appium.webdriver.webdriver.WebDriver`
        """
        if source_path is None and base64data is None:
            raise InvalidArgumentException('Must either pass base64 data or a local file path')

        if source_path is not None:
            try:
                with open(source_path, 'rb') as f:
                    file_data = f.read()
            except IOError as e:
                message = f'source_path "{source_path}" could not be found. Are you sure the file exists?'
                raise InvalidArgumentException(message) from e
            base64data = base64.b64encode(file_data).decode('utf-8')

        data = {
            'path': destination_path,
            'data': base64data,
        }
        self.execute(Command.PUSH_FILE, data)
        return self

    # pylint: disable=protected-access

    def _addCommands(self) -> None:
        self.command_executor._commands[Command.PULL_FILE] = \
            ('POST', '/session/$sessionId/appium/device/pull_file')
        self.command_executor._commands[Command.PULL_FOLDER] = \
            ('POST', '/session/$sessionId/appium/device/pull_folder')
        self.command_executor._commands[Command.PUSH_FILE] = \
            ('POST', '/session/$sessionId/appium/device/push_file')

Ancestors

• selenium.webdriver.remote.webdriver.WebDriver

Subclasses

• WebDriver

Methods

def pull_file(self, path)

Retrieves the file at path.

Args

path : str

the path to the file on the device

Returns

str

The file's contents encoded as Base64.

Expand source code

def pull_file(self, path: str) -> str:
    """Retrieves the file at `path`.

    Args:
        path (str): the path to the file on the device

    Returns:
        str: The file's contents encoded as Base64.
    """
    data = {
        'path': path,
    }
    return self.execute(Command.PULL_FILE, data)['value']

def pull_folder(self, path)

Retrieves a folder at path.

Args

path : str

the path to the folder on the device

Returns

str

The folder's contents zipped and encoded as Base64.

Expand source code

def pull_folder(self, path: str) -> str:
    """Retrieves a folder at `path`.

    Args:
        path (str): the path to the folder on the device

    Returns:
        str: The folder's contents zipped and encoded as Base64.
    """
    data = {
        'path': path,
    }
    return self.execute(Command.PULL_FOLDER, data)['value']

def push_file(self, destination_path, base64data=None, source_path=None)

Puts the data from the file at source_path, encoded as Base64, in the file specified as path.

Specify either base64data or source_path, if both specified default to source_path

Args

destination_path : str

the location on the device/simulator where the local file contents should be saved

base64data (:obj:str, optional): file contents, encoded as Base64, to be written to the file on the device/simulator source_path (:obj:str, optional): local file path for the file to be loaded on device

Returns

WebDriver

Expand source code

def push_file(self, destination_path: str,
              base64data: Optional[str] = None, source_path: Optional[str] = None) -> T:
    """Puts the data from the file at `source_path`, encoded as Base64, in the file specified as `path`.

    Specify either `base64data` or `source_path`, if both specified default to `source_path`

    Args:
        destination_path (str): the location on the device/simulator where the local file contents should be saved
        base64data (:obj:`str`, optional): file contents, encoded as Base64, to be written to the file on the device/simulator
        source_path (:obj:`str`, optional): local file path for the file to be loaded on device

    Returns:
        `appium.webdriver.webdriver.WebDriver`
    """
    if source_path is None and base64data is None:
        raise InvalidArgumentException('Must either pass base64 data or a local file path')

    if source_path is not None:
        try:
            with open(source_path, 'rb') as f:
                file_data = f.read()
        except IOError as e:
            message = f'source_path "{source_path}" could not be found. Are you sure the file exists?'
            raise InvalidArgumentException(message) from e
        base64data = base64.b64encode(file_data).decode('utf-8')

    data = {
        'path': destination_path,
        'data': base64data,
    }
    self.execute(Command.PUSH_FILE, data)
    return self