Skip to main content

A Python package for managing pytest plugins.

Project description

PyPI version Python Development Status Maintenance PyPI License


pytest-plugins

An advanced pytest plugin designed for Python projects, offering robust features and utilities to enhance the testing workflow.
It includes improved conftest.py fixtures, automated test result reporting, detailed logging, and seamless integration with external tools for a streamlined and efficient testing experience.


🚀 Features

  • better-report: Enhanced test result tracking and structured JSON reporting. generate execution_results.json, test_results.json, and test_report.md under tests/results_output/ directory.
    • flags:
      • --better-report: Enable the better report feature.
      • --output-dir: Specify the output directory for the report files (default is root_project/results_output/).
      • --traceback: Include detailed traceback information in the report.
      • --md-report: Generate a Markdown report of the test results.
      • repo-name: Specify the git repository name for the report.
      • --pr-number: Include a pull request number in the report for better traceability.
      • --mr-number: Include a merge request number in the report for better traceability.
      • --pipeline-number: Include a CI pipeline number in the report for better traceability.
      • --commit: Include the commit hash in the report for better traceability.
      • --add-parameters: Add the test parameters as fields to the test results.
      • --pytest-command: Add the detailed information about the pytest command-line to the "execution_results.json" file
      • --pytest-xfail-strict: Enable strict xfail handling, treating unexpected passes as failures, if set to True "execution status" will be "failed" when there is at least one xpass test
      • --result-each-test: Print the pytest result for each test after its execution
      • --log-collected-tests: Log all collected tests at the start of the test session

  • maxfail-streak: Stop test execution after a configurable number of consecutive failures.
    • flags:
      • --maxfail-streak=N: Stop test execution after N consecutive failures.

  • fail2skip: Change failing tests to skipped, allowing for better test management and reporting.
  • flags:
    • --fail2skip: Enable the fail2skip feature.
      • @pytest.mark.fail2skip: Decorator to mark tests that should be skipped on failure.

  • verbose-param-ids: Enhance test IDs with parameter names for better clarity in pytest reports.
  • flags:
    • --verbose-param-ids: Include parameter names in pytest test IDs (e.g., (param1: value1, param2: value2) instead of (param1-param2))

📦 Installation

pip install pytest-plugins

🔧 Usage

Add the following to your pytest.ini file to enable the plugin features:
[pytest]
addopts =
    --better-report
    --output-dir=logs
    --pr-number=123
;    --mr-number=123
    --fail2skip
    --maxfail-streak=3
    --add-parameters
    --pytest-command
    --verbose-param-ids
    --md-report
    --traceback

🤝 Contributing

If you have a helpful tool, pattern, or improvement to suggest: Fork the repo
Create a new branch
Submit a pull request
I welcome additions that promote clean, productive, and maintainable development.


🙏 Thanks

Thanks for exploring this repository!
Happy coding!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pytest_plugins-2.0.6.tar.gz (13.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pytest_plugins-2.0.6-py3-none-any.whl (15.7 kB view details)

Uploaded Python 3

File details

Details for the file pytest_plugins-2.0.6.tar.gz.

File metadata

  • Download URL: pytest_plugins-2.0.6.tar.gz
  • Upload date:
  • Size: 13.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pytest_plugins-2.0.6.tar.gz
Algorithm Hash digest
SHA256 303b0ab1a31f8a566e52e2d8cad250f9c77d34f145afff3f1d9153327286838b
MD5 68cf625cb56e5a6cf7e3c4b6ec4f703e
BLAKE2b-256 28c903c72cef51f5120def6e51cabcac0715b4c1b212429c6459c75824b609cc

See more details on using hashes here.

File details

Details for the file pytest_plugins-2.0.6-py3-none-any.whl.

File metadata

  • Download URL: pytest_plugins-2.0.6-py3-none-any.whl
  • Upload date:
  • Size: 15.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for pytest_plugins-2.0.6-py3-none-any.whl
Algorithm Hash digest
SHA256 6a9260e48017820355b956d92608cc7f42881cd4663c19f6bb904b2756b0d77e
MD5 a4968030ae0a856ee876959c19fbf2e7
BLAKE2b-256 3c138363c899760fba875889552cc2594b48dbde72e1fc82fccd93b16ee2c078

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page