pytest-pyspec 0.5.3__py3-none-any.whl → 1.0.0__py3-none-any.whl

pytest_pyspec-1.0.0.dist-info/METADATA

@@ -0,0 +1,202 @@
+Metadata-Version: 2.4
+Name: pytest-pyspec
+Version: 1.0.0
+Summary: A plugin that transforms the pytest output into a result similar to the RSpec. It enables the use of docstrings to display results and also enables the use of the prefixes "describe", "with" and "it".
+Project-URL: Repository, https://github.com/felipecrp/pytest-pyspec
+Project-URL: Issues, https://github.com/felipecrp/pytest-pyspec/issues
+Author-email: Felipe Curty <felipecrp@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+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
+Classifier: Topic :: Software Development :: Testing
+Classifier: Topic :: Utilities
+Requires-Python: <4,>=3.10
+Requires-Dist: pytest<10,>=9
+Description-Content-Type: text/markdown
+
+[![](https://github.com/felipecrp/pytest-pyspec/actions/workflows/pytest.yml/badge.svg)](https://github.com/felipecrp/pytest-pyspec/actions/workflows/pytest.yml)
+
+# pytest-pyspec
+
+The **pytest-pyspec** plugin transforms pytest output into a beautiful, readable format similar to RSpec. It provides semantic meaning to your tests by organizing them into descriptive hierarchies.
+
+## Features
+
+- **Semantic Output**: Transform pytest's default output into readable, hierarchical descriptions
+- **Multiple Prefixes**: Support for `describe/test` (objects), `with/without/when` (contexts), and `it/test` (tests)
+- **Docstring Support**: Override test descriptions using docstrings
+- **Consolidated Output**: Smart grouping that avoids repeating parent headers
+- **Natural Language**: Automatic lowercase formatting of common words (the, is, are, etc.)
+
+## Quick Start
+
+### Installation
+
+```bash
+pip install pytest pytest-pyspec
+```
+
+### Running
+
+```bash
+pytest --pyspec
+```
+
+## Examples
+
+### Car Scenario
+
+A minimal car example with properties and behaviors:
+
+```python
+class DescribeCar:
+    def test_has_engine(self):
+        assert True
+
+    class WithFullTank:
+        def test_drive_long_distance(self):
+            assert True
+
+    class WithoutFuel:
+        def test_cannot_start_engine(self):
+            assert True
+
+    class WhenTheEngineIsRunning:
+        def test_consumes_fuel(self):
+            assert True
+```
+
+With **pytest-pyspec**, this produces:
+
+```
+a Car
+  ✓ has engine
+
+  with Full Tank
+    ✓ drive long distance
+
+  without Fuel
+    ✓ cannot start engine
+
+  when the Engine is Running
+    ✓ consumes fuel
+```
+
+### Available Prefixes
+
+**pytest-pyspec** supports three types of prefixes to create semantic test hierarchies:
+
+#### 1. Object Classes (use `describe` or `test`)
+
+Define what you're testing:
+
+```python
+class DescribeCar:  # or class TestCar:
+    def test_has_four_wheels(self):
+        assert True
+```
+
+Output:
+```
+a Car
+  ✓ has four wheels
+```
+
+#### 2. Context Classes (use `with`, `without`, or `when`)
+
+Define the context or state:
+
+```python
+class DescribeCar:
+    class WithFullTank:
+        def test_can_drive_long_distances(self):
+            assert True
+
+    class WithoutFuel:
+        def test_cannot_start_engine(self):
+            assert True
+
+    class WhenTheEngineIsRunning:
+        def test_consumes_fuel(self):
+            assert True
+```
+
+Output:
+```
+a Car
+  with Full Tank
+    ✓ can drive long distances
+
+  without Fuel
+    ✓ cannot start engine
+
+  when the Engine is Running
+    ✓ consumes fuel
+```
+
+#### 3. Test Functions (use `it_` or `test_`)
+
+Define the expected behavior:
+
+```python
+class DescribeCar:
+    def it_has_four_wheels(self):
+        assert True
+
+    def test_has_engine(self):
+        assert True
+```
+
+Output:
+```
+a Car
+  ✓ has four wheels
+  ✓ has engine
+```
+
+### Using Docstrings
+
+Override automatic naming with custom descriptions:
+
+```python
+class TestCar:
+    """sports car"""
+    
+    def test_top_speed(self):
+        """reaches 200 mph"""
+        assert True
+
+    class WhenTheNitroIsActivated:
+        """when nitro boost is activated"""
+        
+        def test_acceleration(self):
+            """accelerates rapidly"""
+            assert True
+```
+
+Output:
+```
+a sports car
+  ✓ reaches 200 mph
+
+  when nitro boost is activated
+    ✓ accelerates rapidly
+```
+
+## Configuration
+
+The plugin is automatically enabled when you use the `--pyspec` flag. No additional configuration is required.
+
+For more information, see the [documentation](https://github.com/felipecrp/pytest-pyspec/blob/main/doc/README.md).

pytest_pyspec-1.0.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+pytest_pyspec/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pytest_pyspec/plugin.py,sha256=HS3iA2Xiz9LzdiB_k-2K0YpLtz5vF72Q7yS6l7LmhRk,6869
+pytest_pyspec/tree.py,sha256=1Qg0oh7T-__vQEC9w828GI79lLAPrfzZx8wcPDY8JsE,14812
+pytest_pyspec-1.0.0.dist-info/METADATA,sha256=O8ZEekcDGnnxQm0rOjxmET5GMmgWoK_tQY6_uyB1uz4,4916
+pytest_pyspec-1.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+pytest_pyspec-1.0.0.dist-info/entry_points.txt,sha256=6YScWbxnkpduYs2Ef3gKOe6rV8Cjbj-OxCGMDNdV4Kc,48
+pytest_pyspec-1.0.0.dist-info/licenses/LICENSE,sha256=PXKqh3rDWRsfhWsjBQ27qqYzE5E05n-eFRH95LsKRT4,1094
+pytest_pyspec-1.0.0.dist-info/RECORD,,

{pytest_pyspec-0.5.3.dist-info → pytest_pyspec-1.0.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 1.5.1
+Generator: hatchling 1.27.0
 Root-Is-Purelib: true
 Tag: py3-none-any

pytest_pyspec-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[pytest11]
+pytest_pyspec = pytest_pyspec.plugin

pytest_pyspec-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,9 @@
+The MIT License (MIT)
+
+Copyright 2024 Felipe Curty and others
+
+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.

pytest_pyspec/item.py

@@ -1,141 +0,0 @@
-from types import ModuleType
-from typing import Dict, List
-import pytest
-
-class Item:
-    def __init__(self, item: pytest.Item) -> None:
-        self._item = item
-
-    @property
-    def description(self):        
-        description = self._item.obj.__doc__
-
-        if not description:
-            description = self._item.name
-            description = self._parse_description(description)
-
-        description = description.splitlines()[0]
-        description = description.capitalize()
-        return description
-
-    def _parse_description(self, description: str):
-        split = False
-        if description.lower().startswith("it_"):
-            description = description.replace('it_', '')
-            split = True
-
-        if description.lower().startswith("test_it_"):
-            description = description.replace('test_it_', '')
-            split = True
-
-        if description.lower().startswith("test_describe_"):
-            description = description.replace('test_describe_', '')
-            split = True
-
-        if description.lower().startswith("describe_"):
-            description = description.replace('describe_', '')
-            split = True
-
-        if split:
-            description = description.replace('_', ' ')
-
-        return description
-
-    def __repr__(self):
-        return self._item.__repr__()
-
-
-class Test(Item):
-    def __init__(self, item: pytest.Item) -> None:
-        super().__init__(item)
-        self.container: Container = None
-        self.outcome: str = None
-
-    @property
-    def level(self) -> int:
-        if not self.container:
-            return 0
-        return self.container.level +1
-   
-    
-class Container(Item):
-    def __init__(self, item: pytest.Item):
-        super().__init__(item)
-        self.tests: List[Test] = list()
-        self.containers: List[Container] = list()
-        self.parent = None
-
-    def add(self, test: Test):
-        self.tests.append(test)
-        test.container = self
-
-    def add_container(self, container: 'Container'):
-        self.containers.append(container)
-        container.parent = self
-
-    def flat_list(self):
-        containers = []
-        container = self
-        while container:
-            containers.insert(0, container)
-            container = container.parent
-        return containers
-
-    @property
-    def level(self) -> int:
-        level = 0
-        
-        item = self._item
-        while item.parent and not isinstance(item.parent.obj, ModuleType):
-            level += 1
-            item = item.parent
-        
-        return level
-
-
-class ItemFactory:
-    def __init__(self) -> None:
-        self.container_factory = ContainerFactory()
-
-    def create(self, item: pytest.Item) -> Test:
-        test_item = Test(item)
-
-        container_item = item.parent
-        container = self.container_factory.create(container_item)
-        if container:
-            container.add(test_item)       
-
-        return test_item
-        
-
-class ContainerFactory:
-    def __init__(self) -> None:
-        self.containers: Dict[str, Container] = dict()
-
-    def create(self, item) -> Container:
-        containers = self._create_containers(item)
-        if not containers:
-            return None
-        
-        return containers[-1]
-    
-    def _create_unique_container(self, item):
-        if item not in self.containers:
-            container = Container(item)
-            self.containers[item] = container
-
-        container = self.containers.get(item)
-        return container
-
-    def _create_containers(self, item):
-        containers = []
-        child_container = None
-        while item and not isinstance(item.obj, ModuleType):
-            container = self._create_unique_container(item)
-            if child_container:
-                container.add_container(child_container)
-
-            containers.insert(0, container)
-            child_container = container
-            item = item.parent
-        return containers

pytest_pyspec/output.py

@@ -1,30 +0,0 @@
-import pytest
-from .item import Container, Test
-
-
-def print_container(container: Container):
-    output = "\n"
-    if container:
-        for container in container.flat_list():
-            output += print_parent_container(container)
-            container = container.parent
-    return output
-
-def print_parent_container(container: Container):
-    ident = "  " * container.level
-    output = f"\n{ident}{container.description}"
-    return output
-
-def print_test(test: Test):
-    ident = "  " * test.level
-    status = print_test_status(test)
-    output = f"\n{ident}{status} {test.description}"
-    return output
-
-def print_test_status(test: Test):
-    if test.outcome == 'passed':
-        return '✓'
-    elif test.outcome == 'failed':
-        return '✗'
-    else:
-        return '»'