python_test_helper.h File Reference

PythonTestHelper class declaration — test-frame convenience for MNE-Python cross-validation. More...

#include "utils_global.h"
#include "python_runner.h"
#include <Eigen/Core>
#include <QObject>
#include <QString>
#include <QStringList>
#include <QVariantMap>

Include dependency graph for python_test_helper.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	UTILSLIB::PythonTestHelper

Namespaces
namespace	UTILSLIB
	Shared utilities (I/O helpers, spectral analysis, layout management, warp algorithms).

Macros
#define	GUARD_PYTHON(available, reason)
	Test helper for MNE-Python cross-validation.
#define	GUARD_PYTHON_PACKAGE(helper, packageName)
	Skip (or fail) the current test if a Python package is missing.

Detailed Description

PythonTestHelper class declaration — test-frame convenience for MNE-Python cross-validation.

Author

Christoph Dinh chris.nosp@m.toph.nosp@m..dinh.nosp@m.@mne.nosp@m.-cpp..nosp@m.org

Since

2.2.0

Date

April, 2026

LICENSE

Copyright (C) 2026, Christoph Dinh. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

• Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
• Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
• Neither the name of MNE-CPP authors nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Definition in file python_test_helper.h.

Macro Definition Documentation

GUARD_PYTHON

#define GUARD_PYTHON	(		available,
			reason )

Value:

do { \
    if (!(available)) { \
        if (UTILSLIB::PythonTestHelper::isPythonRequired()) \
            QFAIL(qPrintable(QString("HARD FAIL (MNE_REQUIRE_PYTHON=true): %1").arg(reason))); \
        QSKIP(qPrintable(QString("SKIP: %1").arg(reason))); \
    } \
} while (0)

Test helper for MNE-Python cross-validation.

Test-frame convenience class for cross-validating MNE-CPP outputs against MNE-Python reference implementations.

Usage inside a QTest test:

PythonTestHelper py;
if (!py.isAvailable()) {
    QSKIP("Python/MNE-Python not available");
}
 
// Run a Python snippet that computes a reference value
auto result = py.eval("import mne; print(mne.io.read_info('test.fif')['nchan'])");
QVERIFY(result.success);
QCOMPARE(result.stdOut.trimmed().toInt(), expectedNchan);
 
// Or run a script and parse a numeric output
double pyValue = py.evalDouble("import numpy as np; print(np.linalg.norm(np.ones(10)))");
QVERIFY(qAbs(cppValue - pyValue) < 1e-6);

When MNE-Python is not installed, tests should QSKIP gracefully — but never silently. Use the GUARD_PYTHON / GUARD_PYTHON_PACKAGE macros to ensure skips are intentional and visible. When the environment variable MNE_REQUIRE_PYTHON=true is set (e.g. in CI), those macros QFAIL instead of QSKIP, so a missing Python installation is treated as a hard error.

Skip (or fail) the current test if Python is not available.

Use this macro at the top of any test slot that requires Python.

• If MNE_REQUIRE_PYTHON is not set: QSKIP with a clear message.
• If MNE_REQUIRE_PYTHON=true: QFAIL so the skip is never silent in CI.

Parameters

helper	A PythonTestHelper (or bool) — must support operator bool / isAvailable().
reason	Human-readable reason string.

Definition at line 109 of file python_test_helper.h.

GUARD_PYTHON_PACKAGE

#define GUARD_PYTHON_PACKAGE	(		helper,
			packageName )

Value:

GUARD_PYTHON((helper).hasPackage(packageName), \
             QString("Python package '%1' not available").arg(packageName))

Skip (or fail) the current test if a Python package is missing.

Parameters

helper	A PythonTestHelper instance.
packageName	Package name string (e.g. "sklearn").

Definition at line 124 of file python_test_helper.h.