Fix encoding warnings with PEP 597 enabled (#398)

Co-authored-by: Bartosz Sławecki <[email protected]>

.github/workflows/tests.yml

@@ -5,6 +5,9 @@ on:
   push:
     branches: [main]
 
+env:
+  PYTHONWARNDEFAULTENCODING: true
+
 jobs:
   Tests:
     name: ${{ matrix.os }} / ${{ matrix.python-version }}

news/398.misc.md

@@ -0,0 +1 @@
+Fix encoding warnings with PEP 597 enabled

src/cleo/ui/exception_trace/frame.py

@@ -62,7 +62,7 @@ def file_content(self) -> str:
             return ""
         if self._filename not in type(self)._content_cache:
             try:
-                file_content = Path(self._filename).read_text()
+                file_content = Path(self._filename).read_text(encoding="utf-8")
             except OSError:
                 file_content = ""
             type(self)._content_cache[self._filename] = file_content

src/cleo/ui/question.py

@@ -265,7 +265,7 @@ def _read_from_input(self, io: IO) -> str:
         return ret.strip()
 
     def _has_stty_available(self) -> bool:
-        with Path(os.devnull).open("w") as devnull:
+        with Path(os.devnull).open("w", encoding="utf-8") as devnull:
             try:
                 exit_code = subprocess.call(["stty"], stdout=devnull, stderr=devnull)
             except Exception:

tests/commands/completion/test_completions_command.py

@@ -48,7 +48,10 @@ def test_bash(mocker: MockerFixture) -> None:
     tester = CommandTester(command)
     tester.execute("bash")
 
-    with open(os.path.join(os.path.dirname(__file__), "fixtures", "bash.txt")) as f:
+    with open(
+        os.path.join(os.path.dirname(__file__), "fixtures", "bash.txt"),
+        encoding="utf-8",
+    ) as f:
         expected = f.read()
 
     assert expected == tester.io.fetch_output().replace("\r\n", "\n")
@@ -70,7 +73,9 @@ def test_zsh(mocker: MockerFixture) -> None:
     tester = CommandTester(command)
     tester.execute("zsh")
 
-    with open(os.path.join(os.path.dirname(__file__), "fixtures", "zsh.txt")) as f:
+    with open(
+        os.path.join(os.path.dirname(__file__), "fixtures", "zsh.txt"), encoding="utf-8"
+    ) as f:
         expected = f.read()
 
     assert expected == tester.io.fetch_output().replace("\r\n", "\n")
@@ -92,7 +97,10 @@ def test_fish(mocker: MockerFixture) -> None:
     tester = CommandTester(command)
     tester.execute("fish")
 
-    with open(os.path.join(os.path.dirname(__file__), "fixtures", "fish.txt")) as f:
+    with open(
+        os.path.join(os.path.dirname(__file__), "fixtures", "fish.txt"),
+        encoding="utf-8",
+    ) as f:
         expected = f.read()
 
     assert expected == tester.io.fetch_output().replace("\r\n", "\n")

tests/test_application.py

@@ -68,7 +68,9 @@ def test_long_version() -> None:
 
 
 def test_help(app: Application) -> None:
-    assert app.help == FIXTURES_PATH.joinpath("application_help.txt").read_text()
+    assert app.help == FIXTURES_PATH.joinpath("application_help.txt").read_text(
+        encoding="utf-8"
+    )
 
 
 def test_all(app: Application) -> None:
@@ -218,10 +220,9 @@ def test_set_catch_exceptions(app: Application, environ: dict[str, str]) -> None
     tester.execute("foo", decorated=False)
 
     assert tester.io.fetch_output() == ""
-    assert (
-        tester.io.fetch_error()
-        == FIXTURES_PATH.joinpath("application_exception1.txt").read_text()
-    )
+    assert tester.io.fetch_error() == FIXTURES_PATH.joinpath(
+        "application_exception1.txt"
+    ).read_text(encoding="utf-8")
 
     app.catch_exceptions(False)
 
@@ -256,42 +257,37 @@ def test_run(app: Application, argv: list[str]) -> None:
 def test_run_runs_the_list_command_without_arguments(tester: ApplicationTester) -> None:
     tester.execute("", decorated=False)
 
-    assert (
-        tester.io.fetch_output()
-        == FIXTURES_PATH.joinpath("application_run1.txt").read_text()
-    )
+    assert tester.io.fetch_output() == FIXTURES_PATH.joinpath(
+        "application_run1.txt"
+    ).read_text(encoding="utf-8")
 
 
 def test_run_runs_help_command_if_required(tester: ApplicationTester) -> None:
     tester.execute("--help", decorated=False)
 
-    assert (
-        tester.io.fetch_output()
-        == FIXTURES_PATH.joinpath("application_run2.txt").read_text()
-    )
+    assert tester.io.fetch_output() == FIXTURES_PATH.joinpath(
+        "application_run2.txt"
+    ).read_text(encoding="utf-8")
 
     tester.execute("-h", decorated=False)
 
-    assert (
-        tester.io.fetch_output()
-        == FIXTURES_PATH.joinpath("application_run2.txt").read_text()
-    )
+    assert tester.io.fetch_output() == FIXTURES_PATH.joinpath(
+        "application_run2.txt"
+    ).read_text(encoding="utf-8")
 
 
 def test_run_runs_help_command_with_command(tester: ApplicationTester) -> None:
     tester.execute("--help list", decorated=False)
 
-    assert (
-        tester.io.fetch_output()
-        == FIXTURES_PATH.joinpath("application_run3.txt").read_text()
-    )
+    assert tester.io.fetch_output() == FIXTURES_PATH.joinpath(
+        "application_run3.txt"
+    ).read_text(encoding="utf-8")
 
     tester.execute("list -h", decorated=False)
 
-    assert (
-        tester.io.fetch_output()
-        == FIXTURES_PATH.joinpath("application_run3.txt").read_text()
-    )
+    assert tester.io.fetch_output() == FIXTURES_PATH.joinpath(
+        "application_run3.txt"
+    ).read_text(encoding="utf-8")
 
 
 def test_run_removes_all_output_if_quiet(tester: ApplicationTester) -> None:
@@ -325,33 +321,29 @@ def test_run_with_verbosity(tester: ApplicationTester) -> None:
 def test_run_with_version(tester: ApplicationTester) -> None:
     tester.execute("--version")
 
-    assert (
-        tester.io.fetch_output()
-        == FIXTURES_PATH.joinpath("application_run4.txt").read_text()
-    )
+    assert tester.io.fetch_output() == FIXTURES_PATH.joinpath(
+        "application_run4.txt"
+    ).read_text(encoding="utf-8")
 
     tester.execute("-V")
 
-    assert (
-        tester.io.fetch_output()
-        == FIXTURES_PATH.joinpath("application_run4.txt").read_text()
-    )
+    assert tester.io.fetch_output() == FIXTURES_PATH.joinpath(
+        "application_run4.txt"
+    ).read_text(encoding="utf-8")
 
 
 def test_run_with_help(tester: ApplicationTester) -> None:
     tester.execute("help --help")
 
-    assert (
-        tester.io.fetch_output()
-        == FIXTURES_PATH.joinpath("application_run5.txt").read_text()
-    )
+    assert tester.io.fetch_output() == FIXTURES_PATH.joinpath(
+        "application_run5.txt"
+    ).read_text(encoding="utf-8")
 
     tester.execute("-h help")
 
-    assert (
-        tester.io.fetch_output()
-        == FIXTURES_PATH.joinpath("application_run5.txt").read_text()
-    )
+    assert tester.io.fetch_output() == FIXTURES_PATH.joinpath(
+        "application_run5.txt"
+    ).read_text(encoding="utf-8")
 
 
 def test_run_with_input() -> None:

tests/ui/exception_trace/test_frame.py

@@ -22,7 +22,7 @@ def test_frame() -> None:
     assert frame.function == "test_frame"
     assert frame.line == "        simple_exception()\n"
 
-    with open(__file__) as f:
+    with open(__file__, encoding="utf-8") as f:
         assert f.read() == frame.file_content
 
     assert repr(frame) == f"<Frame {__file__}, test_frame, 12>"

tests/ui/test_question.py

@@ -15,7 +15,7 @@
 
 
 def has_tty_available() -> bool:
-    with open(os.devnull, "w") as devnull:
+    with open(os.devnull, "w", encoding="utf-8") as devnull:
         exit_code = subprocess.call(["stty", "2"], stdout=devnull, stderr=devnull)
 
     return exit_code == 0