Remove ENV_PATH on Black action completion (#3759)

[etc/vim.git] / tests / test_black.py

diff --git a/tests/test_black.py b/tests/test_black.py
index abb304a246d83c2ebbe80e596bce926261aa7d3a..3b3ab721c5f21d1671057e07fa7c0a1f43de18ac 100644 (file)
--- a/tests/test_black.py
+++ b/tests/test_black.py
@@ -149,8 +149,7 @@ class BlackTestCase(BlackBaseTestCase):
         tmp_file = Path(black.dump_to_file())
         try:
             self.assertFalse(ff(tmp_file, write_back=black.WriteBack.YES))
         tmp_file = Path(black.dump_to_file())
         try:
             self.assertFalse(ff(tmp_file, write_back=black.WriteBack.YES))

-            with open(tmp_file, encoding="utf8") as f:
-                actual = f.read()
+            actual = tmp_file.read_text(encoding="utf-8")

         finally:
             os.unlink(tmp_file)
         self.assertFormatEqual(expected, actual)
         finally:
             os.unlink(tmp_file)
         self.assertFormatEqual(expected, actual)


@@ -178,7 +177,7 @@ class BlackTestCase(BlackBaseTestCase):
                     ff(tmp_file, mode=mode, write_back=black.WriteBack.YES)
                 )
                 with open(tmp_file, "rb") as f:
                     ff(tmp_file, mode=mode, write_back=black.WriteBack.YES)
                 )
                 with open(tmp_file, "rb") as f:

-                    actual = f.read().decode("utf8")
+                    actual = f.read().decode("utf-8")

             finally:
                 os.unlink(tmp_file)
             self.assertFormatEqual(expected, actual)
             finally:
                 os.unlink(tmp_file)
             self.assertFormatEqual(expected, actual)


@@ -198,7 +197,7 @@ class BlackTestCase(BlackBaseTestCase):
                 f"--line-length={black.DEFAULT_LINE_LENGTH}",
                 f"--config={EMPTY_CONFIG}",
             ],
                 f"--line-length={black.DEFAULT_LINE_LENGTH}",
                 f"--config={EMPTY_CONFIG}",
             ],

-            input=BytesIO(source.encode("utf8")),
+            input=BytesIO(source.encode("utf-8")),

         )
         self.assertEqual(result.exit_code, 0)
         self.assertFormatEqual(expected, result.output)
         )
         self.assertEqual(result.exit_code, 0)
         self.assertFormatEqual(expected, result.output)


@@ -221,7 +220,7 @@ class BlackTestCase(BlackBaseTestCase):
             f"--config={EMPTY_CONFIG}",
         ]
         result = BlackRunner().invoke(
             f"--config={EMPTY_CONFIG}",
         ]
         result = BlackRunner().invoke(

-            black.main, args, input=BytesIO(source.encode("utf8"))
+            black.main, args, input=BytesIO(source.encode("utf-8"))

         )
         self.assertEqual(result.exit_code, 0)
         actual = diff_header.sub(DETERMINISTIC_HEADER, result.output)
         )
         self.assertEqual(result.exit_code, 0)
         actual = diff_header.sub(DETERMINISTIC_HEADER, result.output)


@@ -239,7 +238,7 @@ class BlackTestCase(BlackBaseTestCase):
             f"--config={EMPTY_CONFIG}",
         ]
         result = BlackRunner().invoke(
             f"--config={EMPTY_CONFIG}",
         ]
         result = BlackRunner().invoke(

-            black.main, args, input=BytesIO(source.encode("utf8"))
+            black.main, args, input=BytesIO(source.encode("utf-8"))

         )
         actual = result.output
         # Again, the contents are checked in a different test, so only look for colors.
         )
         actual = result.output
         # Again, the contents are checked in a different test, so only look for colors.


@@ -286,8 +285,7 @@ class BlackTestCase(BlackBaseTestCase):
         tmp_file = Path(black.dump_to_file(source))
         try:
             self.assertTrue(ff(tmp_file, write_back=black.WriteBack.YES))
         tmp_file = Path(black.dump_to_file(source))
         try:
             self.assertTrue(ff(tmp_file, write_back=black.WriteBack.YES))

