Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/olzhasar/pytest-watcher
Automatically rerun your tests on file modifications
https://github.com/olzhasar/pytest-watcher
pytest python tdd tdd-python test-driven-development testing testing-tools watch watchdog watcher
Last synced: about 2 months ago
JSON representation
Automatically rerun your tests on file modifications
- Host: GitHub
- URL: https://github.com/olzhasar/pytest-watcher
- Owner: olzhasar
- License: mit
- Created: 2021-09-16T20:22:39.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-02-02T16:58:44.000Z (5 months ago)
- Last Synced: 2024-02-02T17:51:25.633Z (5 months ago)
- Topics: pytest, python, tdd, tdd-python, test-driven-development, testing, testing-tools, watch, watchdog, watcher
- Language: Python
- Homepage:
- Size: 635 KB
- Stars: 132
- Watchers: 3
- Forks: 10
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Lists
- awesome-pytest - pytest-watcher - Automatically rerun your tests on file modifications (Plugins)
README
# Welcome to pytest-watcher
[](https://pypi.org/project/pytest-watcher/)
[](https://pypi.org/project/pytest-watcher/)
[](https://github.com/olzhasar/pytest-watcher/blob/master/LICENSE)
## Overview
**pytest-watcher** is a tool to automatically rerun tests (using `pytest` by default) whenever your code changes.
Works on Unix (Linux, MacOS, BSD) and Windows.
Example:
## Table of contents
- [Motivation](#motivation)
- [File Events](#file-events)
- [Installation](#installation)
- [Usage](#usage)
- [Using a different test runner](#using-a-different-test-runner)
- [Watching different patterns](#watching-different-patterns)
- [Delay](#delay)
- [Differences with pytest-watch](#differences-with-pytest-watch)
- [Configuring](#configuring)
- [Compatibility](#compatibility)
- [License](#license)
## Motivation
### Why not general tools
- Easy to use and remember
- Works for most python projects out of the box
- Uses native system monitoring API instead of polling on supported systems (see [watchdog documentation](https://python-watchdog.readthedocs.io/en/stable/installation.html#supported-platforms-and-caveats))
- Listens for new file, delete file, change and move events
- Runs your tests with latest changes in case of post-processing events (see [delay](#delay))
### What about pytest-watch
[pytest-watch](https://github.com/joeyespo/pytest-watch) has been around for a long time and used to address exactly this problem. Unfortunately, pytest-watch is no longer maintained and doesn't work for many users. This project provides an alternative for it.
See also: [Differences with pytest-watch](#differences-with-pytest-watch)
## File events
By default `pytest-watcher` looks for the following events:
- New `*.py` file created
- Existing `*.py` file modified
- Existing `*.py` file deleted
- A `*.py` file moved either from or to the watched path
You can specify alternative file patterns to watch. See [Watching different patterns](#watching-different-patterns)
## Installation
```sh
pip install pytest-watcher
```
## Usage
Specify the path that you want to watch:
```sh
ptw .
```
or
```sh
ptw /home/repos/project
```
`pytest-watcher` will pass any arguments after `` to the test runner (which is `pytest` by default). For example:
```sh
ptw . -x --lf --nf
```
will call `pytest` with the following arguments:
```sh
pytest -x --lf --nf
```
### Using a different test runner
You can specify an alternative test runner using the `--runner` flag:
```sh
ptw . --runner tox
```
### Watching different patterns
You can use the `--patterns` flag to specify file patterns that you want to watch. It accepts a list of Unix-style patterns separated by a comma. The default value is "\*.py"
Example:
```sh
ptw . --patterns '*.py,pyproject.toml'
```
You can also **ignore** certain patterns using the `--ignore-patterns` flag:
```sh
ptw . --ignore-patterns 'settings.py,db.py'
```
### Delay
`pytest-watcher` uses a short delay (0.2 seconds by default) before triggering the actual test run. The main motivation for this is post-processors that can run after you save the file (for example, `black` plugin in your IDE). This ensures that tests will run with the latest version of your code.
You can control the actual delay value with the `--delay` flag:
```sh
ptw . --delay 0.2
```
To disable the delay altogether, you can set zero as a value:
```sh
ptw . --delay 0
```
### Screen clearing
Use the `--clear` flag to clear the terminal screen before each test run
```sh
ptw . --clear
```
### Differences with `pytest-watch`
Even though this project was inspired by [`pytest-watch`](https://github.com/joeyespo/pytest-watch), it's not a fork of it. Therefore, there are **differences** in behavior:
- `pytest-watcher` needs you to specify a path to watch as a first argument:
```sh
ptw .
```
- `pytest-watcher` doesn't start tests immediately by default. You can customize this behavior using `--now` flag.
## Configuring
You can configure `pytest-watcher` via `pyproject.toml` file. Here is the default configuration:
```toml
[tool.pytest-watcher]
now = false
clear = true
delay = 0.2
runner = "pytest"
runner_args = []
patterns = ["*.py"]
ignore_patterns = []
```
## Compatibility
The code is compatible with Python versions 3.7+
## License
This project is licensed under the [MIT License](LICENSE).