setup-selenium-testing 0.1.1__py3-none-any.whl → 0.1.3__py3-none-any.whl

setup_selenium/selenium_module.py

@@ -1,10 +1,12 @@
+"""Setup selenium for testing"""
+
 from __future__ import annotations
 
 import errno
 import logging
 import os as os
 from enum import Enum
-from typing import TYPE_CHECKING, Union
+from typing import TYPE_CHECKING, Optional, Union
 
 from selenium import webdriver
 from selenium.common.exceptions import NoSuchWindowException, WebDriverException
@@ -12,7 +14,7 @@ from selenium.webdriver.chrome.service import Service as ChromeService
 from selenium.webdriver.common.selenium_manager import SeleniumManager
 from selenium.webdriver.edge.service import Service as EdgeService
 from selenium.webdriver.firefox.service import Service as FirefoxService
-from semantic_version import Version  # type: ignore
+from semantic_version import Version  # type: ignore[import-untyped]
 from typing_extensions import TypeAlias
 
 if TYPE_CHECKING:
@@ -22,6 +24,9 @@ if TYPE_CHECKING:
     from selenium.webdriver.common.options import ArgOptions
 
     T_WebDriver: TypeAlias = Union[Firefox, Chrome, Edge]
+    T_DrvOpts: TypeAlias = Union[
+        webdriver.FirefoxOptions, webdriver.ChromeOptions, webdriver.EdgeOptions
+    ]
 
 __all__ = ["SetupSelenium"]
 
@@ -38,12 +43,11 @@ logger = create_logger("sel")
 
 
 def set_logger(logr: logging.Logger) -> None:
-    """
-    Set the global logger with a custom logger
-    """
+    """Set the global logger with a custom logger"""
     # Check if the logger is a valid logger
     if not isinstance(logr, logging.Logger):
-        raise ValueError("The logger must be an instance of logging.Logger")
+        msg = "logger must be an instance of logging.Logger"
+        raise TypeError(msg)
 
     # Bind the logger input to the global logger
     global logger  # noqa: PLW0603
@@ -132,9 +136,7 @@ class SetupSelenium:
     def make_screenshot_path(
         output_dir: str = "./logs", screenshots: str = "screenshots"
     ) -> str:
-        """
-        Set the output directory for where screenshots should go.
-        """
+        """Set the output directory for where screenshots should go."""
         output_dir = os.path.abspath(os.path.expanduser(output_dir))
         if os.path.split(output_dir)[-1].lower() != screenshots:
             output_dir = os.path.join(output_dir, screenshots)
@@ -152,6 +154,7 @@ class SetupSelenium:
     ############################################################################
     @staticmethod
     def log_options(options: ArgOptions) -> None:
+        """Logs the browser option in clean format"""
         opts = "\n".join(options.arguments)
         logger.debug(f"{opts}")
 
@@ -163,7 +166,7 @@ class SetupSelenium:
         browser_path: str | None = None,
         install_browser: bool = False,
     ) -> tuple[str, str]:
-        """install the webdriver and browser if needed."""
+        """Install the webdriver and browser if needed."""
         browser = Browser[browser.upper()].lower()
         driver_version = driver_version or None
 
@@ -203,19 +206,24 @@ class SetupSelenium:
         log_dir: str = "./logs",
         binary: str | None = None,
         driver_path: str | None = None,
+        options: Optional[T_DrvOpts] = None,
     ) -> T_WebDriver:
+        """Instantiates the browser driver"""
         browser = browser.lower()
         driver: T_WebDriver
         if browser == Browser.FIREFOX:
+            assert options is None or isinstance(options, webdriver.FirefoxOptions)
             driver = SetupSelenium.firefox(
                 headless=headless,
                 enable_log_driver=enable_log_driver,
                 log_dir=log_dir,
                 binary=binary,
                 driver_path=driver_path,
+                options=options,
             )
 
         elif browser == Browser.CHROME:
+            assert options is None or isinstance(options, webdriver.ChromeOptions)
             driver = SetupSelenium.chrome(
                 headless=headless,
                 enable_log_performance=enable_log_performance,
@@ -224,9 +232,11 @@ class SetupSelenium:
                 log_dir=log_dir,
                 binary=binary,
                 driver_path=driver_path,
+                options=options,
             )
 
         elif browser == Browser.EDGE:
+            assert options is None or isinstance(options, webdriver.EdgeOptions)
             driver = SetupSelenium.edge(
                 headless=headless,
                 enable_log_performance=enable_log_performance,
@@ -235,15 +245,18 @@ class SetupSelenium:
                 log_dir=log_dir,
                 binary=binary,
                 driver_path=driver_path,
+                options=options,
             )
 
         else:
-            raise ValueError(f"Unknown browser: {browser}")
+            msg = f"Unknown browser: {browser}"
+            raise ValueError(msg)
 
         return driver
 
     @staticmethod
     def firefox_options() -> webdriver.FirefoxOptions:
+        """Default options for firefox"""
         options = webdriver.FirefoxOptions()
         options.set_capability("unhandledPromptBehavior", "ignore")
 
@@ -261,8 +274,9 @@ class SetupSelenium:
         log_dir: str = "./logs",
         driver_path: str | None = None,
         binary: str | None = None,
-        options: webdriver.FirefoxOptions = None,
+        options: webdriver.FirefoxOptions | None = None,
     ) -> webdriver.Firefox:
+        """Instantiates firefox geockodriver"""
         options = options or SetupSelenium.firefox_options()
         if binary:
             options.binary_location = binary
@@ -301,6 +315,7 @@ class SetupSelenium:
 
     @staticmethod
     def chrome_options() -> webdriver.ChromeOptions:
+        """Default options for chrome"""
         logger.debug("Setting up chrome options")
         # The list of options set below mostly came from this StackOverflow post
         # https://stackoverflow.com/q/48450594/2532408
@@ -332,8 +347,9 @@ class SetupSelenium:
         log_dir: str = "./logs",
         driver_path: str | None = None,
         binary: str | None = None,
-        options: webdriver.ChromeOptions = None,
+        options: webdriver.ChromeOptions | None = None,
     ) -> webdriver.Chrome:
+        """Instantiates chromedriver"""
         options = options or SetupSelenium.chrome_options()
         if binary:
             options.binary_location = binary
@@ -374,12 +390,12 @@ class SetupSelenium:
             service = ChromeService(
                 executable_path=driver_path,
                 service_args=args,
-                log_output=logpath,
+                log_output=logpath,  # type: ignore[arg-type]
             )
         else:
             service = ChromeService(
                 service_args=args,
-                log_output=logpath,
+                log_output=logpath,  # type: ignore[arg-type]
             )
 
         driver = webdriver.Chrome(service=service, options=options)
@@ -405,6 +421,7 @@ class SetupSelenium:
 
     @staticmethod
     def set_throttle(driver: webdriver.Chrome):
+        """Experimental settings to slow down browser"""
         # experimental settings to slow down browser
         # @formatter:off
         # fmt: off
@@ -433,6 +450,7 @@ class SetupSelenium:
 
     @staticmethod
     def edge_options() -> webdriver.EdgeOptions:
+        """Default options for edgedriver"""
         logger.debug("Setting up edge options")
         # The list of options set below mostly came from this StackOverflow post
         # https://stackoverflow.com/q/48450594/2532408
@@ -447,8 +465,6 @@ class SetupSelenium:
             # edgedriver crashes without these two in linux
             "--no-sandbox",
             "--disable-dev-shm-usage",
-            # it's possible we no longer need to do these
-            # "--disable-gpu",  # https://stackoverflow.com/q/51959986/2532408
         )
         options = webdriver.EdgeOptions()
         for opt in opts:
@@ -464,8 +480,9 @@ class SetupSelenium:
         log_dir: str = "./logs",
         driver_path: str | None = None,
         binary: str | None = None,
-        options: webdriver.EdgeOptions = None,
+        options: webdriver.EdgeOptions | None = None,
     ) -> webdriver.Edge:
+        """Instantiates edgedriver"""
         options = options or SetupSelenium.edge_options()
         if binary:
             options.binary_location = binary
@@ -507,12 +524,12 @@ class SetupSelenium:
             service = EdgeService(
                 executable_path=driver_path,
                 service_args=args,
-                log_output=logpath,
+                log_output=logpath,  # type: ignore[arg-type]
             )
         else:
             service = EdgeService(
                 service_args=args,
-                log_output=logpath,
+                log_output=logpath,  # type: ignore[arg-type]
             )
         driver = webdriver.Edge(service=service, options=options)
 
@@ -540,6 +557,7 @@ class SetupSelenium:
 
     ############################################################################
     def set_window_size(self, size: str = "720") -> None:
+        """Helper to set the window size after driver has been instantiated."""
         if size == "max":
             self.driver.maximize_window()
             return
