Use global Enum class to avoid typing strings

rybarczykj · thomasballinger · commit e1733c5d4f83 · 2020-07-21T19:59:01.000-07:00
- all_logical_lines uses tuples where the second val is "input" or
"output". Using LineTypeTranslator avoids tying strings
diff --git a/bpython/curtsiesfrontend/repl.py b/bpython/curtsiesfrontend/repl.py
@@ -31,6 +31,7 @@
 
 import bpython
 from bpython.repl import Repl as BpythonRepl, SourceNotFound
+from bpython.repl import LineTypeTranslator as LineType
 from bpython.config import (
     Struct,
     loadini,
@@ -396,7 +397,6 @@ def __init__(
         # current line of output - stdout and stdin go here
         self.current_stdouterr_line = ""
 
-
         # this is every line that's been displayed (input and output)
         # as with formatting applied. Logical lines that exceeded the terminal width
         # at the time of output are split across multiple entries in this list.
@@ -408,8 +408,9 @@ def __init__(
         # This is every logical line that's been displayed, both input and output. 
         # Like self.history, lines are unwrapped, uncolored, and without prompt.
         # Entries are tuples, where
-        #   the first element a string of the line
-        #   the second element is one of 2 strings: "input" or "output".
+        #   - the first element the line (string, not fmtsr)
+        #   - the second element is one of 2 global constants: "input" or "output"
+        #     (use LineType.INPUT or LineType.OUTPUT to avoid typing these strings)
         self.all_logical_lines = []
 
         # formatted version of lines in the buffer kept around so we can
@@ -881,10 +882,9 @@ def on_enter(self, new_code=True, reset_rl_history=True):
             self.rl_history.reset()
 
         self.history.append(self.current_line)
-        self.all_logical_lines.append((self.current_line, "input"))
+        self.all_logical_lines.append((self.current_line, LineType.INPUT))
         self.push(self.current_line, insert_into_history=new_code)
 
-
     def on_tab(self, back=False):
         """Do something on tab key
         taken from bpython.cli
@@ -1016,7 +1016,7 @@ def send_session_to_external_editor(self, filename=None):
         """
         for_editor = EDIT_SESSION_HEADER
         for_editor += "\n".join(
-            line[0] if line[1] == "input"
+            line[0] if line[1] == INPUT
             else "### " + line[0] 
             for line in self.all_logical_lines
         )
@@ -1189,9 +1189,7 @@ def push(self, line, insert_into_history=True):
         if c:
             logger.debug("finished - buffer cleared")
             self.cursor_offset = 0
-
             self.display_lines.extend(self.display_buffer_lines)
-            
             self.display_buffer = []
             self.buffer = []
 
@@ -1296,14 +1294,12 @@ def send_to_stdouterr(self, output):
                     [],
                 )
             )
-
             # These can be FmtStrs, but self.all_logical_lines only wants strings
             for line in [self.current_stdouterr_line] + lines[1:-1]:
                 if isinstance(line, FmtStr):
-                    self.all_logical_lines.append((line.s, "output"))
+                    self.all_logical_lines.append((line.s, LineType.OUTPUT))
                 else:
-                    self.all_logical_lines.append((line, "output"))
-
+                    self.all_logical_lines.append((line, LineType.OUTPUT))
 
             self.current_stdouterr_line = lines[-1]
         logger.debug("display_lines: %r", self.display_lines)
@@ -1846,8 +1842,6 @@ def take_back_empty_line(self):
         self.display_lines.pop()
         self.all_logical_lines.pop()
  
-
-
     def prompt_undo(self):
         if self.buffer:
             return self.take_back_buffer_line()
@@ -1865,7 +1859,7 @@ def redo(self):
         if (self.redo_stack):
             temp = self.redo_stack.pop()
             self.history.append(temp)
-            self.all_logical_lines.append((temp, "input"))
+            self.all_logical_lines.append((temp, LineType.INPUT))
             self.push(temp)
         else:
             self.status_bar.message("Nothing to redo.")
@@ -1954,7 +1948,6 @@ def getstdout(self):
         )
         return s
 
-
     def focus_on_subprocess(self, args):
         prev_sigwinch_handler = signal.getsignal(signal.SIGWINCH)
         try:
diff --git a/bpython/repl.py b/bpython/repl.py
@@ -41,6 +41,7 @@
 from itertools import takewhile
 from six import itervalues
 from types import ModuleType
+from enum import Enum
 
 from pygments.token import Token
 
@@ -387,6 +388,11 @@ def file_prompt(self, s):
 class SourceNotFound(Exception):
     """Exception raised when the requested source could not be found."""
 
+class LineTypeTranslator(Enum):
+    """ Used when adding a tuple to all_logical_lines, to get input / output values
+    having to actually type/know the strings """
+    INPUT = "input"
+    OUTPUT = "output"
 
 class Repl(object):
     """Implements the necessary guff for a Python-repl-alike interface
@@ -821,11 +827,9 @@ def formatforfile(self, session_ouput):
         output lines."""
 
         def process():
-            for line in session_ouput.split("\n"):
-                if line.startswith(self.ps1):
-                    yield line[len(self.ps1) :]
-                elif line.startswith(self.ps2):
-                    yield line[len(self.ps2) :]
+            for line, lineType in self.all_logical_lines:
+                if lineType == LineTypeTranslator.INPUT:
+                    yield line
                 elif line.rstrip():
                     yield "# OUT: %s" % (line,)
 
diff --git a/bpython/test/test_curtsies_repl.py b/bpython/test/test_curtsies_repl.py
@@ -13,6 +13,7 @@
 from bpython.curtsiesfrontend import repl as curtsiesrepl
 from bpython.curtsiesfrontend import interpreter
 from bpython.curtsiesfrontend import events as bpythonevents
+from bpython.repl import LineTypeTranslator as LineType
 from bpython import autocomplete
 from bpython import config
 from bpython import args
@@ -79,7 +80,7 @@ def test_external_communication_encoding(self):
         with captured_output():
             self.repl.display_lines.append('>>> "åß∂ƒ"')
             self.repl.history.append('"åß∂ƒ"')
-            self.repl.all_logical_lines.append(('"åß∂ƒ"',"input"))
+            self.repl.all_logical_lines.append(('"åß∂ƒ"', LineType.INPUT))
             self.repl.send_session_to_external_editor()
 
     def test_get_last_word(self):
