ec3po: log with %r rather than %s for most areas

Mainly, this is about data and oobm coming through and logging it
through repr (%r) for two reasons:
- it handles formatting with ticks automatically
- in py3 it can help highlight where strings are used rather than byte
arrays

BUG=b:173654272
BRANCH=None
TEST=sudo servod -b scarlet
// servod startup turns off the timestamps for CPU uarts, exhibiting
this path

Change-Id: I7954930b658afb5b41fe8915144005d2552f3ad8
Signed-off-by: Ruben Rodriguez Buchillon <coconutruben@chromium.org>
Reviewed-on: https://chromium-review.googlesource.com/c/chromiumos/platform/ec/+/2576141
Reviewed-by: Matthew Blecker <matthewb@chromium.org>

1 files changed, 12 insertions, 12 deletions

diff --git a/util/ec3po/console.py b/util/ec3po/console.py
index 5974aaa014..290ca214ac 100755
--- a/util/ec3po/console.py
+++ b/util/ec3po/console.py
@@ -200,12 +200,12 @@ class Console(object):
     string.append('input_buffer_pos: %d' % self.input_buffer_pos)
     string.append('esc_state: %d' % self.esc_state)
     string.append('line_limit: %d' % self.line_limit)
-    string.append('history: [\'' + '%s' % repr(self.history) + '\']')
+    string.append('history: %r' % self.history)
     string.append('history_pos: %d' % self.history_pos)
-    string.append('prompt: \'%s\'' % self.prompt)
-    string.append('partial_cmd: \'%s\''% self.partial_cmd)
-    string.append('interrogation_mode: \'%s\'' % self.interrogation_mode)
-    string.append('look_buffer: \'%s\'' % self.look_buffer)
+    string.append('prompt: %r' % self.prompt)
+    string.append('partial_cmd: %r'% self.partial_cmd)
+    string.append('interrogation_mode: %r' % self.interrogation_mode)
+    string.append('look_buffer: %r' % self.look_buffer)
     return '\n'.join(string)
 
   def LogConsoleOutput(self, data):
@@ -289,7 +289,7 @@ class Console(object):
 
     # Save the text entered on the console if any.
     if self.history_pos == len(self.history)-1:
-      self.logger.debug('saving partial_cmd: \'%s\'', self.input_buffer)
+      self.logger.debug('saving partial_cmd: %r', self.input_buffer)
       self.partial_cmd = self.input_buffer
 
     # Backspace the line.
@@ -321,7 +321,7 @@ class Console(object):
 
     # Restore the partial cmd.
     if self.history_pos == len(self.history):
-      self.logger.debug('Restoring partial command of \'%s\'', self.partial_cmd)
+      self.logger.debug('Restoring partial command of %r', self.partial_cmd)
       # Backspace the line.
       for _ in range(self.input_buffer_pos):
         self.SendBackspace()
@@ -522,7 +522,7 @@ class Console(object):
     response = ''
     if self.dbg_pipe.poll(self.interrogation_timeout):
       response = self.dbg_pipe.recv()
-      self.logger.debug('response: \'%s\'', binascii.hexlify(response))
+      self.logger.debug('response: %r', binascii.hexlify(response))
     else:
       self.logger.debug('Timed out waiting for EC_ACK')
 
@@ -576,7 +576,7 @@ class Console(object):
         self.logger.debug('End OOBM command.')
         if self.pending_oobm_cmd:
           self.oobm_queue.put(self.pending_oobm_cmd)
-          self.logger.debug('Placed \'%s\' into OOBM command queue.',
+          self.logger.debug('Placed %r into OOBM command queue.',
                             self.pending_oobm_cmd)
 
         # Reset the state.
@@ -796,7 +796,7 @@ class Console(object):
   def ProcessOOBMQueue(self):
     """Retrieve an item from the OOBM queue and process it."""
     item = self.oobm_queue.get()
-    self.logger.debug('OOBM cmd: %s', item)
+    self.logger.debug('OOBM cmd: %r', item)
     cmd = item.split(b' ')
 
     if cmd[0] == b'loglevel':
@@ -1019,7 +1019,7 @@ def StartLoop(console, command_active, shutdown_pipe=None):
           else:
             # Write it to the user console.
             if console.raw_debug:
-              console.logger.debug('|CMD|-%s->\'%s\'',
+              console.logger.debug('|CMD|-%s->%r',
                                    ('u' if master_connected else '') +
                                    ('i' if command_active.value else ''),
                                    data.strip())
@@ -1040,7 +1040,7 @@ def StartLoop(console, command_active, shutdown_pipe=None):
               console.CheckBufferForEnhancedImage(data)
             # Write it to the user console.
             if len(data) > 1 and console.raw_debug:
-              console.logger.debug('|DBG|-%s->\'%s\'',
+              console.logger.debug('|DBG|-%s->%r',
                                    ('u' if master_connected else '') +
                                    ('i' if command_active.value else ''),
                                    data.strip())