Merge pull request #4 from hhslepicka/edge

ENH: Add support for MS Edge browser.

Author: hhslepicka

README.md

@@ -21,6 +21,7 @@
 * Python 3.7+
 * botcity-framework-base
 * beautifulsoup4
+* msedge-selenium-tools 
 * numpy
 * opencv-python
 * pillow

botcity/web/browsers/__init__.py

@@ -1,9 +1,8 @@
 import enum
 
-from selenium import webdriver
-
 from . import chrome
 from . import firefox
+from . import edge
 
 
 class Browser(str, enum.Enum):
@@ -13,20 +12,27 @@ class Browser(str, enum.Enum):
     Attributes:
         CHROME (str): Google Chrome
         FIREFOX (str): Mozilla Firefox
+        EDGE (str): Microsoft Edge
     """
     CHROME = "chrome"
     FIREFOX = "firefox"
+    EDGE = "edge"
 
 
 BROWSER_CONFIGS = {
     Browser.CHROME: {
         "driver": "chromedriver",
-        "class": webdriver.Chrome,
+        "class": chrome.Chrome,
         "options": chrome.default_options
     },
     Browser.FIREFOX: {
         "driver": "geckodriver",
-        "class": webdriver.Firefox,
+        "class": firefox.Firefox,
         "options": firefox.default_options
     },
+    Browser.EDGE: {
+        "driver": "msedgedriver",
+        "class": edge.Edge,
+        "options": edge.default_options
+    },
 }

botcity/web/browsers/chrome.py

@@ -2,6 +2,7 @@
 import os
 import tempfile
 
+from selenium.webdriver import Chrome  # noqa: F401, F403
 from selenium.webdriver.chrome.options import Options as ChromeOptions
 
 from ..util import cleanup_temp_dir

botcity/web/browsers/edge.py

@@ -0,0 +1,55 @@
+import atexit
+import os
+import tempfile
+
+from msedge.selenium_tools import Edge, EdgeOptions  # noqa: F401, F403
+
+from ..util import cleanup_temp_dir
+
+
+def default_options(headless=False, download_folder_path=None, user_data_dir=None):
+    edge_options = EdgeOptions()
+    edge_options.use_chrome = True
+    edge_options.add_argument("--disable-extensions")
+    edge_options.add_argument("--remote-debugging-port=0")
+    edge_options.add_argument("--no-first-run")
+    edge_options.add_argument("--no-default-browser-check")
+    edge_options.add_argument("--disable-background-networking")
+    edge_options.add_argument("--disable-background-timer-throttling")
+    edge_options.add_argument("--disable-client-side-phishing-detection")
+    edge_options.add_argument("--disable-default-apps")
+    edge_options.add_argument("--disable-extensions")
+    edge_options.add_argument("--disable-hang-monitor")
+    edge_options.add_argument("--disable-popup-blocking")
+    edge_options.add_argument("--disable-prompt-on-repost")
+    edge_options.add_argument("--disable-syncdisable-translate")
+    edge_options.add_argument("--metrics-recording-only")
+    edge_options.add_argument("--safebrowsing-disable-auto-update")
+
+    edge_options.add_argument("--disable-blink-features=AutomationControlled")
+
+    # Disable banner for Browser being remote-controlled
+    edge_options.add_experimental_option("excludeSwitches", ["enable-automation"])
+    edge_options.add_experimental_option('useAutomationExtension', False)
+
+    if headless:
+        edge_options.add_argument("--headless")
+        edge_options.add_argument("--disable-gpu")
+        edge_options.add_argument("--hide-scrollbars")
+        edge_options.add_argument("--mute-audio")
+
+    if not user_data_dir:
+        temp_dir = tempfile.TemporaryDirectory(prefix="botcity_")
+        user_data_dir = temp_dir.name
+        atexit.register(cleanup_temp_dir, temp_dir)
+
+    edge_options.add_argument(f"--user-data-dir={user_data_dir}")
+
+    if not download_folder_path:
+        download_folder_path = os.path.join(os.path.expanduser("~"), "Desktop")
+
+    # Set the Downloads default folder
+    prefs = {"download.default_directory": download_folder_path}
+    edge_options.add_experimental_option("prefs", prefs)
+
+    return edge_options

botcity/web/browsers/firefox.py

@@ -3,6 +3,7 @@
 import tempfile
 
 from selenium import webdriver
+from selenium.webdriver import Firefox  # noqa: F401, F403
 from selenium.webdriver.firefox.options import Options as FirefoxOptions
 
 from ..util import cleanup_temp_dir

docs/intro.md

@@ -11,10 +11,11 @@ via code in your bot.
 
 Here is a list of supported browsers along with links for you to download the proper WebDriver:
 
-| Browser | WebDriver Download                                                             |
-|---------|--------------------------------------------------------------------------------|
-| Chrome  | [ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver/downloads) |
-| Firefox | [GeckoDriver](https://github.com/mozilla/geckodriver/releases)                 |
+| Browser | WebDriver Download                                                                   |
+|---------|--------------------------------------------------------------------------------------|
+| Chrome  | [ChromeDriver](https://sites.google.com/a/chromium.org/chromedriver/downloads)       |
+| Firefox | [GeckoDriver](https://github.com/mozilla/geckodriver/releases)                       |
+| Edge    | [MSDriverEdge](https://developer.microsoft.com/en-us/microsoft-edge/tools/webdriver/)|
 
 Please follow the instructions on the WebDriver website for installation and setup.
 

requirements.txt

@@ -1,6 +1,7 @@
 botcity-framework-base>=0.2.0
 beautifulsoup4
+msedge-selenium-tools
 numpy
 opencv-python
 pillow
-selenium
+selenium==3.141