pytest-review 0.1.0__tar.gz

pytest_review-0.1.0/.gitignore

@@ -0,0 +1,215 @@
+.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+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/
+cover/
+
+# 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
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# agents
+.claude
+CLAUDE.md
+AGENTS.md
+GEMINI.md

pytest_review-0.1.0/CHANGELOG.md

@@ -0,0 +1,50 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0]
+
+### Added
+
+- Initial release of pytest-review
+
+#### Core Features
+- pytest plugin integration with `--review` flag
+- Quality scoring system with letter grades (A-F)
+- Multiple output formats: terminal, JSON, HTML
+- Configurable via `pyproject.toml`
+
+#### Analyzers
+- **assertions**: Detects empty tests, trivial assertions (`assert True`), tautologies
+- **naming**: Checks for descriptive test names, snake_case convention, minimum length
+- **complexity**: Flags high statement count, deep nesting, cyclomatic complexity
+- **patterns**: Identifies anti-patterns (bare except, `time.sleep`, print statements, `os.system`)
+- **isolation**: Detects global state modifications, class attribute mutations
+- **performance**: Tracks slow tests at runtime
+- **smells**: Detects test smells (assertion roulette, duplicate asserts, eager tests, magic numbers, skipped tests)
+
+#### CLI Options
+- `--review`: Enable test quality review
+- `--review-format`: Output format (terminal/json/html)
+- `--review-output`: Write report to file
+- `--review-strict`: Fail if quality errors are found
+- `--review-min-score`: Minimum required score (0-100)
+- `--review-only`: Run specific analyzers only
+
+#### Reporters
+- Terminal reporter with colored output
+- JSON reporter with structured data
+- HTML reporter with styled dashboard
+
+### Acknowledgments
+
+The smells analyzer is inspired by the [pytest-smell](https://github.com/maxpacs98/disertation) project.
+Test smell concepts based on research by Van Deursen et al. and Meszaros.
+
+[Unreleased]: https://github.com/shakeeb-alireza/pytest-review/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/shakeeb-alireza/pytest-review/releases/tag/v0.1.0

pytest_review-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Shakeeb Alireza
+
+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_review-0.1.0/Makefile

@@ -0,0 +1,121 @@
+.PHONY: install dev test lint type-check clean all review review-html review-json \
+       example example-html example-json example-only example-strict example-min-score \
+       example-verify build publish publish-test check
+
+all: install test
+
+install:
+	@uv sync --reinstall-package pytest_review
+
+dev:
+	@uv pip install -e .
+
+test:
+	@uv run pytest
+
+test-cov:
+	@uv run pytest --cov=pytest_review --cov-report=term-missing
+
+review:
+	@uv run pytest --review
+
+review-html:
+	@uv run pytest --review --review-format=html --review-output=pytest-review-report.html
+	@echo "HTML report generated: pytest-review-report.html"
+
+review-json:
+	@uv run pytest --review --review-format=json --review-output=pytest-review-report.json
+	@echo "JSON report generated: pytest-review-report.json"
+
+# Example targets using bad_tests.py
+example:
+	@uv run pytest examples/bad_tests.py --review
+
+example-html:
+	@uv run pytest examples/bad_tests.py --review --review-format=html --review-output=examples/report.html
+	@echo "HTML report generated: examples/report.html"
+
+example-json:
+	@uv run pytest examples/bad_tests.py --review --review-format=json --review-output=examples/report.json
+	@echo "JSON report generated: examples/report.json"
+
+example-only:
+	@uv run pytest examples/bad_tests.py --review --review-only=assertions,naming
+
+example-strict:
+	@uv run pytest examples/bad_tests.py --review --review-strict || true
+
+example-min-score:
+	@uv run pytest examples/bad_tests.py --review --review-min-score=70
+
+# Verify all analyzers detect expected issues
+example-verify:
+	@echo "Verifying all analyzers detect expected issues..."
+	@uv run pytest examples/bad_tests.py --review --review-format=json --review-output=/tmp/review.json -q
+	@uv run python -c "\
+import json; \
+data = json.load(open('/tmp/review.json')); \
+rules = {i['rule'] for i in data['issues']}; \
+expected = { \
+    'assertions.missing', 'assertions.trivial', \
+    'naming.non_descriptive', 'naming.too_short', 'naming.not_snake_case', \
+    'complexity.too_many_statements', 'complexity.deep_nesting', 'complexity.high_cyclomatic', \
+    'patterns.bare_except', 'patterns.sleep_in_test', 'patterns.print_statement', \
+    'patterns.os_system', 'patterns.is_literal', \
+    'isolation.global_modification', 'isolation.class_attr_modification', \
+    'smells.assertion_roulette', 'smells.duplicate_assert', 'smells.ignored_test', \
+    'smells.magic_number', 'smells.eager_test', \
+}; \
+missing = expected - rules; \
+extra = rules - expected - {'naming.unclear_abbreviation'}; \
+print(f'Found {len(rules)} unique rules'); \
+print(f'Expected {len(expected)} rules'); \
+[print(f'  MISSING: {r}') for r in sorted(missing)]; \
+[print(f'  (extra): {r}') for r in sorted(extra)]; \
+exit(1 if missing else 0) \
+"
+	@echo "All expected rules detected!"
+
+lint:
+	@uv run ruff check src/ tests/
+	@uv run ruff format --check src/ tests/
+
+format:
+	@uv run ruff check --fix src/ tests/
+	@uv run ruff format src/ tests/
+
+type-check:
+	@uv run mypy src/
+
+clean:
+	@rm -rf build/
+	@rm -rf dist/
+	@rm -rf *.egg-info/
+	@rm -rf src/*.egg-info/
+	@rm -rf .pytest_cache/
+	@rm -rf .mypy_cache/
+	@rm -rf .ruff_cache/
+	@rm -rf htmlcov/
+	@rm -rf .coverage
+	@rm -f pytest-review-report.html
+	@rm -f pytest-review-report.json
+	@rm -f examples/report.html
+	@rm -f examples/report.json
+	@rm -f examples/bad_tests_report.html
+	@find . -type d -name __pycache__ -exec rm -rf {} +
+
+# Build and publish
+build: clean
+	@uv build
+	@echo "Build complete. Distribution files in dist/"
+
+check: build
+	@uv run twine check dist/*
+
+publish-test: check
+	@uv run twine upload --repository testpypi dist/*
+	@echo "Published to TestPyPI"
+
+publish: check
+	@uv run twine upload dist/*
+	@echo "Published to PyPI"

pytest_review-0.1.0/PKG-INFO

@@ -0,0 +1,238 @@
+Metadata-Version: 2.4
+Name: pytest-review
+Version: 0.1.0
+Summary: A pytest plugin that reviews the quality of your tests
+Project-URL: Homepage, https://github.com/shakeeb-alireza/pytest-review
+Project-URL: Repository, https://github.com/shakeeb-alireza/pytest-review
+Author-email: Shakeeb Alireza <me@example.org>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: code-quality,code-review,linter,pytest,pytest-plugin,static-analysis,test-quality,testing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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: Topic :: Software Development :: Testing
+Requires-Python: >=3.9
+Requires-Dist: pytest>=7.0.0
+Provides-Extra: dev
+Requires-Dist: mypy>=1.0.0; extra == 'dev'
+Requires-Dist: pytest-cov>=4.0.0; extra == 'dev'
+Requires-Dist: pytest>=7.0.0; extra == 'dev'
+Requires-Dist: ruff>=0.1.0; extra == 'dev'
+Requires-Dist: twine>=4.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# pytest-review
+
+A pytest plugin that reviews the quality of your tests.
+
+[![PyPI version](https://badge.fury.io/py/pytest-review.svg)](https://badge.fury.io/py/pytest-review)
+[![Python versions](https://img.shields.io/pypi/pyversions/pytest-review.svg)](https://pypi.org/project/pytest-review/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Overview
+
+pytest-review analyzes your test suite and provides actionable feedback on test quality. It detects common anti-patterns, missing assertions, overly complex tests, and more.
+
+## Features
+
+- **Static Analysis**: AST-based detection of test quality issues
+- **Dynamic Analysis**: Runtime performance tracking
+- **Multiple Output Formats**: Terminal, JSON, and HTML reports
+- **Configurable**: Customize thresholds and enable/disable analyzers
+- **Quality Scoring**: Get a letter grade (A-F) for your test suite
+
+### Analyzers
+
+| Analyzer | Description |
+|----------|-------------|
+| **assertions** | Detects empty tests, trivial assertions (`assert True`), tautologies |
+| **naming** | Checks for descriptive test names, proper snake_case |
+| **complexity** | Flags tests with too many statements, deep nesting, high cyclomatic complexity |
+| **patterns** | Identifies anti-patterns: bare except, `time.sleep`, print statements |
+| **isolation** | Detects global state modifications, class attribute mutations |
+| **performance** | Tracks slow tests at runtime |
+| **smells** | Detects test smells: assertion roulette, duplicate asserts, eager tests, magic numbers |
+
+## Installation
+
+```bash
+pip install pytest-review
+```
+
+## Quick Start
+
+Run pytest with the `--review` flag:
+
+```bash
+pytest --review
+```
+
+Example output:
+
+```
+====================== pytest-review: Test Quality Report ======================
+  [X] tests/test_example.py:15 [test_empty] Test has no assertions
+      Suggestion: Add at least one assertion to verify expected behavior
+  [!] tests/test_example.py:20 [test_complex] Test has cyclomatic complexity of 12
+      Suggestion: Simplify test logic or split into multiple tests
+----------------------------------- Summary ------------------------------------
+  Tests analyzed: 25
+  Errors: 2
+  Warnings: 5
+  Info: 3
+  Quality: NEEDS IMPROVEMENT
+
+  Overall Score: 72.0/100 (C)
+================================================================================
+```
+
+## Command Line Options
+
+| Option | Description |
+|--------|-------------|
+| `--review` | Enable test quality review |
+| `--review-format` | Output format: `terminal` (default), `json`, `html` |
+| `--review-output` | Write report to file |
+| `--review-strict` | Fail if quality errors are found |
+| `--review-min-score` | Minimum required score (0-100) |
+| `--review-only` | Comma-separated list of analyzers to run |
+
+### Examples
+
+```bash
+# Generate HTML report
+pytest --review --review-format=html --review-output=report.html
+
+# Generate JSON report
+pytest --review --review-format=json --review-output=report.json
+
+# Run only specific analyzers
+pytest --review --review-only=assertions,naming
+
+# Fail CI if score below 80
+pytest --review --review-min-score=80
+
+# Strict mode: fail on any errors
+pytest --review --review-strict
+```
+
+## Configuration
+
+Configure pytest-review in your `pyproject.toml`:
+
+```toml
+[tool.pytest-review]
+enabled = true
+strict = false
+min_score = 0
+
+[tool.pytest-review.analyzers]
+assertions = { enabled = true, min_assertions = 1 }
+naming = { enabled = true, min_length = 10 }
+complexity = { enabled = true, max_statements = 20, max_depth = 3, max_complexity = 5 }
+patterns = { enabled = true }
+isolation = { enabled = true }
+performance = { enabled = true, slow_threshold_ms = 500, very_slow_threshold_ms = 2000 }
+smells = { enabled = true, max_assertions_without_message = 1, check_magic_numbers = true }
+```
+
+### Skipping Tests
+
+Use the `review_skip` marker to exclude specific tests from review:
+
+```python
+import pytest
+
+@pytest.mark.review_skip
+def test_intentionally_complex():
+    # This test won't be analyzed
+    ...
+```
+
+## Scoring System
+
+The quality score is calculated using weighted categories:
+
+| Category | Weight | Analyzers |
+|----------|--------|-----------|
+| Assertions | 30% | assertions |
+| Clarity | 25% | naming, smells |
+| Isolation | 20% | isolation |
+| Simplicity | 15% | complexity, patterns |
+| Performance | 10% | performance |
+
+Severity penalties:
+- **Error**: -15 points per issue
+- **Warning**: -5 points per issue
+- **Info**: -1 point per issue
+
+Critical penalties (applied globally):
+- Missing assertions: -20 points
+- Trivial assertions: -10 points
+
+### Grade Scale
+
+| Grade | Score Range |
+|-------|-------------|
+| A | 90-100 |
+| B | 80-89 |
+| C | 70-79 |
+| D | 60-69 |
+| F | 0-59 |
+
+## Issue Types
+
+### Errors (X)
+
+Critical issues that indicate likely bugs or useless tests:
+
+- `assertions.missing` - Test has no assertions
+- `assertions.trivial` - Trivial assertion like `assert True`
+- `assertions.tautology` - Comparing value to itself
+
+### Warnings (!)
+
+Issues that may indicate problems:
+
+- `naming.non_descriptive` - Generic names like `test_foo`
+- `complexity.too_many_statements` - Test too long
+- `complexity.too_deep` - Excessive nesting
+- `complexity.too_complex` - High cyclomatic complexity
+- `patterns.bare_except` - Catches all exceptions
+- `patterns.sleep_in_test` - Uses `time.sleep()`
+- `isolation.global_modification` - Modifies global state
+- `smells.assertion_roulette` - Multiple assertions without messages
+- `smells.duplicate_assert` - Duplicate assertion statements
+- `smells.ignored_test` - Test is skipped with decorator
+
+### Info (i)
+
+Suggestions for improvement:
+
+- `naming.too_short` - Name could be more descriptive
+- `patterns.print_statement` - Debug print left in test
+- `performance.slow_test` - Test runs slowly
+- `smells.magic_number` - Literal number in assertion
+- `smells.eager_test` - Test verifies multiple methods
+
+## Acknowledgments
+
+- The smells analyzer is inspired by the [pytest-smell](https://github.com/maxpacs98/disertation) project from the dissertation "Detecting Test Smells in Python" by Maxim Pacsial. 
+- Test smell concepts are based on research by Van Deursen et al. ("Refactoring Test Code", 2001) and Meszaros ("xUnit Test Patterns", 2007).
+
+## Contributing
+
+Contributions are welcome! Please feel free to submit a Pull Request.
+
+## License
+
+MIT License - see [LICENSE](LICENSE) for details.