Merge pull request #98 from saritasa-nest/feature/update-item-class-a…

…ttribute

Improve getting `item class` in `ListComponent`

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

cspell.config.yaml

@@ -49,6 +49,7 @@ words:
   - STDLIB
   - pydocstyle
   - redef
+  - prefs
 
     # RST blocks
   - autodoc

demo/conftest.py

@@ -1,16 +1,23 @@
-from pages import HelpPage, IndexPage, SearchPage
 from selenium import webdriver as selenium_webdriver
 from selenium.webdriver.remote.webdriver import WebDriver
 
 import pytest
 
+from demo.pages import HelpPage, IndexPage, SearchPage
+
 
 # You can implement your own logic to initialize a webdriver.
 # An example of Chrome initialization is described below.
 @pytest.fixture(scope="session")
 def webdriver() -> WebDriver:
     """Initialize `Chrome` webdriver."""
-    webdriver = selenium_webdriver.Chrome()
+    options = selenium_webdriver.ChromeOptions()
+
+    # Set browser's language to English
+    prefs = {"intl.accept_languages": "en,en_U"}
+    options.add_experimental_option("prefs", prefs)
+
+    webdriver = selenium_webdriver.Chrome(options)
     webdriver.set_window_size(1920, 1080)
     return webdriver
 

demo/pages/base/base_page.py

@@ -7,8 +7,8 @@
 from pomcorn import Page, locators
 
 if TYPE_CHECKING:
-    from pages import IndexPage
-    from pages.common import Navbar
+    from demo.pages import IndexPage
+    from demo.pages.common import Navbar
 
 
 class PyPIPage(Page):
