widgetastic.patternfly5 23.8.25.0__py3-none-any.whl → 23.8.28.0__py3-none-any.whl

widgetastic.patternfly5-23.8.28.0.dist-info/METADATA

@@ -0,0 +1,146 @@
+Metadata-Version: 2.1
+Name: widgetastic.patternfly5
+Version: 23.8.28.0
+Summary: Patternfly5 widget library for Widgetastic.
+Project-URL: repository, https://github.com/RedHatQE/widgetastic.patternfly5
+Maintainer-email: Nikhil Dhandre <ndhandre@redhat.com>, Egor Shamardin <eshamard@redhat.com>, Mike Shriver <mshriver@redhat.com>
+License: Copyright 2023 Red Hat, Inc. and/or its affiliates
+        
+        Licensed under the Apache License, Version 2.0 (the "License");
+        you may not use this file except in compliance with the License.
+        You may obtain a copy of the License at
+        
+            http://www.apache.org/licenses/LICENSE-2.0
+        
+        Unless required by applicable law or agreed to in writing, software
+        distributed under the License is distributed on an "AS IS" BASIS,
+        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+        See the License for the specific language governing permissions and
+        limitations under the License.
+License-File: LICENSE
+Keywords: patternfly,patternfly5,widgetastic
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.8
+Requires-Dist: widgetastic-core>=1.0.5
+Provides-Extra: dev
+Requires-Dist: codecov; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest-xdist; extra == 'dev'
+Provides-Extra: doc
+Requires-Dist: sphinx; extra == 'doc'
+Description-Content-Type: text/markdown
+
+<h1 align="center"> widgetastic.patternfly5 </h1>
+
+<p align="center">
+    <a href="https://pypi.org/project/widgetastic.patternfly5/">
+    <img alt="Python Versions" src="https://img.shields.io/pypi/pyversions/widgetastic.patternfly5.svg?style=flat">
+    </a>
+    <a href="https://pypi.org/project/widgetastic.patternfly5/#history">
+    <img alt="PyPI version" src="https://badge.fury.io/py/widgetastic.patternfly5.svg">
+    </a>
+    <a href="https://codecov.io/github/RedHatQE/widgetastic.patternfly5">
+      <img src="https://codecov.io/github/RedHatQE/widgetastic.patternfly5/graph/badge.svg?token=cWuTXniIPm"/>
+    </a>
+    <a href="https://github.com/RedHatQE/widgetastic.patternfly5/actions/workflows/tests.yaml">
+    <img alt="github actions" src="https://github.com/RedHatQE/widgetastic.patternfly5/actions/workflows/tests.yaml/badge.svg">
+    </a>
+    <a href="https://pypi.org/project/black">
+    <img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg">
+    </a>
+</p>
+
+This library offers Widgetastic Widgets for [PatternFly v5](https://www.patternfly.org/), serving as an extended
+itteration of [widgetastic.patternfly4](https://github.com/RedHatQE/widgetastic.patternfly4).
+
+
+### Components:
+- [alert](https://www.patternfly.org/components/alert)
+- [breadcrumb](https://www.patternfly.org/components/breadcrumb)
+- [button](https://www.patternfly.org/components/button)
+- [card](https://www.patternfly.org/components/card)
+- [chip](https://www.patternfly.org/components/chip)
+- [clipboard-copy](https://www.patternfly.org/components/clipboard-copy)
+- date and time
+  - [calendar-month](https://www.patternfly.org/components/date-and-time/calendar-month)
+- [description-list](https://www.patternfly.org/components/description-list)
+- [drawer](https://www.patternfly.org/components/drawer)
+- [dual-list-selector](https://www.patternfly.org/components/dual-list-selector)
+- forms
+  - [form-select](https://www.patternfly.org/components/forms/form-select)
+  - [radio](https://www.patternfly.org/components/forms/radio)
+- menus
+  - [dropdown](https://www.patternfly.org/components/menus/dropdown)
+  - [menu](https://www.patternfly.org/components/menus/menu)
+  - [menu-toggle](https://www.patternfly.org/components/menus/menu-toggle)
+  - [options-menu](https://www.patternfly.org/components/menus/options-menu/)
+  - [select](https://www.patternfly.org/components/menus/select)
+- [modal](https://www.patternfly.org/components/modal)
+- [navigation](https://www.patternfly.org/components/navigation)
+- [pagination](https://www.patternfly.org/components/pagination/)
+- [popover](https://www.patternfly.org/components/popover)
+- [progress](https://www.patternfly.org/components/progress)
+- [slider](https://www.patternfly.org/components/slider)
+- [switch](https://www.patternfly.org/components/switch)
+- [table](https://www.patternfly.org/components/table)
+- [tabs](https://www.patternfly.org/components/tabs)
+- [title](https://www.patternfly.org/components/title)
+
+
+### Charts:
+- [bullet-chart](https://www.patternfly.org/charts/bullet-chart)
+- [donut-chart](https://www.patternfly.org/charts/donut-chart)
+- [legends](https://www.patternfly.org/charts/legends)
+- [line-chart](https://www.patternfly.org/charts/line-chart)
+- [pie-chart](https://www.patternfly.org/charts/pie-chart)
+
+### Patterns:
+- [card-view](https://patternfly-react-main.surge.sh/patterns/card-view)
+
+
+### Contribution guide
+
+```bash
+# clone the repo
+git clone https://github.com/RedHatQE/widgetastic.patternfly5.git
+cd widgetastic.patternfly5
+
+# create a virtual environment
+python3 -m venv .venv_pfy5
+source .venv_pfy5/bin/activate
+
+# update pip and its friends
+pip install -U pip setuptools wheel
+
+# install the package in editable mode
+pip install -e .[dev]
+pre-commit install
+```
+
+### Testing
+
+The library has selenium tests that are performed against [Patternfly React docs](https://patternfly-react-main.surge.sh).
+It's also configured to run the tests every time when a new version of that page is released.
+
+Tests spawn a container from official selenium image - [selenium/standalone-{chrome/firefox}](https://hub.docker.com/u/selenium).
+We can check local runs via vnc `http://localhost:7900`
+
+**Note:** Tests use `podman` to manage containers. Please install it before running.
+
+It's possible to run tests in parallel to speed up the execution. Make sure that you have **xdist** python plugin installed.
+
+Use `-n` key to specify a number
+of workers:
+
+```bash
+BROWSER=firefox pytest -v testing -n 4
+```

{widgetastic.patternfly5-23.8.25.0.dist-info → widgetastic.patternfly5-23.8.28.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-widgetastic_patternfly5/__init__.py,sha256=iQLuJr-PD_llO0E7AK-NBbKicIwi1XOTlL9zBCC3giI,4432
+widgetastic_patternfly5/__init__.py,sha256=R3zeri7LfNyVbt-jNeRnHpns4aZkYLWCiwF23RjmM9M,4620
 widgetastic_patternfly5/ouia.py,sha256=e5eGepCYPB4oSc52h43e3xWaGhKtGMvyNsx07m27jgM,3622
 widgetastic_patternfly5/charts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 widgetastic_patternfly5/charts/bullet_chart.py,sha256=G7-U1l9d8VlkiPKc3IfFtcleHAmM5WXsfAKwiyw5DEg,3737
@@ -10,7 +10,7 @@ widgetastic_patternfly5/components/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQe
 widgetastic_patternfly5/components/alert.py,sha256=lSh2TxSOxLob4VO0J7fr-W09R2_Sa4RLRtR5XBjA4_U,2613
 widgetastic_patternfly5/components/breadcrumb.py,sha256=_lQ7pqmh2P9FSwMae_quUTteHsfXFlQvYaXE4Z1gK1g,2035
 widgetastic_patternfly5/components/button.py,sha256=taiZYjFez5zVyOUBklIIz-kEGFLjigf0I97G2PYepCI,3621
-widgetastic_patternfly5/components/card.py,sha256=96zUD0LS0E8u6Mp5lJx3dagcXwnFwkEq8fj5aNuxyK8,1375
+widgetastic_patternfly5/components/card.py,sha256=Fo8r4gA-JpYlUg1xwqWzLpiBm2xS74og1EX98Mpwaxc,2787
 widgetastic_patternfly5/components/chip.py,sha256=kLSoDHtc3IpayEupGap64cG3uCuroY7YMeG51-6_-ds,11047
 widgetastic_patternfly5/components/clipboard_copy.py,sha256=klEgT2RN4Sc7pd7Erwlxyj6ahOwexeMkTzyn6cCHNRk,1352
 widgetastic_patternfly5/components/description_list.py,sha256=sVhKwKnvJguZh9FqyPC1NU2UA_w7uA3ugkY5eoVRlPk,989
@@ -36,7 +36,7 @@ widgetastic_patternfly5/components/menus/menu.py,sha256=0cUb5V1y3RgRpdAB8DlPIL9O
 widgetastic_patternfly5/components/menus/menu_toggle.py,sha256=PBwNvg6E2RPdCG6ALBUqyTZxCwThJgk5S-9ghTiZ9hM,1029
 widgetastic_patternfly5/components/menus/options_menu.py,sha256=c5L4MhXazdLnfBO9mf4-2UsZa7NGW9yJ6_aDDtHdXAc,1231
 widgetastic_patternfly5/components/menus/select.py,sha256=2nb78mGsdzgmYrtdvvRf2N51iKUDl2VeyE7qEjWl4qQ,5711
-widgetastic.patternfly5-23.8.25.0.dist-info/METADATA,sha256=JTHwm0nVs1lX7Fk9cR8jVDKlRQRrWhmqBIQO_iA2nLs,46391
-widgetastic.patternfly5-23.8.25.0.dist-info/WHEEL,sha256=9QBuHhg6FNW7lppboF2vKVbCGTVzsFykgRQjjlajrhA,87
-widgetastic.patternfly5-23.8.25.0.dist-info/licenses/LICENSE,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-widgetastic.patternfly5-23.8.25.0.dist-info/RECORD,,
+widgetastic.patternfly5-23.8.28.0.dist-info/METADATA,sha256=2F8FUbVRIHibZyBJDjbRuIHE-8w8i5w2v8QZgb02L9U,6416
+widgetastic.patternfly5-23.8.28.0.dist-info/WHEEL,sha256=9QBuHhg6FNW7lppboF2vKVbCGTVzsFykgRQjjlajrhA,87
+widgetastic.patternfly5-23.8.28.0.dist-info/licenses/LICENSE,sha256=nDhhj8jp0XsTdmvWpTWFpOKVn0LPXPb6ecA9zFF3Exk,576
+widgetastic.patternfly5-23.8.28.0.dist-info/RECORD,,

widgetastic.patternfly5-23.8.28.0.dist-info/licenses/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2023 Red Hat, Inc. and/or its affiliates
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

widgetastic_patternfly5/__init__.py

@@ -8,6 +8,9 @@ from .components.alert import Alert
 from .components.breadcrumb import BreadCrumb
 from .components.button import Button
 from .components.card import Card
+from .components.card import CardCheckBox
+from .components.card import CardForCardGroup
+from .components.card import CardGroup
 from .components.card import CardWithActions
 from .components.chip import CategoryChipGroup
 from .components.chip import Chip
@@ -71,6 +74,9 @@ __all__ = [
     "Button",
     "CalendarMonth",
     "Card",
+    "CardCheckBox",
+    "CardForCardGroup",
+    "CardGroup",
     "CardWithActions",
     "CategoryChipGroup",
     "CheckboxMenu",

widgetastic_patternfly5/components/card.py

@@ -1,6 +1,8 @@
 from widgetastic.utils import ParametrizedLocator
 from widgetastic.widget import Checkbox
 from widgetastic.widget import GenericLocatorWidget
+from widgetastic.widget import ParametrizedView
+from widgetastic.widget import View
 
 from widgetastic_patternfly5.components.menus.dropdown import Dropdown
 
@@ -32,13 +34,58 @@ class BaseCard:
 
 
 class Card(BaseCard, GenericLocatorWidget):
+    DEFAULT_LOCATOR = (
+        ".//div[@data-ouia-component-type='PF5/Card'] | .//article[contains(@class, 'pf-c-card')]"
+    )
+
     def __init__(self, parent, locator=None, logger=None):
-        locator = locator or ".//div[contains(@class, '-c-card')]"
+        locator = locator or self.DEFAULT_LOCATOR
         super().__init__(parent, locator, logger=logger)
 
     ROOT = ParametrizedLocator("{@locator}")
 
 
+class CardForCardGroup(BaseCard, ParametrizedView):
+    DEFAULT_LOCATOR = (
+        "(.//div[@data-ouia-component-type='PF5/Card'] | .//article[contains(@class, 'pf-c-card')])"
+    )
+
+    def __init__(self, parent, locator=None, logger=None, **kwargs):
+        View.__init__(self, parent, logger=logger, **kwargs)
+        self.locator = locator or self.DEFAULT_LOCATOR
+
+    PARAMETERS = ("position",)
+
+    ROOT = ParametrizedLocator("{@locator}[{position}]")
+
+    def __locator__(self):
+        return self.ROOT
+
+    @classmethod
+    def all(cls, browser):
+        # todo: OUIA versions should return component ids
+        elements = browser.elements(cls.DEFAULT_LOCATOR)
+        result = []
+        for index, item in enumerate(elements):
+            result.append((index + 1,))
+        return result
+
+
+class CardGroup(GenericLocatorWidget, View):
+    def __init__(self, parent, locator=None, logger=None, **kwargs):
+        View.__init__(self, parent, logger=logger, **kwargs)
+        self.locator = locator
+
+    cards = ParametrizedView.nested(CardForCardGroup)
+
+    def __iter__(self):
+        return iter(self.cards)
+
+
 class CardWithActions(Card):
     dropdown = Dropdown(locator=".//div[contains(@class, '-c-card__actions')]")
     checkbox = Checkbox(locator=".//input[contains(@class, '-c-check__input')]")
+
+
+class CardCheckBox(Checkbox):
+    ROOT = ".//input[contains(@class, '-c-check__input')]"