-            with open(tmp_file, encoding="utf8") as f:
-                actual = f.read()
+            actual = tmp_file.read_text(encoding="utf-8")

         finally:
             os.unlink(tmp_file)
         self.assertFormatEqual(expected, actual)
         finally:
             os.unlink(tmp_file)
         self.assertFormatEqual(expected, actual)


@@ -390,8 +388,7 @@ class BlackTestCase(BlackBaseTestCase):
             black.main, [str(tmp_file), "-x", f"--config={EMPTY_CONFIG}"]
         )
         self.assertEqual(result.exit_code, 0)
             black.main, [str(tmp_file), "-x", f"--config={EMPTY_CONFIG}"]
         )
         self.assertEqual(result.exit_code, 0)

-        with open(tmp_file, encoding="utf8") as f:
-            actual = f.read()
+        actual = tmp_file.read_text(encoding="utf-8")

         self.assertFormatEqual(source, actual)
 
     def test_skip_source_first_line_when_mixing_newlines(self) -> None:
         self.assertFormatEqual(source, actual)
 
     def test_skip_source_first_line_when_mixing_newlines(self) -> None:


@@ -511,6 +508,8 @@ class BlackTestCase(BlackBaseTestCase):
             "pathlib.Path.cwd", return_value=working_directory
         ), patch("pathlib.Path.is_dir", side_effect=mock_n_calls([True])):
             ctx = FakeContext()
             "pathlib.Path.cwd", return_value=working_directory
         ), patch("pathlib.Path.is_dir", side_effect=mock_n_calls([True])):
             ctx = FakeContext()

+            # Note that the root folder (project_root) isn't the folder
+            # named "root" (aka working_directory)

             ctx.obj["root"] = project_root
             report = MagicMock(verbose=True)
             black.get_sources(
             ctx.obj["root"] = project_root
             report = MagicMock(verbose=True)
             black.get_sources(


@@ -530,7 +529,7 @@ class BlackTestCase(BlackBaseTestCase):
             for _, mock_args, _ in report.path_ignored.mock_calls
         ), "A symbolic link was reported."
         report.path_ignored.assert_called_once_with(
             for _, mock_args, _ in report.path_ignored.mock_calls
         ), "A symbolic link was reported."
         report.path_ignored.assert_called_once_with(

-            Path("child", "b.py"), "matches a .gitignore file content"
+            Path("root", "child", "b.py"), "matches a .gitignore file content"

         )
 
     def test_report_verbose(self) -> None:
         )
 
     def test_report_verbose(self) -> None:


@@ -1081,7 +1080,7 @@ class BlackTestCase(BlackBaseTestCase):
                 (workspace / "one.py").resolve(),
                 (workspace / "two.py").resolve(),
             ]:
                 (workspace / "one.py").resolve(),
                 (workspace / "two.py").resolve(),
             ]:

-                f.write_text('print("hello")\n')
+                f.write_text('print("hello")\n', encoding="utf-8")

             self.invokeBlack([str(workspace)])
 
     @event_loop()
             self.invokeBlack([str(workspace)])
 
     @event_loop()


@@ -1118,11 +1117,9 @@ class BlackTestCase(BlackBaseTestCase):
         contents, expected = read_data("miscellaneous", "force_pyi")
         with cache_dir() as workspace:
             path = (workspace / "file.py").resolve()
         contents, expected = read_data("miscellaneous", "force_pyi")
         with cache_dir() as workspace:
             path = (workspace / "file.py").resolve()

-            with open(path, "w") as fh:
-                fh.write(contents)
+            path.write_text(contents, encoding="utf-8")

             self.invokeBlack([str(path), "--pyi"])
             self.invokeBlack([str(path), "--pyi"])

-            with open(path, "r") as fh:
-                actual = fh.read()
+            actual = path.read_text(encoding="utf-8")

             # verify cache with --pyi is separate
             pyi_cache = black.read_cache(pyi_mode)
             self.assertIn(str(path), pyi_cache)
             # verify cache with --pyi is separate
             pyi_cache = black.read_cache(pyi_mode)
             self.assertIn(str(path), pyi_cache)


@@ -1143,12 +1140,10 @@ class BlackTestCase(BlackBaseTestCase):
                 (workspace / "file2.py").resolve(),
             ]
             for path in paths:
                 (workspace / "file2.py").resolve(),
             ]
             for path in paths:

