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.
$ cat > writepatterns.py <<EOF
> import sys
>
> path = sys.argv[1]
> patterns = sys.argv[2:]
>
> fp = open(path, 'wb')
> for pattern in patterns:
> count = int(pattern[0:-1])
> char = pattern[-1].encode('utf8') + b'\n'
> fp.write(char * count)
> fp.close()
> EOF
prepare repo
$ hg init a
$ cd a
These initial lines of Xs were not in the original file used to generate
the patch. So all the patch hunks need to be applied to a constant offset
within this file. If the offset isn't tracked then the hunks can be
applied to the wrong lines of this file.
$ "$PYTHON" ../writepatterns.py a 34X 10A 1B 10A 1C 10A 1B 10A 1D 10A 1B 10A 1E 10A 1B 10A
$ hg commit -Am adda
adding a
This is a cleaner patch generated via diff
In this case it reproduces the problem when
the output of hg export does not
import patch
$ hg import -v -m 'b' -d '2 0' - <<EOF
> --- a/a 2009-12-08 19:26:17.000000000 -0800
> +++ b/a 2009-12-08 19:26:17.000000000 -0800
> @@ -9,7 +9,7 @@
> A
> A
> B
> -A
> +a
> A
> A
> A
> @@ -53,7 +53,7 @@
> A
> A
> B
> -A
> +a
> A
> A
> A
> @@ -75,7 +75,7 @@
> A
> A
> B
> -A
> +a
> A
> A
> A
> EOF
applying patch from stdin
patching file a
Hunk #1 succeeded at 43 (offset 34 lines).
Hunk #2 succeeded at 87 (offset 34 lines).
Hunk #3 succeeded at 109 (offset 34 lines).
committing files:
a
committing manifest
committing changelog
created 189885cecb41
compare imported changes against reference file
$ "$PYTHON" ../writepatterns.py aref 34X 10A 1B 1a 9A 1C 10A 1B 10A 1D 10A 1B 1a 9A 1E 10A 1B 1a 9A
$ diff aref a
$ cd ..