pomcorn 0.4.0__tar.gz → 0.6.0__tar.gz

{pomcorn-0.4.0 → pomcorn-0.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pomcorn
-Version: 0.4.0
+Version: 0.6.0
 Summary: Base implementation of Page Object Model
 Home-page: https://pypi.org/project/pomcorn/
 License: MIT

{pomcorn-0.4.0 → pomcorn-0.6.0}/pomcorn/component.py

@@ -1,4 +1,3 @@
-import abc
 from typing import Generic, TypeVar, overload
 
 from . import locators
@@ -34,26 +33,28 @@ class ComponentWithBaseLocator(Generic[TPage], Component[TPage]):
 
     """
 
+    base_locator: locators.XPathLocator
+
     def __init__(
         self,
         page: TPage,
-        base_locator: locators.XPathLocator,
+        base_locator: locators.XPathLocator | None = None,
         wait_until_visible: bool = True,
     ):
         """Initialize component.
 
         Args:
             page: An instance of the page that uses this component.
-            base_locator: locator: Instance of a class to locate the element in
+            base_locator: Instance of a class to locate the element in
                 the browser. Used in relative element initialization methods
-                and visibility waits.
+                and visibility waits. You also can specify it as attribute.
             wait_until_visible: Whether to wait for the component to become
                 visible before completing initialization or not.
 
         """
         super().__init__(page)
-        self.base_locator = base_locator
-        self.body = self.init_element(locator=base_locator)
+        self.base_locator = base_locator or self.base_locator
+        self.body = self.init_element(locator=self.base_locator)
 
         if wait_until_visible:
             self.wait_until_visible()
@@ -194,14 +195,44 @@ class ListComponent(
     Waits for `base_item_locator` property to be implemented and value of
     `item_class` to be set.
 
+    Waits for `base_item_locator` property  to be overridden or one of the
+    attributes (`item_locator` or `relative_item_locator`) to be specified.
+
+    The `item_class` attribute is also required.
+
     """
 
     item_class: type[ListItemType]
 
-    @abc.abstractproperty
+    item_locator: locators.XPathLocator | None = None
+    relative_item_locator: locators.XPathLocator | None = None
+
+    @property
     def base_item_locator(self) -> locators.XPathLocator:
-        """Get the base locator of list item."""
-        raise NotImplementedError
+        """Get the base locator of list item.
+
+        Raises:
+            ValueError: If both attributes are specified.
+            NotImplementedError: If no attribute has been specified,
+
+        """
+        if self.relative_item_locator and self.item_locator:
+            raise ValueError(
+                "You only need to specify one of the attributes: "
+                "`relative_item_locator` - if you want locator nested within "
+                "`base_locator`, `item_locator` - otherwise. "
+                "Or override `base_item_locator` property.",
+            )
+        if not self.relative_item_locator:
+            if not self.item_locator:
+                raise NotImplementedError(
+                    "You need to specify one of the arguments: "
+                    "`relative_item_locator` - if you want locator nested "
+                    "within `base_locator`, `item_locator` - otherwise. "
+                    "Or override `base_item_locator` property.",
+                )
+            return self.item_locator
+        return self.base_locator // self.relative_item_locator
 
     @property
     def count(self) -> int:
@@ -220,7 +251,7 @@ class ListComponent(
 
         items: list[ListItemType] = []
         for locator in self.iter_locators(self.base_item_locator):
-            items.append(self.item_class(self.page, locator))
+            items.append(self.item_class(page=self.page, base_locator=locator))
         return items
 
     def get_item_by_text(self, text: str) -> ListItemType:

{pomcorn-0.4.0 → pomcorn-0.6.0}/pomcorn/locators/xpath_locators.py

@@ -200,13 +200,18 @@ class ButtonWithTextLocator(ElementWithTextLocator):
         super().__init__(text=text, element="button", exact=exact)
 
 
-class InputByLabelLocator(XPathLocator):
+class InputInLabelLocator(XPathLocator):
     """Locator to looking for input with label by XPath.
 
     Specify the query as the string
     ``//label[contains(., "label")]//input``, where ``label`` is the text of
     the input label.
 
+    Example:
+        <label>Title</label>
+            <input value="Value">
+        </label>
+
     """
 
     def __init__(self, label: str):
@@ -216,6 +221,28 @@ class InputByLabelLocator(XPathLocator):
         )
 
 
+class InputByLabelLocator(XPathLocator):
+    """Locator to looking for input next to label by XPath.
+
+    Specify the query as the string
+    ``//label[contains(., "label")]/following-sibling::input``, where ``label``
+    is the text of the input label.
+
+    Example:
+        <div>
+            <label for="InputWithLabel">Title</label>
+            <input id="InputWithLabel" value="Value">
+        </div>
+
+    """
+
+    def __init__(self, label: str):
+        """Init XPathLocator."""
+        super().__init__(
+            query=f'//label[contains(., "{label}")]/following-sibling::input',
+        )
+
+
 class TextAreaByLabelLocator(XPathLocator):
     """Locator to looking for textarea with label by XPath.
 

{pomcorn-0.4.0 → pomcorn-0.6.0}/pomcorn/page.py

@@ -3,7 +3,6 @@ from typing import Self
 from selenium.common.exceptions import TimeoutException
 from selenium.webdriver.remote.webdriver import WebDriver
 
-from . import locators
 from .exceptions import PageDidNotLoadedError
 from .web_view import WebView
 
@@ -146,14 +145,19 @@ class Page(WebView):
             self._get_full_relative_url(self.app_root, relative_url),
         )
 
-    def click_on_page(self):
-        """Click on page `html` tag.
+    def click_on_page(self) -> None:
+        """Click on (1, 1) coordinates in the upper left corner of the page.
 
         Allows you to move focus away from an element, for example, if it
         is currently unavailable for interaction.
 
         """
-        self.init_element(locator=locators.TagNameLocator("html")).click()
+        from selenium.webdriver.common.action_chains import ActionChains
+
+        ActionChains(self.webdriver).move_by_offset(
+            xoffset=1,  # cspell:disable-line
+            yoffset=1,  # cspell:disable-line
+        ).click().perform()
 
     @staticmethod
     def _get_full_relative_url(app_root: str, relative_url: str) -> str:

{pomcorn-0.4.0 → pomcorn-0.6.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pomcorn"
-version = "0.4.0"
+version = "0.6.0"
 description = "Base implementation of Page Object Model"
 authors = [
   "Saritasa <pypi@saritasa.com>",