Unverified Commit 65abd100 authored by Jelle Zijlstra's avatar Jelle Zijlstra Committed by GitHub
Browse files

add context manager to temporarily change the cwd (#2377)

Commit history before merge:

* add context manager to temporarily change the cwd
* Iterator, not Iterable
parent 4dd100bf
Loading
Loading
Loading
Loading
+3 −14
Changes for tests/test_black.py: 3 added lines, 14 removed lines.
Original line number Diff line number Diff line
@@ -44,6 +44,7 @@
# Import other test classes
from tests.util import (
    THIS_DIR,
    change_directory,
    read_data,
    DETERMINISTIC_HEADER,
    BlackBaseTestCase,
@@ -2009,17 +2010,12 @@ def test_bpo_33660_workaround(self) -> None:
            return

        # https://bugs.python.org/issue33660

        old_cwd = Path.cwd()
        try:
        root = Path("/")
            os.chdir(str(root))
        with change_directory(root):
            path = Path("workspace") / "project"
            report = black.Report(verbose=True)
            normalized_path = black.normalize_path_maybe_ignore(path, root, report)
            self.assertEqual(normalized_path, "workspace/project")
        finally:
            os.chdir(str(old_cwd))

    def test_newline_comment_interaction(self) -> None:
        source = "class A:\\\r\n# type: ignore\n pass\n"
@@ -2170,10 +2166,6 @@ def test_code_option_config(self) -> None:
        Test that the code option finds the pyproject.toml in the current directory.
        """
        with patch.object(black, "parse_pyproject_toml", return_value={}) as parse:
            # Make sure we are in the project root with the pyproject file
            if not Path("tests").exists():
                os.chdir("..")

            args = ["--code", "print"]
            CliRunner().invoke(black.main, args)

@@ -2192,10 +2184,7 @@ def test_code_option_parent_config(self) -> None:
        Test that the code option finds the pyproject.toml in the parent directory.
        """
        with patch.object(black, "parse_pyproject_toml", return_value={}) as parse:
            # Make sure we are in the tests directory
            if Path("tests").exists():
                os.chdir("tests")

            with change_directory(Path("tests")):
                args = ["--code", "print"]
                CliRunner().invoke(black.main, args)

+13 −1
Changes for tests/util.py: 13 added lines, 1 removed line.
Original line number Diff line number Diff line
import os
import unittest
from pathlib import Path
from typing import List, Tuple, Any
from typing import Iterator, List, Tuple, Any
from contextlib import contextmanager
from functools import partial

import black
@@ -72,3 +73,14 @@ def read_data_from_file(file_name: Path) -> Tuple[str, str]:
        # If there's no output marker, treat the entire file as already pre-formatted.
        _output = _input[:]
    return "".join(_input).strip() + "\n", "".join(_output).strip() + "\n"


@contextmanager
def change_directory(path: Path) -> Iterator[None]:
    """Context manager to temporarily chdir to a different directory."""
    previous_dir = os.getcwd()
    try:
        os.chdir(path)
        yield
    finally:
        os.chdir(previous_dir)