Simplify stdout flushing.

Author: Mike Stegeman

gateway_addon/adapter.py

@@ -1,8 +1,13 @@
 """High-level Adapter base class implementation."""
 
+import functools
+
 from .addon_manager_proxy import AddonManagerProxy
 
 
+print = functools.partial(print, flush=True)
+
+
 class Adapter:
     """An Adapter represents a way of communicating with a set of devices."""
 
@@ -40,7 +45,7 @@ def close_proxy(self):
 
     def dump(self):
         """Dump the state of the adapter to the log."""
-        print('Adapter:', self.name, '- dump() not implemented', flush=True)
+        print('Adapter:', self.name, '- dump() not implemented')
 
     def get_id(self):
         """
@@ -130,13 +135,11 @@ def start_pairing(self, timeout):
 
         timeout -- Timeout in seconds at which to quit pairing
         """
-        print('Adapter:', self.name, 'id', self.id, 'pairing started',
-              flush=True)
+        print('Adapter:', self.name, 'id', self.id, 'pairing started')
 
     def cancel_pairing(self):
         """Cancel the pairing process."""
-        print('Adapter:', self.name, 'id', self.id, 'pairing cancelled',
-              flush=True)
+        print('Adapter:', self.name, 'id', self.id, 'pairing cancelled')
 
     def remove_thing(self, device_id):
         """
@@ -147,8 +150,7 @@ def remove_thing(self, device_id):
         device = self.get_device(device_id)
         if device:
             print('Adapter:', self.name, 'id', self.id,
-                  'remove_thing(' + device.id + ')',
-                  flush=True)
+                  'remove_thing(' + device.id + ')')
 
     def cancel_remove_thing(self, device_id):
         """
@@ -159,9 +161,8 @@ def cancel_remove_thing(self, device_id):
         device = self.get_device(device_id)
         if device:
             print('Adapter:', self.name, 'id', self.id,
-                  'cancel_remove_thing(' + device.id + ')',
-                  flush=True)
+                  'cancel_remove_thing(' + device.id + ')')
 
     def unload(self):
         """Perform any necessary cleanup before adapter is shut down."""
-        print('Adapter:', self.name, 'unloaded', flush=True)
+        print('Adapter:', self.name, 'unloaded')

gateway_addon/addon_manager_proxy.py

@@ -1,11 +1,14 @@
 """Proxy for sending messages between the Gateway and an add-on."""
 
 from nnpy.errors import NNError
+import functools
 import json
 import threading
 
 from .ipc import IpcClient
 
+print = functools.partial(print, flush=True)
+
 
 class AddonManagerProxy:
     """
@@ -48,7 +51,7 @@ def add_adapter(self, adapter):
         adapter -- the Adapter that was added
         """
         if self.verbose:
-            print('AddonManagerProxy: add_adapter:', adapter.id, flush=True)
+            print('AddonManagerProxy: add_adapter:', adapter.id)
 
         self.adapter = adapter
         self.send('addAdapter', {
@@ -64,8 +67,7 @@ def handle_device_added(self, device):
         device -- the Device that was added
         """
         if self.verbose:
-            print('AddonManagerProxy: handle_device_added:', device.id,
-                  flush=True)
+            print('AddonManagerProxy: handle_device_added:', device.id)
 
         device_dict = device.as_dict()
         device_dict['adapterId'] = device.adapter.id
@@ -78,8 +80,7 @@ def handle_device_removed(self, device):
         device -- the Device that was removed
         """
         if self.verbose:
-            print('AddonManagerProxy: handle_device_removed:', device.id,
-                  flush=True)
+            print('AddonManagerProxy: handle_device_removed:', device.id)
 
         self.send('handleDeviceRemoved', {
             'adapterId': device.adapter.id,
@@ -116,8 +117,7 @@ def send(self, msg_type, data):
                 'data': data,
             }))
         except NNError as e:
-            print('AddonManagerProxy: Failed to send message: {}'.format(e),
-                  flush=True)
+            print('AddonManagerProxy: Failed to send message: {}'.format(e))
 
     def recv(self):
         """Read a message from the IPC socket."""
@@ -126,29 +126,28 @@ def recv(self):
                 msg = self.ipc_client.plugin_socket.recv()
             except NNError as e:
                 print('AddonManagerProxy: Error receiving message from '
-                      'socket: {}'.format(e), flush=True)
+                      'socket: {}'.format(e))
                 break
 
             if self.verbose:
