Ruff pre-commit & workflow added

Author: VladimirPodolian

.github/workflows/ruff.yml

@@ -0,0 +1,32 @@
+name: Ruff
+
+on:
+  push:
+    branches:
+      - 'master'
+    paths-ignore:
+      - 'docs/**'
+      - 'README.md'
+      - 'CHANGELOG.md'
+      - 'LICENSE'
+      - '.gitignore'
+  pull_request:
+
+jobs:
+  ruff:
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Environment
+        uses: ./.github/actions/setup
+        with:
+          python-version: '3.12'
+
+      - name: Ruff lint
+        run: uv run ruff check
+
+      - name: Ruff format
+        run: uv run ruff format --check

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.8
+    hooks:
+      - id: ruff
+        args: [--fix]
+        pass_filenames: false
+      - id: ruff-format
+        pass_filenames: false

mops/__init__.py

@@ -1,3 +1,4 @@
 """Wrapper of Selenium, Appium and Playwright with a single API."""
+
 __version__ = '3.5.0'
 __project_name__ = 'mops'

mops/abstraction/driver_wrapper_abc.py

@@ -291,10 +291,10 @@ def get_window_size(self) -> Size:
         raise NotImplementedError
 
     def save_screenshot(
-            self,
-            file_name: str,
-            screenshot_base: Image | bytes = None,
-            convert_type: str | None = None,
+        self,
+        file_name: str,
+        screenshot_base: Image | bytes = None,
+        convert_type: str | None = None,
     ) -> Image:
         """
         Take a full screenshot of the driver and save it to the specified path/filename.
@@ -318,15 +318,15 @@ def get_scroll_position(self) -> int:
         raise NotImplementedError
 
     def assert_screenshot(
-            self,
-            filename: str = '',
-            test_name: str = '',
-            name_suffix: str = '',
-            threshold: float | None = None,
-            delay: float | None = None,
-            remove: Element | list[Element] = None,
-            cut_box: Box = None,
-            hide: Element | list[Element] = None,
+        self,
+        filename: str = '',
+        test_name: str = '',
+        name_suffix: str = '',
+        threshold: float | None = None,
+        delay: float | None = None,
+        remove: Element | list[Element] = None,
+        cut_box: Box = None,
+        hide: Element | list[Element] = None,
     ) -> None:
         """
         Assert that the given screenshot matches the currently taken screenshot.
