Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: add deprecated mark for find_element_by* #657

Merged
merged 1 commit into from
Nov 24, 2021
Merged

chore: add deprecated mark for find_element_by* #657

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 47 additions & 7 deletions appium/webdriver/extensions/search_context/android.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import json
from typing import TYPE_CHECKING, Any, List, Optional, TypeVar, Union

from appium.common.logger import logger
from appium.webdriver.common.mobileby import MobileBy

from .base_search_context import BaseSearchContext
Expand All @@ -33,7 +34,10 @@ class AndroidSearchContext(BaseSearchContext):
def find_element_by_android_view_matcher(
self: T, name: Optional[str] = None, args: Optional[Any] = None, className: Optional[str] = None
) -> 'WebElement':
"""Finds element by [onView](https://developer.android.com/training/testing/espresso/basics) in Android
"""
[Deprecated] Please use 'find_element' with 'MobileBy.ANDROID_VIEW_MATCHER' instead.

Finds element by [onView](https://developer.android.com/training/testing/espresso/basics) in Android

It works with [Espresso Driver](https://github.com/appium/appium-espresso-driver).

Expand All @@ -57,14 +61,19 @@ def find_element_by_android_view_matcher(
driver.find_element_by_android_view_matcher(name='withText', args=['Accessibility'], className='ViewMatchers')
"""

logger.warning("[Deprecated] Please use 'find_element' with 'MobileBy.ANDROID_VIEW_MATCHER' instead.")

return self.find_element(
by=MobileBy.ANDROID_VIEW_MATCHER, value=self._build_data_matcher(name=name, args=args, className=className)
)

def find_element_by_android_data_matcher(
self: T, name: Optional[str] = None, args: Optional[Any] = None, className: Optional[str] = None
) -> 'WebElement':
"""Finds element by
"""
[Deprecated] Please use 'find_element' with 'MobileBy.ANDROID_DATA_MATCHER' instead.

Finds element by
[onData](https://medium.com/androiddevelopers/adapterviews-and-espresso-f4172aa853cf) in Android

It works with [Espresso Driver](https://github.com/appium/appium-espresso-driver).
Expand All @@ -89,14 +98,19 @@ def find_element_by_android_data_matcher(
driver.find_element_by_android_data_matcher(name='hasEntry', args=['title', 'Animation'])
"""

logger.warning("[Deprecated] Please use 'find_element' with 'MobileBy.ANDROID_DATA_MATCHER' instead.")

return self.find_element(
by=MobileBy.ANDROID_DATA_MATCHER, value=self._build_data_matcher(name=name, args=args, className=className)
)

def find_elements_by_android_data_matcher(
self: T, name: Optional[str] = None, args: Optional[Any] = None, className: Optional[str] = None
) -> List['WebElement']:
"""Finds elements by
"""
[Deprecated] Please use 'find_elements' with 'MobileBy.ANDROID_DATA_MATCHER' instead.

Finds elements by
[onData](https://medium.com/androiddevelopers/adapterviews-and-espresso-f4172aa853cf) in Android
It works with [Espresso Driver](https://github.com/appium/appium-espresso-driver).

Expand All @@ -117,6 +131,8 @@ def find_elements_by_android_data_matcher(
driver.find_elements_by_android_data_matcher(name='hasEntry', args=['title', 'Animation'])
"""

logger.warning("[Deprecated] Please use 'find_elements' with 'MobileBy.ANDROID_DATA_MATCHER' instead.")

return self.find_elements(
by=MobileBy.ANDROID_DATA_MATCHER, value=self._build_data_matcher(name=name, args=args, className=className)
)
Expand All @@ -133,7 +149,10 @@ def _build_data_matcher(
return json.dumps(result)

def find_element_by_android_uiautomator(self: T, uia_string: str) -> 'WebElement':
"""Finds element by uiautomator in Android.
"""
[Deprecated] Please use 'find_element' with 'MobileBy.ANDROID_UIAUTOMATOR' instead.

Finds element by uiautomator in Android.

Args:
uia_string: The element name in the Android UIAutomator library
Expand All @@ -144,10 +163,16 @@ def find_element_by_android_uiautomator(self: T, uia_string: str) -> 'WebElement
Returns:
`appium.webdriver.webelement.WebElement`: The found element
"""

logger.warning("[Deprecated] Please use 'find_element' with 'MobileBy.ANDROID_UIAUTOMATOR' instead.")

return self.find_element(by=MobileBy.ANDROID_UIAUTOMATOR, value=uia_string)

def find_elements_by_android_uiautomator(self: T, uia_string: str) -> List['WebElement']:
"""Finds elements by uiautomator in Android.
"""
[Deprecated] Please use 'find_elements' with 'MobileBy.ANDROID_UIAUTOMATOR' instead.

Finds elements by uiautomator in Android.

Args:
uia_string: The element name in the Android UIAutomator library
Expand All @@ -158,10 +183,16 @@ def find_elements_by_android_uiautomator(self: T, uia_string: str) -> List['WebE
Returns:
:obj:`list` of :obj:`appium.webdriver.webelement.WebElement`: The found elements
"""

logger.warning("[Deprecated] Please use 'find_elements' with 'MobileBy.ANDROID_UIAUTOMATOR' instead.")

return self.find_elements(by=MobileBy.ANDROID_UIAUTOMATOR, value=uia_string)

def find_element_by_android_viewtag(self: T, tag: str) -> 'WebElement':
"""Finds element by [View#tags](https://developer.android.com/reference/android/view/View#tags) in Android.
"""
[Deprecated] Please use 'find_element' with 'MobileBy.ANDROID_VIEWTAG' instead.

Finds element by [View#tags](https://developer.android.com/reference/android/view/View#tags) in Android.

It works with [Espresso Driver](https://github.com/appium/appium-espresso-driver).

Expand All @@ -174,10 +205,16 @@ def find_element_by_android_viewtag(self: T, tag: str) -> 'WebElement':
Returns:
`appium.webdriver.webelement.WebElement`: The found element
"""

logger.warning("[Deprecated] Please use 'find_element' with 'MobileBy.ANDROID_VIEWTAG' instead.")

return self.find_element(by=MobileBy.ANDROID_VIEWTAG, value=tag)

def find_elements_by_android_viewtag(self: T, tag: str) -> List['WebElement']:
"""Finds element by [View#tags](https://developer.android.com/reference/android/view/View#tags) in Android.
"""
[Deprecated] Please use 'find_elements' with 'MobileBy.ANDROID_VIEWTAG' instead.

Finds element by [View#tags](https://developer.android.com/reference/android/view/View#tags) in Android.

It works with [Espresso Driver](https://github.com/appium/appium-espresso-driver).

Expand All @@ -190,4 +227,7 @@ def find_elements_by_android_viewtag(self: T, tag: str) -> List['WebElement']:
Returns:
:obj:`list` of :obj:`appium.webdriver.webelement.WebElement`: The found elements
"""

logger.warning("[Deprecated] Please use 'find_element' with 'MobileBy.ANDROID_VIEWTAG' instead.")

return self.find_elements(by=MobileBy.ANDROID_VIEWTAG, value=tag)
17 changes: 15 additions & 2 deletions appium/webdriver/extensions/search_context/custom.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

from typing import TYPE_CHECKING, List, TypeVar, Union

from appium.common.logger import logger
from appium.webdriver.common.mobileby import MobileBy

from .base_search_context import BaseSearchContext
Expand All @@ -30,7 +31,10 @@ class CustomSearchContext(BaseSearchContext):
"""Define search context for custom plugin"""

def find_element_by_custom(self: T, selector: str) -> 'WebElement':
"""Finds an element in conjunction with a custom element finding plugin
"""
[Deprecated] Please use 'find_element' with 'MobileBy.CUSTOM' instead.

Finds an element in conjunction with a custom element finding plugin

Args:
selector: a string of the form "module:selector", where "module" is
Expand All @@ -45,10 +49,16 @@ def find_element_by_custom(self: T, selector: str) -> 'WebElement':
`appium.webdriver.webelement.WebElement`: The found element

"""

logger.warning("[Deprecated] Please use 'find_element' with 'MobileBy.CUSTOM' instead.")

return self.find_element(by=MobileBy.CUSTOM, value=selector)

def find_elements_by_custom(self: T, selector: str) -> List['WebElement']:
"""Finds elements in conjunction with a custom element finding plugin
"""
[Deprecated] Please use 'find_elements' with 'MobileBy.CUSTOM' instead.

Finds elements in conjunction with a custom element finding plugin

Args:
selector: a string of the form "module:selector", where "module" is
Expand All @@ -62,4 +72,7 @@ def find_elements_by_custom(self: T, selector: str) -> List['WebElement']:
Returns:
:obj:`list` of :obj:`appium.webdriver.webelement.WebElement`: The found elements
"""

logger.warning("[Deprecated] Please use 'find_elements' with 'MobileBy.CUSTOM' instead.")

return self.find_elements(by=MobileBy.CUSTOM, value=selector)
49 changes: 43 additions & 6 deletions appium/webdriver/extensions/search_context/ios.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

from typing import TYPE_CHECKING, List, TypeVar, Union

from appium.common.logger import logger
from appium.webdriver.common.mobileby import MobileBy

from .base_search_context import BaseSearchContext
Expand All @@ -30,7 +31,10 @@ class iOSSearchContext(BaseSearchContext):
"""Define search context for iOS"""

def find_element_by_ios_uiautomation(self: T, uia_string: str) -> 'WebElement':
"""Finds an element by uiautomation in iOS.
"""
[Deprecated] Please use 'find_element' with 'MobileBy.IOS_UIAUTOMATION' instead.

Finds an element by uiautomation in iOS.

Args:
uia_string: The element name in the iOS UIAutomation library
Expand All @@ -42,10 +46,16 @@ def find_element_by_ios_uiautomation(self: T, uia_string: str) -> 'WebElement':
`appium.webdriver.webelement.WebElement`: The found element

"""

logger.warning("[Deprecated] Please use 'find_element' with 'MobileBy.IOS_UIAUTOMATION' instead.")

return self.find_element(by=MobileBy.IOS_UIAUTOMATION, value=uia_string)

def find_elements_by_ios_uiautomation(self: T, uia_string: str) -> List['WebElement']:
"""Finds elements by uiautomation in iOS.
"""
[Deprecated] Please use 'find_elements' with 'MobileBy.IOS_UIAUTOMATION' instead.

Finds elements by uiautomation in iOS.

Args:
uia_string: The element name in the iOS UIAutomation library
Expand All @@ -57,10 +67,16 @@ def find_elements_by_ios_uiautomation(self: T, uia_string: str) -> List['WebElem
:obj:`list` of :obj:`appium.webdriver.webelement.WebElement`: The found elements

"""

logger.warning("[Deprecated] Please use 'find_elements' with 'MobileBy.IOS_UIAUTOMATION' instead.")

return self.find_elements(by=MobileBy.IOS_UIAUTOMATION, value=uia_string)

def find_element_by_ios_predicate(self: T, predicate_string: str) -> 'WebElement':
"""Find an element by ios predicate string.
"""
[Deprecated] Please use 'find_element' with 'MobileBy.IOS_PREDICATE' instead.

Find an element by ios predicate string.

Args:
predicate_string: The predicate string
Expand All @@ -72,10 +88,16 @@ def find_element_by_ios_predicate(self: T, predicate_string: str) -> 'WebElement
`appium.webdriver.webelement.WebElement`: The found element

"""

logger.warning("[Deprecated] Please use 'find_element' with 'MobileBy.IOS_PREDICATE' instead.")

return self.find_element(by=MobileBy.IOS_PREDICATE, value=predicate_string)

def find_elements_by_ios_predicate(self: T, predicate_string: str) -> List['WebElement']:
"""Finds elements by ios predicate string.
"""
[Deprecated] Please use 'find_elements' with 'MobileBy.IOS_PREDICATE' instead.

Finds elements by ios predicate string.

Args:
predicate_string: The predicate string
Expand All @@ -86,10 +108,16 @@ def find_elements_by_ios_predicate(self: T, predicate_string: str) -> List['WebE
Returns:
:obj:`list` of :obj:`appium.webdriver.webelement.WebElement`: The found elements
"""

logger.warning("[Deprecated] Please use 'find_elements' with 'MobileBy.IOS_PREDICATE' instead.")

return self.find_elements(by=MobileBy.IOS_PREDICATE, value=predicate_string)

def find_element_by_ios_class_chain(self: T, class_chain_string: str) -> 'WebElement':
"""Find an element by ios class chain string.
"""
[Deprecated] Please use 'find_element' with 'MobileBy.IOS_CLASS_CHAIN' instead.

Find an element by ios class chain string.

Args:
class_chain_string: The class chain string
Expand All @@ -100,10 +128,16 @@ def find_element_by_ios_class_chain(self: T, class_chain_string: str) -> 'WebEle
Returns:
`appium.webdriver.webelement.WebElement`: The found element
"""

logger.warning("[Deprecated] Please use 'find_element' with 'MobileBy.IOS_CLASS_CHAIN' instead.")

return self.find_element(by=MobileBy.IOS_CLASS_CHAIN, value=class_chain_string)

def find_elements_by_ios_class_chain(self: T, class_chain_string: str) -> List['WebElement']:
"""Finds elements by ios class chain string.
"""
[Deprecated] Please use 'find_elements' with 'MobileBy.IOS_CLASS_CHAIN' instead.

Finds elements by ios class chain string.

Args:
class_chain_string: The class chain string
Expand All @@ -114,4 +148,7 @@ def find_elements_by_ios_class_chain(self: T, class_chain_string: str) -> List['
Returns:
:obj:`list` of :obj:`appium.webdriver.webelement.WebElement`: The found elements
"""

logger.warning("[Deprecated] Please use 'find_elements' with 'MobileBy.IOS_CLASS_CHAIN' instead.")

return self.find_elements(by=MobileBy.IOS_CLASS_CHAIN, value=class_chain_string)
18 changes: 16 additions & 2 deletions appium/webdriver/extensions/search_context/mobile.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
import base64
from typing import TYPE_CHECKING, List, TypeVar, Union

from appium.common.logger import logger
from appium.webdriver.common.mobileby import MobileBy

from .base_search_context import BaseSearchContext
Expand All @@ -31,7 +32,10 @@ class MobileSearchContext(BaseSearchContext):
"""Define search context for Mobile(Android, iOS)"""

def find_element_by_accessibility_id(self: T, accessibility_id: str) -> 'WebElement':
"""Finds an element by accessibility id.
"""
[Deprecated] Please use 'find_element' with 'MobileBy.ACCESSIBILITY_ID' instead.

Finds an element by accessibility id.

Args:
accessibility_id: A string corresponding to a recursive element search using the
Expand All @@ -44,10 +48,16 @@ def find_element_by_accessibility_id(self: T, accessibility_id: str) -> 'WebElem
`appium.webdriver.webelement.WebElement`: The found element

"""

logger.warning("[Deprecated] Please use 'find_element' with 'MobileBy.ACCESSIBILITY_ID' instead.")

return self.find_element(by=MobileBy.ACCESSIBILITY_ID, value=accessibility_id)

def find_elements_by_accessibility_id(self: T, accessibility_id: str) -> List['WebElement']:
"""Finds elements by accessibility id.
"""
[Deprecated] Please use 'find_elements' with 'MobileBy.ACCESSIBILITY_ID' instead.

Finds elements by accessibility id.

Args:
accessibility_id: a string corresponding to a recursive element search using the
Expand All @@ -60,6 +70,9 @@ def find_elements_by_accessibility_id(self: T, accessibility_id: str) -> List['W
:obj:`list` of :obj:`appium.webdriver.webelement.WebElement`: The found elements

"""

logger.warning("[Deprecated] Please use 'find_elements' with 'MobileBy.ACCESSIBILITY_ID' instead.")

return self.find_elements(by=MobileBy.ACCESSIBILITY_ID, value=accessibility_id)

def find_element_by_image(self: T, img_path: str) -> 'WebElement':
Expand All @@ -73,6 +86,7 @@ def find_element_by_image(self: T, img_path: str) -> 'WebElement':
Returns:
`appium.webdriver.webelement.WebElement`: The found element
"""

with open(img_path, 'rb') as i_file:
b64_data = base64.b64encode(i_file.read()).decode('UTF-8')

Expand Down
Loading