pomcorn 0.8.4__py3-none-any.whl → 0.8.6__py3-none-any.whl

pomcorn/__init__.py

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

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.

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/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/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",
 )

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,13 +157,35 @@ 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. # noqa: D202, E501.
+        """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.
@@ -174,7 +201,6 @@ class XPathLocator(Locator):
             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}"'
 
@@ -261,4 +287,4 @@ class XPathLocator(Locator):
                 "not a valid locator.",
             )
 
-        return other if not self else self
+        return self if self else other

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/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.4.dist-info → pomcorn-0.8.6.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pomcorn
-Version: 0.8.4
+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.6.dist-info/RECORD

@@ -0,0 +1,16 @@
+pomcorn/__init__.py,sha256=gB9I-SXauMrhxQlvZmFgh_htHqUXjII6tvQmtJEU5Ks,318
+pomcorn/component.py,sha256=t1GARAI0cW5ubfv1hurxpD_2KFyFxvfzxVADtwcRhiE,12161
+pomcorn/descriptors/__init__.py,sha256=5q_d5GtcaFlIIyHdsUnE9UNbz3g40qJCHKNaWGvcC6s,72
+pomcorn/descriptors/element.py,sha256=jSYxEUqKdAIEHf_zL9m6udyO4QDR22Ivm37BOa-tdKc,4486
+pomcorn/element.py,sha256=l8haq8F25CZSIBTFST5bCwNWq9eg0rbjeKjvEiwG3VI,12205
+pomcorn/locators/__init__.py,sha256=rDc7DlK9XIXlSCrZt4kZK3VapNE2ggDM1mGk-TGW5_k,708
+pomcorn/locators/base_locators.py,sha256=J9zrmuYxns5Kj54IvWmEYqY8YoRaeBFYYrz0r5ahkFg,9159
+pomcorn/locators/xpath_locators.py,sha256=zcGNIk5HX36TTauCApgX0csdobWj8QFZ_td4-9qkTgU,7461
+pomcorn/page.py,sha256=AJLXffI6GFP6XN3vhoGGrUknzvJZzP6GBP7BLaGumX0,5824
+pomcorn/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pomcorn/waits_conditions.py,sha256=E8sLfBvIV2EO91Mm5KyKXB5IGEB9gUWza3XPE4_aCQE,3528
+pomcorn/web_view.py,sha256=qt3Gpr9BMtV0tLp5sLlleSEqweh2PphHXlT02awf9SE,13585
+pomcorn-0.8.6.dist-info/LICENSE,sha256=1vmhQNp1dDH8ksJ199LuG4oKz5D4ZvNccPcFckiG2S4,1091
+pomcorn-0.8.6.dist-info/METADATA,sha256=_ptVy6j9atm0jUz6jD0EIPbXg3hmwZhCy44vxYEjTIQ,5880
+pomcorn-0.8.6.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+pomcorn-0.8.6.dist-info/RECORD,,

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.4.dist-info/RECORD

@@ -1,17 +0,0 @@
-pomcorn/__init__.py,sha256=V8v_V3wgKbao1KAQkcVTMnpGwyslw0nHfuTp-DwWTXg,318
-pomcorn/component.py,sha256=XdG6OJ_4dKXsDh4E_TJhbmcL3iXFOI8lvopCVjWpwXM,12164
-pomcorn/descriptors/__init__.py,sha256=5q_d5GtcaFlIIyHdsUnE9UNbz3g40qJCHKNaWGvcC6s,72
-pomcorn/descriptors/element.py,sha256=4g_4ay5f00AXzCT4xHN1i7mTrlsECoUHh1Ph_TFPBDs,4502
-pomcorn/element.py,sha256=6VLLSPlc7961qa4rRXdno7cEAAeY8GEP2d4wtM5R9a0,12216
-pomcorn/exceptions.py,sha256=8ZOmrybDwvEVZRLQzyozjRNhJvSLbablaFwGFUVMhrU,1131
-pomcorn/locators/__init__.py,sha256=hNSlfmz3y-LI4PXF5VIwX8J5WSalyE2wmzuYc6kNxMA,708
-pomcorn/locators/base_locators.py,sha256=nokiwxnIQh90bolOJcFJSQjuaX_0a4iB5aPhp_Vrbr8,8439
-pomcorn/locators/xpath_locators.py,sha256=zcGNIk5HX36TTauCApgX0csdobWj8QFZ_td4-9qkTgU,7461
-pomcorn/page.py,sha256=wuLoGUn1n0e7wSXLGYyUVnoPlz_gMfT8Jtg6yA09IeY,5755
-pomcorn/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pomcorn/waits_conditions.py,sha256=E8sLfBvIV2EO91Mm5KyKXB5IGEB9gUWza3XPE4_aCQE,3528
-pomcorn/web_view.py,sha256=PlwEVgdOwFZXJY2WuUT2C2wyK1xOBJne5-A_FOuwsQI,14209
-pomcorn-0.8.4.dist-info/LICENSE,sha256=1vmhQNp1dDH8ksJ199LuG4oKz5D4ZvNccPcFckiG2S4,1091
-pomcorn-0.8.4.dist-info/METADATA,sha256=jPDp_4lyHdfibn0IqP1DNHb0ZP5QhG55dkA8aEWDZoE,5973
-pomcorn-0.8.4.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
-pomcorn-0.8.4.dist-info/RECORD,,