changeset:   91824:0177d8a4e82a
branch:      2.7
parent:      91811:e70ab72286b4
user:        Victor Stinner <victor.stinner@gmail.com>
date:        Thu Jul 24 12:22:24 2014 +0200
files:       Lib/test/test_readline.py Misc/NEWS Modules/readline.c
description:
Issue #19884: readline: Disable the meta modifier key if stdout is not a
terminal to not write the ANSI sequence "\033[1034h" into stdout. This sequence
is used on some terminal (ex: TERM=xterm-256color") to enable support of 8 bit
characters.


diff -r e70ab72286b4 -r 0177d8a4e82a Lib/test/test_readline.py
--- a/Lib/test/test_readline.py	Thu Jul 24 08:08:15 2014 +0300
+++ b/Lib/test/test_readline.py	Thu Jul 24 12:22:24 2014 +0200
@@ -1,17 +1,19 @@
 """
 Very minimal unittests for parts of the readline module.
-
-These tests were added to check that the libedit emulation on OSX and
-the "real" readline have the same interface for history manipulation. That's
-why the tests cover only a small subset of the interface.
 """
+import os
 import unittest
 from test.test_support import run_unittest, import_module
+from test.script_helper import assert_python_ok
 
 # Skip tests if there is no readline module
 readline = import_module('readline')
 
 class TestHistoryManipulation (unittest.TestCase):
+    """These tests were added to check that the libedit emulation on OSX and
+    the "real" readline have the same interface for history manipulation.
+    That's why the tests cover only a small subset of the interface.
+    """
 
     @unittest.skipIf(not hasattr(readline, 'clear_history'),
                      "The history update test cannot be run because the "
@@ -40,8 +42,18 @@
         self.assertEqual(readline.get_current_history_length(), 1)
 
 
+class TestReadline(unittest.TestCase):
+    def test_init(self):
+        # Issue #19884: Ensure that the ANSI sequence "\033[1034h" is not
+        # written into stdout when the readline module is imported and stdout
+        # is redirected to a pipe.
+        rc, stdout, stderr = assert_python_ok('-c', 'import readline',
+                                              TERM='xterm-256color')
+        self.assertEqual(stdout, b'')
+
+
 def test_main():
-    run_unittest(TestHistoryManipulation)
+    run_unittest(TestHistoryManipulation, TestReadline)
 
 if __name__ == "__main__":
     test_main()
diff -r e70ab72286b4 -r 0177d8a4e82a Misc/NEWS
--- a/Misc/NEWS	Thu Jul 24 08:08:15 2014 +0300
+++ b/Misc/NEWS	Thu Jul 24 12:22:24 2014 +0200
@@ -13,6 +13,11 @@
 Library
 -------
 
+- Issue #19884: readline: Disable the meta modifier key if stdout is not
+  a terminal to not write the ANSI sequence "\033[1034h" into stdout. This
+  sequence is used on some terminal (ex: TERM=xterm-256color") to enable
+  support of 8 bit characters.
+
 - Issue #22017: Correct reference counting errror in the initialization of the
   _warnings module.
 
diff -r e70ab72286b4 -r 0177d8a4e82a Modules/readline.c
--- a/Modules/readline.c	Thu Jul 24 08:08:15 2014 +0300
+++ b/Modules/readline.c	Thu Jul 24 12:22:24 2014 +0200
@@ -887,7 +887,7 @@
 #endif
 
 #ifdef __APPLE__
-    /* the libedit readline emulation resets key bindings etc 
+    /* the libedit readline emulation resets key bindings etc
      * when calling rl_initialize.  So call it upfront
      */
     if (using_libedit_emulation)
@@ -932,6 +932,17 @@
 
     begidx = PyInt_FromLong(0L);
     endidx = PyInt_FromLong(0L);
+
+    if (!isatty(STDOUT_FILENO)) {
+        /* Issue #19884: stdout is no a terminal. Disable meta modifier
+           keys to not write the ANSI sequence "\033[1034h" into stdout. On
+           terminals supporting 8 bit characters like TERM=xterm-256color
+           (which is now the default Fedora since Fedora 18), the meta key is
+           used to enable support of 8 bit characters (ANSI sequence
+           "\033[1034h"). */
+        rl_variable_bind ("enable-meta-key", "off");
+    }
+
     /* Initialize (allows .inputrc to override)
      *
      * XXX: A bug in the readline-2.2 library causes a memory leak
@@ -943,7 +954,7 @@
     else
 #endif /* __APPLE__ */
         rl_initialize();
-    
+
     RESTORE_LOCALE(saved_locale)
 }