-                with open(path, "w") as fh:
-                    fh.write(contents)
+                path.write_text(contents, encoding="utf-8")

             self.invokeBlack([str(p) for p in paths] + ["--pyi"])
             for path in paths:
             self.invokeBlack([str(p) for p in paths] + ["--pyi"])
             for path in paths:

-                with open(path, "r") as fh:
-                    actual = fh.read()
+                actual = path.read_text(encoding="utf-8")

                 self.assertEqual(actual, expected)
             # verify cache with --pyi is separate
             pyi_cache = black.read_cache(pyi_mode)
                 self.assertEqual(actual, expected)
             # verify cache with --pyi is separate
             pyi_cache = black.read_cache(pyi_mode)


@@ -1160,7 +1155,7 @@ class BlackTestCase(BlackBaseTestCase):
     def test_pipe_force_pyi(self) -> None:
         source, expected = read_data("miscellaneous", "force_pyi")
         result = CliRunner().invoke(
     def test_pipe_force_pyi(self) -> None:
         source, expected = read_data("miscellaneous", "force_pyi")
         result = CliRunner().invoke(

-            black.main, ["-", "-q", "--pyi"], input=BytesIO(source.encode("utf8"))
+            black.main, ["-", "-q", "--pyi"], input=BytesIO(source.encode("utf-8"))

         )
         self.assertEqual(result.exit_code, 0)
         actual = result.output
         )
         self.assertEqual(result.exit_code, 0)
         actual = result.output


@@ -1172,11 +1167,9 @@ class BlackTestCase(BlackBaseTestCase):
         source, expected = read_data("miscellaneous", "force_py36")
         with cache_dir() as workspace:
             path = (workspace / "file.py").resolve()
         source, expected = read_data("miscellaneous", "force_py36")
         with cache_dir() as workspace:
             path = (workspace / "file.py").resolve()

-            with open(path, "w") as fh:
-                fh.write(source)
+            path.write_text(source, encoding="utf-8")

             self.invokeBlack([str(path), *PY36_ARGS])
             self.invokeBlack([str(path), *PY36_ARGS])

-            with open(path, "r") as fh:
-                actual = fh.read()
+            actual = path.read_text(encoding="utf-8")

             # verify cache with --target-version is separate
             py36_cache = black.read_cache(py36_mode)
             self.assertIn(str(path), py36_cache)
             # verify cache with --target-version is separate
             py36_cache = black.read_cache(py36_mode)
             self.assertIn(str(path), py36_cache)


@@ -1195,12 +1188,10 @@ class BlackTestCase(BlackBaseTestCase):
                 (workspace / "file2.py").resolve(),
             ]
             for path in paths:
                 (workspace / "file2.py").resolve(),
             ]
             for path in paths:

-                with open(path, "w") as fh:
-                    fh.write(source)
+                path.write_text(source, encoding="utf-8")

             self.invokeBlack([str(p) for p in paths] + PY36_ARGS)
             for path in paths:
             self.invokeBlack([str(p) for p in paths] + PY36_ARGS)
             for path in paths:

-                with open(path, "r") as fh:
-                    actual = fh.read()
+                actual = path.read_text(encoding="utf-8")

                 self.assertEqual(actual, expected)
             # verify cache with --target-version is separate
             pyi_cache = black.read_cache(py36_mode)
                 self.assertEqual(actual, expected)
             # verify cache with --target-version is separate
             pyi_cache = black.read_cache(py36_mode)


@@ -1214,7 +1205,7 @@ class BlackTestCase(BlackBaseTestCase):
         result = CliRunner().invoke(
             black.main,
             ["-", "-q", "--target-version=py36"],
         result = CliRunner().invoke(
             black.main,
             ["-", "-q", "--target-version=py36"],

-            input=BytesIO(source.encode("utf8")),
+            input=BytesIO(source.encode("utf-8")),

         )
         self.assertEqual(result.exit_code, 0)
         actual = result.output
         )
         self.assertEqual(result.exit_code, 0)
         actual = result.output


