Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bpo-13601: always use line-buffering for sys.stderr #17646

Merged
merged 13 commits into from Jan 1, 2020

Conversation

@jendrikseipp
Copy link
Contributor

jendrikseipp commented Dec 17, 2019

@pitrou

This comment has been minimized.

Copy link
Member

pitrou commented Dec 17, 2019

@pitrou
pitrou approved these changes Dec 17, 2019
Copy link
Member

pitrou left a comment

LGTM, but it would be nice if you could add a test, for example in Lib/test/test_cmd_line.py.

Doc/library/sys.rst Outdated Show resolved Hide resolved
Doc/library/sys.rst Outdated Show resolved Hide resolved
@jendrikseipp

This comment has been minimized.

Copy link
Contributor Author

jendrikseipp commented Dec 19, 2019

Thanks for your comments! I hope my changes address them adequately.

code = f'import os, sys; {buf}.write({txt1!r}); {buf}.write({txt2!r}); os._exit(0)'
rc, out, err = assert_python_ok('-c', code)
self.assertEqual(out, out_ok)
self.assertEqual(err, err_ok)

This comment has been minimized.

Copy link
@vstinner

vstinner Dec 19, 2019

Member

I'm not sure that a functional test is required here to validate manually that buffered are flushed properly. Maybe testing the following attributes are enough?

>>> sys.stdout.write_through, sys.stdout.write_through
(False, False)

What do you think @pitrou?

My worry is that functional tests are more likely to fail and so give me more to work to maintain the CI :-)

This comment has been minimized.

Copy link
@jendrikseipp

jendrikseipp Dec 20, 2019

Author Contributor

I added non-functional tests and removed the functional tests.

Copy link
Member

vstinner left a comment

Thanks for the documentation update!

('sys.stderr.line_buffering', True),
]
for attr, value in cases:
self.assertEqual(get_value(attr), value, f'{attr} is not {value}')

This comment has been minimized.

Copy link
@vstinner

vstinner Dec 20, 2019

Member

I suggest to rewrite the test to run Python a single time rather than 6 times, to make the test faster:

    def test_non_interactive_output_buffering(self):
        code = textwrap.dedent("""
            import sys
            out = sys.stdout
            print(out.isatty(), out.write_through, out.line_buffering)
            err = sys.stderr
            print(err.isatty(), err.write_through, err.line_buffering)
        """)
        args = [sys.executable, '-c', code]
        proc = subprocess.run(args, stdout=subprocess.PIPE,
                              text=True, check=True)
        self.assertEqual(proc.stdout,
                         'False False False\n'
                         'True False True\n')

This comment has been minimized.

Copy link
@jendrikseipp

jendrikseipp Dec 20, 2019

Author Contributor

Good point! I used your code, but added stderr=subprocess.PIPE to ensure that sys.stderr is not a TTY (without this both the old and the new code would pass the test).

@@ -0,0 +1,2 @@
``sys.stderr`` is always line-buffered now, even if ``stderr`` is

This comment has been minimized.

Copy link
@serhiy-storchaka

serhiy-storchaka Dec 21, 2019

Member

Unless it is unbuffered.

This comment has been minimized.

Copy link
@serhiy-storchaka

serhiy-storchaka Dec 21, 2019

Member

This is your first contribution. Please add your name in Misc/ACKS. You can also add "Patch by yourname." here.

This comment has been minimized.

Copy link
@jendrikseipp

jendrikseipp Dec 21, 2019

Author Contributor

Thanks, I added some explanations.

Copy link
Member

vstinner left a comment

LGTM. @serhiy-storchaka, @pitrou: does it look good to you? I let you merge the change.

@pitrou pitrou merged commit 5b90771 into python:master Jan 1, 2020
9 checks passed
9 checks passed
Docs
Details
Windows (x86)
Details
Windows (x64)
Details
macOS
Details
Ubuntu Ubuntu
Details
Azure Pipelines PR #20200101.16 succeeded
Details
bedevere/issue-number Issue number 13601 found
Details
bedevere/news News entry found in Misc/NEWS.d
continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
6 participants
You can’t perform that action at this time.