pomcorn 0.8.0__py3-none-any.whl → 0.8.2__py3-none-any.whl

pomcorn/component.py

@@ -1,4 +1,14 @@
-from typing import Generic, TypeVar, get_args, overload
+import typing
+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 +18,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.
 
@@ -182,31 +203,67 @@ class ListComponent(Generic[ListItemType, TPage], Component[TPage]):
 
     """
 
+    _item_class: type[ListItemType] = EmptyValue
+
     item_locator: locators.XPathLocator | None = None
     relative_item_locator: locators.XPathLocator | None = None
 
+    def __class_getitem__(cls, item: tuple[type, ...]) -> Any:
+        """Create parameterized versions of generic classes.
+
+        This method is called when the class is used as a parameterized type,
+        such as MyGeneric[int] or MyGeneric[List[str]].
+
+        We override this method to store values passed in generic parameters.
+
+        Args:
+            cls - The generic class itself.
+            item - The type used for parameterization.
+
+        Returns:
+            type: A parameterized version of the class with the specified type.
+
+        """
+        list_cls = super().__class_getitem__(item)  # type: ignore
+        cls.__parameters__ = item  # type: ignore
+        return list_cls
+
     def __init__(
         self,
         page: TPage,
         base_locator: locators.XPathLocator | None = None,
         wait_until_visible: bool = True,
-    ):
+    ) -> None:
+        # If `_item_class` was not specified in `__init_subclass__`, this means
+        # that `ListComponent` is used as a parameterized type
+        # (e.g., `List[ItemClass, Page]`).
+        if isinstance(self._item_class, _EmptyValue):
+            # In this way we check the stored generic parameters and, if first
+            # from them is valid, set it as `_item_class`
+            first_generic_param = self.__parameters__[0]
+            if self.is_valid_item_class(first_generic_param):
+                self._item_class = first_generic_param
         super().__init__(page, base_locator, wait_until_visible)
-        if item_class := getattr(self, "item_class", None):
-            import warnings
-
-            warnings.warn(
-                DeprecationWarning(
-                    "\nSpecifying `item_class` attribute in `ListComponent` "
-                    f"({self.__class__}) is DEPRECATED. It is now "
-                    "automatically substituted from Generic[ListItemType]. "
-                    "Ability to specify this attribute will be removed soon.",
-                ),
-                stacklevel=2,
-            )
-            self._item_class = item_class
-        else:
-            self._item_class = self._get_list_item_class()
+
+    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:
@@ -257,6 +314,41 @@ class ListComponent(Generic[ListItemType, TPage], Component[TPage]):
             )
         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``
+        * or TypeAlias based on ``Component``
+
+        """
+        if isclass(item_class) and issubclass(item_class, Component):
+            return True
+
+        if isinstance(item_class, typing._GenericAlias):  # type: ignore
+            type_alias = item_class.__origin__  # type: ignore
+            return isclass(type_alias) and issubclass(type_alias, Component)
+
+        return False
+
     def get_item_by_text(self, text: str) -> ListItemType:
         """Get list item by text."""
         locator = self.base_item_locator.extend_query(
@@ -264,10 +356,6 @@ class ListComponent(Generic[ListItemType, TPage], Component[TPage]):
         )
         return self._item_class(page=self.page, base_locator=locator)
 
-    def _get_list_item_class(self) -> type[ListItemType]:
-        """Return class passed in `Generic[ListItemType]`."""
-        return get_args(self.__orig_bases__[0])[0]  # type: ignore
-
     def __repr__(self) -> str:
         return (
             "ListComponent("

{pomcorn-0.8.0.dist-info → pomcorn-0.8.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pomcorn
-Version: 0.8.0
+Version: 0.8.2
 Summary: Base implementation of Page Object Model
 Home-page: https://pypi.org/project/pomcorn/
 License: MIT
@@ -18,6 +18,7 @@ Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Dist: selenium (>=4.12)
 Project-URL: Documentation, http://pomcorn.rtfd.io/
@@ -119,7 +120,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.8.0.dist-info → pomcorn-0.8.2.dist-info}/RECORD

@@ -1,5 +1,5 @@
 pomcorn/__init__.py,sha256=V8v_V3wgKbao1KAQkcVTMnpGwyslw0nHfuTp-DwWTXg,318
-pomcorn/component.py,sha256=-QoF5BnCKGqugUKHO4SPMKZJtmX6zLCVoZBQm9QzhIA,9286
+pomcorn/component.py,sha256=Z0WAcHjWDj67YpQeuU66zrjexmcYLuFStgTPzUqcy9Y,12078
 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.8.0.dist-info/LICENSE,sha256=1vmhQNp1dDH8ksJ199LuG4oKz5D4ZvNccPcFckiG2S4,1091
-pomcorn-0.8.0.dist-info/METADATA,sha256=YuVbebm1X8leLyFIAxmYbS4UqAUwT1iEaqmy70QhBkA,5949
-pomcorn-0.8.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-pomcorn-0.8.0.dist-info/RECORD,,
+pomcorn-0.8.2.dist-info/LICENSE,sha256=1vmhQNp1dDH8ksJ199LuG4oKz5D4ZvNccPcFckiG2S4,1091
+pomcorn-0.8.2.dist-info/METADATA,sha256=ZiCtGGbvbQuzLFzxbdLXtqCN6VReZ8lTc2QXOtzosV4,5973
+pomcorn-0.8.2.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+pomcorn-0.8.2.dist-info/RECORD,,

{pomcorn-0.8.0.dist-info → pomcorn-0.8.2.dist-info}/WHEEL

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