@@ -1443,11 +1434,11 @@ class BlackTestCase(BlackBaseTestCase):
             contents = nl.join(["def f(  ):", "    pass"])
             runner = BlackRunner()
             result = runner.invoke(
             contents = nl.join(["def f(  ):", "    pass"])
             runner = BlackRunner()
             result = runner.invoke(

-                black.main, ["-", "--fast"], input=BytesIO(contents.encode("utf8"))
+                black.main, ["-", "--fast"], input=BytesIO(contents.encode("utf-8"))

             )
             self.assertEqual(result.exit_code, 0)
             output = result.stdout_bytes
             )
             self.assertEqual(result.exit_code, 0)
             output = result.stdout_bytes

-            self.assertIn(nl.encode("utf8"), output)
+            self.assertIn(nl.encode("utf-8"), output)

             if nl == "\n":
                 self.assertNotIn(b"\r\n", output)
 
             if nl == "\n":
                 self.assertNotIn(b"\r\n", output)
 


@@ -1466,30 +1457,6 @@ class BlackTestCase(BlackBaseTestCase):
         with self.assertRaises(AssertionError):
             black.assert_equivalent("{}", "None")
 
         with self.assertRaises(AssertionError):
             black.assert_equivalent("{}", "None")
 

-    def test_shhh_click(self) -> None:
-        try:
-            from click import _unicodefun  # type: ignore
-        except ImportError:
-            self.skipTest("Incompatible Click version")
-
-        if not hasattr(_unicodefun, "_verify_python_env"):
-            self.skipTest("Incompatible Click version")
-
-        # First, let's see if Click is crashing with a preferred ASCII charset.
-        with patch("locale.getpreferredencoding") as gpe:
-            gpe.return_value = "ASCII"
-            with self.assertRaises(RuntimeError):
-                _unicodefun._verify_python_env()
-        # Now, let's silence Click...
-        black.patch_click()
-        # ...and confirm it's silent.
-        with patch("locale.getpreferredencoding") as gpe:
-            gpe.return_value = "ASCII"
-            try:
-                _unicodefun._verify_python_env()
-            except RuntimeError as re:
-                self.fail(f"`patch_click()` failed, exception still raised: {re}")
-

     def test_root_logger_not_used_directly(self) -> None:
         def fail(*args: Any, **kwargs: Any) -> None:
             self.fail("Record created with root logger")
     def test_root_logger_not_used_directly(self) -> None:
         def fail(*args: Any, **kwargs: Any) -> None:
             self.fail("Record created with root logger")


@@ -1631,8 +1598,8 @@ class BlackTestCase(BlackBaseTestCase):
             src_pyproject = src_dir / "pyproject.toml"
             src_pyproject.touch()
 
             src_pyproject = src_dir / "pyproject.toml"
             src_pyproject.touch()
 

-            test_toml_file = THIS_DIR / "test.toml"
-            src_pyproject.write_text(test_toml_file.read_text())
+            test_toml_content = (THIS_DIR / "test.toml").read_text(encoding="utf-8")
+            src_pyproject.write_text(test_toml_content, encoding="utf-8")

 
             src_python = src_dir / "foo.py"
             src_python.touch()
 
             src_python = src_dir / "foo.py"
             src_python.touch()


@@ -1985,10 +1952,10 @@ class TestCaching:
         mode = DEFAULT_MODE
         with cache_dir() as workspace:
             cache_file = get_cache_file(mode)
         mode = DEFAULT_MODE
         with cache_dir() as workspace:
             cache_file = get_cache_file(mode)

-            cache_file.write_text("this is not a pickle")
+            cache_file.write_text("this is not a pickle", encoding="utf-8")

             assert black.read_cache(mode) == {}
             src = (workspace / "test.py").resolve()
             assert black.read_cache(mode) == {}
             src = (workspace / "test.py").resolve()

-            src.write_text("print('hello')")
+            src.write_text("print('hello')", encoding="utf-8")

             invokeBlack([str(src)])
             cache = black.read_cache(mode)
             assert str(src) in cache
             invokeBlack([str(src)])
             cache = black.read_cache(mode)
             assert str(src) in cache


@@ -1997,10 +1964,10 @@ class TestCaching:
         mode = DEFAULT_MODE
         with cache_dir() as workspace:
             src = (workspace / "test.py").resolve()
         mode = DEFAULT_MODE
         with cache_dir() as workspace:
             src = (workspace / "test.py").resolve()

