Merge pull request #1241 from seleniumbase/add-click-with-offset

Add "click_with_offset()" method

Author: mdmintz

examples/test_canvas.py

@@ -0,0 +1,38 @@
+from seleniumbase import BaseCase
+
+
+class CanvasTests(BaseCase):
+    def get_pixel_colors(self):
+        # Return the RGB colors of the canvas element's top left pixel
+        x = 0
+        y = 0
+        if self.browser == "safari":
+            x = 1
+            y = 1
+        color = self.execute_script(
+            "return document.querySelector('canvas').getContext('2d')"
+            ".getImageData(%s,%s,1,1).data;" % (x, y)
+        )
+        if self.is_chromium():
+            return [color[0], color[1], color[2]]
+        else:
+            return [color['0'], color['1'], color['2']]
+
+    def test_canvas_actions(self):
+        self.open("https://seleniumbase.io/canvas/")
+        self.highlight("canvas")
+        rgb = self.get_pixel_colors()
+        self.assert_equal(rgb, [221, 242, 231])  # Looks greenish
+        self.click_with_offset("canvas", 500, 350)
+        self.highlight("canvas")
+        rgb = self.get_pixel_colors()
+        self.assert_equal(rgb, [39, 42, 56])  # Blue by hamburger
+
+    def test_canvas_click(self):
+        self.open("https://seleniumbase.io/other/canvas")
+        self.click_with_offset("canvas", 300, 200)
+        self.sleep(1)  # Not needed (Lets you see the alert pop up)
+        alert = self.switch_to_alert()
+        self.assert_equal(alert.text, "You clicked on the square!")
+        self.accept_alert()
+        self.sleep(1)  # Not needed (Lets you see the alert go away)

help_docs/method_summary.md

@@ -130,6 +130,8 @@ self.click_if_visible(selector, by=By.CSS_SELECTOR)
 
 self.click_active_element()
 
+self.click_with_offset(selector, x, y, by=By.CSS_SELECTOR, mark=False, timeout=None)
+
 self.is_selected(selector, by=By.CSS_SELECTOR, timeout=None)
 # Duplicates: self.is_checked(selector, by=By.CSS_SELECTOR, timeout=None)
 

mkdocs.yml

@@ -10,7 +10,7 @@ edit_uri: ""
 site_dir: "site"
 docs_dir: "mkdocs_build"
 # Copyright
-copyright: Copyright © 2014 - 2021 Michael Mintz
+copyright: Copyright © 2014 - 2022 Michael Mintz
 # Extensions
 markdown_extensions:
   - admonition

requirements.txt

@@ -17,6 +17,12 @@ PyYAML>=6.0;python_version>="3.6"
 traitlets>=4.3.3;python_version<"3.7"
 traitlets>=5.1.1;python_version>="3.7"
 certifi>=2021.10.8
+filelock>=3.2.1;python_version<"3.6"
+filelock>=3.4.1;python_version>="3.6" and python_version<"3.7"
+filelock>=3.6.0;python_version>="3.7"
+platformdirs>=2.0.2;python_version<"3.6"
+platformdirs>=2.4.0;python_version>="3.6" and python_version<"3.7"
+platformdirs>=2.5.1;python_version>="3.7"
 six==1.16.0
 ipdb==0.13.4;python_version<"3.5"
 ipdb==0.13.9;python_version>="3.5"
@@ -39,17 +45,14 @@ h11==0.13.0;python_version>="3.7"
 trio==0.20.0;python_version>="3.7"
 trio-websocket==0.9.2;python_version>="3.7"
 pyopenssl==22.0.0;python_version>="3.7"
-wsproto==1.0.0;python_version>="3.7"
+wsproto==1.1.0;python_version>="3.7"
 selenium==3.141.0;python_version<"3.7"
 selenium==4.1.2;python_version>="3.7"
 msedge-selenium-tools==3.141.3;python_version<"3.7"
 more-itertools==5.0.0;python_version<"3.5"
 more-itertools==8.12.0;python_version>="3.5"
 cssselect==1.1.0
 sortedcontainers==2.4.0
-filelock==3.2.1;python_version<"3.6"
-filelock==3.4.1;python_version>="3.6" and python_version<"3.7"
-filelock==3.6.0;python_version>="3.7"
 fasteners==0.16;python_version<"3.5"
 fasteners==0.16.3;python_version>="3.5" and python_version<"3.6"
 fasteners==0.17.3;python_version>="3.6"
@@ -97,13 +100,8 @@ ipython==7.16.1;python_version>="3.6" and python_version<"3.7"
 ipython==7.32.0;python_version>="3.7"
 matplotlib-inline==0.1.3;python_version>="3.7"
 colorama==0.4.4
-platformdirs==2.0.2;python_version<"3.6"
-platformdirs==2.4.0;python_version>="3.6" and python_version<"3.7"
-platformdirs==2.5.1;python_version>="3.7"
-pathlib2==2.3.6;python_version<"3.5"
 importlib-metadata==2.1.3;python_version<"3.6"
 importlib-metadata==4.2.0;python_version>="3.6" and python_version<"3.8"
-virtualenv>=20.13.2
 pycparser==2.21
 pymysql==0.10.1;python_version<"3.6"
 pymysql==1.0.2;python_version>="3.6"

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "2.4.15"
+__version__ = "2.4.16"

seleniumbase/fixtures/base_case.py

@@ -1733,6 +1733,69 @@ def click_active_element(self):
         elif self.slow_mode:
             self.__slow_mode_pause_if_active()
 
