Module appium.webdriver.extensions.location

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

from selenium import webdriver

from ..mobilecommand import MobileCommand as Command

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


class Location(webdriver.Remote):
    def toggle_location_services(self) -> T:
        """Toggle the location services on the device.

        Android only.

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

    def set_location(self,
                     latitude: Union[float, str],
                     longitude: Union[float, str],
                     altitude: Union[float, str] = None) -> T:
        """Set the location of the device

        Args:
            latitude (Union[float, str]): String or numeric value between -90.0 and 90.00
            longitude (Union[float, str]): String or numeric value between -180.0 and 180.0
            altitude (Union[float, str], optional): String or numeric value (Android real device only)

        Returns:
            `appium.webdriver.webdriver.WebDriver`
        """
        data = {
            "location": {
                "latitude": latitude,
                "longitude": longitude,
            }
        }
        if altitude is not None:
            data['location']['altitude'] = altitude
        self.execute(Command.SET_LOCATION, data)
        return self

    @property
    def location(self) -> Dict[str, float]:
        """Retrieves the current location

        Returns:
            A dictionary whose keys are
             - latitude (float)
             - longitude (float)
             - altitude (float)
        """
        return self.execute(Command.GET_LOCATION)['value']

    # pylint: disable=protected-access

    def _addCommands(self) -> None:
        self.command_executor._commands[Command.TOGGLE_LOCATION_SERVICES] = \
            ('POST', '/session/$sessionId/appium/device/toggle_location_services')
        self.command_executor._commands[Command.GET_LOCATION] = \
            ('GET', '/session/$sessionId/location')
        self.command_executor._commands[Command.SET_LOCATION] = \
            ('POST', '/session/$sessionId/location')

Classes

class Location (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 Location(webdriver.Remote):
    def toggle_location_services(self) -> T:
        """Toggle the location services on the device.

        Android only.

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

    def set_location(self,
                     latitude: Union[float, str],
                     longitude: Union[float, str],
                     altitude: Union[float, str] = None) -> T:
        """Set the location of the device

        Args:
            latitude (Union[float, str]): String or numeric value between -90.0 and 90.00
            longitude (Union[float, str]): String or numeric value between -180.0 and 180.0
            altitude (Union[float, str], optional): String or numeric value (Android real device only)

        Returns:
            `appium.webdriver.webdriver.WebDriver`
        """
        data = {
            "location": {
                "latitude": latitude,
                "longitude": longitude,
            }
        }
        if altitude is not None:
            data['location']['altitude'] = altitude
        self.execute(Command.SET_LOCATION, data)
        return self

    @property
    def location(self) -> Dict[str, float]:
        """Retrieves the current location

        Returns:
            A dictionary whose keys are
             - latitude (float)
             - longitude (float)
             - altitude (float)
        """
        return self.execute(Command.GET_LOCATION)['value']

    # pylint: disable=protected-access

    def _addCommands(self) -> None:
        self.command_executor._commands[Command.TOGGLE_LOCATION_SERVICES] = \
            ('POST', '/session/$sessionId/appium/device/toggle_location_services')
        self.command_executor._commands[Command.GET_LOCATION] = \
            ('GET', '/session/$sessionId/location')
        self.command_executor._commands[Command.SET_LOCATION] = \
            ('POST', '/session/$sessionId/location')

Ancestors

  • selenium.webdriver.remote.webdriver.WebDriver

Subclasses

Instance variables

var location

Retrieves the current location

Returns

A dictionary whose keys are
 
  • latitude (float)
  • longitude (float)
  • altitude (float)
Expand source code 
@property
def location(self) -> Dict[str, float]:
    """Retrieves the current location

    Returns:
        A dictionary whose keys are
         - latitude (float)
         - longitude (float)
         - altitude (float)
    """
    return self.execute(Command.GET_LOCATION)['value']

Methods

def set_location(self, latitude, longitude, altitude=None)

Set the location of the device

Args

latitude : Union[float, str]
String or numeric value between -90.0 and 90.00
longitude : Union[float, str]
String or numeric value between -180.0 and 180.0
altitude : Union[float, str], optional
String or numeric value (Android real device only)

Returns

WebDriver

Expand source code 
def set_location(self,
                 latitude: Union[float, str],
                 longitude: Union[float, str],
                 altitude: Union[float, str] = None) -> T:
    """Set the location of the device

    Args:
        latitude (Union[float, str]): String or numeric value between -90.0 and 90.00
        longitude (Union[float, str]): String or numeric value between -180.0 and 180.0
        altitude (Union[float, str], optional): String or numeric value (Android real device only)

    Returns:
        `appium.webdriver.webdriver.WebDriver`
    """
    data = {
        "location": {
            "latitude": latitude,
            "longitude": longitude,
        }
    }
    if altitude is not None:
        data['location']['altitude'] = altitude
    self.execute(Command.SET_LOCATION, data)
    return self
def toggle_location_services(self)

Toggle the location services on the device.

Android only.

Returns

WebDriver

Expand source code 
def toggle_location_services(self) -> T:
    """Toggle the location services on the device.

    Android only.

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