pytest-pyspec 0.8.2__tar.gz → 1.0.0__tar.gz

pytest_pyspec-1.0.0/.gitignore

@@ -0,0 +1,130 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+.vscode

pytest_pyspec-1.0.0/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,174 @@
+[![](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/pyproject.toml

@@ -0,0 +1,53 @@
+[project]
+name = "pytest-pyspec"
+version = "1.0.0"
+description = '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".'
+authors = [{ name = "Felipe Curty", email = "felipecrp@gmail.com" }]
+requires-python = ">=3.10, <4"
+readme = "README.md"
+license = "MIT"
+dependencies = [
+    "pytest>=9,<10",
+]
+
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "Operating System :: MacOS",
+    "Operating System :: Microsoft :: Windows",
+    "Operating System :: POSIX",
+    "Operating System :: Unix",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development :: Testing",
+    "Topic :: Utilities",
+]
+
+[project.urls]
+Repository = "https://github.com/felipecrp/pytest-pyspec"
+Issues = "https://github.com/felipecrp/pytest-pyspec/issues"
+
+[project.entry-points.pytest11]
+pytest_pyspec = "pytest_pyspec.plugin"
+
+[dependency-groups]
+dev = ["autopep8>=2.0.2,<3"]
+
+[tool.hatch.build.targets.sdist]
+include = ["pytest_pyspec"]
+
+[tool.hatch.build.targets.wheel]
+include = ["pytest_pyspec"]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.pytest.ini_options]
+addopts = "--pyspec"
+