pomcorn 0.8.0__tar.gz → 0.8.2__tar.gz

{pomcorn-0.8.0 → pomcorn-0.8.2}/PKG-INFO

@@ -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 → pomcorn-0.8.2}/README.md

@@ -93,7 +93,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 → pomcorn-0.8.2}/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 → pomcorn-0.8.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "pomcorn"
-version = "0.8.0"
+version = "0.8.2"
 description = "Base implementation of Page Object Model"
 authors = [
   "Saritasa <pypi@saritasa.com>",
@@ -64,7 +64,7 @@ sphinx = ">= 7.2.6"
 sphinx-rtd-theme = ">= 1.3.0rc1"
 # Support mermaid diagrams
 # https://github.com/mgaitan/sphinxcontrib-mermaid/tree/master
-sphinxcontrib-mermaid = "^0.9.2"
+sphinxcontrib-mermaid = ">=0.9.2,<1.1.0"
 
 [tool.poetry.group.demo.dependencies]
 pytest = ">= 7.4.2"
@@ -171,6 +171,11 @@ 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