ENH: Implement compability find_element_by in selenium 4

Author: kayqueGovetri

botcity/web/__init__.py

@@ -1,3 +1,7 @@
+### PATCH Selenium for Compat ###
+from .compat import patch_selenium
+patch_selenium()
+
 from .bot import WebBot, Browser, BROWSER_CONFIGS, By, PageLoadStrategy  # noqa: F401, F403
 from .parsers import table_to_dict, data_from_row, sanitize_header  # noqa: F401, F403
 from .util import element_as_select  # noqa: F401, F403

botcity/web/bot.py

@@ -26,7 +26,7 @@
 from selenium.webdriver.support.wait import WebDriverWait, TimeoutException, NoSuchElementException
 from selenium.webdriver.support import expected_conditions as EC
 
-from . import config, cv2find
+from . import config, cv2find, compat
 from .browsers import BROWSER_CONFIGS, Browser, PageLoadStrategy
 
 try:
@@ -235,7 +235,6 @@ def start_browser(self):
         """
         Starts the selected browser.
         """
-
         def check_driver():
             # Look for driver
             driver_name = BROWSER_CONFIGS.get(self.browser).get("driver")
@@ -260,11 +259,14 @@ def check_driver():
         self.capabilities = cap
         driver_path = self.driver_path or check_driver()
         self.driver_path = driver_path
-        service = BROWSER_CONFIGS.get(self.browser).get("service")
-        service = service(executable_path=self.driver_path)
-        service.desired_capabilities = cap
+        if compat.version_selenium_is_larger_than_four():
+            service = BROWSER_CONFIGS.get(self.browser).get("service")
+            service = service(executable_path=self.driver_path)
+            service.desired_capabilities = cap
 
-        self._driver = driver_class(options=opt, service=service)
+            self._driver = driver_class(options=opt, service=service)
+        else:
+            self._driver = driver_class(options=opt, desired_capabilities=cap, executable_path=driver_path)
         self.set_screen_resolution()
 
     def stop_browser(self):

botcity/web/compat.py

@@ -0,0 +1,45 @@
+import warnings
+
+
+def patch_selenium():
+    if version_selenium_is_larger_than_four():
+        from selenium import webdriver
+
+        web_element = webdriver.remote.webelement.WebElement
+
+        remote_driver = webdriver.remote.webdriver.WebDriver
+
+        bys = ['id', 'class name', 'xpath', 'link text', 'partial link text', 'name', 'css selector', 'tag name']
+        for by in bys:
+            name = '_'.join(by.split(' '))
+            find_element_by_function_name = f"find_element_by_{name}"
+            find_elements_by_function_name = f"find_elements_by_{name}"
+            setattr(web_element, find_element_by_function_name, find_element_by(by))
+            setattr(web_element, find_elements_by_function_name, find_elements_by(by))
+            setattr(remote_driver, find_element_by_function_name, find_element_by(by))
+            setattr(remote_driver, find_elements_by_function_name, find_elements_by(by))
+
+
+def find_element_by(by):
+    def func(self, value):
+        warnings.warn("This function is deprecated in version 4, please review the usage for find_element.",
+                      category=DeprecationWarning, stacklevel=2)
+        return self.find_element(by=by, value=value)
+    return func
+
+
+def find_elements_by(by):
+    def func(self, value):
+        warnings.warn("This function is deprecated in version 4, please review the usage for find_elements.",
+                      category=DeprecationWarning, stacklevel=2)
+        return self.find_elements(by=by, value=value)
+    return func
+
+
+def version_selenium_is_larger_than_four():
+    import selenium
+    from packaging import version
+    se_version = version.parse(selenium.__version__)
+
+    needs_patch = se_version >= version.parse("4.0")
+    return needs_patch

teste.py

@@ -0,0 +1,41 @@
+from botcity.web import WebBot, Browser, By
+bot = WebBot()
+
+# Firefox
+# bot.driver_path = "/home/kayque/Downloads/geckodriver-v0.32.0-linux64/geckodriver"
+# bot.browser = Browser.FIREFOX
+# bot.headless = True
+
+# Chrome
+bot.driver_path = "/home/kayque/Downloads/chromedriver_linux64(9)/chromedriver"
+bot.browser = Browser.CHROME
+bot.headless = False
+
+# Edge
+# bot.driver_path = "/home/kayque/Downloads/edgedriver_linux64/msedgedriver"
+# bot.browser = Browser.EDGE
+# bot.headless = True
+
+try:
+    bot.start_browser()
+    bot.browse("https://google.com")
+    search = bot.find_element(selector="/html/body/div[1]/div[3]/form/div[1]/div[1]/div[1]/div", by=By.XPATH)
+    search_div2 = search.find_elements_by_tag_name("div")
+    search_input = search_div2[2].find_element_by_tag_name("input")
+    teste1 = bot.driver.find_element_by_id("gb")
+    teste2 = bot.driver.find_element_by_xpath("/html/body/div[1]/div[3]/form/div[1]/div[1]/div[1]/div/div[2]/input")
+    teste3 = search.find_element_by_tag_name("input")
+    teste4 = bot.driver.find_elements_by_tag_name("input")
+    print(search)
+    search.send_keys("cotação dolar")
+    bot.enter()
+    value = bot.find_element(selector="/html/body/div[7]/div/div[10]/div/div[2]/div[2]/div/div/div[1]/div/div/div/div/div/div/div/div[3]/div[1]/div[1]/div[2]/span[1]",
+                             by=By.XPATH)
+    date = bot.find_element(selector="/html/body/div[7]/div/div[10]/div/div[2]/div[2]/div/div/div[1]/div/div/div/div/div/div/div/div[3]/div[1]/div[2]/span", by=By.XPATH)
+
+    print(f"$ 1 = R$ {value.text}")
+    print(f"Date: {date.text}")
+except Exception as error:
+    print(error)
+finally:
+    bot.stop_browser()

teste2.py

@@ -0,0 +1,35 @@
+from selenium import webdriver
+
+web_element = webdriver.remote.webelement.WebElement
+
+remote_driver = webdriver.remote.webdriver.WebDriver
+
+
+def find_by_id(self, _id):
+
+    return self.find_element("id", _id)
+
+
+web_element.find_element_by_id = find_by_id
+
+remote_driver.find_element_by_id = find_by_id
+
+driver = webdriver.Firefox(service=webdriver.firefox.service.Service(executable_path="/home/kayque/Downloads/geckodriver-v0.32.0-linux64/geckodriver"))
+
+driver.get("https://www.google.com")
+
+body = driver.find_element("tag name", "body")
+
+test1 = body.find_element_by_id("gb")
+
+test2 = driver.find_element_by_id("gb")
+
+driver.quit()
+
+from packaging import version
+
+import selenium
+
+se_version = version.parse(selenium.__version__)
+
+needs_patch = se_version >= version.parse("4.0")

teste3.py

@@ -0,0 +1,3 @@
+import warnings
+
+warnings.warn("deprecated", DeprecationWarning)