pomcorn 0.8.3__tar.gz → 0.8.6__tar.gz

{pomcorn-0.8.3 → pomcorn-0.8.6}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pomcorn
-Version: 0.8.3
+Version: 0.8.6
 Summary: Base implementation of Page Object Model
 Home-page: https://pypi.org/project/pomcorn/
 License: MIT
@@ -27,7 +27,8 @@ Description-Content-Type: text/markdown
 
 # Pomcorn
 
-![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/saritasa-nest/pomcorn/pre-commit.yml) ![PyPI](https://img.shields.io/pypi/v/pomcorn) ![PyPI - Status](https://img.shields.io/pypi/status/pomcorn) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pomcorn) ![PyPI - License](https://img.shields.io/pypi/l/pomcorn) ![PyPI - Downloads](https://img.shields.io/pypi/dm/pomcorn) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/saritasa-nest/pomcorn/pre-commit.yml) ![PyPI](https://img.shields.io/pypi/v/pomcorn) ![PyPI - Status](https://img.shields.io/pypi/status/pomcorn) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pomcorn) ![PyPI - License](https://img.shields.io/pypi/l/pomcorn) ![PyPI - Downloads](https://img.shields.io/pypi/dm/pomcorn) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
 
 **Pomcorn**, or **Page Object Model corn**, is a Python package that contains base classes to create systems based on [Selenium](https://github.com/SeleniumHQ/selenium#selenium) framework and **Page Object Model** pattern. You can read more about this pattern [here](https://www.selenium.dev/documentation/test_practices/encouraged/page_object_models/). The package can be used to create autotesting systems, parsing scripts and anything that requires
 interaction with the browser.

{pomcorn-0.8.3 → pomcorn-0.8.6}/README.md

@@ -1,6 +1,7 @@
 # Pomcorn
 
-![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/saritasa-nest/pomcorn/pre-commit.yml) ![PyPI](https://img.shields.io/pypi/v/pomcorn) ![PyPI - Status](https://img.shields.io/pypi/status/pomcorn) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pomcorn) ![PyPI - License](https://img.shields.io/pypi/l/pomcorn) ![PyPI - Downloads](https://img.shields.io/pypi/dm/pomcorn) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336)](https://pycqa.github.io/isort/)
+![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/saritasa-nest/pomcorn/pre-commit.yml) ![PyPI](https://img.shields.io/pypi/v/pomcorn) ![PyPI - Status](https://img.shields.io/pypi/status/pomcorn) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pomcorn) ![PyPI - License](https://img.shields.io/pypi/l/pomcorn) ![PyPI - Downloads](https://img.shields.io/pypi/dm/pomcorn) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
 
 **Pomcorn**, or **Page Object Model corn**, is a Python package that contains base classes to create systems based on [Selenium](https://github.com/SeleniumHQ/selenium#selenium) framework and **Page Object Model** pattern. You can read more about this pattern [here](https://www.selenium.dev/documentation/test_practices/encouraged/page_object_models/). The package can be used to create autotesting systems, parsing scripts and anything that requires
 interaction with the browser.

{pomcorn-0.8.3 → pomcorn-0.8.6}/pomcorn/component.py

@@ -72,16 +72,18 @@ class Component(Generic[TPage], WebView):
             self.wait_until_visible()
 
     @overload
-    def init_element(self, *, locator: locators.XPathLocator) -> XPathElement:
-        ...
+    def init_element(
+        self,
+        *,
+        locator: locators.XPathLocator,
+    ) -> XPathElement: ...
 
     @overload
     def init_element(
         self,
         *,
         relative_locator: locators.XPathLocator,
-    ) -> XPathElement:
-        ...
+    ) -> XPathElement: ...
 
     def init_element(
         self,
@@ -110,16 +112,14 @@ class Component(Generic[TPage], WebView):
         self,
         *,
         locator: locators.XPathLocator | None = None,
-    ) -> list[XPathElement]:
-        ...
+    ) -> list[XPathElement]: ...
 
     @overload
     def init_elements(
         self,
         *,
         relative_locator: locators.XPathLocator | None = None,
-    ) -> list[XPathElement]:
-        ...
+    ) -> list[XPathElement]: ...
 
     def init_elements(
         self,
@@ -217,8 +217,8 @@ class ListComponent(Generic[ListItemType, TPage], Component[TPage]):
         We override this method to store values passed in generic parameters.
 
         Args:
-            cls - The generic class itself.
-            item - The type used for parameterization.
+            cls: The generic class itself.
+            item: The type used for parameterization.
 
         Returns:
             type: A parameterized version of the class with the specified type.
@@ -352,7 +352,9 @@ class ListComponent(Generic[ListItemType, TPage], Component[TPage]):
     def get_item_by_text(self, text: str) -> ListItemType:
         """Get list item by text."""
         locator = self.base_item_locator.extend_query(
-            extra_query=f"[contains(.,'{text}')]",
+            extra_query=(
+                f"[contains(., {self.base_item_locator._escape_quotes(text)})]"
+            ),
         )
         return self._item_class(page=self.page, base_locator=locator)
 

{pomcorn-0.8.3 → pomcorn-0.8.6}/pomcorn/descriptors/element.py

@@ -27,16 +27,14 @@ class Element:
     def __init__(
         self,
         locator: locators.XPathLocator | None = None,
-    ) -> None:
-        ...
+    ) -> None: ...
 
     @overload
     def __init__(
         self,
         *,
         relative_locator: locators.XPathLocator | None = None,
-    ) -> None:
-        ...
+    ) -> None: ...
 
     def __init__(
         self,

{pomcorn-0.8.3 → pomcorn-0.8.6}/pomcorn/element.py

@@ -187,7 +187,7 @@ class PomcornElement(Generic[locators.TLocator]):
 
         Args:
             keys: The names of the keys in the form of a single string.
-                More keys: https://www.selenium.dev/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html     # noqa
+                More keys: https://www.selenium.dev/selenium/docs/api/py/webdriver/selenium.webdriver.common.keys.html
             only_visible: Flag for viewing visible elements. If this is `True`
                 (default), then this method will only get visible elements,
                 otherwise all the elements (including not visible) will be

{pomcorn-0.8.3 → pomcorn-0.8.6}/pomcorn/locators/base_locators.py

@@ -1,3 +1,16 @@
+"""Module with `XPathLocator`.
+
+Provide only `XPathLocator` because a locator of this type
+is sufficient for all operations and
+it also allows to combine locators with `/` operator.
+It's better to use one type of locators for consistency.
+
+Example:
+  # Search button inside base element
+  button_element_locator = base_locator / button_locator
+
+"""
+
 from __future__ import annotations
 
 from collections.abc import Iterator
@@ -5,14 +18,6 @@ from typing import Literal, TypeVar
 
 from selenium.webdriver.common.by import By
 
-# Provide only `XPathLocator` because a locator of this type is sufficient for
-# all operations and it also allows to combine locators with `/` operator.
-# It's better to use one type of locators for consistency.
-#
-# Example:
-#   # Search button inside base element
-#   button_element_locator = base_locator / button_locator
-
 
 class Locator:
     """Base locator for looking for elements in page."""
@@ -152,10 +157,72 @@ class XPathLocator(Locator):
         """
         return XPathLocator(query=f"({self.query} | {other.query})")
 
+    def __getitem__(self, index: int) -> XPathLocator:
+        """Allow get related xpath locator by index.
+
+        Example:
+            div_locator = XPathLocator("//div") --> `//div`
+            div_locator[0]  --> `(//div)[1]`   # xpath numeration starts with 1
+            div_locator[-1] --> `(//div)[last()]`
+
+        """
+        query = f"({self.query})"
+
+        if index >= 0:
+            # `+1` is used here because numeration in xpath starts with 1
+            query += f"[{index + 1}]"
+        elif index == -1:
+            # To avoid ugly locators with `...)[last() - 0]`
+            query += "[last()]"
+        else:
+            query += f"[last() - {abs(index + 1)}]"
+
+        return XPathLocator(query)
+
     def __bool__(self) -> bool:
         """Return whether query of current locator is empty or not."""
         return bool(self.related_query)
 
+    @classmethod
+    def _escape_quotes(cls, text: str) -> str:
+        """Escape single and double quotes in given text for use in locators.
+
+        This method is useful when locating elements
+        with text containing single or double quotes.
+
+        For example, the text `He's 6'2"` will be transformed into:
+        `concat("He", "'", "s 6", "'", "2", '"')`.
+
+        The resulting string can be used in XPath expressions
+        like `text()=...` or `contains(.,...)`.
+
+        Returns:
+            The escaped text wrapped in `concat()` for XPath compatibility,
+            or the original text in double quotes if no escaping is needed.
+
+        """
+        if not text or ('"' not in text and "'" not in text):
+            return f'"{text}"'
+
+        escaped_parts = []
+        buffer = ""  # Temporary storage for normal characters
+
+        for char in text:
+            if char not in ('"', "'"):
+                buffer += char
+                continue
+            if buffer:
+                escaped_parts.append(f'"{buffer}"')
+                buffer = ""
+            escaped_parts.append(
+                "'" + char + "'" if char == '"' else '"' + char + '"',
+            )
+
+        if buffer:
+            escaped_parts.append(f'"{buffer}"')
+
+        return f"concat({', '.join(escaped_parts)})"
+
     def extend_query(self, extra_query: str) -> XPathLocator:
         """Return new XPathLocator with extended query."""
         return XPathLocator(query=self.query + extra_query)
@@ -172,8 +239,8 @@ class XPathLocator(Locator):
                 By default, the search is based on a partial match.
 
         """
-        partial_query = f"[contains(., '{text}')]"
-        exact_query = f"[./text()='{text}']"
+        partial_query = f"[contains(., {self._escape_quotes(text)})]"
+        exact_query = f"[./text()={self._escape_quotes(text)}]"
         return self.extend_query(exact_query if exact else partial_query)
 
     def prepare_relative_locator(
@@ -220,4 +287,4 @@ class XPathLocator(Locator):
                 "not a valid locator.",
             )
 
-        return other if not self else self
+        return self if self else other

{pomcorn-0.8.3 → pomcorn-0.8.6}/pomcorn/locators/xpath_locators.py

@@ -140,8 +140,8 @@ class ElementWithTextLocator(XPathLocator):
                 partial match of the value.
 
         """
-        exact_query = f'//{element}[./text()="{text}"]'
-        partial_query = f'//{element}[contains(.,"{text}")]'
+        exact_query = f"//{element}[./text()={self._escape_quotes(text)}]"
+        partial_query = f"//{element}[contains(.,{self._escape_quotes(text)})]"
 
         super().__init__(query=exact_query if exact else partial_query)
 
@@ -219,7 +219,7 @@ class InputInLabelLocator(XPathLocator):
     def __init__(self, label: str):
         """Init XPathLocator."""
         super().__init__(
-            query=f'//label[contains(., "{label}")]//input',
+            query=f"//label[contains(., {self._escape_quotes(label)})]//input",
         )
 
 
@@ -243,7 +243,10 @@ class InputByLabelLocator(XPathLocator):
     def __init__(self, label: str):
         """Init XPathLocator."""
         super().__init__(
-            query=f'//label[contains(., "{label}")]/following-sibling::input',
+            query=(
+                f"//label[contains(., {self._escape_quotes(label)})]"
+                "/following-sibling::input"
+            ),
         )
 
 
@@ -259,5 +262,8 @@ class TextAreaByLabelLocator(XPathLocator):
     def __init__(self, label: str):
         """Init XPathLocator."""
         super().__init__(
-            query=f'//*[label[contains(text(), "{label}")]]/textarea',
+            query=(
+                "//*[label[contains(text(), "
+                f"{self._escape_quotes(label)})]]/textarea"
+            ),
         )

{pomcorn-0.8.3 → pomcorn-0.8.6}/pomcorn/page.py

@@ -1,9 +1,7 @@
 from typing import Self
 
-from selenium.common.exceptions import TimeoutException
 from selenium.webdriver.remote.webdriver import WebDriver
 
-from .exceptions import PageDidNotLoadedError
 from .web_view import WebView
 
 
@@ -101,6 +99,8 @@ class Page(WebView):
             app_root: The URL of page, by default the value of `APP_ROOT`
                 attribute is used.
             path: Relative URL.
+            **kwargs: Additional arguments passed to the
+                page object initialization.
 
         """
         # hack to not specify app_root in each page init method
@@ -124,14 +124,14 @@ class Page(WebView):
 
     def wait_until_loaded(self) -> None:
         """Wait until page is loaded."""
-        try:
-            self.wait.until(lambda _: self.check_page_is_loaded())
-        except TimeoutException:
-            raise PageDidNotLoadedError(
+        self.wait.until(
+            method=lambda _: self.check_page_is_loaded(),
+            message=(
                 f"Page `{self.__class__}` didn't loaded in "
                 f"{self.wait_timeout} seconds! Didn't wait for `True` from "
-                "`check_page_is_loaded` method.",
-            )
+                "`check_page_is_loaded` method."
+            ),
+        )
 
     def navigate(self, url: str) -> None:
         """Navigate absolute URL.
@@ -172,6 +172,8 @@ class Page(WebView):
         """Add relative URL to application root URL.
 
         Args:
+            app_root: The URL of page, by default the value of `APP_ROOT`
+                attribute is used.
             relative_url (str): Relative URL
 
         """

{pomcorn-0.8.3 → pomcorn-0.8.6}/pomcorn/web_view.py

@@ -1,6 +1,5 @@
 from contextlib import contextmanager
 
-from selenium.common.exceptions import TimeoutException
 from selenium.webdriver import ActionChains
 from selenium.webdriver.remote.webdriver import WebDriver
 from selenium.webdriver.remote.webelement import WebElement
@@ -9,7 +8,7 @@ from selenium.webdriver.support.wait import WebDriverWait
 
 from pomcorn.element import PomcornElement, XPathElement
 
-from . import exceptions, locators, waits_conditions
+from . import locators, waits_conditions
 from .locators.base_locators import TInitLocator
 
 
@@ -22,7 +21,7 @@ class WebView:
         *,
         app_root: str,
         wait_timeout: int,
-        poll_frequency=float(0),
+        poll_frequency: float = 0,
     ):
         """Initialize webview.
 
@@ -177,13 +176,13 @@ class WebView:
                 has not ended.
 
         """
-        try:
-            self.wait.until(expected_conditions.url_contains(url))
-        except TimeoutException:
-            raise exceptions.UrlDoesContainError(
+        self.wait.until(
+            method=expected_conditions.url_contains(url),
+            message=(
                 f"Url doesn't contain `{url}` in {self.wait_timeout} seconds! "
-                f"The current URL is `{self.current_url}`.",
-            )
+                f"The current URL is `{self.current_url}`."
+            ),
+        )
 
     def wait_until_url_not_contains(self, url: str):
         """Wait until browser's url doesn't not contains input url.
@@ -193,13 +192,13 @@ class WebView:
                 has not ended.
 
         """
-        try:
-            self.wait.until(waits_conditions.url_not_matches(url))
-        except TimeoutException:
-            raise exceptions.UrlDoesContainError(
+        self.wait.until(
+            method=waits_conditions.url_not_matches(url),
+            message=(
                 f"Url does contain `{url}` in {self.wait_timeout} seconds! "
-                f"The current URL is `{self.current_url}`.",
-            )
+                f"The current URL is `{self.current_url}`."
+            ),
+        )
 
     def wait_until_url_changes(self, url: str | None = None):
         """Wait until url changes.
@@ -214,13 +213,13 @@ class WebView:
 
         """
         url = url or self.current_url
-        try:
-            self.wait.until(expected_conditions.url_changes(url))
-        except TimeoutException:
-            raise exceptions.UrlDidNotChangedError(
+        self.wait.until(
+            method=expected_conditions.url_changes(url),
+            message=(
                 f"Url didn't changed from {url} in {self.wait_timeout} "
-                f"seconds! The current URL is `{self.current_url}`.",
-            )
+                f"seconds! The current URL is `{self.current_url}`."
+            ),
+        )
 
     def wait_until_locator_visible(self, locator: locators.Locator):
         """Wait until element matching locator becomes visible.
@@ -233,16 +232,14 @@ class WebView:
                 has not ended.
 
         """
-        try:
-            self.wait.until(
-                expected_conditions.visibility_of_element_located(
-                    locator=(locator.by, locator.query),
-                ),
-            )
-        except TimeoutException:
-            raise exceptions.ElementIsNotVisibleError(
-                f"Unable to locate {locator} in {self.wait_timeout} seconds!",
-            )
+        self.wait.until(
+            method=expected_conditions.visibility_of_element_located(
+                locator=(locator.by, locator.query),
+            ),
+            message=(
+                f"Unable to locate {locator} in {self.wait_timeout} seconds!"
+            ),
+        )
 
     def wait_until_locator_invisible(self, locator: locators.Locator):
         """Wait until element matching locator becomes invisible.
@@ -255,16 +252,14 @@ class WebView:
                 has not ended.
 
         """
-        try:
-            self.wait.until(
-                expected_conditions.invisibility_of_element_located(
-                    locator=(locator.by, locator.query),
-                ),
-            )
-        except TimeoutException:
-            raise exceptions.ElementIsNotInvisibleError(
-                f"{locator} is still visible in {self.wait_timeout} seconds!",
-            )
+        self.wait.until(
+            method=expected_conditions.invisibility_of_element_located(
+                locator=(locator.by, locator.query),
+            ),
+            message=(
+                f"{locator} is still visible in {self.wait_timeout} seconds!"
+            ),
+        )
 
     def wait_until_clickable(self, locator: locators.Locator):
         """Wait until element matching locator becomes clickable.
@@ -277,17 +272,14 @@ class WebView:
                 has not ended.
 
         """
-        try:
-            self.wait.until(
-                expected_conditions.element_to_be_clickable(
-                    mark=(locator.by, locator.query),
-                ),
-            )
-        except TimeoutException:
-            raise exceptions.ElementIsNotClickableError(
-                f"{locator} isn't clickable after {self.wait_timeout} "
-                "seconds!",
-            )
+        self.wait.until(
+            method=expected_conditions.element_to_be_clickable(
+                mark=(locator.by, locator.query),
+            ),
+            message=(
+                f"{locator} isn't clickable after {self.wait_timeout} seconds!"
+            ),
+        )
 
     def wait_until_text_is_in_element(
         self,
@@ -305,18 +297,16 @@ class WebView:
                 has not ended.
 
         """
-        try:
-            self.wait.until(
-                expected_conditions.text_to_be_present_in_element(
-                    locator=(locator.by, locator.query),
-                    text_=text,
-                ),
-            )
-        except TimeoutException:
-            raise exceptions.TextIsNotInElementError(
+        self.wait.until(
+            method=expected_conditions.text_to_be_present_in_element(
+                locator=(locator.by, locator.query),
+                text_=text,
+            ),
+            message=(
                 f"{locator} doesn't have `{text}` after {self.wait_timeout} "
-                "seconds!",
-            )
+                "seconds!"
+            ),
+        )
 
     def wait_until_not_exists_in_dom(
         self,
@@ -325,7 +315,7 @@ class WebView:
         """Wait until element ceases to exist in DOM.
 
         Args:
-            locator: Instance of a class to locate the element in the browser
+            element: Instance of a class to locate the element in the browser
                 or instance of element.
 
         Raises:
@@ -333,15 +323,13 @@ class WebView:
                 has not ended.
 
         """
-        try:
-            self.wait.until(
-                waits_conditions.element_not_exists_in_dom(element),
-            )
-        except TimeoutException:
-            raise exceptions.TextIsNotInElementError(
+        self.wait.until(
+            method=waits_conditions.element_not_exists_in_dom(element),
+            message=(
                 f"{element} is still exists in DOM after {self.wait_timeout} "
-                "seconds!",
-            )
+                "seconds!"
+            ),
+        )
 
     def drag_and_drop(self, source: WebElement, target: WebElement):
         """Perform drag and drop.
@@ -396,6 +384,7 @@ class WebView:
 
         Args:
             script: JavaScript code as a string object.
+            *args: Any applicable arguments for your JavaScript.
 
         """
         self.webdriver.execute_script(script, *args)

pomcorn-0.8.6/pyproject.toml

@@ -0,0 +1,235 @@
+[tool.poetry]
+name = "pomcorn"
+version = "0.8.6"
+description = "Base implementation of Page Object Model"
+authors = [
+  "Saritasa <pypi@saritasa.com>",
+]
+maintainers = [
+    "Anton Oboleninov <anton.oboleninov@saritasa.com>",
+]
+homepage = "https://pypi.org/project/pomcorn/"
+repository = "https://github.com/saritasa-nest/pomcorn/"
+documentation = "http://pomcorn.rtfd.io/"
+keywords = [
+  "python",
+  "selenium",
+  "webdriver",
+  "autotests",
+  "page object model",
+  "page object pattern",
+  "page object",
+  "pom",
+  "parsing",
+  "browser",
+]
+license = "MIT"
+readme = "README.md"
+packages = [
+  { include = "pomcorn" }
+]
+
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "License :: OSI Approved :: MIT License",
+  "Natural Language :: English",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3.12",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[tool.poetry.dependencies]
+python = ">= 3.11, < 4.0"
+# Python bindings for Selenium
+# https://selenium-python.readthedocs.io/index.html
+selenium = ">= 4.12"
+
+[tool.poetry.group.dev.dependencies]
+# Improved REPL
+ipdb = ">= 0.13.13"
+ipython = ">= 8.14.0"
+# A framework for managing and maintaining multi-language pre-commit hooks.
+# https://pre-commit.com/
+pre-commit = ">= 3.3.3"
+# Collection of invoke commands
+# https://github.com/saritasa-nest/saritasa-python-invocations
+saritasa-invocations = ">= 0.8"
+
+[tool.poetry.group.docs.dependencies]
+# Need to support autodoc for pomcorn modules
+sphinx = ">= 7.2.6"
+# The Sphinx theme for docs
+# https://sphinx-rtd-theme.readthedocs.io/en/stable/
+sphinx-rtd-theme = ">= 1.3.0rc1"
+# Support mermaid diagrams
+# https://github.com/mgaitan/sphinxcontrib-mermaid/tree/master
+sphinxcontrib-mermaid = ">=0.9.2,<1.1.0"
+
+[tool.poetry.group.demo.dependencies]
+pytest = ">= 7.4.2"
+
+[tool.poetry.group.linters.dependencies]
+# Mypy is a static type checker for Python.
+# https://mypy.readthedocs.io/en/stable/
+mypy = "^1.7.0"
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+
+[tool.ruff]
+line-length = 79
+indent-width = 4
+target-version = "py311"
+exclude = [
+  ".venv",
+  "venv",
+]
+
+
+[tool.ruff.lint]
+extend-select = [
+  # https://docs.astral.sh/ruff/rules/#pycodestyle-e-w
+  "W",
+  "E",
+  # https://docs.astral.sh/ruff/rules/#mccabe-c90
+  "C90",
+  # https://docs.astral.sh/ruff/rules/#isort-i
+  "I",
+  # https://docs.astral.sh/ruff/rules/#pep8-naming-n
+  "N",
+  # https://docs.astral.sh/ruff/rules/#pydocstyle-d
+  "D",
+  # https://docs.astral.sh/ruff/rules/#pyupgrade-up
+  "UP",
+  # https://docs.astral.sh/ruff/rules/#flake8-annotations-ann
+  "ANN",
+  # https://docs.astral.sh/ruff/rules/#flake8-bandit-s
+  "S",
+  # https://docs.astral.sh/ruff/rules/#flake8-bugbear-b
+  "B",
+  # https://docs.astral.sh/ruff/rules/#flake8-builtins-a
+  "A",
+  # https://docs.astral.sh/ruff/rules/#flake8-commas-com
+  "COM",
+  # https://docs.astral.sh/ruff/rules/#flake8-comprehensions-c4
+  "C4",
+  # https://docs.astral.sh/ruff/rules/#flake8-datetimez-dtz
+  "DTZ",
+  # https://docs.astral.sh/ruff/rules/#flake8-debugger-t10
+  "T10",
+  # https://docs.astral.sh/ruff/rules/#flake8-django-dj
+  "DJ",
+  # https://docs.astral.sh/ruff/rules/#flake8-print-t20
+  "T20",
+  # https://docs.astral.sh/ruff/rules/#flake8-pytest-style-pt
+  "PT",
+  # https://docs.astral.sh/ruff/rules/#flake8-simplify-sim
+  "SIM",
+  # https://docs.astral.sh/ruff/rules/#flake8-use-pathlib-pth
+  "PTH",
+  # https://docs.astral.sh/ruff/rules/#flake8-todos-td
+  "TD",
+  # https://docs.astral.sh/ruff/rules/#eradicate-era
+  "ERA",
+  # https://docs.astral.sh/ruff/rules/#ruff-specific-rules-ruf
+  "RUF",
+]
+
+ignore = [
+  # https://docs.astral.sh/ruff/rules/missing-type-args/
+  "ANN002",
+  # https://docs.astral.sh/ruff/rules/missing-type-kwargs/
+  "ANN003",
+  # https://docs.astral.sh/ruff/rules/missing-return-type-undocumented-public-function/
+  "ANN201",
+  # https://docs.astral.sh/ruff/rules/missing-return-type-special-method/
+  "ANN204",
+  # https://docs.astral.sh/ruff/rules/any-type/
+  "ANN401",
+  # https://docs.astral.sh/ruff/rules/function-call-in-default-argument/
+  "B008",
+  # https://docs.astral.sh/ruff/rules/raise-without-from-inside-except/
+  "B904",
+  # https://docs.astral.sh/ruff/rules/one-blank-line-before-class/
+  "D203",
+  # https://docs.astral.sh/ruff/rules/multi-line-summary-second-line/
+  "D213",
+  # https://docs.astral.sh/ruff/rules/undocumented-public-module/
+  "D100",
+  # https://docs.astral.sh/ruff/rules/undocumented-public-method/
+  "D102",
+  # https://docs.astral.sh/ruff/rules/undocumented-public-function/
+  "D103",
+  # https://docs.astral.sh/ruff/rules/undocumented-public-package/
+  "D104",
+  # https://docs.astral.sh/ruff/rules/undocumented-magic-method/
+  "D105",
+  # https://docs.astral.sh/ruff/rules/undocumented-public-nested-class/
+  "D106",
+  # https://docs.astral.sh/ruff/rules/undocumented-public-init/
+  "D107",
+  # https://docs.astral.sh/ruff/rules/undefined-local-with-import-star/
+  "F403",
+  # https://docs.astral.sh/ruff/rules/undefined-local-with-import-star-usage/
+  "F405",
+  # https://docs.astral.sh/ruff/rules/assert/
+  "S101",
+  # https://docs.astral.sh/ruff/rules/non-pep695-type-alias/
+  "UP040",
+  # https://docs.astral.sh/ruff/rules/#flake8-datetimez-dtz
+  "DTZ",
+]
+
+
+[tool.ruff.lint.isort]
+force-wrap-aliases = true
+split-on-trailing-comma = true
+section-order = [
+  "future",
+  "standard-library",
+  "third-party",
+  "first-party",
+  "local-folder",
+]
+
+[tool.ruff.lint.flake8-pytest-style]
+fixture-parentheses = false
+parametrize-names-type = "list"
+parametrize-values-type = "list"
+parametrize-values-row-type = "list"
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+skip-magic-trailing-comma = false
+line-ending = "auto"
+
+[tool.ruff.lint.per-file-ignores]
+"**/test_*" = [
+  # https://docs.astral.sh/ruff/rules/missing-return-type-undocumented-public-function/
+  "ANN201",
+]
+"**/__init__.py" = [
+  # https://docs.astral.sh/ruff/rules/unused-import/
+  "F401",
+]
+
+[tool.mypy]
+# mypy configurations: https://mypy.readthedocs.io/en/latest/config_file.html
+# https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports
+ignore_missing_imports = true
+strict = false
+warn_no_return = false
+disable_error_code = ["override", "no-redef"]
+check_untyped_defs = true
+exclude = "config|venv|.venv| __init__.py"
+disallow_any_generics = true
+
+[tool.docformatter]
+wrap-descriptions = 0
+wrap-summaries = 100
+in-place = true
+blank = true

pomcorn-0.8.3/pomcorn/exceptions.py

@@ -1,38 +0,0 @@
-class ElementIsNotClickableError(TimeoutError):
-    """Raised when element is not clickable when it should be."""
-
-
-class UrlDoesNotContainError(TimeoutError):
-    """Raised when url does not contain needed substring when it should."""
-
-
-class UrlDoesContainError(TimeoutError):
-    """Raised when url does contain needed substring when it shouldn't."""
-
-
-class UrlDidNotChangedError(TimeoutError):
-    """Raised when url didn't changed when it should."""
-
-
-class ElementIsNotVisibleError(TimeoutError):
-    """Raised when element is not visible when it should be."""
-
-
-class ElementIsNotInvisibleError(TimeoutError):
-    """Raised when element is not invisible when it should be."""
-
-
-class TextIsNotInElementError(TimeoutError):
-    """Raised when element doesn't have required when it should have."""
-
-
-class AttributeDoesNotContainError(TimeoutError):
-    """Raised when attribute doesn't contain needed value when it should."""
-
-
-class FailedFormSubmissionError(Exception):
-    """Raised when there an error on form submission."""
-
-
-class PageDidNotLoadedError(Exception):
-    """Raised when page load timeout has expired."""

pomcorn-0.8.3/pyproject.toml

@@ -1,191 +0,0 @@
-[tool.poetry]
-name = "pomcorn"
-version = "0.8.3"
-description = "Base implementation of Page Object Model"
-authors = [
-  "Saritasa <pypi@saritasa.com>",
-]
-maintainers = [
-    "Anton Oboleninov <anton.oboleninov@saritasa.com>",
-]
-homepage = "https://pypi.org/project/pomcorn/"
-repository = "https://github.com/saritasa-nest/pomcorn/"
-documentation = "http://pomcorn.rtfd.io/"
-keywords = [
-  "python",
-  "selenium",
-  "webdriver",
-  "autotests",
-  "page object model",
-  "page object pattern",
-  "page object",
-  "pom",
-  "parsing",
-  "browser",
-]
-license = "MIT"
-readme = "README.md"
-packages = [
-  { include = "pomcorn" }
-]
-
-classifiers = [
-  "Development Status :: 4 - Beta",
-  "License :: OSI Approved :: MIT License",
-  "Natural Language :: English",
-  "Intended Audience :: Developers",
-  "Operating System :: OS Independent",
-  "Programming Language :: Python :: 3.12",
-  "Topic :: Software Development :: Libraries :: Python Modules",
-]
-
-[tool.poetry.dependencies]
-python = ">= 3.11, < 4.0"
-# Python bindings for Selenium
-# https://selenium-python.readthedocs.io/index.html
-selenium = ">= 4.12"
-
-[tool.poetry.group.dev.dependencies]
-# Improved REPL
-ipdb = ">= 0.13.13"
-ipython = ">= 8.14.0"
-# A framework for managing and maintaining multi-language pre-commit hooks.
-# https://pre-commit.com/
-pre-commit = ">= 3.3.3"
-# Collection of invoke commands
-# https://github.com/saritasa-nest/saritasa-python-invocations
-saritasa-invocations = ">= 0.8"
-
-[tool.poetry.group.docs.dependencies]
-# Need to support autodoc for pomcorn modules
-sphinx = ">= 7.2.6"
-# The Sphinx theme for docs
-# https://sphinx-rtd-theme.readthedocs.io/en/stable/
-sphinx-rtd-theme = ">= 1.3.0rc1"
-# Support mermaid diagrams
-# https://github.com/mgaitan/sphinxcontrib-mermaid/tree/master
-sphinxcontrib-mermaid = ">=0.9.2,<1.1.0"
-
-[tool.poetry.group.demo.dependencies]
-pytest = ">= 7.4.2"
-
-[tool.poetry.group.linters.dependencies]
-# Flake dependencies are added so that VSCode extension for flake8
-# would work properly
-# https://marketplace.visualstudio.com/items?itemName=ms-python.flake8&ssr=false#overview
-flake8 = ">=6.1,<8.0"
-# A flake8 plugin that warn about backslashes usage.
-# https://github.com/wemake-services/flake8-broken-line
-flake8-broken-line = "^1.0.0"
-# A plugin for Flake8 finding likely bugs and design problems in your program.
-# https://github.com/PyCQA/flake8-bugbear
-flake8-bugbear = ">=23.9.16,<25.0.0"
-# A simple module that adds an extension for the fantastic pydocstyle tool to flake8.
-# https://github.com/PyCQA/flake8-docstrings
-flake8-docstrings = "^1.7.0"
-# flake8 plugin to validate type annotations according to modern practices.
-# https://github.com/plinss/flake8-modern-annotations
-flake8-modern-annotations = "^1.5.0"
-# A flake8 plugin loading the configuration from pyproject.toml
-# https://github.com/john-hen/Flake8-pyproject
-flake8-pyproject = "^1.2.3"
-
-# Mypy is a static type checker for Python.
-# https://mypy.readthedocs.io/en/stable/
-mypy = "^1.7.0"
-
-[build-system]
-requires = ["poetry-core"]
-build-backend = "poetry.core.masonry.api"
-
-[tool.isort]
-profile="black"
-line_length=79
-multi_line_output=3
-skip=[
-    "_tmp",
-    "src",
-    ".env",
-    "env",
-    ".venv",
-    "venv",
-]
-known_pytest=[
-    "pytest",
-    "_pytest",
-    "xdist",
-]
-sections=[
-    "FUTURE",
-    "STDLIB",
-    "THIRDPARTY",
-    "PYTEST",
-    "FIRSTPARTY",
-    "LOCALFOLDER",
-]
-include_trailing_comma=true
-# For sorting `__all__` sections
-# Off until the issue is fixed: https://github.com/PyCQA/isort/issues/2193
-# sort_reexports=true
-
-[tool.flake8]
-# F403: using wildcard imports (from … import *)
-# F405: name may be undefined, or defined from star imports: module
-# D100: missing docstring in public module
-# D102: missing docstring in public method
-# D103: missing docstring in public function
-# D105: missing docstring in magic method
-# D106: missing docstring in public nested
-# D107: missing docstring in __init__
-# PT004: missing add leading underscore in name of fixture that does not return anything
-# B008: function calls in argument defaults
-ignore = [
-    "D100",
-    "D102",
-    "D103",
-    "D105",
-    "D106",
-    "D107",
-    "F403",
-    "F405",
-    "W503",
-    "PT004",
-    "B008",
-]
-exclude = [
-    "config",
-    ".venv",
-    "venv",
-    "__init__.py",
-]
-max-line-length = 79
-inline-quotes = "double"
-docstring-quotes = "double"
-count = true
-max-complexity = 10
-
-# flake8-pytest-style configuration
-# https://github.com/m-burst/flake8-pytest-style
-pytest-fixture-no-parentheses = true
-pytest-parametrize-names-type = "list"
-pytest-parametrize-values-type = "list"
-pytest-parametrize-values-row-type = "list"
-
-per-file-ignores = [
-  # Ignore using lambda in `item_class` tests
-  "tests/list_component/test_item_class.py: E731",
-]
-
-[tool.mypy]
-# mypy configurations: https://mypy.readthedocs.io/en/latest/config_file.html
-# https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports
-ignore_missing_imports = true
-strict = false
-warn_no_return = false
-disable_error_code = ["override", "no-redef"]
-check_untyped_defs = true
-exclude = "config|venv|.venv| __init__.py"
-disallow_any_generics = true
-
-[tool.black]
-line-length=79

{pomcorn-0.8.3 → pomcorn-0.8.6}/pomcorn/__init__.py

@@ -6,9 +6,9 @@ from pomcorn.web_view import WebView
 
 __all__ = (
     "Component",
-    "ListComponent",
     "Element",
-    "XPathElement",
+    "ListComponent",
     "Page",
     "WebView",
+    "XPathElement",
 )

{pomcorn-0.8.3 → pomcorn-0.8.6}/pomcorn/locators/__init__.py

@@ -18,18 +18,18 @@ from pomcorn.locators.xpath_locators import (
 )
 
 __all__ = (
-    "Locator",
-    "TInitLocator",
-    "TLocator",
-    "XPathLocator",
     "ButtonWithTextLocator",
     "ClassLocator",
     "DataTestIdLocator",
     "ElementWithTextLocator",
     "IdLocator",
     "InputByLabelLocator",
+    "Locator",
     "NameLocator",
     "PropertyLocator",
+    "TInitLocator",
+    "TLocator",
     "TagNameLocator",
     "TextAreaByLabelLocator",
+    "XPathLocator",
 )