-                print('AddonMangerProxy: recv:', msg, flush=True)
+                print('AddonMangerProxy: recv:', msg)
 
             if not msg:
                 break
 
             if not self.adapter:
                 print('AddonManagerProxy: No adapter added yet, ignoring '
-                      'message.', flush=True)
+                      'message.')
                 continue
 
             try:
                 msg = json.loads(msg)
             except ValueError:
-                print('AddonManagerProxy: Error parsing message as JSON',
-                      flush=True)
+                print('AddonManagerProxy: Error parsing message as JSON')
                 continue
 
             if 'messageType' not in msg:
-                print('AddonManagerProxy: Invalid message', flush=True)
+                print('AddonManagerProxy: Invalid message')
                 continue
 
             msg_type = msg['messageType']
@@ -180,7 +179,7 @@ def unload_fn(proxy):
             # All messages from here on are assumed to require a valid deviceId
             if 'data' not in msg or 'deviceId' not in msg['data']:
                 print('AddonManagerProxy: No deviceId present in message, '
-                      'ignoring.', flush=True)
+                      'ignoring.')
                 continue
 
             device_id = msg['data']['deviceId']
@@ -206,6 +205,12 @@ def set_prop_fn(proxy):
 
     @staticmethod
     def make_thread(target, args=()):
+        """
+        Start up a thread in the background.
+
+        target -- the target function
+        args -- arguments to pass to target
+        """
         t = threading.Thread(target=target, args=args)
         t.daemon = True
         t.start()

gateway_addon/ipc.py

@@ -1,12 +1,15 @@
 """IPC client to communicate with the Gateway."""
 
 from nnpy.errors import NNError
+import functools
 import json
 import nnpy
 
 
 _IPC_BASE = 'ipc:///tmp/'
 
+print = functools.partial(print, flush=True)
+
 
 class IpcClient:
     """IPC client which can communicate between the Gateway and an add-on."""
@@ -23,7 +26,7 @@ def __init__(self, plugin_id, verbose=False):
             self.manager_socket.connect(_IPC_BASE + 'gateway.addonManager')
 
         if verbose:
-            print('IpcClient: Connected to server, registering...', flush=True)
+            print('IpcClient: Connected to server, registering...')
 
         try:
             self.manager_socket.send(json.dumps({
@@ -33,20 +36,17 @@ def __init__(self, plugin_id, verbose=False):
                 }
             }))
         except NNError as e:
-            print('IpcClient: Failed to send message: {}'.format(e),
-                  flush=True)
+            print('IpcClient: Failed to send message: {}'.format(e))
             return
 
         try:
             resp = self.manager_socket.recv()
         except NNError as e:
-            print('IpcClient: Error receiving message: {}'.format(e),
-                  flush=True)
+            print('IpcClient: Error receiving message: {}'.format(e))
             return
 
         if verbose:
-            print('IpcClient: Received manager message: {}'.format(resp),
-                  flush=True)
+            print('IpcClient: Received manager message: {}'.format(resp))
 
         try:
             resp = json.loads(resp)
@@ -59,7 +59,7 @@ def __init__(self, plugin_id, verbose=False):
                 _IPC_BASE + resp['data']['ipcBaseAddr'])
 
             if verbose:
-                print('IpcClient: Registered with PluginServer', flush=True)
+                print('IpcClient: Registered with PluginServer')
         except ValueError:
             print('IpcClient: Unexpected registration reply from gateway: {}'
-                  .format(resp), flush=True)
+                  .format(resp))