Module appium.webdriver.extensions.search_context.ios

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.

# pylint: disable=abstract-method

from typing import TYPE_CHECKING, List

from appium.webdriver.common.mobileby import MobileBy

from .base_search_context import BaseSearchContext

if TYPE_CHECKING:
    from appium.webdriver.webelement import WebElement


class iOSSearchContext(BaseSearchContext):
    """Define search context for iOS"""

    def find_element_by_ios_uiautomation(self, uia_string: str) -> 'WebElement':
        """Finds an element by uiautomation in iOS.

        Args:
            uia_string (str): The element name in the iOS UIAutomation library

        Usage:
            driver.find_element_by_ios_uiautomation('.elements()[1].cells()[2]')

        Returns:
            `appium.webdriver.webelement.WebElement`

        # To enable auto completion in PyCharm(IDE)
        :rtype: `appium.webdriver.webelement.WebElement`
        """
        return self.find_element(by=MobileBy.IOS_UIAUTOMATION, value=uia_string)

    def find_elements_by_ios_uiautomation(self, uia_string: str) -> List['WebElement']:
        """Finds elements by uiautomation in iOS.

        Args:
            uia_string (str): The element name in the iOS UIAutomation library

        Usage:
            driver.find_elements_by_ios_uiautomation('.elements()[1].cells()[2]')

        Returns:
            :obj:`list` of :obj:`appium.webdriver.webelement.WebElement`

        :rtype: list of `appium.webdriver.webelement.WebElement`
        """
        return self.find_elements(by=MobileBy.IOS_UIAUTOMATION, value=uia_string)

    def find_element_by_ios_predicate(self, predicate_string: str) -> 'WebElement':
        """Find an element by ios predicate string.

        Args:
            predicate_string (str): The predicate string

        Usage:
            driver.find_element_by_ios_predicate('label == "myLabel"')

        Returns:
            `appium.webdriver.webelement.WebElement`

        :rtype: `appium.webdriver.webelement.WebElement`
        """
        return self.find_element(by=MobileBy.IOS_PREDICATE, value=predicate_string)

    def find_elements_by_ios_predicate(self, predicate_string: str) -> List['WebElement']:
        """Finds elements by ios predicate string.

        Args:
            predicate_string (str): The predicate string

        Usage:
            driver.find_elements_by_ios_predicate('label == "myLabel"')

        Returns:
            :obj:`list` of :obj:`appium.webdriver.webelement.WebElement`

        :rtype: list of `appium.webdriver.webelement.WebElement`
        """
        return self.find_elements(by=MobileBy.IOS_PREDICATE, value=predicate_string)

    def find_element_by_ios_class_chain(self, class_chain_string: str) -> 'WebElement':
        """Find an element by ios class chain string.

        Args:
            class_chain_string (str): The class chain string

        Usage:
            driver.find_element_by_ios_class_chain('XCUIElementTypeWindow/XCUIElementTypeButton[3]')

        Returns:
            `appium.webdriver.webelement.WebElement`

        :rtype: `appium.webdriver.webelement.WebElement`
        """
        return self.find_element(by=MobileBy.IOS_CLASS_CHAIN, value=class_chain_string)

    def find_elements_by_ios_class_chain(self, class_chain_string: str) -> List['WebElement']:
        """Finds elements by ios class chain string.

        Args:
            class_chain_string (str): The class chain string

        Usage:
            driver.find_elements_by_ios_class_chain('XCUIElementTypeWindow[2]/XCUIElementTypeAny[-2]')

        Returns:
            :obj:`list` of :obj:`appium.webdriver.webelement.WebElement`

        :rtype: list of `appium.webdriver.webelement.WebElement`
        """
        return self.find_elements(by=MobileBy.IOS_CLASS_CHAIN, value=class_chain_string)

Classes

class iOSSearchContext (*args, **kwargs)

Define search context for iOS

