pomcorn 0.10.2__tar.gz

pomcorn-0.10.2/LICENSE

@@ -0,0 +1,20 @@
+ The MIT License (MIT)
+ Copyright (c) 2023 Saritasa
+
+ Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+
+ The above copyright notice and this permission notice shall be included in all
+ copies or substantial portions of the Software.
+
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+ IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+ DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+ OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+ OR OTHER DEALINGS IN THE SOFTWARE.

pomcorn-0.10.2/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: pomcorn
+Version: 0.10.2
+Summary: Base implementation of Page Object Model
+License: MIT
+License-File: LICENSE
+Keywords: python,selenium,webdriver,autotests,page object model,page object pattern,page object,pom,parsing,browser
+Author: Saritasa
+Author-email: pypi@saritasa.com
+Maintainer: Anton Oboleninov
+Maintainer-email: anton.oboleninov@saritasa.com
+Requires-Python: >=3.11,<4.0
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: selenium (>=4.12)
+Project-URL: Documentation, http://pomcorn.rtfd.io/
+Project-URL: Homepage, https://pypi.org/project/pomcorn/
+Project-URL: Repository, https://github.com/saritasa-nest/pomcorn/
+Description-Content-Type: text/markdown
+
+# Pomcorn
+
+![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/saritasa-nest/pomcorn/pre-commit.yml) ![PyPI](https://img.shields.io/pypi/v/pomcorn) ![PyPI - Status](https://img.shields.io/pypi/status/pomcorn) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pomcorn) ![PyPI - License](https://img.shields.io/pypi/l/pomcorn) ![PyPI - Downloads](https://img.shields.io/pypi/dm/pomcorn) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+
+**Pomcorn**, or **Page Object Model corn**, is a Python package that contains base classes to create systems based on [Selenium](https://github.com/SeleniumHQ/selenium#selenium) framework and **Page Object Model** pattern. You can read more about this pattern [here](https://www.selenium.dev/documentation/test_practices/encouraged/page_object_models/). The package can be used to create autotesting systems, parsing scripts and anything that requires
+interaction with the browser.
+
+The package includes next base classes to create Page Object Model (``POM``) pages:
+
+```mermaid
+  classDiagram
+    WebView <|-- Component
+    WebView <|-- Page
+    Component <|-- ListComponent
+    Component .. Locator
+    Page .. Component
+
+    class WebView{
+        -webdriver: Webdriver
+    }
+    class Page{
+        +wait_until_loaded()
+        +open()
+    }
+    class Component{
+        -page: Page
+        -base_locator: Locator
+        + wait_until_visible()
+    }
+    class ListComponent{
+        -item_locator: Locator
+        +count()
+        +all()
+        +get_item_by_text()
+    }
+    class Locator{
+      -query: String
+    }
+
+```
+
+It also includes [classes to locate elements](https://pomcorn.readthedocs.io/en/latest/locators.html) on the web page and a number of additional [waiting conditions](https://pomcorn.readthedocs.io/en/latest/waits_conditions.html).
+
+## Installation
+
+You can install it by **pip**:
+
+```bash
+  pip install pomcorn
+```
+
+Or **poetry**:
+
+```bash
+  poetry add pomcorn
+```
+
+## Documentation
+
+Link to the documentation: [http://pomcorn.rtfd.io/](http://pomcorn.rtfd.io/).
+
+## Usage
+
+You need to [install pomcorn](https://pomcorn.readthedocs.io/en/latest/installation.html) and [Chrome webdriver](https://pomcorn.readthedocs.io/en/latest/installation.html#chrome-driver).
+
+Below is the code that opens ``PyPI.org``, searches for packages by name and prints names of found packages to the terminal. The script contains all base classes contained in ``pomcorn``: **Page**, **Component**, **ListComponent** and **Element**.
+
+```python
+
+  from typing import Self
+
+  from selenium.webdriver import Chrome
+  from selenium.webdriver.common.keys import Keys
+  from selenium.webdriver.remote.webdriver import WebDriver
+
+  from pomcorn import Component, Element, ListComponent, Page, locators
+
+
+  # Prepare base page
+  class PyPIPage(Page):
+
+      APP_ROOT = "https://pypi.org"
+
+      search = Element(locators.IdLocator("search"))
+
+      def check_page_is_loaded(self) -> bool:
+          return self.init_element(locators.TagNameLocator("main")).is_displayed
+
+
+  # Prepare components
+  Package = Component[PyPIPage]
+
+
+  class PackageList(ListComponent[Package, PyPIPage]):
+
+      relative_item_locator = locators.ClassLocator("snippet__name")
+
+      @property
+      def names(self) -> list[str]:
+          return [package.body.get_text() for package in self.all]
+
+
+  # Prepare search page
+  class SearchPage(PyPIPage):
+
+      @classmethod
+      def open(cls, webdriver: WebDriver, **kwargs) -> Self:
+          pypi_page = super().open(webdriver, **kwargs)
+          # Specific logic for PyPI for an open search page
+          pypi_page.search.fill("")
+          pypi_page.search.send_keys(Keys.ENTER)
+          return cls(webdriver, **kwargs)
+
+      @property
+      def results(self) -> PackageList:
+          return PackageList(
+              page=self,
+              base_locator=locators.PropertyLocator(
+                  prop="aria-label",
+                  value="Search results",
+              ),
+          )
+
+      def find(self, query: str) -> PackageList:
+          self.search.fill(query)
+          self.search.send_keys(Keys.ENTER)
+          return self.results
+
+
+  search_page = SearchPage.open(webdriver=Chrome())
+  print(search_page.find("saritasa").names)
+  search_page.webdriver.close()
+```
+
+For more information about package classes, you can read in [Object Hierarchy](https://pomcorn.readthedocs.io/en/latest/objects_hierarchy.html) and [Developer Interface](https://pomcorn.readthedocs.io/en/latest/developer_interface.html).
+
+Also you can try our [demo autotests project](https://pomcorn.readthedocs.io/en/latest/demo.html).
+

pomcorn-0.10.2/README.md

@@ -0,0 +1,138 @@
+# Pomcorn
+
+![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/saritasa-nest/pomcorn/pre-commit.yml) ![PyPI](https://img.shields.io/pypi/v/pomcorn) ![PyPI - Status](https://img.shields.io/pypi/status/pomcorn) ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pomcorn) ![PyPI - License](https://img.shields.io/pypi/l/pomcorn) ![PyPI - Downloads](https://img.shields.io/pypi/dm/pomcorn) [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+
+**Pomcorn**, or **Page Object Model corn**, is a Python package that contains base classes to create systems based on [Selenium](https://github.com/SeleniumHQ/selenium#selenium) framework and **Page Object Model** pattern. You can read more about this pattern [here](https://www.selenium.dev/documentation/test_practices/encouraged/page_object_models/). The package can be used to create autotesting systems, parsing scripts and anything that requires
+interaction with the browser.
+
+The package includes next base classes to create Page Object Model (``POM``) pages:
+
+```mermaid
+  classDiagram
+    WebView <|-- Component
+    WebView <|-- Page
+    Component <|-- ListComponent
+    Component .. Locator
+    Page .. Component
+
+    class WebView{
+        -webdriver: Webdriver
+    }
+    class Page{
+        +wait_until_loaded()
+        +open()
+    }
+    class Component{
+        -page: Page
+        -base_locator: Locator
+        + wait_until_visible()
+    }
+    class ListComponent{
+        -item_locator: Locator
+        +count()
+        +all()
+        +get_item_by_text()
+    }
+    class Locator{
+      -query: String
+    }
+
+```
+
+It also includes [classes to locate elements](https://pomcorn.readthedocs.io/en/latest/locators.html) on the web page and a number of additional [waiting conditions](https://pomcorn.readthedocs.io/en/latest/waits_conditions.html).
+
+## Installation
+
+You can install it by **pip**:
+
+```bash
+  pip install pomcorn
+```
+
+Or **poetry**:
+
+```bash
+  poetry add pomcorn
+```
+
+## Documentation
+
+Link to the documentation: [http://pomcorn.rtfd.io/](http://pomcorn.rtfd.io/).
+
+## Usage
+
+You need to [install pomcorn](https://pomcorn.readthedocs.io/en/latest/installation.html) and [Chrome webdriver](https://pomcorn.readthedocs.io/en/latest/installation.html#chrome-driver).
+
+Below is the code that opens ``PyPI.org``, searches for packages by name and prints names of found packages to the terminal. The script contains all base classes contained in ``pomcorn``: **Page**, **Component**, **ListComponent** and **Element**.
+
+```python
+
+  from typing import Self
+
+  from selenium.webdriver import Chrome
+  from selenium.webdriver.common.keys import Keys
+  from selenium.webdriver.remote.webdriver import WebDriver
+
+  from pomcorn import Component, Element, ListComponent, Page, locators
+
+
+  # Prepare base page
+  class PyPIPage(Page):
+
+      APP_ROOT = "https://pypi.org"
+
+      search = Element(locators.IdLocator("search"))
+
+      def check_page_is_loaded(self) -> bool:
+          return self.init_element(locators.TagNameLocator("main")).is_displayed
+
+
+  # Prepare components
+  Package = Component[PyPIPage]
+
+
+  class PackageList(ListComponent[Package, PyPIPage]):
+
+      relative_item_locator = locators.ClassLocator("snippet__name")
+
+      @property
+      def names(self) -> list[str]:
+          return [package.body.get_text() for package in self.all]
+
+
+  # Prepare search page
+  class SearchPage(PyPIPage):
+
+      @classmethod
+      def open(cls, webdriver: WebDriver, **kwargs) -> Self:
+          pypi_page = super().open(webdriver, **kwargs)
+          # Specific logic for PyPI for an open search page
+          pypi_page.search.fill("")
+          pypi_page.search.send_keys(Keys.ENTER)
+          return cls(webdriver, **kwargs)
+
+      @property
+      def results(self) -> PackageList:
+          return PackageList(
+              page=self,
+              base_locator=locators.PropertyLocator(
+                  prop="aria-label",
+                  value="Search results",
+              ),
+          )
+
+      def find(self, query: str) -> PackageList:
+          self.search.fill(query)
+          self.search.send_keys(Keys.ENTER)
+          return self.results
+
+
+  search_page = SearchPage.open(webdriver=Chrome())
+  print(search_page.find("saritasa").names)
+  search_page.webdriver.close()
+```
+
+For more information about package classes, you can read in [Object Hierarchy](https://pomcorn.readthedocs.io/en/latest/objects_hierarchy.html) and [Developer Interface](https://pomcorn.readthedocs.io/en/latest/developer_interface.html).
+
+Also you can try our [demo autotests project](https://pomcorn.readthedocs.io/en/latest/demo.html).

pomcorn-0.10.2/pomcorn/__init__.py

@@ -0,0 +1,14 @@
+from pomcorn.component import Component, ListComponent
+from pomcorn.descriptors import Element
+from pomcorn.element import XPathElement
+from pomcorn.page import Page
+from pomcorn.web_view import WebView
+
+__all__ = (
+    "Component",
+    "Element",
+    "ListComponent",
+    "Page",
+    "WebView",
+    "XPathElement",
+)