pomcorn 0.7.5__py3-none-any.whl → 0.8.1__py3-none-any.whl

pomcorn/component.py

@@ -1,4 +1,13 @@
-from typing import Generic, TypeVar, overload
+from inspect import isclass
+from typing import (
+    Any,
+    Generic,
+    Literal,
+    TypeVar,
+    get_args,
+    get_origin,
+    overload,
+)
 
 from . import locators
 from .element import XPathElement
@@ -8,6 +17,17 @@ from .web_view import WebView
 TPage = TypeVar("TPage", bound=Page)
 
 
+class _EmptyValue:
+    """Singleton to use as default value for empty class attribute."""
+
+    def __bool__(self) -> Literal[False]:
+        """Allow `EmptyValue` to be used in bool expressions."""
+        return False
+
+
+EmptyValue: Any = _EmptyValue()
+
+
 class Component(Generic[TPage], WebView):
     """The class to represent a page component that depends on base locator.
 
@@ -177,21 +197,36 @@ class ListComponent(Generic[ListItemType, TPage], Component[TPage]):
     * all
     * get_item_by_text()
 
-    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]
+    _item_class: type[ListItemType] = EmptyValue
 
     item_locator: locators.XPathLocator | None = None
     relative_item_locator: locators.XPathLocator | None = None
 
+    def __init_subclass__(cls) -> None:
+        """Run logic for getting/overriding item_class attr for subclasses."""
+        super().__init_subclass__()
+
+        # If class has valid `_item_class` attribute from a parent class
+        if cls.is_valid_item_class(cls._item_class):
+            # We leave using of parent `item_class`
+            return
+
+        # Try to get `item_class` from first generic variable
+        list_item_class = cls.get_list_item_class()
+
+        if not list_item_class:
+            # If `item_class` is not specified in generic we leave it empty
+            # because it maybe not specified in base class but will be
+            # specified in child
+            return
+
+        cls._item_class = list_item_class
+
     @property
     def base_item_locator(self) -> locators.XPathLocator:
         """Get the base locator of list item.
@@ -236,21 +271,49 @@ class ListComponent(Generic[ListItemType, TPage], Component[TPage]):
 
         items: list[ListItemType] = []
         for locator in self.iter_locators(self.base_item_locator):
-            items.append(self.item_class(page=self.page, base_locator=locator))
+            items.append(
+                self._item_class(page=self.page, base_locator=locator),
+            )
         return items
 
+    @classmethod
+    def get_list_item_class(cls) -> type[ListItemType] | None:
+        """Return class passed in `Generic[ListItemType]`."""
+        base_class = next(
+            _class
+            for _class in cls.__orig_bases__  # type: ignore
+            if isclass(get_origin(_class))
+            and issubclass(get_origin(_class), ListComponent)
+        )
+
+        # Get first generic variable and return it if it is valid item class
+        item_class = get_args(base_class)[0]
+        if cls.is_valid_item_class(item_class):
+            return item_class
+
+        return None
+
+    @classmethod
+    def is_valid_item_class(cls, item_class: Any) -> bool:
+        """Check that specified ``item_class`` is valid.
+
+        Valid `item_class` should be a class and subclass of ``Component``.
+
+        """
+        return isclass(item_class) and issubclass(item_class, Component)
+
     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}')]",
         )
-        return self.item_class(page=self.page, base_locator=locator)
+        return self._item_class(page=self.page, base_locator=locator)
 
     def __repr__(self) -> str:
         return (
             "ListComponent("
             f"component={self.__class__}, "
-            f"item_class={self.item_class}, "
+            f"item_class={self._item_class}, "
             f"base_item_locator={self.base_item_locator}, "
             f"count={self.count}, "
             f"items={self.all}, "

{pomcorn-0.7.5.dist-info → pomcorn-0.8.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pomcorn
-Version: 0.7.5
+Version: 0.8.1
 Summary: Base implementation of Page Object Model
 Home-page: https://pypi.org/project/pomcorn/
 License: MIT
@@ -119,7 +119,6 @@ Below is the code that opens ``PyPI.org``, searches for packages by name and pri
 
   class PackageList(ListComponent[Package, PyPIPage]):
 
-      item_class = Package
       relative_item_locator = locators.ClassLocator("snippet__name")
 
       @property

{pomcorn-0.7.5.dist-info → pomcorn-0.8.1.dist-info}/RECORD

@@ -1,5 +1,5 @@
 pomcorn/__init__.py,sha256=V8v_V3wgKbao1KAQkcVTMnpGwyslw0nHfuTp-DwWTXg,318
-pomcorn/component.py,sha256=7nRt-A20Psm0Xl7Rm6tRUK8yOhIh4t2Bdm1fwmJ0MjA,8385
+pomcorn/component.py,sha256=iZrTw8F_DiLvJe9voe3FlhKt2B3Ncy_g8hxP3hq2LzU,10260
 pomcorn/descriptors/__init__.py,sha256=5q_d5GtcaFlIIyHdsUnE9UNbz3g40qJCHKNaWGvcC6s,72
 pomcorn/descriptors/element.py,sha256=4g_4ay5f00AXzCT4xHN1i7mTrlsECoUHh1Ph_TFPBDs,4502
 pomcorn/element.py,sha256=6VLLSPlc7961qa4rRXdno7cEAAeY8GEP2d4wtM5R9a0,12216
@@ -11,7 +11,7 @@ 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.7.5.dist-info/LICENSE,sha256=1vmhQNp1dDH8ksJ199LuG4oKz5D4ZvNccPcFckiG2S4,1091
-pomcorn-0.7.5.dist-info/METADATA,sha256=Z4CQLFxxt1K15BVGS-HP7cjv0VApHDmdfH7gk0Zmhps,5949
-pomcorn-0.7.5.dist-info/WHEEL,sha256=d2fvjOD7sXsVzChCqf0Ty0JbHKBaLYwDbGQDwQTnJ50,88
-pomcorn-0.7.5.dist-info/RECORD,,
+pomcorn-0.8.1.dist-info/LICENSE,sha256=1vmhQNp1dDH8ksJ199LuG4oKz5D4ZvNccPcFckiG2S4,1091
+pomcorn-0.8.1.dist-info/METADATA,sha256=l9lbcd093ClWUJeEtyLXcUGFFG3S8mteJ_PTMBbYTo8,5922
+pomcorn-0.8.1.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+pomcorn-0.8.1.dist-info/RECORD,,

{pomcorn-0.7.5.dist-info → pomcorn-0.8.1.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.7.0
+Generator: poetry-core 1.9.0
 Root-Is-Purelib: true
 Tag: py3-none-any