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.
#require pytype py3 slow
$ cd $RUNTESTDIR/..
Many of the individual files that are excluded here confuse pytype
because they do a mix of Python 2 and Python 3 things
conditionally. There's no good way to help it out with that as far as
I can tell, so let's just hide those files from it for now. We should
endeavor to empty this list out over time, as some of these are
probably hiding real problems.
mercurial/bundlerepo.py # no vfs and ui attrs on bundlerepo
mercurial/context.py # many [attribute-error]
mercurial/crecord.py # tons of [attribute-error], [module-attr]
mercurial/debugcommands.py # [wrong-arg-types]
mercurial/dispatch.py # initstdio: No attribute ... on TextIO [attribute-error]
mercurial/exchange.py # [attribute-error]
mercurial/hgweb/hgweb_mod.py # [attribute-error], [name-error], [wrong-arg-types]
mercurial/hgweb/server.py # [attribute-error], [name-error], [module-attr]
mercurial/hgweb/wsgicgi.py # confused values in os.environ
mercurial/httppeer.py # [attribute-error], [wrong-arg-types]
mercurial/interfaces # No attribute 'capabilities' on peer [attribute-error]
mercurial/keepalive.py # [attribute-error]
mercurial/localrepo.py # [attribute-error]
mercurial/manifest.py # [unsupported-operands], [wrong-arg-types]
mercurial/minirst.py # [unsupported-operands], [attribute-error]
mercurial/pure/osutil.py # [invalid-typevar], [not-callable]
mercurial/pure/parsers.py # [attribute-error]
mercurial/repoview.py # [attribute-error]
mercurial/testing/storage.py # tons of [attribute-error]
mercurial/ui.py # [attribute-error], [wrong-arg-types]
mercurial/unionrepo.py # ui, svfs, unfiltered [attribute-error]
mercurial/win32.py # [not-callable]
mercurial/wireprotoframing.py # [unsupported-operands], [attribute-error], [import-error]
mercurial/wireprotov1peer.py # [attribute-error]
mercurial/wireprotov1server.py # BUG?: BundleValueError handler accesses subclass's attrs
TODO: use --no-cache on test server? Caching the files locally helps during
development, but may be a hinderance for CI testing.
$ pytype -V 3.7 --keep-going --jobs auto mercurial \
> -x mercurial/bundlerepo.py \
> -x mercurial/context.py \
> -x mercurial/crecord.py \
> -x mercurial/debugcommands.py \
> -x mercurial/dispatch.py \
> -x mercurial/exchange.py \
> -x mercurial/hgweb/hgweb_mod.py \
> -x mercurial/hgweb/server.py \
> -x mercurial/hgweb/wsgicgi.py \
> -x mercurial/httppeer.py \
> -x mercurial/interfaces \
> -x mercurial/keepalive.py \
> -x mercurial/localrepo.py \
> -x mercurial/manifest.py \
> -x mercurial/minirst.py \
> -x mercurial/pure/osutil.py \
> -x mercurial/pure/parsers.py \
> -x mercurial/repoview.py \
> -x mercurial/testing/storage.py \
> -x mercurial/thirdparty \
> -x mercurial/ui.py \
> -x mercurial/unionrepo.py \
> -x mercurial/win32.py \
> -x mercurial/wireprotoframing.py \
> -x mercurial/wireprotov1peer.py \
> -x mercurial/wireprotov1server.py \
> > $TESTTMP/pytype-output.txt || cat $TESTTMP/pytype-output.txt
Only show the results on a failure, because the output on success is also
voluminous and variable.