Skip to content

Drag and Drop#

DragAndDropGestures #

Access pinch/zoom related gestures.

Source code in src/interaction/gesture/drag_and_drop.py 
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
class DragAndDropGestures:
    """Access pinch/zoom related gestures."""

    def __init__(self, driver: WebDriver, platform: str) -> None:
        self._driver = driver
        self._platform = platform

    def drag_and_drop(
        self,
        element_source: WebElement,
        element_target: WebElement,
        speed: float = 1.0,
    ) -> None:
        """
        Perform a drag and drop action from the source element to the target element.

        This function only supports initial and final elements which are both visible within the viewport.

        Args:
            element_source (WebElement): The source element to begin the drag and drop gesture on.
            element_target (WebElement): The target element to finish the drag and drop gesture on.
            speed (float, optional): The velocity of the drag-and-drop gesture as a percentage.
                For Android, this is multiplied by the device's DPI to calculate the final velocity.
                For iOS, this value is multiplied by the default value of 400.
                Defaults to 1.0 (100%).
        """
        p = DragAndDropParameters(element_source, element_target, speed)

        if element_source is element_target:
            raise ValueError("Source and target elements must be different")

        try:
            init_element = calculate_element_points(p.element_source)
            init_x, init_y = init_element["mid"]
            final_element = calculate_element_points(p.element_target)
            final_x, final_y = final_element["mid"]

            return (
                self._drag_drop_android(init_x, init_y, final_x, final_y, p.speed)
                if self._platform == "android"
                else self._drag_drop_ios(init_x, init_y, final_x, final_y, p.speed)
            )
        except Exception as e:
            msg = f"Failed to perform drag and drop: {str(e)}"
            logger.error(msg)
            raise DragDropError(msg) from e

    def _drag_drop_android(
        self, init_x: int, init_y: int, final_x: int, final_y: int, speed: float
    ) -> bool:
        """Execute Android-specific drag-and-drop gesture."""
        dpi = self._driver.get_display_density()
        velocity = (2500 * dpi) * speed
        return self._driver.execute_script(
            "mobile: dragGesture",
            {
                "startX": init_x,
                "startY": init_y,
                "endX": final_x,
                "endY": final_y,
                "speed": velocity,
            },
        )

    def _drag_drop_ios(
        self, init_x: int, init_y: int, final_x: int, final_y: int, speed: float
    ) -> bool:
        """Execute iOS-specific drag-and-drop gesture."""
        velocity = 400 * speed
        press_duration = 0.5
        hold_duration = 0.1
        return self._driver.execute_script(
            "mobile: dragFromToWithVelocity",
            {
                "pressDuration": press_duration,
                "holdDuration": hold_duration,
                "fromX": init_x,
                "fromY": init_y,
                "toX": final_x,
                "toY": final_y,
                "velocity": velocity,
            },
        )

drag_and_drop(element_source, element_target, speed=1.0) #

Perform a drag and drop action from the source element to the target element.

This function only supports initial and final elements which are both visible within the viewport.

Parameters:

Name Type Description Default
element_source WebElement

The source element to begin the drag and drop gesture on.

 required
element_target WebElement

The target element to finish the drag and drop gesture on.

 required
speed float

The velocity of the drag-and-drop gesture as a percentage. For Android, this is multiplied by the device's DPI to calculate the final velocity. For iOS, this value is multiplied by the default value of 400. Defaults to 1.0 (100%).

 1.0
Source code in src/interaction/gesture/drag_and_drop.py 
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
def drag_and_drop(
    self,
    element_source: WebElement,
    element_target: WebElement,
    speed: float = 1.0,
) -> None:
    """
    Perform a drag and drop action from the source element to the target element.

    This function only supports initial and final elements which are both visible within the viewport.

    Args:
        element_source (WebElement): The source element to begin the drag and drop gesture on.
        element_target (WebElement): The target element to finish the drag and drop gesture on.
        speed (float, optional): The velocity of the drag-and-drop gesture as a percentage.
            For Android, this is multiplied by the device's DPI to calculate the final velocity.
            For iOS, this value is multiplied by the default value of 400.
            Defaults to 1.0 (100%).
    """
    p = DragAndDropParameters(element_source, element_target, speed)

    if element_source is element_target:
        raise ValueError("Source and target elements must be different")

    try:
        init_element = calculate_element_points(p.element_source)
        init_x, init_y = init_element["mid"]
        final_element = calculate_element_points(p.element_target)
        final_x, final_y = final_element["mid"]

        return (
            self._drag_drop_android(init_x, init_y, final_x, final_y, p.speed)
            if self._platform == "android"
            else self._drag_drop_ios(init_x, init_y, final_x, final_y, p.speed)
        )
    except Exception as e:
        msg = f"Failed to perform drag and drop: {str(e)}"
        logger.error(msg)
        raise DragDropError(msg) from e

DragAndDropParameters dataclass #

Encapsulates the parameters needed to perform the drag and drop gestures.

Source code in src/interaction/gesture/drag_and_drop.py 
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
@dataclass
class DragAndDropParameters:
    """Encapsulates the parameters needed to perform the drag and drop gestures."""

    element_source: WebElement
    element_target: WebElement
    _speed: float = field(default=1.0, repr=False)

    @property
    def speed(self) -> float:
        """Get the velocity factor for the drag and drop gesture."""
        return self._speed

    @speed.setter
    def speed(self, value: float) -> None:
        if not 0.0 <= value <= 10.0:
            msg = f"Speed must be between 0.0 and 10.0, got {value}"
            raise ValueError(msg)
        self._speed = value

    def __post_init__(self):
        self.speed = self._speed

speed: float property writable #

Get the velocity factor for the drag and drop gesture.