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.
Create configuration
$ echo "[ui]" >> $HGRCPATH
$ echo "interactive=true" >> $HGRCPATH
help qrefresh (no record)
$ echo "[extensions]" >> $HGRCPATH
$ echo "mq=" >> $HGRCPATH
$ hg help qrefresh
hg qrefresh [-I] [-X] [-e] [-m TEXT] [-l FILE] [-s] [FILE]...
update the current patch
If any file patterns are provided, the refreshed patch will contain only
the modifications that match those patterns; the remaining modifications
will remain in the working directory.
If -s/--short is specified, files currently included in the patch will be
refreshed just like matched files and remain in the patch.
If -e/--edit is specified, Mercurial will start your configured editor for
you to enter a message. In case qrefresh fails, you will find a backup of
your message in ".hg/last-message.txt".
hg add/remove/copy/rename work as usual, though you might want to use git-
style patches (-g/--git or [diff] git=1) to track copies and renames. See
the diffs help topic for more information on the git diff format.
Returns 0 on success.
options ([+] can be repeated):
-e --edit invoke editor on commit messages
-g --git use git extended diff format
-s --short refresh only files already in the patch and
specified files
-U --currentuser add/update author field in patch with current user
-u --user USER add/update author field in patch with given user
-D --currentdate add/update date field in patch with current date
-d --date DATE add/update date field in patch with given date
-I --include PATTERN [+] include names matching the given patterns
-X --exclude PATTERN [+] exclude names matching the given patterns
-m --message TEXT use text as commit message
-l --logfile FILE read commit message from file
(some details hidden, use --verbose to show complete help)
help qrefresh (record)
$ echo "record=" >> $HGRCPATH
$ hg help qrefresh
hg qrefresh [-I] [-X] [-e] [-m TEXT] [-l FILE] [-s] [FILE]...
update the current patch
If any file patterns are provided, the refreshed patch will contain only
the modifications that match those patterns; the remaining modifications
will remain in the working directory.
If -s/--short is specified, files currently included in the patch will be
refreshed just like matched files and remain in the patch.
If -e/--edit is specified, Mercurial will start your configured editor for
you to enter a message. In case qrefresh fails, you will find a backup of
your message in ".hg/last-message.txt".
hg add/remove/copy/rename work as usual, though you might want to use git-
style patches (-g/--git or [diff] git=1) to track copies and renames. See
the diffs help topic for more information on the git diff format.
Returns 0 on success.
options ([+] can be repeated):
-e --edit invoke editor on commit messages
-g --git use git extended diff format
-s --short refresh only files already in the patch and
specified files
-U --currentuser add/update author field in patch with current user
-u --user USER add/update author field in patch with given user
-D --currentdate add/update date field in patch with current date
-d --date DATE add/update date field in patch with given date
-I --include PATTERN [+] include names matching the given patterns
-X --exclude PATTERN [+] exclude names matching the given patterns
-m --message TEXT use text as commit message
-l --logfile FILE read commit message from file
-i --interactive interactively select changes to refresh
(some details hidden, use --verbose to show complete help)
$ hg init a
$ cd a
Base commit
$ cat > 1.txt <<EOF
> 1
> 2
> 3
> 4
> 5
> EOF
$ cat > 2.txt <<EOF
> a
> b
> c
> d
> e
> f
> EOF
$ mkdir dir
$ cat > dir/a.txt <<EOF
> hello world
>
> someone
> up
> there
> loves
> me
> EOF
$ hg add 1.txt 2.txt dir/a.txt
$ hg commit -m aaa
$ hg qrecord --config ui.interactive=false patch
abort: running non-interactively, use qnew instead
[10]
$ hg qnew -i --config ui.interactive=false patch
abort: running non-interactively
[10]
$ hg qnew -d '0 0' patch
Changing files
$ sed -e 's/2/2 2/;s/4/4 4/' 1.txt > 1.txt.new
$ sed -e 's/b/b b/' 2.txt > 2.txt.new
$ sed -e 's/hello world/hello world!/' dir/a.txt > dir/a.txt.new
$ mv -f 1.txt.new 1.txt
$ mv -f 2.txt.new 2.txt
$ mv -f dir/a.txt.new dir/a.txt
Whole diff
$ hg diff --nodates
diff -r ed27675cb5df 1.txt
--- a/1.txt
+++ b/1.txt
@@ -1,5 +1,5 @@
1
-2
+2 2
3
-4
+4 4
5
diff -r ed27675cb5df 2.txt
--- a/2.txt
+++ b/2.txt
@@ -1,5 +1,5 @@
a
-b
+b b
c
d
e
diff -r ed27675cb5df dir/a.txt
--- a/dir/a.txt
+++ b/dir/a.txt
@@ -1,4 +1,4 @@
-hello world
+hello world!
someone
up
partial qrefresh
$ hg qrefresh -i --config ui.interactive=false
abort: running non-interactively
[10]
$ hg qrefresh -i -d '0 0' <<EOF
> y
> y
> n
> y
> y
> n
> EOF
diff --git a/1.txt b/1.txt
2 hunks, 2 lines changed
examine changes to '1.txt'?
(enter ? for help) [Ynesfdaq?] y
@@ -1,3 +1,3 @@
1
-2
+2 2
3
record change 1/4 to '1.txt'?
(enter ? for help) [Ynesfdaq?] y
@@ -3,3 +3,3 @@
3
-4
+4 4
5
record change 2/4 to '1.txt'?
(enter ? for help) [Ynesfdaq?] n
diff --git a/2.txt b/2.txt
1 hunks, 1 lines changed
examine changes to '2.txt'?
(enter ? for help) [Ynesfdaq?] y
@@ -1,5 +1,5 @@
a
-b
+b b
c
d
e
record change 3/4 to '2.txt'?
(enter ? for help) [Ynesfdaq?] y
diff --git a/dir/a.txt b/dir/a.txt
1 hunks, 1 lines changed
examine changes to 'dir/a.txt'?
(enter ? for help) [Ynesfdaq?] n
After partial qrefresh 'tip'
$ hg tip -p
changeset: 1:0738af1a8211
tag: patch
tag: qbase
tag: qtip
tag: tip
user: test
date: Thu Jan 01 00:00:00 1970 +0000
summary: [mq]: patch
diff -r 1fd39ab63a33 -r 0738af1a8211 1.txt
--- a/1.txt Thu Jan 01 00:00:00 1970 +0000
+++ b/1.txt Thu Jan 01 00:00:00 1970 +0000
@@ -1,5 +1,5 @@
1
-2
+2 2
3
4
5
diff -r 1fd39ab63a33 -r 0738af1a8211 2.txt
--- a/2.txt Thu Jan 01 00:00:00 1970 +0000
+++ b/2.txt Thu Jan 01 00:00:00 1970 +0000
@@ -1,5 +1,5 @@
a
-b
+b b
c
d
e
After partial qrefresh 'diff'
$ hg diff --nodates
diff -r 0738af1a8211 1.txt
--- a/1.txt
+++ b/1.txt
@@ -1,5 +1,5 @@
1
2 2
3
-4
+4 4
5
diff -r 0738af1a8211 dir/a.txt
--- a/dir/a.txt
+++ b/dir/a.txt
@@ -1,4 +1,4 @@
-hello world
+hello world!
someone
up
qrefresh interactively everything else
$ hg qrefresh -i -d '0 0' <<EOF
> y
> y
> y
> y
> EOF
diff --git a/1.txt b/1.txt
1 hunks, 1 lines changed
examine changes to '1.txt'?
(enter ? for help) [Ynesfdaq?] y
@@ -1,5 +1,5 @@
1
2 2
3
-4
+4 4
5
record change 1/2 to '1.txt'?
(enter ? for help) [Ynesfdaq?] y
diff --git a/dir/a.txt b/dir/a.txt
1 hunks, 1 lines changed
examine changes to 'dir/a.txt'?
(enter ? for help) [Ynesfdaq?] y
@@ -1,4 +1,4 @@
-hello world
+hello world!
someone
up
record change 2/2 to 'dir/a.txt'?
(enter ? for help) [Ynesfdaq?] y
After final qrefresh 'tip'
$ hg tip -p
changeset: 1:2c3f66afeed9
tag: patch
tag: qbase
tag: qtip
tag: tip
user: test
date: Thu Jan 01 00:00:00 1970 +0000
summary: [mq]: patch
diff -r 1fd39ab63a33 -r 2c3f66afeed9 1.txt
--- a/1.txt Thu Jan 01 00:00:00 1970 +0000
+++ b/1.txt Thu Jan 01 00:00:00 1970 +0000
@@ -1,5 +1,5 @@
1
-2
+2 2
3
-4
+4 4
5
diff -r 1fd39ab63a33 -r 2c3f66afeed9 2.txt
--- a/2.txt Thu Jan 01 00:00:00 1970 +0000
+++ b/2.txt Thu Jan 01 00:00:00 1970 +0000
@@ -1,5 +1,5 @@
a
-b
+b b
c
d
e
diff -r 1fd39ab63a33 -r 2c3f66afeed9 dir/a.txt
--- a/dir/a.txt Thu Jan 01 00:00:00 1970 +0000
+++ b/dir/a.txt Thu Jan 01 00:00:00 1970 +0000
@@ -1,4 +1,4 @@
-hello world
+hello world!
someone
up
After qrefresh 'diff'
$ hg diff --nodates
$ cd ..