conftest.py

"""Define some fixtures that can be re-used between tests."""

import shutil
import sys
from pathlib import Path
from shutil import copytree  # pylint: disable=E0611,W4901
from typing import TYPE_CHECKING, Iterator

import pytest

if TYPE_CHECKING:
    from py._path.local import LocalPath


@pytest.fixture(autouse=True)
def tmp_pyprojecttoml(tmpdir: "LocalPath") -> Iterator[Path]:
    """
    Temporarily delete pyproject.toml so it can be recreated during tests.

    Parameters
    ----------
    tmpdir
        Pytest fixture, gives us a temporary directory.
    """
    filename = Path("pyproject.toml")
    temp_file = Path(tmpdir) / filename
    shutil.copy(str(filename), str(temp_file))
    filename.unlink()
    yield filename
    shutil.copy(str(temp_file), str(filename))


@pytest.fixture(autouse=True)
def tmp_setupcfg(tmpdir: "LocalPath") -> Iterator[None]:
    """
    Temporarily delete setup.cfg so it can be recreated during tests.

    Parameters
    ----------
    tmpdir
        Pytest fixture, gives us a temporary directory.
    """
    filename = Path("setup.cfg")
    temp_file = Path(tmpdir) / filename
    shutil.copy(str(filename), str(temp_file))
    filename.unlink()
    yield
    shutil.copy(str(temp_file), str(filename))


@pytest.fixture
def tmp_notebook_for_testing(tmpdir: "LocalPath") -> Iterator[Path]:
    """
    Make temporary copy of test notebook before it's operated on, then revert it.

    Parameters
    ----------
    tmpdir
        Pytest fixture, gives us a temporary directory.

    Yields
    ------
    Path
        Temporary copy of test notebook.
    """
    filename = Path("tests/data") / "notebook_for_testing.ipynb"
    temp_file = Path(tmpdir) / "tmp.ipynb"
    shutil.copy(str(filename), str(temp_file))
    yield filename
    shutil.copy(str(temp_file), str(filename))


@pytest.fixture
def tmp_notebook_with_multiline(tmpdir: "LocalPath") -> Iterator[Path]:
    """
    Make temporary copy of test notebook before it's operated on, then revert it.

    Parameters
    ----------
    tmpdir
        Pytest fixture, gives us a temporary directory.

    Yields
    ------
    Path
        Temporary copy of test notebook.
    """
    filename = Path("tests/data") / "clean_notebook_with_multiline.ipynb"
    temp_file = Path(tmpdir) / "tmp.ipynb"
    shutil.copy(str(filename), str(temp_file))
    yield filename
    shutil.copy(str(temp_file), str(filename))


@pytest.fixture
def tmp_notebook_starting_with_md(tmpdir: "LocalPath") -> Iterator[Path]:
    """
    Make temporary copy of test notebook before it's operated on, then revert it.

    Parameters
    ----------
    tmpdir
        Pytest fixture, gives us a temporary directory.

    Yields
    ------
    Path
        Temporary copy of notebook.
    """
    filename = Path("tests/data") / "notebook_starting_with_md.ipynb"
    temp_file = Path(tmpdir) / "tmp.ipynb"
    shutil.copy(str(filename), str(temp_file))
    yield filename
    shutil.copy(str(temp_file), str(filename))


@pytest.fixture
def tmp_test_data(tmpdir: "LocalPath") -> Iterator[Path]:
    """
    Make temporary copy of test data before it's operated on, then revert it.

    Parameters
    ----------
    tmpdir
        Pytest fixture, gives us a temporary directory.

    Yields
    ------
    Path
        Temporary copy of test data.
    """
    dirname = Path("tests/data")
    temp_dir = Path(tmpdir)
    copytree(str(dirname), str(temp_dir / dirname))
    yield dirname
    copytree(str(temp_dir / dirname), str(dirname), dirs_exist_ok=True)


@pytest.fixture
def tmp_notebook_with_trailing_semicolon(tmpdir: "LocalPath") -> Iterator[Path]:
    """
    Make temporary copy of test notebook before it's operated on, then revert it.

    Parameters
    ----------
    tmpdir
        Pytest fixture, gives us a temporary directory.

    Yields
    ------
    Path
        Temporary copy of notebook.
    """
    filename = Path("tests/data") / "notebook_with_trailing_semicolon.ipynb"
    temp_file = Path(tmpdir) / "tmp.ipynb"
    shutil.copy(str(filename), str(temp_file))
    yield filename
    shutil.copy(str(temp_file), str(filename))


@pytest.fixture
def tmp_notebook_with_indented_magics(tmpdir: "LocalPath") -> Iterator[Path]:
    """
    Make temporary copy of test notebook before it's operated on, then revert it.

    Parameters
    ----------
    tmpdir
        Pytest fixture, gives us a temporary directory.

    Yields
    ------
    Path
        Temporary copy of notebook.
    """
    filename = Path("tests/data") / "notebook_with_indented_magics.ipynb"
    temp_file = Path(tmpdir) / "tmp.ipynb"
    shutil.copy(str(filename), str(temp_file))
    yield filename
    shutil.copy(str(temp_file), str(filename))


@pytest.fixture
def tmp_notebook_for_autoflake(tmpdir: "LocalPath") -> Iterator[Path]:
    """
    Make temporary copy of test notebook before it's operated on, then revert it.

    Parameters
    ----------
    tmpdir
        Pytest fixture, gives us a temporary directory.

    Yields
    ------
    Path
        Temporary copy of notebook.
    """
    filename = Path("tests/data") / "notebook_for_autoflake.ipynb"
    temp_file = Path(tmpdir) / "tmp.ipynb"
    shutil.copy(str(filename), str(temp_file))
    yield filename
    shutil.copy(str(temp_file), str(filename))


@pytest.fixture
def tmp_remove_comments() -> Iterator[None]:
    """Make temporary copy of ``tests/remove_comments.py`` in root dir."""
    temp_file = Path("remove_comments.py")
    shutil.copy(str(Path("tests") / temp_file), str(temp_file))
    yield
    temp_file.unlink()
    if "remove_comments" in sys.modules:
        del sys.modules["remove_comments"]


@pytest.fixture
def tmp_remove_all() -> Iterator[None]:
    """Make temporary copy of ``tests/remove_all.py`` in root dir."""
    temp_file = Path("remove_all.py")
    shutil.copy(str(Path("tests") / temp_file), str(temp_file))
    yield
    temp_file.unlink()
    if "remove_all" in sys.modules:
        del sys.modules["remove_all"]


@pytest.fixture
def tmp_print_6174() -> Iterator[None]:
    """Make temporary copy of ``tests/print_6174.py`` in root dir."""
    temp_file = Path("print_6174.py")
    shutil.copy(str(Path("tests") / temp_file), str(temp_file))
    yield
    temp_file.unlink()