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.

     1

#!/usr/bin/env python

     2

     3

import sys

     4

     5

from mercurial import (

     6

    commands,

     7

    localrepo,

     8

    ui as uimod,

     9

)

    10

    11

print_ = print

    12

    13

    14

def print(*args, **kwargs):

    15

    """print() wrapper that flushes stdout buffers to avoid py3 buffer issues

    16

    17

    We could also just write directly to sys.stdout.buffer the way the

    18

    ui object will, but this was easier for porting the test.

    19

    """

    20

    print_(*args, **kwargs)

    21

    sys.stdout.flush()

    22

    23

    24

u = uimod.ui.load()

    25

    26

print('% creating repo')

    27

repo = localrepo.instance(u, b'.', create=True)

    28

    29

f = open('test.py', 'w')

    30

try:

    31

    f.write('foo\n')

    32

finally:

    33

    f.close

    34

    35

print('% add and commit')

    36

commands.add(u, repo, b'test.py')

    37

commands.commit(u, repo, message=b'*')

    38

commands.status(u, repo, clean=True)

    39

    40

    41

print('% change')

    42

f = open('test.py', 'w')

    43

try:

    44

    f.write('bar\n')

    45

finally:

    46

    f.close()

    47

    48

# this would return clean instead of changed before the fix

    49

commands.status(u, repo, clean=True, modified=True)