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

  $ hg init

     2

     3

  $ cat > .hg/hgrc <<EOF

     4

  > [extensions]

     5

  > prefixfilter = prefix.py

     6

  > [encode]

     7

  > *.txt = stripprefix: Copyright 2046, The Masters

     8

  > [decode]

     9

  > *.txt = insertprefix: Copyright 2046, The Masters

    10

  > EOF

    11

    12

  $ cat > prefix.py <<EOF

    13

  > from mercurial import error

    14

  > def stripprefix(s, cmd, filename, **kwargs):

    15

  >     header = b'%s\n' % cmd

    16

  >     if s[:len(header)] != header:

    17

  >         raise error.Abort(b'missing header "%s" in %s' % (cmd, filename))

    18

  >     return s[len(header):]

    19

  > def insertprefix(s, cmd):

    20

  >     return b'%s\n%s' % (cmd, s)

    21

  > def reposetup(ui, repo):

    22

  >     repo.adddatafilter(b'stripprefix:', stripprefix)

    23

  >     repo.adddatafilter(b'insertprefix:', insertprefix)

    24

  > EOF

    25

    26

  $ cat > .hgignore <<EOF

    27

  > .hgignore

    28

  > prefix.py

    29

  > prefix.pyc

    30

  > __pycache__/

    31

  > EOF

    32

    33

  $ cat > stuff.txt <<EOF

    34

  > Copyright 2046, The Masters

    35

  > Some stuff to ponder very carefully.

    36

  > EOF

    37

  $ hg add stuff.txt

    38

  $ hg ci -m stuff

    39

    40

Repository data:

    41

    42

  $ hg cat stuff.txt

    43

  Some stuff to ponder very carefully.

    44

    45

Fresh checkout:

    46

    47

  $ rm stuff.txt

    48

  $ hg up -C

    49

  1 files updated, 0 files merged, 0 files removed, 0 files unresolved

    50

  $ cat stuff.txt

    51

  Copyright 2046, The Masters

    52

  Some stuff to ponder very carefully.

    53

  $ echo "Very very carefully." >> stuff.txt

    54

  $ hg stat

    55

  M stuff.txt

    56

    57

  $ echo "Unauthorized material subject to destruction." > morestuff.txt

    58

    59

Problem encoding:

    60

    61

  $ hg add morestuff.txt

    62

  $ hg ci -m morestuff

    63

  abort: missing header "Copyright 2046, The Masters" in morestuff.txt

    64

  [255]

    65

  $ hg stat

    66

  M stuff.txt

    67

  A morestuff.txt