setup-selenium-testing 0.1.1__tar.gz → 0.1.3__tar.gz

{setup_selenium_testing-0.1.1 → setup_selenium_testing-0.1.3}/PKG-INFO

@@ -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.1 → setup_selenium_testing-0.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "setup-selenium-testing"
-version = "0.1.1"
+version = "0.1.3"
 description = "Setup Selenium for automation testing"
 authors = ["Marcel Wilson <trenchrats@gmail.com>"]
 license = "MIT"
@@ -25,30 +25,23 @@ packages = [{include = "setup_selenium"}]
 python = "^3.8"
 selenium = ">=4.7.0"
 semantic-version = "*"
-typing-extensions = "^4.7.1"
+typing-extensions = "*"
 
 # extras
 pytest = {version="*", optional = true}
-coverage = {version="*", optional = true}
-flake8 = {version="*", optional = true}
 black = {version="*", optional = true}
 mypy = {version="*", optional = true}
-pylint = {version="*", optional = true}
-setuptools = {version="*", optional = true}
 ruff = {version="*", optional = true}
 tox = {version="*", optional = true}
-
+isort = {version = "*", optional = true}
 
 [tool.poetry.extras]
 dev = [
     "pytest",
-    "coverage",
-    "flake8",
     "black",
     "mypy",
-    "pylint",
-    "setuptools",
     "ruff",
+    "isort",
     "tox",
 ]
 test = [
@@ -88,72 +81,68 @@ build-backend = "poetry.core.masonry.api"
 # Unlike Flake8, Ruff doesn't enable pycodestyle warnings (`W`) or
 # McCabe complexity (`C901`) by default.
 select = [
+    "A",  # flake8-builtins
+    "ANN",  # flake8-annotations  # coming back to this one later to compare against mypy
+    "ARG",  # flake8-unused-arguments
+    "B",  # flake8-bugbear
+    "BLE",  # flake8-blind-except
+    "C4",  # flake8-comprehensions
+    "D",  # pydocstyle
     "E",  # pycodestyle error
-    "W",  # pycodestyle warning
+    "EM",  # flake8-errmsg
+    "ERA",  # eradicate
     "F",  # Pyflakes
-    "FA", # flake8-future-annotations
+    "FA",  # flake8-future-annotations
+#    "FBT",  # flake8-boolean-trap
+    "FIX",  # flake8-fixme
+    "FLY",  # flynt
     "I",  # isort
-    "D",  # pydocstyle
-    "C4",  # flake8-comprehensions
-    "TCH",  # type checking
+    "ICN",  # flake8-import-conventions
+    "ISC",  # flake8-implicit-str-concat
+    "PGH",  # pygrep-hooks
+    "PIE",  # flake8-pie
+    "PL",  # pylint
+    "PT",  # flake8-pytest-style
+    "Q",  # flake8-quotes
+    "RET",  # flake8-return
+    "RSE",  # flake8-raise
     "RUF",  # ruff specific
-    "ANN",  # annotations
+    "SIM",  # flake8-simplify
+    "T10",  # flake8-debugger
+    "TCH",  # flake8-type-checking
+    "TD",  #TODOs
+    "TRY",  # tryceratops
     "UP",  # python upgrade
-    "B",  # bugbear
-    "SIM", # flake8 simplify
-    "A",  # built-ins
-    "RET", # flake8 return
-    "YTT", # flake8-2020
-    "EXE", # flake8-executable
-    "ISC", # flake8-implicit-str-concat
-    "PIE", # flake8-pie
-    "Q",  # flake8-quotes
-    "RSE", # flake8-raise
-    "FLY", # flynt
-    "PERF", # perflint
-    "PL", # pylint
-#    "ERA", # eradicate
-    #    "N", # pep8 naming -- dear lord, leave this off
+    "W",  # pycodestyle warning
+    "YTT",  # flake8-2020
 
     # may eventually use but for now these are not helpful
-    #    "FURB", # refurb
-    #    "ARG",  # unused arguments
-    #    "PT",  # Pytest style
-    #    "TD",  #TODOs
-    #    "FBT",  # boolean trap
+#    "FURB", # refurb  # needs --preview flag to run
 ]
 ignore = [
-    #    "PT003",  # pytest fixture scope implied
-    #    "PT004",  # pytest fixture setup doesn't return anything
-    "RUF100",  # blanket noqa
     "ANN101",  # missing-type-self
     "ANN102",  # cls 
     "E501",   # line too long -- black will take care of this for us
-    "E721", # type-comparison WTF? 
-    "B028", # No explicit `stacklevel` keyword argument found
-    "SIM102", # single if instead of nested -- only sometimes useful
-    "SIM114", # combine if branches using logical OR -- only sometimes useful
     "SIM115", # use context handler for open -- situationally useful
-    "SIM118", # use x in y instead of y.keys() - sometimes we want the keys 
-    "SIM300", # yoda conditions -- meh
+#    "SIM300", # yoda conditions -- meh
 
     "PERF203", # `try`-`except` within a loop incurs performance overhead
     "PERF401", # use list comp
 
     # NOT OPTIONAL. MUST REMAIN AS SET
     # these are all completely unnecessary 
-    "D100", # Missing docstring in public module
     "D101", # Missing docstring in public class
-    "D102", # Missing docstring in public method
-    "D103", # Missing docstring in public function
     "D104", # Missing docstring in public package
     "D105", # Missing docstring in magic method
     "D106", # Missing docstring in public nested class
     "D107", # Missing docstring in `__init__`
-    "D301", # Use `r"""` if any backslashes in a docstring
+    "D202", # no blank lines after docstring
+    "D203", # one-blank-line-before-class
+    "D204", # blank line required after docstring
+    "D205", # blank line between summary and description
+    "D212", # Multi-line summary should start at the first line
     "D400", # First line should end with a period
     "D401", # imperative mood
-    "D403", # first word of 1st line caps
     "D404", # First word of the docstring should not be "This"
     "D405", # Section name should be properly capitalized
     "D406", # Section name should end with a newline 
@@ -161,21 +150,12 @@ ignore = [
     "D411", # Missing blank line before section
     "D412", # No blank lines allowed between a section header and its content 
     "D415", # First line should end with punctuation
-    "D200", # One-line docstring should fit on one line
-    "D202", # no blank lines after docstring
-    "D204", # blank line required after docstring
-    "D205", # blank line between summary and description
-    "D203", # one-blank-line-before-class
-    "D210", # whitespace
-    "D212", # Multi-line summary should start at the first line
-    "D214", # Section overindented
-    "A003", # Class attribute shadow builtin
+
     "PLC0414", # useless-import-alias
     "PLR0911", # too-many-return-statements
     "PLR0912", # too-many-branches
     "PLR0913", # too-many-arguments
     "PLR0915", # too-many-statements
-    "PLR2004", # magic-value-comparison
 
     # 3.8 & 3.9 compatibility
     "UP007", # Use `X | Y` for type annotations
@@ -215,11 +195,25 @@ exclude = [
 ]
 
 [tool.ruff.lint]
-extend-safe-fixes = ["TCH003"]
+extend-safe-fixes = [
+    "EM101",
+    "EM102",
+    "TCH001", "TCH002", "TCH003", "TCH004",
+    #    "SIM108"
+    "C419",
+    "D200", "D205",
+    "PT003", "PT006", "PT018",
+    "RET504",
+    "UP007",
+]
 
 [tool.ruff.per-file-ignores]
 "__init__.py" = ["F401"]
-
+"tests/**" = [
+    "D",  # we don't need public-API-polished docstrings in tests.
+    "FBT",  # using a boolean as a test object is useful!
+    "PLR",  # likewise using specific numbers and strings in tests.
+]
 
 [tool.ruff.isort]
 combine-as-imports = true
@@ -234,19 +228,16 @@ mark-parentheses = false
 ignore-overlong-task-comments = true
 
 
-#[tool.ruff.flake8-annotations]
-#mypy-init-return = true
-
-
 [tool.ruff.flake8-annotations]
 # ignore returns types for functions that implicity or explicitly only return None
 suppress-none-returning = true
 allow-star-arg-any = true
+#mypy-init-return = true
 
 
 [tool.black]
 line-length = 88
-target-version = ['py310']
+target-version = ['py311']
 
 # 'extend-exclude' excludes files or directories in addition to the defaults
 extend-exclude = '''

{setup_selenium_testing-0.1.1 → setup_selenium_testing-0.1.3}/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