All committers have signed the CLA.

PR Reviewer Guide 🔍

(Review updated until commit 012d7f7)

Here are some key observations to aid the review process:

LocatorType = Union[Tuple[ByType, str], Tuple[RelativeBy, None]]

from .relative_locator import RelativeBy

PR Code Suggestions ✨

Latest suggestions up to 012d7f7
Explore these optional code suggestions:

-LocatorType = Union[Tuple[ByType, str], Tuple[RelativeBy, None]]
+LocatorType = Union[Tuple[ByType, str], RelativeBy]

+def find_element(self, by: Union[ByType, RelativeBy] = By.ID,
+                 value: Optional[str] = None) -> WebElement:
+    """Find an element inside a shadow root given a By strategy and
+    locator.
 
+    Parameters:
+    ----------

Previous suggestions

 def find_element(self, by: Union[ByType, RelativeBy] = By.ID,
                  value: Optional[str] = None) -> WebElement:
+    if isinstance(by, RelativeBy):
+        elements = by.find_elements(self)
+        if not elements:
+            raise NoSuchElementException(f"Cannot locate relative element with: {by.root}")
+        return elements[0]
+
     if by == By.CLASS_NAME:
         by = By.CSS_SELECTOR
         value = f".{value}"
     elif by == By.NAME:
         by = By.CSS_SELECTOR
         value = f'[name="{value}"]'
 
     return self._execute(Command.FIND_ELEMENT_FROM_SHADOW_ROOT, {"using": by, "value": value})["value"]

-LocatorType = Union[Tuple[ByType, str], Tuple[RelativeBy, None]]
+LocatorType = Union[Tuple[ByType, str], Tuple[RelativeBy, Optional[str]]]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.86%. Comparing base (57f8398) to head (28d4f96).
Report is 1141 commits behind head on trunk.

@@            Coverage Diff             @@
##            trunk   #15050      +/-   ##
==========================================
+ Coverage   58.48%   58.86%   +0.38%     
==========================================
  Files          86       94       +8     
  Lines        5270     6012     +742     
  Branches      220      259      +39     
==========================================
+ Hits         3082     3539     +457     
- Misses       1968     2214     +246     
- Partials      220      259      +39     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@gryznar Thanks for the PR!

Please run scripts/format.sh to pass the formatting tests

Sure. I was not aware of this script and therefore I've formatted manually

Sure. I was not aware of this script and therefore I've formatted manually

No worries, I didn't know about it either until someone directed me to it

Please run scripts/format.sh to pass the formatting tests

@shbenzer Done

I've also reverted changes in shadowroot.py, because they were causing circular imports

@gryznar Could you please provide some tests for this enhancement? We'll need to ensure that RelativeBy is fully handleable here before we can roll this out.

I'll try

Sorry, that this is taking so long from my side, but I am unsure where to put these tests and what would they to cover?

Is this still relevant? If so, can you fix the merge conflicts?

Sorry, that this is taking so long from my side, but I am unsure where to put these tests and what would they to cover?

To answer this question:

• You would add additional tests to where these files are currently tested (eg. /py/test/.../path/to/test)
• The tests would ensure that RelativeBys can be passed in each instance you altered

To answer this question:

• You would add additional tests to where these files are currently tested (eg. /py/test/.../path/to/test)
• The tests would ensure that RelativeBys can be passed in each instance you altered

Thanks for the answer! I'll try to both resolve conflicts and add these tests this week

@gryznar if you have any questions about adding tests, join us on Slack: https://inviter.co/seleniumhq

Are you no longer working on this @gryznar?

I've broken something and trying to fix

Edit: Done, conflicts also solved. Now I am trying to add tests and check if everything works

This broke every single test :)

Check out the CI logs... I think there is a circular import.

Yeah, I am aware of this. I was trying to set up Bazel environment (this is not obvious) and almost figure out that. I will take care of it in a bit

no problem. Feel free to ask for help in our Slack if you can't get bazel working:
https://www.selenium.dev/support/#ChatRoom

You can also do the build with bazel (./go py:local_dev -- --trace) and then run tests with PyTest. That's what I do for local development since bazel is kind of slow.

Nice trick, thanks!

I didn't manage to run bazel tests on Windows (some strange errors from js I think). Closing and sorry for the whole churn