-            src.write_text("print('hello')")
+            src.write_text("print('hello')", encoding="utf-8")

             black.write_cache({}, [src], mode)
             invokeBlack([str(src)])
             black.write_cache({}, [src], mode)
             invokeBlack([str(src)])

-            assert src.read_text() == "print('hello')"
+            assert src.read_text(encoding="utf-8") == "print('hello')"

 
     @event_loop()
     def test_cache_multiple_files(self) -> None:
 
     @event_loop()
     def test_cache_multiple_files(self) -> None:


@@ -2009,17 +1976,13 @@ class TestCaching:
             "concurrent.futures.ProcessPoolExecutor", new=ThreadPoolExecutor
         ):
             one = (workspace / "one.py").resolve()
             "concurrent.futures.ProcessPoolExecutor", new=ThreadPoolExecutor
         ):
             one = (workspace / "one.py").resolve()

-            with one.open("w") as fobj:
-                fobj.write("print('hello')")
+            one.write_text("print('hello')", encoding="utf-8")

             two = (workspace / "two.py").resolve()
             two = (workspace / "two.py").resolve()

-            with two.open("w") as fobj:
-                fobj.write("print('hello')")
+            two.write_text("print('hello')", encoding="utf-8")

             black.write_cache({}, [one], mode)
             invokeBlack([str(workspace)])
             black.write_cache({}, [one], mode)
             invokeBlack([str(workspace)])

-            with one.open("r") as fobj:
-                assert fobj.read() == "print('hello')"
-            with two.open("r") as fobj:
-                assert fobj.read() == 'print("hello")\n'
+            assert one.read_text(encoding="utf-8") == "print('hello')"
+            assert two.read_text(encoding="utf-8") == 'print("hello")\n'

             cache = black.read_cache(mode)
             assert str(one) in cache
             assert str(two) in cache
             cache = black.read_cache(mode)
             assert str(one) in cache
             assert str(two) in cache


@@ -2029,8 +1992,7 @@ class TestCaching:
         mode = DEFAULT_MODE
         with cache_dir() as workspace:
             src = (workspace / "test.py").resolve()
         mode = DEFAULT_MODE
         with cache_dir() as workspace:
             src = (workspace / "test.py").resolve()

-            with src.open("w") as fobj:
-                fobj.write("print('hello')")
+            src.write_text("print('hello')", encoding="utf-8")

             with patch("black.read_cache") as read_cache, patch(
                 "black.write_cache"
             ) as write_cache:
             with patch("black.read_cache") as read_cache, patch(
                 "black.write_cache"
             ) as write_cache:


@@ -2049,8 +2011,7 @@ class TestCaching:
         with cache_dir() as workspace:
             for tag in range(0, 4):
                 src = (workspace / f"test{tag}.py").resolve()
         with cache_dir() as workspace:
             for tag in range(0, 4):
                 src = (workspace / f"test{tag}.py").resolve()

-                with src.open("w") as fobj:
-                    fobj.write("print('hello')")
+                src.write_text("print('hello')", encoding="utf-8")

             with patch(
                 "black.concurrency.Manager", wraps=multiprocessing.Manager
             ) as mgr:
             with patch(
                 "black.concurrency.Manager", wraps=multiprocessing.Manager
             ) as mgr:


@@ -2120,11 +2081,9 @@ class TestCaching:
             "concurrent.futures.ProcessPoolExecutor", new=ThreadPoolExecutor
         ):
             failing = (workspace / "failing.py").resolve()
             "concurrent.futures.ProcessPoolExecutor", new=ThreadPoolExecutor
         ):
             failing = (workspace / "failing.py").resolve()

-            with failing.open("w") as fobj:
-                fobj.write("not actually python")
+            failing.write_text("not actually python", encoding="utf-8")

             clean = (workspace / "clean.py").resolve()
             clean = (workspace / "clean.py").resolve()

-            with clean.open("w") as fobj:
-                fobj.write('print("hello")\n')
+            clean.write_text('print("hello")\n', encoding="utf-8")

             invokeBlack([str(workspace)], exit_code=123)
             cache = black.read_cache(mode)
             assert str(failing) not in cache
             invokeBlack([str(workspace)], exit_code=123)
             cache = black.read_cache(mode)
             assert str(failing) not in cache