Expand source code 
class iOSSearchContext(BaseSearchContext):
    """Define search context for iOS"""

    def find_element_by_ios_uiautomation(self, uia_string: str) -> 'WebElement':
        """Finds an element by uiautomation in iOS.

        Args:
            uia_string (str): The element name in the iOS UIAutomation library

        Usage:
            driver.find_element_by_ios_uiautomation('.elements()[1].cells()[2]')

        Returns:
            `appium.webdriver.webelement.WebElement`

        # To enable auto completion in PyCharm(IDE)
        :rtype: `appium.webdriver.webelement.WebElement`
        """
        return self.find_element(by=MobileBy.IOS_UIAUTOMATION, value=uia_string)

    def find_elements_by_ios_uiautomation(self, uia_string: str) -> List['WebElement']:
        """Finds elements by uiautomation in iOS.

        Args:
            uia_string (str): The element name in the iOS UIAutomation library

        Usage:
            driver.find_elements_by_ios_uiautomation('.elements()[1].cells()[2]')

        Returns:
            :obj:`list` of :obj:`appium.webdriver.webelement.WebElement`

        :rtype: list of `appium.webdriver.webelement.WebElement`
        """
        return self.find_elements(by=MobileBy.IOS_UIAUTOMATION, value=uia_string)

    def find_element_by_ios_predicate(self, predicate_string: str) -> 'WebElement':
        """Find an element by ios predicate string.

        Args:
            predicate_string (str): The predicate string

        Usage:
            driver.find_element_by_ios_predicate('label == "myLabel"')

        Returns:
            `appium.webdriver.webelement.WebElement`

        :rtype: `appium.webdriver.webelement.WebElement`
        """
        return self.find_element(by=MobileBy.IOS_PREDICATE, value=predicate_string)

    def find_elements_by_ios_predicate(self, predicate_string: str) -> List['WebElement']:
        """Finds elements by ios predicate string.

        Args:
            predicate_string (str): The predicate string

        Usage:
            driver.find_elements_by_ios_predicate('label == "myLabel"')

        Returns:
            :obj:`list` of :obj:`appium.webdriver.webelement.WebElement`

        :rtype: list of `appium.webdriver.webelement.WebElement`
        """
        return self.find_elements(by=MobileBy.IOS_PREDICATE, value=predicate_string)

    def find_element_by_ios_class_chain(self, class_chain_string: str) -> 'WebElement':
        """Find an element by ios class chain string.

        Args:
            class_chain_string (str): The class chain string

        Usage:
            driver.find_element_by_ios_class_chain('XCUIElementTypeWindow/XCUIElementTypeButton[3]')

        Returns:
            `appium.webdriver.webelement.WebElement`

        :rtype: `appium.webdriver.webelement.WebElement`
        """
        return self.find_element(by=MobileBy.IOS_CLASS_CHAIN, value=class_chain_string)

    def find_elements_by_ios_class_chain(self, class_chain_string: str) -> List['WebElement']:
        """Finds elements by ios class chain string.

        Args:
            class_chain_string (str): The class chain string

        Usage:
            driver.find_elements_by_ios_class_chain('XCUIElementTypeWindow[2]/XCUIElementTypeAny[-2]')

        Returns:
            :obj:`list` of :obj:`appium.webdriver.webelement.WebElement`

        :rtype: list of `appium.webdriver.webelement.WebElement`
        """
        return self.find_elements(by=MobileBy.IOS_CLASS_CHAIN, value=class_chain_string)

Ancestors

Subclasses

Methods

def find_element_by_ios_class_chain(self, class_chain_string)

Find an element by ios class chain string.

Args

class_chain_string : str
The class chain string

Usage

driver.find_element_by_ios_class_chain('XCUIElementTypeWindow/XCUIElementTypeButton[3]')

Returns

WebElement :rtype: WebElement

Expand source code 
def find_element_by_ios_class_chain(self, class_chain_string: str) -> 'WebElement':
    """Find an element by ios class chain string.

    Args:
        class_chain_string (str): The class chain string

    Usage:
        driver.find_element_by_ios_class_chain('XCUIElementTypeWindow/XCUIElementTypeButton[3]')

    Returns:
        `appium.webdriver.webelement.WebElement`

    :rtype: `appium.webdriver.webelement.WebElement`
    """
    return self.find_element(by=MobileBy.IOS_CLASS_CHAIN, value=class_chain_string)
def find_element_by_ios_predicate(self, predicate_string)

Find an element by ios predicate string.

Args

predicate_string : str
The predicate string

Usage

driver.find_element_by_ios_predicate('label == "myLabel"')

Returns

WebElement :rtype: WebElement

