pytest-datadir

pytest plugin for manipulating test data directories and files.

Usage

pytest-datadir will look up for a directory with the name of your module or the global 'data' folder. Let's say you have a structure like this:

.
├── data/
│   └── hello.txt
├── other_data/
│   └── other_data.txt
├── test_hello/
│   └── spam.txt
└── test_hello.py

You can access the contents of these files using injected variables datadir (for test_ folder) or shared_datadir (for data folder):

def test_read_global(shared_datadir):
    contents = (shared_datadir / 'hello.txt').read_text()
    assert contents == 'Hello World!\n'

def test_read_module(datadir):
    contents = (datadir / 'spam.txt').read_text()
    assert contents == 'eggs\n'

pytest-datadir will copy the original file to a temporary folder, so changing the file contents won't change the original data file.

Both datadir and shared_datadir fixtures are pathlib.Path objects.

Scoped datadirs

By default datadir and shared_datadir are scoped by function and are actually aliases for function_datadir and function_shared_datadir.

This library provides scoped datadirs and shared_datadirs for:

module
class
function

The benefit of using scoped datadirs is that if your data files are large then each test will need to copy them which can be very slow. Using the scoped datadirs will only copy them once for the scope. Be careful though, as any changes to the directory will be seen by other tests in the scope.

Datadir factory

Similar to how tmp_path_factory works you can also generate temporary datadirs in your code:

def test_read_module(datadir_factory):

    datadir0 = datadir_factory.mkdatadir()
    contents = (datadir0 / 'spam.txt').read_text()
    assert contents == 'eggs\n'
    
    with open((datadir0 / 'spam.txt'), 'w') as wf:
        wf.write('ham\n')

    # with a fresh temp datadir
    datadir1 = datadir_factory.mkdatadir()
    contents = (datadir1 / 'spam.txt').read_text()
    assert contents == 'eggs\n'

Additionally you can also specify which folder you actually want to pull data from beyond the default 'data' dir from the shared_datadir fixture:

def test_factory_module(datadir_factory):

    datadir = datadir_factory.mkdatadir('other_data')
    contents = (datadir / 'other_data.txt').read_text()
    assert contents == 'fun stuff\n'

Releases

Follow these steps to make a new release:

Create a new branch release-X.Y.Z from master.
Update CHANGELOG.rst.
Open a PR.
After it is green and approved, push a new tag in the format X.Y.Z.

Travis will deploy to PyPI automatically.

Afterwards, update the recipe in conda-forge/pytest-datadir-feedstock.

License

MIT.

salotz / pytest-datadir-extras