# Pomcorn
      [](https://github.com/psf/black) [](https://pycqa.github.io/isort/)
**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]):
item_class = Package
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).
Raw data
{
"_id": null,
"home_page": "https://pypi.org/project/pomcorn/",
"name": "pomcorn",
"maintainer": "Anton Oboleninov",
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": "anton.oboleninov@saritasa.com",
"keywords": "python, selenium, webdriver, autotests, page object model, page object pattern, page object, pom, parsing, browser",
"author": "Saritasa",
"author_email": "pypi@saritasa.com",
"download_url": "https://files.pythonhosted.org/packages/d4/14/35a7387a6dec532f9bd76413e1181b9698a89cb7c6c69c65bac0927b2399/pomcorn-0.8.0.tar.gz",
"platform": null,
"description": "# Pomcorn\n\n      [](https://github.com/psf/black) [](https://pycqa.github.io/isort/)\n\n**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\ninteraction with the browser.\n\nThe package includes next base classes to create Page Object Model (``POM``) pages:\n\n```mermaid\n classDiagram\n WebView <|-- Component\n WebView <|-- Page\n Component <|-- ListComponent\n Component .. Locator\n Page .. Component\n\n class WebView{\n -webdriver: Webdriver\n }\n class Page{\n +wait_until_loaded()\n +open()\n }\n class Component{\n -page: Page\n -base_locator: Locator\n + wait_until_visible()\n }\n class ListComponent{\n -item_locator: Locator\n +count()\n +all()\n +get_item_by_text()\n }\n class Locator{\n -query: String\n }\n\n```\n\nIt 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>).\n\n## Installation\n\nYou can install it by **pip**:\n\n```bash\n pip install pomcorn\n```\n\nOr **poetry**:\n\n```bash\n poetry add pomcorn\n```\n\n## Documentation\n\nLink to the documentation: [http://pomcorn.rtfd.io/](http://pomcorn.rtfd.io/).\n\n## Usage\n\nYou 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).\n\nBelow 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**.\n\n```python\n\n from typing import Self\n\n from selenium.webdriver import Chrome\n from selenium.webdriver.common.keys import Keys\n from selenium.webdriver.remote.webdriver import WebDriver\n\n from pomcorn import Component, Element, ListComponent, Page, locators\n\n\n # Prepare base page\n class PyPIPage(Page):\n\n APP_ROOT = \"https://pypi.org\"\n\n search = Element(locators.IdLocator(\"search\"))\n\n def check_page_is_loaded(self) -> bool:\n return self.init_element(locators.TagNameLocator(\"main\")).is_displayed\n\n\n # Prepare components\n Package = Component[PyPIPage]\n\n\n class PackageList(ListComponent[Package, PyPIPage]):\n\n item_class = Package\n relative_item_locator = locators.ClassLocator(\"snippet__name\")\n\n @property\n def names(self) -> list[str]:\n return [package.body.get_text() for package in self.all]\n\n\n # Prepare search page\n class SearchPage(PyPIPage):\n\n @classmethod\n def open(cls, webdriver: WebDriver, **kwargs) -> Self:\n pypi_page = super().open(webdriver, **kwargs)\n # Specific logic for PyPI for an open search page\n pypi_page.search.fill(\"\")\n pypi_page.search.send_keys(Keys.ENTER)\n return cls(webdriver, **kwargs)\n\n @property\n def results(self) -> PackageList:\n return PackageList(\n page=self,\n base_locator=locators.PropertyLocator(\n prop=\"aria-label\",\n value=\"Search results\",\n ),\n )\n\n def find(self, query: str) -> PackageList:\n self.search.fill(query)\n self.search.send_keys(Keys.ENTER)\n return self.results\n\n\n search_page = SearchPage.open(webdriver=Chrome())\n print(search_page.find(\"saritasa\").names)\n search_page.webdriver.close()\n```\n\nFor 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).\n\nAlso you can try our [demo autotests project](https://pomcorn.readthedocs.io/en/latest/demo.html).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Base implementation of Page Object Model",
"version": "0.8.0",
"project_urls": {
"Documentation": "http://pomcorn.rtfd.io/",
"Homepage": "https://pypi.org/project/pomcorn/",
"Repository": "https://github.com/saritasa-nest/pomcorn/"
},
"split_keywords": [
"python",
" selenium",
" webdriver",
" autotests",
" page object model",
" page object pattern",
" page object",
" pom",
" parsing",
" browser"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6cedb3aaf855c091569169c55b485fdcca4ff4d18c766825ddfad8ab5ba5a076",
"md5": "eca0d206d5de14ec264599feec4db665",
"sha256": "f726e4b851bc9047123f562b57080781fb9f986be5616fd4be262ef3048f2464"
},
"downloads": -1,
"filename": "pomcorn-0.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "eca0d206d5de14ec264599feec4db665",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 21721,
"upload_time": "2024-07-08T09:24:22",
"upload_time_iso_8601": "2024-07-08T09:24:22.361353Z",
"url": "https://files.pythonhosted.org/packages/6c/ed/b3aaf855c091569169c55b485fdcca4ff4d18c766825ddfad8ab5ba5a076/pomcorn-0.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d41435a7387a6dec532f9bd76413e1181b9698a89cb7c6c69c65bac0927b2399",
"md5": "328b2ecc768bd390036b5a99cfd47ba3",
"sha256": "9945277d710bbebabea45fd0c0ccbcb39f2d40b932e080d80b7020579a8a7024"
},
"downloads": -1,
"filename": "pomcorn-0.8.0.tar.gz",
"has_sig": false,
"md5_digest": "328b2ecc768bd390036b5a99cfd47ba3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 20271,
"upload_time": "2024-07-08T09:24:23",
"upload_time_iso_8601": "2024-07-08T09:24:23.928685Z",
"url": "https://files.pythonhosted.org/packages/d4/14/35a7387a6dec532f9bd76413e1181b9698a89cb7c6c69c65bac0927b2399/pomcorn-0.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-08 09:24:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "saritasa-nest",
"github_project": "pomcorn",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pomcorn"
}
JSON
