Skip to main content

Edit the source code of a failed test with `pytest --edit`.

Project description

pytest-edit

PyPI - Version PyPI - Python Version

A simple Pytest plugin for opening editor on the failed tests.

Installation & usage

Install with:

pip install pytest-edit

After installing the plugin, you need to rerun your tests before the plugin will be able to open them for edition.

Usage:

pytest --edit

This will open your $EDITOR at the first line of the last failed test. Not all editors are capable of opening a file at a given line, and not all editors that do are supported by pytest-edit. See below.

You can also specify the test using its index in the shortreport, for example:

pytest --edit=2    # will open the third failed test from the last run.
pytest --edit=-2   # will open the second-to-last failed test from the last run.

Setting the right editor & editor support

Use $EDITOR environment variable to set the editor that should be opened. E.g. you can add export EDITOR=vim line to your .bashrc or .zshrc to set the editor to vim.

If no editor is set, the defaults are vi for POSIX platforms and notepad for Windows.

The plugin tries to be cleaver about the options given to the detected editor. If something is not working properly for you, don't hesitate to open an issue.

If an editor is not supported, the file of the specified test will be opened without specifying the line the editor should place the cursor at.

I have not tested 90% of the editor support - there are at least 3 platforms with tens of different editors. Issues & PRs welcome.

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_edit-1.2.tar.gz (4.5 kB view details)

Uploaded Source

Built Distribution

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

pytest_edit-1.2-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file pytest_edit-1.2.tar.gz.

File metadata

  • Download URL: pytest_edit-1.2.tar.gz
  • Upload date:
  • Size: 4.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for pytest_edit-1.2.tar.gz
Algorithm Hash digest
SHA256 055837f7f7a9284eb7508657777b66ce187a9f2f102daf14512052a4bac25f4c
MD5 8f57d1b98526a56481dc3f006427c6d5
BLAKE2b-256 9406d1c2dff17eea05bc50230ba30d703ec7e218d2f9437c958dd3e95533d5d9

See more details on using hashes here.

File details

Details for the file pytest_edit-1.2-py3-none-any.whl.

File metadata

  • Download URL: pytest_edit-1.2-py3-none-any.whl
  • Upload date:
  • Size: 4.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for pytest_edit-1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 63762c64d63e8ba6c63f70dfde2a81d02f1f237034eddc18333f2673c841c1a1
MD5 a9d5f9e7e4dd55470bceb3c0633b5a11
BLAKE2b-256 4d495bd65c3a24fbda8a67742a13f52fcd936176fe7c4bf4268a5d6a83b86973

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