implement functions in py; adjust tests

Author: AdamPDotty

py/selenium/webdriver/support/relative_locator.py

@@ -60,7 +60,7 @@ def locate_with(by: ByType, using: str) -> "RelativeBy":
 
 class RelativeBy:
     """Gives the opportunity to find elements based on their relative location
-    on the page from a root elelemt. It is recommended that you use the helper
+    on the page from a root element. It is recommended that you use the helper
     function to create it.
 
     Example:
@@ -159,6 +159,78 @@ def to_right_of(self, element_or_locator: Union[WebElement, Dict, None] = None)
         self.filters.append({"kind": "right", "args": [element_or_locator]})
         return self
 
+    @overload
+    def straight_above(self, element_or_locator: Union[WebElement, LocatorType]) -> "RelativeBy": ...
+
+    @overload
+    def straight_above(self, element_or_locator: None = None) -> "NoReturn": ...
+
+    def straight_above(self, element_or_locator: Union[WebElement, LocatorType, None] = None) -> "RelativeBy":
+        """Add a filter to look for elements above.
+
+        :Args:
+            - element_or_locator: Element to look above
+        """
+        if not element_or_locator:
+            raise WebDriverException("Element or locator must be given when calling above method")
+
+        self.filters.append({"kind": "straightAbove", "args": [element_or_locator]})
+        return self
+
+    @overload
+    def straight_below(self, element_or_locator: Union[WebElement, LocatorType]) -> "RelativeBy": ...
+
+    @overload
+    def straight_below(self, element_or_locator: None = None) -> "NoReturn": ...
+
+    def straight_below(self, element_or_locator: Union[WebElement, Dict, None] = None) -> "RelativeBy":
+        """Add a filter to look for elements below.
+
+        :Args:
+            - element_or_locator: Element to look below
+        """
+        if not element_or_locator:
+            raise WebDriverException("Element or locator must be given when calling below method")
+
+        self.filters.append({"kind": "straightBelow", "args": [element_or_locator]})
+        return self
+
+    @overload
+    def straight_left_of(self, element_or_locator: Union[WebElement, LocatorType]) -> "RelativeBy": ...
+
+    @overload
+    def straight_left_of(self, element_or_locator: None = None) -> "NoReturn": ...
+
+    def straight_left_of(self, element_or_locator: Union[WebElement, Dict, None] = None) -> "RelativeBy":
+        """Add a filter to look for elements to the left of.
+
+        :Args:
+            - element_or_locator: Element to look to the left of
+        """
+        if not element_or_locator:
+            raise WebDriverException("Element or locator must be given when calling to_left_of method")
+
+        self.filters.append({"kind": "straightLeft", "args": [element_or_locator]})
+        return self
+
+    @overload
+    def straight_right_of(self, element_or_locator: Union[WebElement, LocatorType]) -> "RelativeBy": ...
+
+    @overload
+    def straight_right_of(self, element_or_locator: None = None) -> "NoReturn": ...
+
+    def straight_right_of(self, element_or_locator: Union[WebElement, Dict, None] = None) -> "RelativeBy":
+        """Add a filter to look for elements right of.
+
+        :Args:
+            - element_or_locator: Element to look right of
+        """
+        if not element_or_locator:
+            raise WebDriverException("Element or locator must be given when calling to_right_of method")
+
+        self.filters.append({"kind": "straightRight", "args": [element_or_locator]})
+        return self
+
     @overload
     def near(self, element_or_locator: Union[WebElement, LocatorType], distance: int = 50) -> "RelativeBy": ...
 

py/test/selenium/webdriver/support/relative_by_tests.py

@@ -133,7 +133,7 @@ def test_should_be_able_to_combine_straight_filters(driver, pages):
 
     elements = driver.find_elements(
         with_tag_name("td")
-        .straightBelow(driver.find_element(By.ID, "topRight"))
+        .straight_below(driver.find_element(By.ID, "topRight"))
         .straight_to_right_of(driver.find_element(By.ID, "bottomLeft"))
     )
 
@@ -261,7 +261,7 @@ def test_should_find_elements_right_of_another(driver, pages):
 def test_should_find_elements_straight_above_another(driver, pages):
     pages.load("relative_locators.html")
 
-    elements = driver.find_elements(with_tag_name("td").above({By.ID: "bottom"}))
+    elements = driver.find_elements(with_tag_name("td").straight_above({By.ID: "bottom"}))
 
     ids = [el.get_attribute("id") for el in elements]
     assert len(ids) == 2
@@ -272,7 +272,7 @@ def test_should_find_elements_straight_above_another(driver, pages):
 def test_should_find_elements_straight_below_another(driver, pages):
     pages.load("relative_locators.html")
 
-    elements = driver.find_elements(with_tag_name("td").below({By.ID: "top"}))
+    elements = driver.find_elements(with_tag_name("td").straight_below({By.ID: "top"}))
 
     ids = [el.get_attribute("id") for el in elements]
     assert len(ids) == 2
@@ -283,7 +283,7 @@ def test_should_find_elements_straight_below_another(driver, pages):
 def test_should_find_elements_straight_left_of_another(driver, pages):
     pages.load("relative_locators.html")
 
-    elements = driver.find_elements(with_tag_name("td").to_left_of({By.ID: "right"}))
+    elements = driver.find_elements(with_tag_name("td").straight_left_of({By.ID: "right"}))
 
     ids = [el.get_attribute("id") for el in elements]
     assert len(ids) == 2
@@ -294,7 +294,7 @@ def test_should_find_elements_straight_left_of_another(driver, pages):
 def test_should_find_elements_straight_right_of_another(driver, pages):
     pages.load("relative_locators.html")
 
-    elements = driver.find_elements(with_tag_name("td").to_right_of({By.ID: "left"}))
+    elements = driver.find_elements(with_tag_name("td").straight_right_of({By.ID: "left"}))
 
     ids = [el.get_attribute("id") for el in elements]
     assert len(ids) == 2