procutil: make stream detection in make_line_buffered more correct and strict
In make_line_buffered(), we don’t want to wrap the stream if we know that lines
get flushed to the underlying raw stream already.
Previously, the heuristic was too optimistic. It assumed that any stream which
is not an instance of io.BufferedIOBase doesn’t need wrapping. However, there
are buffered streams that aren’t instances of io.BufferedIOBase, like
Mercurial’s own winstdout.
The new logic is different in two ways:
First, only for the check, if unwraps any combination of WriteAllWrapper and
winstdout.
Second, it skips wrapping the stream only if it is an instance of io.RawIOBase
(or already wrapped). If it is an instance of io.BufferedIOBase, it gets
wrapped. In any other case, the function raises an exception. This ensures
that, if an unknown stream is passed or we add another wrapper in the future,
we don’t wrap the stream if it’s already line buffered or not wrap the stream
if it’s not line buffered. In fact, this was already helpful during development
of this change. Without it, I possibly would have forgot that WriteAllWrapper
needs to be ignored for the check, leading to unnecessary wrapping if stdout is
unbuffered.
The alternative would have been to always wrap unknown streams. However, I
don’t think that anyone would benefit from being less strict. We can expect
streams from the standard library to be subclassing either io.RawIOBase or
io.BufferedIOBase, so running Mercurial in the standard way should not regress
by this change. Py2exe might replace sys.stdout and sys.stderr, but that
currently breaks Mercurial anyway and also these streams don’t claim to be
interactive, so this function is not called for them.
# Helper module to use the Hypothesis tool in tests
#
# Copyright 2015 David R. MacIver
#
# For details see http://hypothesis.readthedocs.org
import os
import sys
import traceback
try:
# hypothesis 2.x
from hypothesis.configuration import set_hypothesis_home_dir
from hypothesis import settings
except ImportError:
# hypothesis 1.x
from hypothesis.settings import set_hypothesis_home_dir
from hypothesis import Settings as settings
import hypothesis.strategies as st
from hypothesis import given
# hypothesis store data regarding generate example and code
set_hypothesis_home_dir(os.path.join(os.getenv('TESTTMP'), ".hypothesis"))
def check(*args, **kwargs):
"""decorator to make a function a hypothesis test
Decorated function are run immediately (to be used doctest style)"""
def accept(f):
# Workaround for https://github.com/DRMacIver/hypothesis/issues/206
# Fixed in version 1.13 (released 2015 october 29th)
f.__module__ = '__anon__'
try:
with settings(max_examples=2000):
given(*args, **kwargs)(f)()
except Exception:
traceback.print_exc(file=sys.stdout)
sys.exit(1)
return accept
def roundtrips(data, decode, encode):
"""helper to tests function that must do proper encode/decode roundtripping"""
@given(data)
def testroundtrips(value):
encoded = encode(value)
decoded = decode(encoded)
if decoded != value:
raise ValueError(
"Round trip failed: %s(%r) -> %s(%r) -> %r"
% (encode.__name__, value, decode.__name__, encoded, decoded)
)
try:
testroundtrips()
except Exception:
# heredoc swallow traceback, we work around it
traceback.print_exc(file=sys.stdout)
raise
print("Round trip OK")
# strategy for generating bytestring that might be an issue for Mercurial
bytestrings = (
st.builds(
lambda s, e: s.encode(e),
st.text(),
st.sampled_from(
[
'utf-8',
'utf-16',
]
),
)
) | st.binary()