@@ -550,17 +568,22 @@ class SetupSelenium:
         self.driver.set_window_size(width, height)
 
     def set_main_window_handle(self, window: str | None = None) -> str:
-        if not window:
-            # does the main_window_handle exist and point to an available window?
-            if not self.main_window_handle:
+        """
+        maintains the initial window handle as an attribute
+
+        Most users will never utilize this. It's part of a legacy requirement for
+        an old test suite
+        """
+        # does the main_window_handle exist and point to an available window?
+        if not window and not self.main_window_handle:
+            try:
+                window = self.driver.current_window_handle
+            except NoSuchWindowException:
                 try:
-                    window = self.driver.current_window_handle
-                except NoSuchWindowException:
-                    try:
-                        window = self.driver.window_handles[0]
-                    except WebDriverException:
-                        # Have we closed all the windows?
-                        raise
+                    window = self.driver.window_handles[0]
+                except WebDriverException:  # noqa: TRY302
+                    # Have we closed all the windows?
+                    raise
         if window:
             self.main_window_handle = window
         return self.main_window_handle

{setup_selenium_testing-0.1.1.dist-info → setup_selenium_testing-0.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: setup-selenium-testing
-Version: 0.1.1
+Version: 0.1.3
 Summary: Setup Selenium for automation testing
 Home-page: https://github.com/bandophahita/setup_selenium
 License: MIT
@@ -21,17 +21,14 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Provides-Extra: dev
 Provides-Extra: test
 Requires-Dist: black ; extra == "dev"
-Requires-Dist: coverage ; extra == "dev"
-Requires-Dist: flake8 ; extra == "dev"
+Requires-Dist: isort ; extra == "dev"
 Requires-Dist: mypy ; extra == "dev"
-Requires-Dist: pylint ; extra == "dev"
 Requires-Dist: pytest ; extra == "dev" or extra == "test"
 Requires-Dist: ruff ; extra == "dev"
 Requires-Dist: selenium (>=4.7.0)
 Requires-Dist: semantic-version
-Requires-Dist: setuptools ; extra == "dev"
 Requires-Dist: tox ; extra == "dev" or extra == "test"
-Requires-Dist: typing-extensions (>=4.7.1,<5.0.0)
+Requires-Dist: typing-extensions
 Project-URL: Repository, https://github.com/bandophahita/setup_selenium
 Description-Content-Type: text/markdown
 

setup_selenium_testing-0.1.3.dist-info/RECORD

@@ -0,0 +1,7 @@
+setup_selenium/__init__.py,sha256=Wem42Sg7sr4nq1d_qVeSrxee5YXllJvfex3sBdoiCRM,64
+setup_selenium/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+setup_selenium/selenium_module.py,sha256=4nLGWMXQsUwQPxJWMuq8XnR_qNHQGhyF7ta71SomzrQ,21006
+setup_selenium_testing-0.1.3.dist-info/LICENSE,sha256=KGdE-1D1chm3UNFtfE8x-EpVxhmv2zFx8oltbO8M1qE,1070
+setup_selenium_testing-0.1.3.dist-info/METADATA,sha256=CsHV_im2TaGQtkc2Oe85GAdpusQ6PIiTcEfA53IM_ZI,5385
+setup_selenium_testing-0.1.3.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
+setup_selenium_testing-0.1.3.dist-info/RECORD,,

setup_selenium_testing-0.1.1.dist-info/RECORD

@@ -1,7 +0,0 @@
-setup_selenium/__init__.py,sha256=Wem42Sg7sr4nq1d_qVeSrxee5YXllJvfex3sBdoiCRM,64
-setup_selenium/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-setup_selenium/selenium_module.py,sha256=VjTD-PvkBX7L3IV0sZixDiZxXn9R0cHiLEHYMrQcAqk,19786
-setup_selenium_testing-0.1.1.dist-info/LICENSE,sha256=KGdE-1D1chm3UNFtfE8x-EpVxhmv2zFx8oltbO8M1qE,1070
-setup_selenium_testing-0.1.1.dist-info/METADATA,sha256=9tt5YPpODqG0xM759xjjtuXxQcSsyo1elplCsmPpES4,5526
-setup_selenium_testing-0.1.1.dist-info/WHEEL,sha256=FMvqSimYX_P7y0a7UY-_Mc83r5zkBZsCYPm7Lr0Bsq4,88
-setup_selenium_testing-0.1.1.dist-info/RECORD,,