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

# Support code for event tracing in Mercurial. Lives in demandimport

     2

# so it can also be used in demandimport.

     3

#

     4

# Copyright 2018 Google LLC.

     5

#

     6

# This software may be used and distributed according to the terms of the

     7

# GNU General Public License version 2 or any later version.

     8

     9

import contextlib

    10

import os

    11

    12

_pipe = None

    13

_checked = False

    14

_session = 'none'

    15

    16

    17

def _isactive():

    18

    global _pipe, _session, _checked

    19

    if _pipe is None:

    20

        if _checked:

    21

            return False

    22

        _checked = True

    23

        if 'HGCATAPULTSERVERPIPE' not in os.environ:

    24

            return False

    25

        _pipe = open(os.environ['HGCATAPULTSERVERPIPE'], 'w', 1)

    26

        _session = os.environ.get('HGCATAPULTSESSION', 'none')

    27

    return True

    28

    29

    30

@contextlib.contextmanager

    31

def log(whencefmt, *whenceargs):

    32

    if not _isactive():

    33

        yield

    34

        return

    35

    whence = whencefmt % whenceargs

    36

    try:

    37

        # Both writes to the pipe are wrapped in try/except to ignore

    38

        # errors, as we can see mysterious errors in here if the pager

    39

        # is active. Presumably other conditions could trigger

    40

        # problems too.

    41

        try:

    42

            _pipe.write('START %s %s\n' % (_session, whence))

    43

        except IOError:

    44

            pass

    45

        yield

    46

    finally:

    47

        try:

    48

            _pipe.write('END %s %s\n' % (_session, whence))

    49

        except IOError:

    50

            pass

    51

    52

    53

def counter(label, amount, *labelargs):

    54

    if not _isactive():

    55

        return

    56

    l = label % labelargs

    57

    # See above in log() for why this is in a try/except.

    58

    try:

    59

        _pipe.write('COUNTER %s %d %s\n' % (_session, amount, l))

    60

    except IOError:

    61

        pass