restore a behaviour which was broken by b2fe479ec33c (more than 3 years ago :-/): correctly propagate unrecognized escape sequences, so that they are handled by later steps; in particular, this allows M-backspace to work again]

Author: antocuni

pyrepl/console.py

@@ -30,6 +30,10 @@ def __init__(self, evt, data, raw=''):
     def __repr__(self):
         return 'Event(%r, %r)' % (self.evt, self.data)
 
+    def __eq__(self, other):
+        return (self.evt == other.evt and
+                self.data == other.data and
+                self.raw == other.raw)
 
 class Console(object):
     """Attributes:

pyrepl/unix_eventqueue.py

@@ -114,11 +114,21 @@ def push(self, char):
                 self.insert(Event('key', k, self.flush_buf()))
                 self.k = self.ck
 
+        elif self.buf and self.buf[0] == 033: # 033 == escape
+            # escape sequence not recognized by our keymap: propagate it
+            # outside so that i can be recognized as an M-... key (see also
+            # the docstring in keymap.py, in particular the line \\E.
+            trace('unrecognized escape sequence, propagating...')
+            self.k = self.ck
+            self.insert(Event('key', '\033', '\033'))
+            for c in self.flush_buf()[1:]:
+                self.push(chr(c))
+
         else:
             try:
                 decoded = bytes(self.buf).decode(self.encoding)
-            except:
+            except UnicodeError:
                 return
-
-            self.insert(Event('key', decoded, self.flush_buf()))
+            else:
+                self.insert(Event('key', decoded, self.flush_buf()))
             self.k = self.ck

testing/test_unix_reader.py

@@ -1,5 +1,5 @@
 from __future__ import unicode_literals
-from pyrepl.unix_eventqueue import EncodedQueue
+from pyrepl.unix_eventqueue import EncodedQueue, Event
 
 
 def test_simple():
@@ -14,3 +14,34 @@ def test_simple():
     assert q.get() is None
     assert event.data == a
     assert event.raw == b
+
+
+def test_propagate_escape():
+    def send(keys):
+        for c in keys:
+            q.push(c)
+
+        events = []
+        while True:
+            event = q.get()
+            if event is None:
+                break
+            events.append(event)
+        return events        
+
+    keymap = {
+        b'\033': {b'U': 'up', b'D': 'down'},
+        b'\xf7': 'backspace',
+    }
+    q = EncodedQueue(keymap, 'utf-8')
+
+    # normal behaviour
+    assert send(b'\033U') == [Event('key', 'up', bytearray(b'\033U'))]
+    assert send(b'\xf7') == [Event('key', 'backspace', bytearray(b'\xf7'))]
+
+    # escape propagation: simulate M-backspace
+    events = send(b'\033\xf7')
+    assert events == [
+        Event('key', '\033', bytearray(b'\033')),
+        Event('key', 'backspace', bytearray(b'\xf7'))
+    ]