pre-commit/flake8
1
0
Fork 0
mirror of https://github.com/PyCQA/flake8.git synced 2026-04-09 14:24:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #1382 from PyCQA/stdio-encoding-sadness

Browse source 
write directly to sys.stdout.buffer to avoid windows io encoding
This commit is contained in:
Anthony Sottile 2021-09-08 17:20:53 -04:00 • committed by GitHub
commit eea10665da
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 20 deletions
Download patch file Download diff file Expand all files Collapse all files

3
src/flake8/formatting/base.py
View file

@ -1,6 +1,7 @@
"""The base class and interface for all formatting plugins.""" """The base class and interface for all formatting plugins."""
import argparse import argparse
import os import os
import sys
from typing import IO from typing import IO
from typing import List from typing import List
from typing import Optional from typing import Optional
@ -183,7 +184,7 @@ class BaseFormatter:
if self.output_fd is not None: if self.output_fd is not None:
self.output_fd.write(output + self.newline) self.output_fd.write(output + self.newline)
if self.output_fd is None or self.options.tee: if self.output_fd is None or self.options.tee:
print(output, end=self.newline) sys.stdout.buffer.write(output.encode() + self.newline.encode())
def write(self, line: Optional[str], source: Optional[str]) -> None: def write(self, line: Optional[str], source: Optional[str]) -> None:
"""Write the line either to the output file or stdout. """Write the line either to the output file or stdout.

21
tests/unit/test_base_formatter.py
View file

@ -102,7 +102,7 @@ def test_show_source_updates_physical_line_appropriately(line1, line2, column):
@pytest.mark.parametrize("tee", [False, True]) @pytest.mark.parametrize("tee", [False, True])
def test_write_uses_an_output_file(tee): def test_write_uses_an_output_file(tee, capsys):
"""Verify that we use the output file when it's present.""" """Verify that we use the output file when it's present."""
line = "Something to write" line = "Something to write"
source = "source" source = "source"
@ -111,16 +111,11 @@ def test_write_uses_an_output_file(tee):
formatter = base.BaseFormatter(options(tee=tee)) formatter = base.BaseFormatter(options(tee=tee))
formatter.output_fd = filemock formatter.output_fd = filemock
with mock.patch("flake8.formatting.base.print") as print_func:
formatter.write(line, source) formatter.write(line, source)
if tee: if tee:
assert print_func.called assert capsys.readouterr().out == f"{line}\n{source}\n"
assert print_func.mock_calls == [
mock.call(line, end="\n"),
mock.call(source, end="\n"),
]
else: else:
assert not print_func.called assert capsys.readouterr().out == ""
assert filemock.write.called is True assert filemock.write.called is True
assert filemock.write.call_count == 2 assert filemock.write.call_count == 2
@ -130,8 +125,7 @@ def test_write_uses_an_output_file(tee):
] ]
@mock.patch("flake8.formatting.base.print") def test_write_uses_print(capsys):
def test_write_uses_print(print_function):
"""Verify that we use the print function without an output file.""" """Verify that we use the print function without an output file."""
line = "Something to write" line = "Something to write"
source = "source" source = "source"
@ -139,12 +133,7 @@ def test_write_uses_print(print_function):
formatter = base.BaseFormatter(options()) formatter = base.BaseFormatter(options())
formatter.write(line, source) formatter.write(line, source)
assert print_function.called is True assert capsys.readouterr().out == f"{line}\n{source}\n"
assert print_function.call_count == 2
assert print_function.mock_calls == [
mock.call(line, end="\n"),
mock.call(source, end="\n"),
]
class AfterInitFormatter(base.BaseFormatter): class AfterInitFormatter(base.BaseFormatter):