@@ -56,7 +56,7 @@ def __init__(
     @property
     def navbar(self) -> Navbar:
         """Get a component for working with the page navigation panel."""
-        from pages.common import Navbar
+        from demo.pages.common import Navbar
 
         return Navbar(self)
 
@@ -82,7 +82,7 @@ def check_page_is_loaded(self) -> bool:
 
     def click_on_logo(self) -> IndexPage:
         """Click on the logo and redirect to `IndexPage`."""
-        from pages import IndexPage
+        from demo.pages import IndexPage
 
         self.logo.click()
         return IndexPage(self.webdriver)

demo/pages/common/navigation_bar.py

@@ -2,12 +2,11 @@
 
 from typing import TYPE_CHECKING
 
-from pages import PyPIComponent
-
+from demo.pages import PyPIComponent
 from pomcorn import Element, locators
 
 if TYPE_CHECKING:
-    from pages.help_page import HelpPage
+    from demo.pages.help_page import HelpPage
 
 
 # `Component` implements methods of waiting until the component becomes
@@ -30,7 +29,7 @@ class Navbar(PyPIComponent):
 
     def open_help(self) -> HelpPage:
         """Click on `Help` button and redirect to HelpPage."""
-        from pages.help_page import HelpPage
+        from demo.pages.help_page import HelpPage
 
         self.help_button.click()
         return HelpPage(self.webdriver)

demo/pages/common/search.py

@@ -2,13 +2,13 @@
 
 from typing import TYPE_CHECKING
 
-from pages import PyPIComponent
 from selenium.webdriver.common.keys import Keys
 
+from demo.pages import PyPIComponent
 from pomcorn import locators
 
 if TYPE_CHECKING:
-    from pages.search_page import SearchPage
+    from demo.pages.search_page import SearchPage
 
 
 class Search(PyPIComponent):
@@ -24,7 +24,7 @@ def find(self, text: str) -> SearchPage:
         Redirect to `SearchPage` and return its instance.
 
         """
-        from pages.search_page import SearchPage
+        from demo.pages.search_page import SearchPage
 
         self.body.fill(text)
         self.body.send_keys(Keys.ENTER)

demo/pages/help_page.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
 
-from pages.base import PyPIPage
 from selenium.webdriver.remote.webdriver import WebDriver
 
+from demo.pages.base import PyPIPage
 from pomcorn import Element, locators
 
 
@@ -20,7 +20,7 @@ def open(
         app_root: str | None = None,
     ) -> HelpPage:
         """Open the help page via the index page."""
-        from pages.index_page import IndexPage
+        from demo.pages.index_page import IndexPage
 
         # Reusing already implemented methods of opening a page instead of
         # overriding `app_root` allows us to be independent from URK changes:

demo/pages/index_page.py

@@ -1,7 +1,8 @@
-from pages.base import PyPIPage
-from pages.common import Search
 from selenium.webdriver.remote.webdriver import WebDriver
 
+from demo.pages.base import PyPIPage
+from demo.pages.common import Search
+
 
 class IndexPage(PyPIPage):
     """Represent the index page."""

demo/pages/package_details_page.py

@@ -1,8 +1,8 @@
 from __future__ import annotations
 
-from pages.base import PyPIPage
 from selenium.webdriver.remote.webdriver import WebDriver
 
+from demo.pages.base import PyPIPage
 from pomcorn import locators
 
 
@@ -25,7 +25,7 @@ def open(
         app_root: str | None = None,
     ) -> PackageDetailsPage:
         """Search and open the package details page by its name."""
-        from pages import IndexPage
+        from demo.pages import IndexPage
 
         search_page = IndexPage.open(
             webdriver,

demo/pages/search_page/components/package.py

@@ -2,12 +2,11 @@
 
 from typing import TYPE_CHECKING
 
-from pages import PyPIComponent
-
+from demo.pages import PyPIComponent
 from pomcorn import locators
 
 if TYPE_CHECKING:
-    from pages import PackageDetailsPage
+    from demo.pages import PackageDetailsPage
 
 
 class Package(PyPIComponent):
@@ -22,7 +21,7 @@ def name(self) -> str:
 
     def open(self) -> PackageDetailsPage:
         """Click on the package and open its details page."""
-        from pages import PackageDetailsPage
+        from demo.pages import PackageDetailsPage
 
         # The property `body` is available because the package is descendant of
         # `Component`. It allows us to interact with the body of the component

demo/pages/search_page/components/package_list.py

@@ -1,5 +1,4 @@
-from pages import PyPIPage
-
+from demo.pages import PyPIPage
 from pomcorn import ListComponent, locators
 
 from .package import Package
@@ -8,9 +7,9 @@
 class PackageList(ListComponent[Package, PyPIPage]):
     """Represent the list of search results on `SearchPage`."""
 
-    # The ``ListComponent`` item should always be ``Component``, because all
-    # its methods depend on `base_locator`. Also this attribute is required.
-    item_class = Package
+    # By default `ListComponent` have `item_class` attribute with stored first
+    # Generic variable (Package in current case). This attribute is responsible
+    # for the class that will be used for list items.
 
     base_locator = locators.PropertyLocator(
         prop="aria-label",

demo/pages/search_page/search_page.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
-from pages import IndexPage, PyPIPage
 from selenium.webdriver.remote.webdriver import WebDriver
 
+from demo.pages import IndexPage, PyPIPage
+
 from .components import PackageList
 
 

demo/tests/test_logo.py

@@ -1,4 +1,4 @@
-from pages import HelpPage
+from demo.pages import HelpPage
 
 
 def test_logo(help_page: HelpPage):

demo/tests/test_search.py

@@ -1,4 +1,4 @@
-from pages import IndexPage
+from demo.pages import IndexPage
 
 
 def test_search(index_page: IndexPage):

docs/CHANGELOG.rst

@@ -3,6 +3,14 @@ Version history
 
 We follow `Semantic Versions <https://semver.org/>`_.
 
+0.8.1 (25.11.24)
+*******************************************************************************
+- Improve getting ``item class`` from first ``ListComponent`` generic variable.
+  There were several cases where this didn't work correctly (for multiple generic variables
+  and inheritance). Examples of such cases are presented in `this PR <https://github.com/saritasa-nest/pomcorn/pull/98#issuecomment-2485811259>`_.\
+
+**Warning**: The ``item_class`` class attribute was removed.
+
 0.8.0 (05.07.24)
 *******************************************************************************
 - Add ability to not specify ``item_class`` in ``ListComponent``. Instead, it
@@ -21,19 +29,16 @@ deprecated and will be removed soon.
 - Improve ``Page.click_on_page()`` method to click the page coordinates instead
   of offset relative to  current mouse position
 
-
 0.7.3
 *******************************************************************************
 - Add ability to not specify ``app_root`` in ``Page.open_from_url()`` as in ``Page.open()``
 
-
 0.7.2
 *******************************************************************************
 - Improve ``Page.click_on_page()`` method to click on <html> tag
 - Improve ``Page.open_from_url()`` to support kwargs
 - Fix ``\`` related problems in ``Page._get_full_relative_url()``
 
-
 0.7.1
 *******************************************************************************
 
@@ -42,7 +47,6 @@ deprecated and will be removed soon.
 - Fix some possible xpath errors depending on empty locators queries and
   brackets.
 
-
 0.7.0
 *******************************************************************************
 

docs/developer_interface.rst

@@ -22,7 +22,6 @@ Components
 .. automodule:: pomcorn.component
    :members:
 
-
 PomcornElement
 *******************************************************************************