Source code for respy.conftest

"""This module includes code to configure pytest."""
import os

import numpy as np
import pandas as pd
import pytest

import respy as rp


@pytest.fixture(autouse=True)
def _fresh_directory(tmp_path):
    """Each test is executed in a fresh directory."""
    os.chdir(tmp_path)


@pytest.fixture(autouse=True)
def _patch_doctest_namespace(doctest_namespace):
    """Patch the namespace for doctests.

    This function adds some packages to namespace of every doctest.

    """
    doctest_namespace["np"] = np
    doctest_namespace["pd"] = pd
    doctest_namespace["rp"] = rp


@pytest.fixture(scope="session")
def seed():
    """Create placeholder value for function argument `seed` to be overwritten."""
    return "placeholder value"


def pytest_addoption(parser):
    """Add a custom option to the pytest call.

    Simply use

    .. code-block:: bash

        $ pytest --n-random-tests=n

    to restrict running each random test with `n` increments of the base seed given by
    `pytest-randomly`.

    """
    parser.addoption(
        "--n-random-tests",
        action="store",
        default=5,
        help="Number of runs for each random test with different seeds.",
    )


def pytest_generate_tests(metafunc):
    """Re-run some tests with different seeds by incrementing the base seed.

    The base seed is given by `pytest-randomly` in each session derived from the
    timestamp. You can use five as the seed value with

    .. code-block:: bash

        $ pytest --randomly-seed=5

    Then, tests with certain parameter names are parameterized with incremented seed
    values (5, 6, 7, 8, ...). Existing parameterizations are extended.

    """
    if "model_or_seed" in metafunc.fixturenames:
        argument = "model_or_seed"
    elif "seed" in metafunc.fixturenames:
        argument = "seed"
    else:
        argument = False

    if argument:
        n_random_tests = int(metafunc.config.getoption("--n-random-tests"))
        seeds = [
            metafunc.config.getoption("--randomly-seed", 0) + i
            for i in range(n_random_tests)
        ]

        mark = metafunc.definition.get_closest_marker("parametrize")
        # If a marker exist, extend it with the seeds.
        if mark:
            # Combine the existing parametrize with the seeds.
            extended_mark = pytest.mark.parametrize(argument, mark.args[1] + seeds).mark

            # Replace the old parametrize marker with the extended marker.
            all_marks = metafunc.definition.own_markers
            pos = [
                i for i in range(len(all_marks)) if all_marks[i].name == "parametrize"
            ][0]
            metafunc.definition.own_markers[pos] = extended_mark
        # Else, parametrize with the seeds.
        else:
            metafunc.parametrize(argument, seeds)