+    def click_with_offset(
+        self, selector, x, y, by=By.CSS_SELECTOR, mark=False, timeout=None
+    ):
+        """
+        Click an element at an {X,Y}-offset location.
+        {0,0} is the top-left corner of the element.
+        If mark==True, will draw a dot at location. (Useful for debugging)
+        """
+        from selenium.webdriver.common.action_chains import ActionChains
+
+        self.__check_scope()
+        if not timeout:
+            timeout = settings.SMALL_TIMEOUT
+        if self.timeout_multiplier and timeout == settings.SMALL_TIMEOUT:
+            timeout = self.__get_new_timeout(timeout)
+        selector, by = self.__recalculate_selector(selector, by)
+        element = page_actions.wait_for_element_visible(
+            self.driver, selector, by, timeout
+        )
+        self.__demo_mode_highlight_if_active(selector, by)
+        if mark:
+            selector = self.convert_to_css_selector(selector, by=by)
+            selector = re.escape(selector)
+            selector = self.__escape_quotes_if_needed(selector)
+            px = x - 2
+            if px < 0:
+                px = 0
+            py = y - 2
+            if py < 0:
+                py = 0
+            script = (
+                "var canvas = document.querySelector('%s');"
+                "var ctx = canvas.getContext('2d');"
+                "ctx.fillStyle = '#F80808';"
+                "ctx.fillRect(%s, %s, 5, 5);"
+                % (selector, px, py)
+            )
+            self.execute_script(script)
+        try:
+            element_location = element.location["y"]
+            element_location = element_location - 130 + y
+            if element_location < 0:
+                element_location = 0
+            scroll_script = "window.scrollTo(0, %s);" % element_location
+            self.driver.execute_script(scroll_script)
+            self.sleep(0.1)
+        except Exception:
+            pass
+        try:
+            action_chains = ActionChains(self.driver)
+            action_chains.move_to_element_with_offset(element, x, y)
+            action_chains.click().perform()
+        except MoveTargetOutOfBoundsException:
+            message = (
+                "Target coordinates for click are out-of-bounds!\n"
+                "The offset must stay inside the target element!"
+            )
+            raise Exception(message)
+        if self.demo_mode:
+            self.__demo_mode_pause_if_active()
+        elif self.slow_mode:
+            self.__slow_mode_pause_if_active()
+
     def is_checked(self, selector, by=By.CSS_SELECTOR, timeout=None):
         """Determines if a checkbox or a radio button element is checked.
         Returns True if the element is checked.

setup.py

@@ -142,6 +142,12 @@
         'traitlets>=4.3.3;python_version<"3.7"',
         'traitlets>=5.1.1;python_version>="3.7"',
         "certifi>=2021.10.8",
+        'filelock>=3.2.1;python_version<"3.6"',
+        'filelock>=3.4.1;python_version>="3.6" and python_version<"3.7"',
+        'filelock>=3.6.0;python_version>="3.7"',
+        'platformdirs>=2.0.2;python_version<"3.6"',
+        'platformdirs>=2.4.0;python_version>="3.6" and python_version<"3.7"',
+        'platformdirs>=2.5.1;python_version>="3.7"',
         "six==1.16.0",
         'ipdb==0.13.4;python_version<"3.5"',
         'ipdb==0.13.9;python_version>="3.5"',
@@ -164,17 +170,14 @@
         'trio==0.20.0;python_version>="3.7"',
         'trio-websocket==0.9.2;python_version>="3.7"',
         'pyopenssl==22.0.0;python_version>="3.7"',
-        'wsproto==1.0.0;python_version>="3.7"',
+        'wsproto==1.1.0;python_version>="3.7"',
         'selenium==3.141.0;python_version<"3.7"',
         'selenium==4.1.2;python_version>="3.7"',
         'msedge-selenium-tools==3.141.3;python_version<"3.7"',
         'more-itertools==5.0.0;python_version<"3.5"',
         'more-itertools==8.12.0;python_version>="3.5"',
         "cssselect==1.1.0",
         "sortedcontainers==2.4.0",
-        'filelock==3.2.1;python_version<"3.6"',
-        'filelock==3.4.1;python_version>="3.6" and python_version<"3.7"',
-        'filelock==3.6.0;python_version>="3.7"',
         'fasteners==0.16;python_version<"3.5"',
         'fasteners==0.16.3;python_version>="3.5" and python_version<"3.6"',
         'fasteners==0.17.3;python_version>="3.6"',
@@ -222,13 +225,8 @@
         'ipython==7.32.0;python_version>="3.7"',  # Requires matplotlib-inline
         'matplotlib-inline==0.1.3;python_version>="3.7"',  # ipython needs this
         "colorama==0.4.4",
-        'platformdirs==2.0.2;python_version<"3.6"',
-        'platformdirs==2.4.0;python_version>="3.6" and python_version<"3.7"',
-        'platformdirs==2.5.1;python_version>="3.7"',
-        'pathlib2==2.3.6;python_version<"3.5"',  # Sync with "virtualenv"
         'importlib-metadata==2.1.3;python_version<"3.6"',
         'importlib-metadata==4.2.0;python_version>="3.6" and python_version<"3.8"',  # noqa: E501
-        "virtualenv>=20.13.2",  # Sync with importlib-metadata and pathlib2
         "pycparser==2.21",
         'pymysql==0.10.1;python_version<"3.6"',
         'pymysql==1.0.2;python_version>="3.6"',