Skip to content

feat: add pause in drag_and_drop #961

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

Merged
merged 4 commits into from
Feb 24, 2024
Merged

feat: add pause in drag_and_drop #961

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
024da68
feat: add pause in drag_and_drop
KazuCocoa Feb 22, 2024
c420b30
docs: tweak docstring
KazuCocoa Feb 22, 2024
8308192
Update action_helpers.py
KazuCocoa Feb 22, 2024
b54b8ee
apply pause only when the value is not negative
KazuCocoa Feb 23, 2024
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
7 changes: 6 additions & 1 deletion appium/webdriver/extensions/action_helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,19 +61,24 @@ def scroll(self, origin_el: WebElement, destination_el: WebElement, duration: Op
actions.perform()
return cast('WebDriver', self)

def drag_and_drop(self, origin_el: WebElement, destination_el: WebElement) -> 'WebDriver':
def drag_and_drop(
self, origin_el: WebElement, destination_el: WebElement, pause: Optional[float] = None
) -> 'WebDriver':
"""Drag the origin element to the destination element

Args:
origin_el: the element to drag
destination_el: the element to drag to
pause: how long the action pauses before moving after the tap and hold, in float seconds.

Returns:
Union['WebDriver', 'ActionHelpers']: Self instance
"""
actions = ActionChains(self)
# 'mouse' pointer action
actions.w3c_actions.pointer_action.click_and_hold(origin_el)
if pause is not None and pause > 0:
actions.w3c_actions.pointer_action.pause(pause)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume we need to convert the value to integer milliseconds according to w3c spec

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

selenium client takes care it
https://github.com/SeleniumHQ/selenium/blob/93c780439f2886607474a6cebaf4e678f9730047/py/selenium/webdriver/common/actions/pointer_actions.py#L198-L200
https://github.com/SeleniumHQ/selenium/blob/93c780439f2886607474a6cebaf4e678f9730047/py/selenium/webdriver/common/actions/pointer_input.py#L63-L64

actions.w3c_actions.pointer_action.move_to(destination_el)
actions.w3c_actions.pointer_action.release()
actions.perform()
Expand Down