Expand source code 
def find_element_by_ios_predicate(self, predicate_string: str) -> 'WebElement':
    """Find an element by ios predicate string.

    Args:
        predicate_string (str): The predicate string

    Usage:
        driver.find_element_by_ios_predicate('label == "myLabel"')

    Returns:
        `appium.webdriver.webelement.WebElement`

    :rtype: `appium.webdriver.webelement.WebElement`
    """
    return self.find_element(by=MobileBy.IOS_PREDICATE, value=predicate_string)
def find_element_by_ios_uiautomation(self, uia_string)

Finds an element by uiautomation in iOS.

Args

uia_string : str
The element name in the iOS UIAutomation library

Usage

driver.find_element_by_ios_uiautomation('.elements()[1].cells()[2]')

Returns

WebElement

To enable auto completion in PyCharm(IDE)

:rtype: WebElement

Expand source code 
def find_element_by_ios_uiautomation(self, uia_string: str) -> 'WebElement':
    """Finds an element by uiautomation in iOS.

    Args:
        uia_string (str): The element name in the iOS UIAutomation library

    Usage:
        driver.find_element_by_ios_uiautomation('.elements()[1].cells()[2]')

    Returns:
        `appium.webdriver.webelement.WebElement`

    # To enable auto completion in PyCharm(IDE)
    :rtype: `appium.webdriver.webelement.WebElement`
    """
    return self.find_element(by=MobileBy.IOS_UIAUTOMATION, value=uia_string)
def find_elements_by_ios_class_chain(self, class_chain_string)

Finds elements by ios class chain string.

Args

class_chain_string : str
The class chain string

Usage

driver.find_elements_by_ios_class_chain('XCUIElementTypeWindow[2]/XCUIElementTypeAny[-2]')

Returns

:obj:list of :obj:WebElement :rtype: list of WebElement

Expand source code 
def find_elements_by_ios_class_chain(self, class_chain_string: str) -> List['WebElement']:
    """Finds elements by ios class chain string.

    Args:
        class_chain_string (str): The class chain string

    Usage:
        driver.find_elements_by_ios_class_chain('XCUIElementTypeWindow[2]/XCUIElementTypeAny[-2]')

    Returns:
        :obj:`list` of :obj:`appium.webdriver.webelement.WebElement`

    :rtype: list of `appium.webdriver.webelement.WebElement`
    """
    return self.find_elements(by=MobileBy.IOS_CLASS_CHAIN, value=class_chain_string)
def find_elements_by_ios_predicate(self, predicate_string)

Finds elements by ios predicate string.

Args

predicate_string : str
The predicate string

Usage

driver.find_elements_by_ios_predicate('label == "myLabel"')

Returns

:obj:list of :obj:WebElement :rtype: list of WebElement

Expand source code 
def find_elements_by_ios_predicate(self, predicate_string: str) -> List['WebElement']:
    """Finds elements by ios predicate string.

    Args:
        predicate_string (str): The predicate string

    Usage:
        driver.find_elements_by_ios_predicate('label == "myLabel"')

    Returns:
        :obj:`list` of :obj:`appium.webdriver.webelement.WebElement`

    :rtype: list of `appium.webdriver.webelement.WebElement`
    """
    return self.find_elements(by=MobileBy.IOS_PREDICATE, value=predicate_string)
def find_elements_by_ios_uiautomation(self, uia_string)

Finds elements by uiautomation in iOS.

Args

uia_string : str
The element name in the iOS UIAutomation library

Usage

driver.find_elements_by_ios_uiautomation('.elements()[1].cells()[2]')

Returns

:obj:list of :obj:WebElement :rtype: list of WebElement

Expand source code 
def find_elements_by_ios_uiautomation(self, uia_string: str) -> List['WebElement']:
    """Finds elements by uiautomation in iOS.

    Args:
        uia_string (str): The element name in the iOS UIAutomation library

    Usage:
        driver.find_elements_by_ios_uiautomation('.elements()[1].cells()[2]')

    Returns:
        :obj:`list` of :obj:`appium.webdriver.webelement.WebElement`

    :rtype: list of `appium.webdriver.webelement.WebElement`
    """
    return self.find_elements(by=MobileBy.IOS_UIAUTOMATION, value=uia_string)