Merge pull request #86 from kayqueGovetri/ENH/binary_path

ENH: Implement binary path

Author: kayqueGovetri

botcity/web/bot.py

@@ -5,6 +5,7 @@
 import json
 import logging
 import os
+import pathlib
 import platform
 import random
 import re
@@ -65,6 +66,7 @@ def __init__(self, headless=False):
         self._driver = None
         self._headless = headless
         self._page_load_strategy = PageLoadStrategy.NORMAL
+        self._binary_path = None
 
         self._clipboard = ""
 
@@ -232,6 +234,27 @@ def page_load_strategy(self, page_load_strategy: PageLoadStrategy):
             logger.warning("Browser is running. Invoke stop_browser and start browser for changes to take effect.")
         self._page_load_strategy = page_load_strategy
 
+    @property
+    def binary_path(self):
+        """The binary path to be used.
+
+        Returns:
+             binary_path (pathlib.Path): The binary path to be used.
+        """
+        return pathlib.Path(self._binary_path)
+
+    @binary_path.setter
+    def binary_path(self, binary_path: str):
+        """The binary path to be used.
+
+        Args:
+             binary_path (str): The binary path to be used.
+        """
+        path = pathlib.Path(binary_path)
+        if not path.is_file():
+            raise ValueError("There is no file in the binary path.")
+        self._binary_path = path
+
     def start_browser(self):
         """
         Starts the selected browser.
@@ -253,7 +276,7 @@ def check_driver():
         func_def_capabilities = BROWSER_CONFIGS.get(self.browser).get("capabilities")
 
         opt = self.options or func_def_options(
-            self.headless, self._download_folder_path, None, self.page_load_strategy
+            self.headless, self._download_folder_path, None, self.page_load_strategy, self._binary_path
         )
         cap = self.capabilities or func_def_capabilities()
         self.options = opt

botcity/web/browsers/chrome.py

@@ -12,7 +12,7 @@
 
 
 def default_options(headless=False, download_folder_path=None, user_data_dir=None,
-                    page_load_strategy="normal") -> ChromeOptions:
+                    page_load_strategy="normal", binary_path: str = None) -> ChromeOptions:
     """Retrieve the default options for this browser curated by BotCity.
 
     Args:
@@ -22,6 +22,7 @@ def default_options(headless=False, download_folder_path=None, user_data_dir=Non
         user_data_dir ([type], optional): The directory to use as user profile.
             If None, a new temporary directory is used. Defaults to None.
         page_load_strategy (str, optional): The page load strategy. Defaults to "normal".
+        binary_path (str, optional): The path to the browser binary.
 
     Returns:
         ChromeOptions: The Chrome options.
@@ -31,6 +32,8 @@ def default_options(headless=False, download_folder_path=None, user_data_dir=Non
         page_load_strategy = page_load_strategy.value
     except AttributeError:
         page_load_strategy = page_load_strategy
+    if binary_path:
+        chrome_options.binary_location = str(binary_path)
     chrome_options.page_load_strategy = page_load_strategy
     chrome_options.add_argument("--remote-debugging-port=0")
     chrome_options.add_argument("--no-first-run")

botcity/web/browsers/edge.py

@@ -12,7 +12,7 @@
 
 
 def default_options(headless=False, download_folder_path=None, user_data_dir=None,
-                    page_load_strategy="normal") -> EdgeOptions:
+                    page_load_strategy="normal", binary_path: str = None) -> EdgeOptions:
     """Retrieve the default options for this browser curated by BotCity.
     Args:
         headless (bool, optional): Whether or not to use the headless mode. Defaults to False.
@@ -21,6 +21,7 @@ def default_options(headless=False, download_folder_path=None, user_data_dir=Non
         user_data_dir ([type], optional): The directory to use as user profile.
             If None, a new temporary directory is used. Defaults to None.
         page_load_strategy (str, optional): The page load strategy. Defaults to "normal".
+        binary_path (str, optional): The path to the browser binary.
     Returns:
         EdgeOptions: The Edge options.
     """
@@ -29,6 +30,8 @@ def default_options(headless=False, download_folder_path=None, user_data_dir=Non
         page_load_strategy = page_load_strategy.value
     except AttributeError:
         page_load_strategy = page_load_strategy
+    if binary_path:
+        edge_options.binary_location = str(binary_path)
     edge_options.page_load_strategy = page_load_strategy
     edge_options.use_chromium = True
     edge_options.add_argument("--remote-debugging-port=0")

botcity/web/browsers/firefox.py

@@ -337,7 +337,7 @@
 
 
 def default_options(headless=False, download_folder_path=None, user_data_dir=None,
-                    page_load_strategy="normal") -> FirefoxOptions:
+                    page_load_strategy="normal", binary_path: str = None) -> FirefoxOptions:
     """Retrieve the default options for this browser curated by BotCity.
 
     Args:
@@ -347,7 +347,7 @@ def default_options(headless=False, download_folder_path=None, user_data_dir=Non
         user_data_dir ([type], optional): The directory to use as user profile.
             If None, a new temporary directory is used. Defaults to None.
         page_load_strategy (str, optional): The page load strategy to use.
-
+        binary_path (str, optional): The path to the browser binary.
     Returns:
         FirefoxOptions: The Firefox options.
     """
@@ -363,6 +363,8 @@ def default_options(headless=False, download_folder_path=None, user_data_dir=Non
         temp_dir = tempfile.TemporaryDirectory(prefix="botcity_")
         user_data_dir = temp_dir.name
         atexit.register(cleanup_temp_dir, temp_dir)
+    if binary_path:
+        firefox_options.binary_location = str(binary_path)
     firefox_options.set_preference("profile", user_data_dir)
     firefox_options.set_preference("security.default_personal_cert", "Select Automatically")
     firefox_options.set_preference('browser.download.folderList', 2)

botcity/web/browsers/undetected_chrome.py

@@ -17,7 +17,7 @@
 
 
 def default_options(headless=False, download_folder_path=None, user_data_dir=None,
-                    page_load_strategy="normal") -> ChromeOptions:
+                    page_load_strategy="normal", binary_path: str = None) -> ChromeOptions:
     """Retrieve the default options for this browser curated by BotCity.
 
     Args:
@@ -27,7 +27,7 @@ def default_options(headless=False, download_folder_path=None, user_data_dir=Non
         user_data_dir ([type], optional): The directory to use as user profile.
             If None, a new temporary directory is used. Defaults to None.
         page_load_strategy (str, optional): The page load strategy. Defaults to "normal".
-
+        binary_path (str, optional): The path to the browser binary.
     Returns:
         ChromeOptions: The Chrome options.
     """
@@ -36,6 +36,8 @@ def default_options(headless=False, download_folder_path=None, user_data_dir=Non
         page_load_strategy = page_load_strategy.value
     except AttributeError:
         page_load_strategy = page_load_strategy
+    if binary_path:
+        chrome_options.binary_location = str(binary_path)
     chrome_options.page_load_strategy = page_load_strategy
     chrome_options.add_argument("--remote-debugging-port=0")
     chrome_options.add_argument("--no-first-run")

conftest.py

@@ -54,7 +54,6 @@ def setup_firefox(headless: bool, tmp_folder: str, download_driver: str) -> WebB
 
     web.driver_path = download_driver
     web.download_folder_path = tmp_folder
-
     return web