File: _testing.py

package info (click to toggle)
python-mne 1.9.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 131,492 kB
  • sloc: python: 213,302; javascript: 12,910; sh: 447; makefile: 144
file content (77 lines) | stat: -rw-r--r-- 2,038 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
# Authors: The MNE-Python contributors.
# License: BSD-3-Clause
# Copyright the MNE-Python contributors.

from functools import partial

from ...utils import get_config, verbose
from ..utils import (
    _data_path_doc,
    _download_mne_dataset,
    _get_version,
    _version_doc,
    has_dataset,
)

has_testing_data = partial(has_dataset, name="testing")


@verbose
def data_path(
    path=None, force_update=False, update_path=True, download=True, *, verbose=None
):  # noqa: D103
    # Make sure we don't do something stupid
    if download and get_config("MNE_SKIP_TESTING_DATASET_TESTS", "false") == "true":
        raise RuntimeError("Cannot download data if skipping is forced")

    return _download_mne_dataset(
        name="testing",
        processor="untar",
        path=path,
        force_update=force_update,
        update_path=update_path,
        download=download,
    )


data_path.__doc__ = _data_path_doc.format(
    name="testing", conf="MNE_DATASETS_TESTING_PATH"
)


def get_version():  # noqa: D103
    return _get_version("testing")


get_version.__doc__ = _version_doc.format(name="testing")


# Allow forcing of testing dataset skip (for Debian tests) using:
# `make test-no-testing-data`
def _skip_testing_data():
    skip_testing = get_config("MNE_SKIP_TESTING_DATASET_TESTS", "false") == "true"
    skip = skip_testing or not has_testing_data()
    return skip


def requires_testing_data(func):
    """Skip testing data test."""
    return _pytest_mark()(func)


def _pytest_param(*args, **kwargs):
    if len(args) == 0:
        args = ("testing_data",)
    import pytest

    # turn anything that uses testing data into an auto-skipper by
    # setting params=[testing._pytest_param()], or by parametrizing functions
    # with testing._pytest_param(whatever)
    kwargs["marks"] = kwargs.get("marks", list()) + [_pytest_mark()]
    return pytest.param(*args, **kwargs)


def _pytest_mark():
    import pytest

    return pytest.mark.skipif(_skip_testing_data(), reason="Requires testing dataset")