@@ -360,15 +360,15 @@ def assert_screenshot(
         raise NotImplementedError
 
     def soft_assert_screenshot(
-            self,
-            filename: str = '',
-            test_name: str = '',
-            name_suffix: str = '',
-            threshold: float | None = None,
-            delay: float | None = None,
-            remove: Element | list[Element] = None,
-            cut_box: Box = None,
-            hide: Element | list[Element] = None,
+        self,
+        filename: str = '',
+        test_name: str = '',
+        name_suffix: str = '',
+        threshold: float | None = None,
+        delay: float | None = None,
+        remove: Element | list[Element] = None,
+        cut_box: Box = None,
+        hide: Element | list[Element] = None,
     ) -> tuple[bool, str]:
         """
         Compare the currently taken screenshot to the expected screenshot and return a result.
@@ -638,5 +638,3 @@ def dismiss_alert(self) -> DriverWrapper:
         :return: :obj:`.DriverWrapper` - The current instance of the driver wrapper.
         """
         raise NotImplementedError
-
-

mops/abstraction/element_abc.py

@@ -22,7 +22,6 @@
 
 
 class ElementABC(MixinABC, ABC):
-
     name: str
     parent: Any | bool | None
     wait: bool | None
@@ -170,11 +169,11 @@ def uncheck(self) -> Element:
         raise NotImplementedError
 
     def wait_visibility(
-            self,
-            *,
-            timeout: int = WAIT_EL,
-            silent: bool = False,
-            continuous: bool | float = False,
+        self,
+        *,
+        timeout: int = WAIT_EL,
+        silent: bool = False,
+        continuous: bool | float = False,
     ) -> Element:
         """
         Wait until the element becomes visible.
@@ -206,11 +205,11 @@ def wait_visibility(
         raise NotImplementedError
 
     def wait_hidden(
-            self,
-            *,
-            timeout: int = WAIT_EL,
-            silent: bool = False,
-            continuous: bool | float = False,
+        self,
+        *,
+        timeout: int = WAIT_EL,
+        silent: bool = False,
+        continuous: bool | float = False,
     ) -> Element:
         """
         Wait until the element becomes hidden.
@@ -266,10 +265,10 @@ def wait_availability(self, *, timeout: int = WAIT_EL, silent: bool = False) ->
         raise NotImplementedError
 
     def save_screenshot(
-            self,
-            file_name: str,
-            screenshot_base: bytes | Image = None,
-            convert_type: str | None = None,
+        self,
+        file_name: str,
+        screenshot_base: bytes | Image = None,
+        convert_type: str | None = None,
     ) -> Image:
         """
         Save a screenshot of the element.
@@ -534,11 +533,11 @@ def send_keyboard_action(self, action: str | KeyboardKeys) -> Element:
         raise NotImplementedError
 
     def wait_elements_count(
-            self,
-            expected_count: int,
-            *,
-            timeout: float = WAIT_EL,
-            silent: bool = False,
+        self,
+        expected_count: int,
+        *,
+        timeout: float = WAIT_EL,
+        silent: bool = False,
     ) -> Element:
         """
         Wait until the number of matching elements equals the expected count.
@@ -567,11 +566,11 @@ def wait_elements_count(
         raise NotImplementedError
 
     def wait_for_text(
-            self,
-            expected_text: str | None = None,
-            *,
-            timeout: float = WAIT_EL,
-            silent: bool = False,
+        self,
+        expected_text: str | None = None,
+        *,
+        timeout: float = WAIT_EL,
+        silent: bool = False,
     ) -> Element:
         """
         Wait for the presence of a specific text in the current element, or for any non-empty text.
@@ -600,11 +599,11 @@ def wait_for_text(
         raise NotImplementedError
 
     def wait_for_value(
-            self,
-            expected_value: str | None = None,
-            *,
-            timeout: float = WAIT_EL,
-            silent: bool = False,
+        self,
+        expected_value: str | None = None,
+        *,
+        timeout: float = WAIT_EL,
+        silent: bool = False,
     ) -> Element:
         """
         Wait for a specific value in the current element, or for any non-empty value.
@@ -633,11 +632,11 @@ def wait_for_value(
         raise NotImplementedError
 
     def wait_visibility_without_error(
-            self,
-            *,
-            timeout: float = QUARTER_WAIT_EL,
-            silent: bool = False,
-            continuous: bool | float = False,
+        self,
+        *,
+        timeout: float = QUARTER_WAIT_EL,
+        silent: bool = False,
+        continuous: bool | float = False,
     ) -> Element:
         """
         Wait for the element to become visible, without raising an error if it does not.
@@ -669,11 +668,11 @@ def wait_visibility_without_error(
         raise NotImplementedError
 
     def wait_hidden_without_error(
-            self,
-            *,
-            timeout: float = QUARTER_WAIT_EL,
-            silent: bool = False,
-            continuous: bool | float = False,
+        self,
+        *,
+        timeout: float = QUARTER_WAIT_EL,
+        silent: bool = False,
+        continuous: bool | float = False,
     ) -> Element:
         """
         Wait for the element to become hidden, without raising an error if it does not.
@@ -755,11 +754,11 @@ def wait_disabled(self, *, timeout: float = WAIT_EL, silent: bool = False) -> El
         raise NotImplementedError
 
     def wait_for_size(
-            self,
-            expected_size: Size,
-            *,
-            timeout: float = WAIT_EL,
-            silent: bool = False,
+        self,
+        expected_size: Size,
+        *,
+        timeout: float = WAIT_EL,
+        silent: bool = False,
     ) -> Element:
         """
         Wait until element size will be equal to given :class:`.Size` object
@@ -814,11 +813,11 @@ def is_fully_visible(self, check_displaying: bool = True, silent: bool = False)
         raise NotImplementedError
 
     def scroll_into_view(
-            self,
-            block: ScrollTo = ScrollTo.CENTER,
-            behavior: ScrollTypes = ScrollTypes.INSTANT,
-            sleep: float = 0,
-            silent: bool = False,
+        self,
+        block: ScrollTo = ScrollTo.CENTER,
+        behavior: ScrollTypes = ScrollTypes.INSTANT,
+        sleep: float = 0,
+        silent: bool = False,
     ) -> Element:
         """
         Scrolls the element into view using a JavaScript script.
@@ -836,17 +835,17 @@ def scroll_into_view(
         raise NotImplementedError
 
     def assert_screenshot(
-            self,
-            filename: str = '',
-            test_name: str = '',
-            name_suffix: str = '',
-            threshold: float | None = None,
-            delay: float | None = None,
-            scroll: bool = False,
-            remove: Element | list[Element] = None,
-            fill_background: str | bool = False,
-            cut_box: Box = None,
-            hide: Element | list[Element] = None,
+        self,
+        filename: str = '',
+        test_name: str = '',
+        name_suffix: str = '',
+        threshold: float | None = None,
+        delay: float | None = None,
+        scroll: bool = False,
+        remove: Element | list[Element] = None,
+        fill_background: str | bool = False,
+        cut_box: Box = None,
+        hide: Element | list[Element] = None,
     ) -> None:
         """
         Assert that the given screenshot matches the currently taken screenshot.
@@ -885,17 +884,17 @@ def assert_screenshot(
         raise NotImplementedError
 
     def soft_assert_screenshot(
-            self,
-            filename: str = '',
-            test_name: str = '',
-            name_suffix: str = '',
-            threshold: float | None = None,
-            delay: float | None = None,
-            scroll: bool = False,
-            remove: Element | list[Element] = None,
-            fill_background: str | bool = False,
-            cut_box: Box = None,
-            hide: Element | list[Element] = None,
+        self,
+        filename: str = '',
+        test_name: str = '',
+        name_suffix: str = '',
+        threshold: float | None = None,
+        delay: float | None = None,
+        scroll: bool = False,
+        remove: Element | list[Element] = None,
+        fill_background: str | bool = False,
+        cut_box: Box = None,
+        hide: Element | list[Element] = None,
     ) -> tuple[bool, str]:
         """
         Compare the currently taken screenshot to the expected screenshot and return a result.

mops/abstraction/mixin_abc.py

@@ -10,7 +10,6 @@
 
 
 class MixinABC(ABC):
-
     @property
     def driver(self) -> SeleniumWebDriver | AppiumWebDriver | PlaywrightSourcePage:
         r"""

mops/abstraction/page_abc.py

@@ -12,7 +12,6 @@
 
 
 class PageABC(MixinABC, ABC):
-
     anchor: Element
 
     def reload_page(self, wait_page_load: bool = True) -> Page:
@@ -64,13 +63,13 @@ def is_page_opened(self, with_elements: bool = False, with_url: bool = False) ->
         raise NotImplementedError
 
     def swipe(
-            self,
-            start_x: int,
-            start_y: int,
-            end_x: int,
-            end_y: int,
-            duration: int = 0,
-            sleep: float = 0,
+        self,
+        start_x: int,
+        start_y: int,
+        end_x: int,
+        end_y: int,
+        duration: int = 0,
+        sleep: float = 0,
     ) -> Page:
         """
         Appium only: Swipe from one point to another, with an optional duration and post-swipe delay.