Renamed ElementFinder to LocatorElementEngine

Under this new model I am separating out the new element finder. Thus the old naming is best changed
to something different. As it is now the "engine" that drive both the locator parsing and the element
finding I am naming it (for now) the LocatorElementEngine :)

Author: emanlove

src/SeleniumLibrary/__init__.py

@@ -51,7 +51,7 @@
     WindowKeywords,
 )
 from SeleniumLibrary.keywords.screenshot import EMBED
-from SeleniumLibrary.locators import ElementFinder
+from SeleniumLibrary.locators import LocatorElementEngine
 from SeleniumLibrary.utils import LibraryListener, is_truthy, _convert_timeout, _convert_delay
 
 
@@ -640,7 +640,7 @@ def __init__(
         self._running_on_failure_keyword = False
         self.screenshot_root_directory = screenshot_root_directory
         self._resolve_screenshot_root_directory()
-        self._element_finder = ElementFinder(self)
+        self._loc_elem_engine = LocatorElementEngine(self)
         self._plugin_keywords = []
         libraries = [
             AlertKeywords(self),
@@ -766,7 +766,7 @@ def find_element(
         :rtype: selenium.webdriver.remote.webelement.WebElement
         :raises SeleniumLibrary.errors.ElementNotFound: If element not found.
         """
-        return self._element_finder.find(locator, parent=parent)
+        return self._loc_elem_engine.find(locator, parent=parent)
 
     def find_elements(
         self, locator: str, parent: WebElement = None
@@ -782,7 +782,7 @@ def find_elements(
         :return: list of found `WebElement` or e,mpty if elements are not found.
         :rtype: list[selenium.webdriver.remote.webelement.WebElement]
         """
-        return self._element_finder.find(
+        return self._loc_elem_engine.find(
             locator, first_only=False, required=False, parent=parent
         )
 

src/SeleniumLibrary/base/context.py

@@ -39,11 +39,11 @@ def drivers(self):
 
     @property
     def element_finder(self):
-        return self.ctx._element_finder
+        return self.ctx._loc_elem_engine
 
     @element_finder.setter
     def element_finder(self, value: Any):
-        self.ctx._element_finder = value
+        self.ctx._loc_elem_engine = value
 
     @property
     def event_firing_webdriver(self):

src/SeleniumLibrary/locators/__init__.py

@@ -15,5 +15,5 @@
 # limitations under the License.
 
 from .customlocator import CustomLocator  # noqa
-from .elementfinder import ElementFinder  # noqa
+from .elementfinder import LocatorElementEngine  # noqa
 from .windowmanager import WindowManager  # noqa

src/SeleniumLibrary/locators/elementfinder.py

@@ -31,7 +31,7 @@
 
 class Finder():
     def __int__(self):
-        """Placeholder to Finder class instantation method """
+        """Placeholder to Finder class instantiation method """
         pass
 
     def pre_find_action(self):
@@ -133,97 +133,18 @@ def _get_tag_and_constraints(self, tag):
             tag = "textarea"
         return tag, constraints
 
+def _is_webelement(self, element):
+    # Hook for unit tests
+    return isinstance(element, (WebElement, EventFiringWebElement))
 
-class Strategies(ContextAware):
-    def __init__(self, ctx):
-        ContextAware.__init__(self, ctx)
-        strategies = {
-            "identifier": ElementFinder._find_by_identifier,
-            "id": ElementFinder._find_by_id,
-            "name": ElementFinder._find_by_name,
-            "xpath": ElementFinder._find_by_xpath,
-            "dom": ElementFinder._find_by_dom,
-            "link": ElementFinder._find_by_link_text,
-            "partial link": ElementFinder._find_by_partial_link_text,
-            "css": ElementFinder._find_by_css_selector,
-            "class": ElementFinder._find_by_class_name,
-            "jquery": ElementFinder._find_by_jquery_selector,
-            "sizzle": ElementFinder._find_by_jquery_selector,
-            "tag": ElementFinder._find_by_tag_name,
-            "scLocator": ElementFinder._find_by_sc_locator,
-            "data": ElementFinder._find_by_data_locator,
-            "default": ElementFinder._find_by_default,
-        }
-        self._strategies = NormalizedDict(
-            initial=strategies, caseless=True, spaceless=True
-        )
-        self._default_strategies = list(strategies)
-    def register(self, strategy_name, strategy_keyword, persist=False):
-        strategy = CustomLocator(self.ctx, strategy_name, strategy_keyword)
-        if strategy.name in self._strategies:
-            raise RuntimeError(
-                f"The custom locator '{strategy.name}' cannot be registered. "
-                "A locator of that name already exists."
-            )
-        self._strategies[strategy.name] = strategy.find
-        if is_falsy(persist):
-            # Unregister after current scope ends
-            events.on("scope_end", "current", self.unregister, strategy.name)
-
-    def unregister(self, strategy_name):
-        if strategy_name in self._default_strategies:
-            raise RuntimeError(
-                f"Cannot unregister the default strategy '{strategy_name}'."
-            )
-        if strategy_name not in self._strategies:
-            raise RuntimeError(
-                f"Cannot unregister the non-registered strategy '{strategy_name}'."
-            )
-        del self._strategies[strategy_name]
-
+def _disallow_webelement_parent(self, element):
+    if _is_webelement(element):
+        raise ValueError("This method does not allow WebElement as parent")
 
 
-class ElementFinder(ContextAware):
+class LocatorElementEngine(ContextAware):
     def __init__(self, ctx):
         ContextAware.__init__(self, ctx)
-        strategies = {
-            "identifier": self._find_by_identifier,
-            "id": self._find_by_id,
-            "name": self._find_by_name,
-            "xpath": self._find_by_xpath,
-            "dom": self._find_by_dom,
-            "link": self._find_by_link_text,
-            "partial link": self._find_by_partial_link_text,
-            "css": self._find_by_css_selector,
-            "class": self._find_by_class_name,
-            "jquery": self._find_by_jquery_selector,
-            "sizzle": self._find_by_jquery_selector,
-            "tag": self._find_by_tag_name,
-            "scLocator": self._find_by_sc_locator,
-            "data": self._find_by_data_locator,
-            "default": self._find_by_default,
-        }
-        self._strategies = NormalizedDict(
-            initial=strategies, caseless=True, spaceless=True
-        )
-        self._default_strategies = list(strategies)
-        self._key_attrs = {
-            None: ["@id", "@name"],
-            "a": [
-                "@id",
-                "@name",
-                "@href",
-                "normalize-space(descendant-or-self::text())",
-            ],
-            "img": ["@id", "@name", "@src", "@alt"],
-            "input": ["@id", "@name", "@value", "@src"],
-            "button": [
-                "@id",
-                "@name",
-                "@value",
-                "normalize-space(descendant-or-self::text())",
-            ],
-        }
         self._split_re = re.compile(
             r" >> (?=identifier ?[:|=]|id ?[:|=]|name ?[:|=]|xpath ?[:|=]|dom ?[:|=]|link ?[:|=]|partial link ?[:|=]"
             r"|css ?[:|=]|class ?[:|=]|jquery ?[:|=]|sizzle ?[:|=]|tag ?[:|=]|scLocator ?[:|=])",
@@ -283,6 +204,108 @@ def _find(self, locator, tag=None, first_only=True, required=True, parent=None):
             return elements[0]
         return elements
 
+    def _get_tag_and_constraints(self, tag):
+        if tag is None:
+            return None, {}
+        tag = tag.lower()
+        constraints = {}
+        if tag == "link":
+            tag = "a"
+        if tag == "partial link":
+            tag = "a"
+        elif tag == "image":
+            tag = "img"
+        elif tag == "list":
+            tag = "select"
+        elif tag == "radio button":
+            tag = "input"
+            constraints["type"] = "radio"
+        elif tag == "checkbox":
+            tag = "input"
+            constraints["type"] = "checkbox"
+        elif tag == "text field":
+            tag = "input"
+            constraints["type"] = [
+                "date",
+                "datetime-local",
+                "email",
+                "month",
+                "number",
+                "password",
+                "search",
+                "tel",
+                "text",
+                "time",
+                "url",
+                "week",
+                "file",
+            ]
+        elif tag == "file upload":
+            tag = "input"
+            constraints["type"] = "file"
+        elif tag == "text area":
+            tag = "textarea"
+        return tag, constraints
+
+    def _parse_locator(self, locator):
+        if re.match(r"\(*//", locator):
+            return "xpath", locator
+        index = self._get_locator_separator_index(locator)
+        if index != -1:
+            prefix = locator[:index].strip()
+            if prefix in self._strategies:
+                return prefix, locator[index + 1 :].lstrip()
+        return "default", locator
+
+    def _get_locator_separator_index(self, locator):
+        if "=" not in locator:
+            return locator.find(":")
+        if ":" not in locator:
+            return locator.find("=")
+        return min(locator.find("="), locator.find(":"))
+
+class Strategies(ContextAware):
+    def __init__(self, ctx):
+        ContextAware.__init__(self, ctx)
+        strategies = {
+            "identifier": self._find_by_identifier,
+            "id": self._find_by_id,
+            "name": self._find_by_name,
+            "xpath": self._find_by_xpath,
+            "dom": self._find_by_dom,
+            "link": self._find_by_link_text,
+            "partial link": self._find_by_partial_link_text,
+            "css": self._find_by_css_selector,
+            "class": self._find_by_class_name,
+            "jquery": self._find_by_jquery_selector,
+            "sizzle": self._find_by_jquery_selector,
+            "tag": self._find_by_tag_name,
+            "scLocator": self._find_by_sc_locator,
+            "data": self._find_by_data_locator,
+            "default": self._find_by_default,
+        }
+        self._strategies = NormalizedDict(
+            initial=strategies, caseless=True, spaceless=True
+        )
+        self._default_strategies = list(strategies)
+        self._key_attrs = {
+            None: ["@id", "@name"],
+            "a": [
+                "@id",
+                "@name",
+                "@href",
+                "normalize-space(descendant-or-self::text())",
+            ],
+            "img": ["@id", "@name", "@src", "@alt"],
+            "input": ["@id", "@name", "@value", "@src"],
+            "button": [
+                "@id",
+                "@name",
+                "@value",
+                "normalize-space(descendant-or-self::text())",
+            ],
+        }
+
     def register(self, strategy_name, strategy_keyword, persist=False):
         strategy = CustomLocator(self.ctx, strategy_name, strategy_keyword)
         if strategy.name in self._strategies:
@@ -306,14 +329,6 @@ def unregister(self, strategy_name):
             )
         del self._strategies[strategy_name]
 
-    def _is_webelement(self, element):
-        # Hook for unit tests
-        return isinstance(element, (WebElement, EventFiringWebElement))
-
-    def _disallow_webelement_parent(self, element):
-        if self._is_webelement(element):
-            raise ValueError("This method does not allow WebElement as parent")
-
     def _find_by_identifier(self, criteria, tag, constraints, parent):
         elements = self._normalize(
             parent.find_elements(By.ID, criteria)
@@ -424,66 +439,6 @@ def _get_xpath_constraint(self, name, value):
         else:
             return f"@{name}='{value}'"
 
-    def _get_tag_and_constraints(self, tag):
-        if tag is None:
-            return None, {}
-        tag = tag.lower()
-        constraints = {}
-        if tag == "link":
-            tag = "a"
-        if tag == "partial link":
-            tag = "a"
-        elif tag == "image":
-            tag = "img"
-        elif tag == "list":
-            tag = "select"
-        elif tag == "radio button":
-            tag = "input"
-            constraints["type"] = "radio"
-        elif tag == "checkbox":
-            tag = "input"
-            constraints["type"] = "checkbox"
-        elif tag == "text field":
-            tag = "input"
-            constraints["type"] = [
-                "date",
-                "datetime-local",
-                "email",
-                "month",
-                "number",
-                "password",
-                "search",
-                "tel",
-                "text",
-                "time",
-                "url",
-                "week",
-                "file",
-            ]
-        elif tag == "file upload":
-            tag = "input"
-            constraints["type"] = "file"
-        elif tag == "text area":
-            tag = "textarea"
-        return tag, constraints
-
-    def _parse_locator(self, locator):
-        if re.match(r"\(*//", locator):
-            return "xpath", locator
-        index = self._get_locator_separator_index(locator)
-        if index != -1:
-            prefix = locator[:index].strip()
-            if prefix in self._strategies:
-                return prefix, locator[index + 1 :].lstrip()
-        return "default", locator
-
-    def _get_locator_separator_index(self, locator):
-        if "=" not in locator:
-            return locator.find(":")
-        if ":" not in locator:
-            return locator.find("=")
-        return min(locator.find("="), locator.find(":"))
-
     def _element_matches(self, element, tag, constraints):
         if not element.tag_name.lower() == tag:
             return False