Skip to main content

Manager for test data providing downloads, caching of generated files, and a context for temp directories.

Project description

The datadir-mgr plugin for pytest provides the datadir_mgr fixture which allow test functions to easily download data files and cache generated data files in data directories in a manner that allows for overlaying of results. datadir-mgr is pathlib-based, so complete paths to data files are handled, not just filenames.

The datadir_mgr behaves like a limited dictionary, with datadir_mgr[item] returning a path with the most specific scope (out of global, module, [class], [function] that matches the string or path specified by item. In addition to serving data files already stored in the data directory, the fixture provides five methods useful for adding to the test data stored in the repository:

  • The download method allows downloading data files into data directories, with option MD5 checksum checks, un-gzipping, and a progressbar.

  • The savepath fixture lets an arbitrary path relative to the current working directory to be saved at a particular scope in the data directories.

  • The add_scope method lets one add directories from scopes different from the present request to be added to the search path. This lets the results of previous cached steps to be used in scopes other than global.

  • The in_tmp_dir method creates a context in a temporary directory with a list of request file paths copied in. Optionally, all output file paths can be saved at a particular scope at cleanup with an optional exclusion filter pattern (e.g., for excluding log files). Note that files in directories that begin with test_ or end with _test could be confused with scope directories and cannnot be saved.

  • The paths_from_scope returns a list of all paths to files from a specified scope.

Prerequisites

Python 3.6 or greater is required. This package is tested under Linux and MacOS using Python 3.7.

Installation for Users

Install via pip

pip install pytest-datadir-mgr

For Developers

If you plan to develop datadir_mgr, you’ll need to install the poetry dependency manager. If you haven’t previously installed poetry, execute the command:

curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python

Next, get the master branch from GitHub

git clone https://github.com/legumeinfo/pytest-datadir-mgr.git

Change to the datadir-mgr/ directory and install with poetry:

poetry install -v

Test datadir-mgr with poetry:

poetry run pytest -s

Project Status

Latest Release

Python package

GitHub

GitHub repository

License

License terms

Travis Build

Travis CI

Coverage

Codecov.io test coverage

Code Grade

Codacy.io grade

Dependencies

dependabot dependencies

Issues

Issues reported

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-datadir-mgr-1.1.2.tar.gz (9.4 kB view details)

Uploaded Source

Built Distribution

pytest_datadir_mgr-1.1.2-py3-none-any.whl (7.8 kB view details)

Uploaded Python 3

File details

Details for the file pytest-datadir-mgr-1.1.2.tar.gz.

File metadata

  • Download URL: pytest-datadir-mgr-1.1.2.tar.gz
  • Upload date:
  • Size: 9.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.8.5 Linux/5.8.4-gentoo-x86_64

File hashes

Hashes for pytest-datadir-mgr-1.1.2.tar.gz
Algorithm Hash digest
SHA256 c5712e8a56a5bbc78671a5968e54ea789d0432d8d1877067940ddfa018f0bb9d
MD5 501094b140b3e9c18ca84d0a333ee237
BLAKE2b-256 74589ea37d32312cd1ef1f388b5d300b2483de10f92b247a1429002ca3c15196

See more details on using hashes here.

File details

Details for the file pytest_datadir_mgr-1.1.2-py3-none-any.whl.

File metadata

  • Download URL: pytest_datadir_mgr-1.1.2-py3-none-any.whl
  • Upload date:
  • Size: 7.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.8.5 Linux/5.8.4-gentoo-x86_64

File hashes

Hashes for pytest_datadir_mgr-1.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 c6f048d37883c319ba0c728549f79e87ca587d61e7e64e4a685f64ed11f3b38c
MD5 793477b88db439cb854983ff4cef9f40
BLAKE2b-256 4c4ff559d02f169a87fd8c679b9259a321c0074f49958ffa64fc77d23d6ee176

See more details on using hashes here.

Supported by

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