Updated readme, docstrings. Changes for readability

Author: Dan

README.rst

@@ -46,23 +46,38 @@ Run ``ls`` on two remote hosts in parallel with ``sudo``.
 
 ::
 
-  from __future__ import print_function
-  
+  from pprint import pprint
   from pssh import ParallelSSHClient
+
   hosts = ['myhost1', 'myhost2']
   client = ParallelSSHClient(hosts)
   output = client.run_command('ls -ltrh /tmp/', sudo=True)
-  print(output)
-  {'myhost1': {'exit_code': None, 'stdout': <generator>, 'stderr': <generator>, 'channel': <channel>, 'cmd' : <greenlet>, 'exception' : None},
-   'myhost2': {'exit_code': None, 'stdout': <generator>, 'stderr': <generator>, 'channel': <channel>, 'cmd' : <greenlet>, 'exception' : None}}
+  pprint(output)
+  {'myhost1': 
+        host=myhost1
+	cmd=<Greenlet>
+	channel=<channel>
+	stdout=<generator>
+	stderr=<generator>
+	stdin=<channel>
+	exception=None
+    'myhost2': 
+        host=myhost2
+	cmd=<Greenlet>
+	channel=<channel>
+	stdout=<generator>
+	stderr=<generator>
+	stdin=<channel>
+	exception=None
+  }
 
 Stdout and stderr buffers are available in output. Iterating on them can be used to get output as it becomes available. Iteration ends *only when command has finished*, though it may be interrupted and resumed at any point.
 
 ::
 
   for host in output:
-     for line in output[host]['stdout']:
-         print("Host %s - output: %s" % (host, line))
+     for line in output[host].stdout:
+         pprint("Host %s - output: %s" % (host, line))
   Host myhost1 - output: drwxr-xr-x  6 xxx xxx 4.0K Jan  1 00:00 xxx
   Host myhost1 - output: <..>
   Host myhost2 - output: drwxr-xr-x  6 xxx xxx 4.0K Jan  1 00:00 xxx
@@ -73,7 +88,7 @@ Exit codes become available once stdout/stderr is iterated on or ``client.join(o
 ::
 
   for host in output:
-      print(output[host]['exit_code'])
+      print(output[host].exit_code)
   0
   0
 
@@ -84,9 +99,9 @@ The client's ``join`` function can be used to block and wait for all parallel co
 Similarly, exit codes are available after ``client.join`` is called::
 
   output = client.run_command('exit 0')
-  # Block and gather exit codes. Output variable is updated in-place
+  # Block and gather exit codes. Output is updated in-place
   client.join(output)
-  print(output[client.hosts[0]]['exit_code'])
+  pprint(output[client.hosts[0]].exit_code)
   0
 
 .. note::

pssh/output.py

@@ -1,3 +1,5 @@
+from os import linesep
+
 class HostOutput(dict):
     __slots__ = ('host', 'cmd', 'channel', 'stdout', 'stderr', 'stdin', 'exit_code', 'exception')
 
@@ -25,6 +27,9 @@ def update(self, update_dict):
             object.__setattr__(self, key, update_dict[key])
 
     def __repr__(self):
-        return "host=%s, cmd=%s, channel=%s, stdout=%s, stderr=%s, stdin=%s, \
-exception=%s" % (self.host, self.cmd, self.channel, self.stdout, self.stdin,
-                 self.stderr, self.exception,)
+        return "{linesep}\thost={host}{linesep}" \
+"\tcmd={cmd}{linesep}\tchannel={channel}{linesep}" \
+"\tstdout={stdout}{linesep}\tstderr={stderr}{linesep}\tstdin={stdin}{linesep}\
+\texception={exception}{linesep}".format(
+    host=self.host, cmd=self.cmd, channel=self.channel, stdout=self.stdout,
+    stdin=self.stdin, stderr=self.stderr, exception=self.exception, linesep=linesep,)

pssh/pssh_client.py

@@ -210,7 +210,7 @@ def __init__(self, hosts,
         
         For individual commands the status of channel can be checked ::
         
-          output[host]['channel'].closed
+          output[host].channel.closed
           False
         
         which returns ``True`` if command has finished.
@@ -234,7 +234,7 @@ def __init__(self, hosts,
         
             client.get_exit_codes(output)
                 for host in output:
-                    print(output[host]['exit_code'])
+                    print(output[host].exit_code)
             0
             0
         
@@ -243,7 +243,7 @@ def __init__(self, hosts,
         .. code-block:: python
         
           for host in output:
-              for line in output[host]['stdout']:
+              for line in output[host].stdout:
                   print(line)
           [myhost1]     ls: cannot access /tmp/aasdfasdf: No such file or directory
           [myhost2]     ls: cannot access /tmp/aasdfasdf: No such file or directory
@@ -406,18 +406,22 @@ def run_command(self, *args, **kwargs):
         **Print stdout for each command**
         
         .. code-block:: python
-        
+
+          from __future__ import print_function
+
           for host in output:
-              for line in output[host]['stdout']:
+              for line in output[host].stdout:
                   print(line)
         
         **Get exit codes after command has finished**
 
         .. code-block:: python
-        
+
+          from __future__ import print_function
+
           client.get_exit_codes(output)
           for host in output:
-              print(output[host]['exit_code'])
+              print(output[host].exit_code)
           0
           0
         
@@ -426,9 +430,9 @@ def run_command(self, *args, **kwargs):
         .. code-block:: python
         
           client.join(output)
-          print(output[host]['exit_code'])
+          print(output[host].exit_code)
           0
-          for line in output[host]['stdout']:
+          for line in output[host].stdout:
               print(line)
         
         **Run with sudo**
@@ -448,9 +452,11 @@ def run_command(self, *args, **kwargs):
         `Enabling Host Logger` above.
 
         .. code-block:: python
-        
+
+          from __future__ import print_function
+
           for host in output:
-              stdout = list(output[host]['stdout'])
+              stdout = list(output[host]stdout)
               print("Complete stdout for host %s is %s" % (host, stdout,))
 
         **Command with per-host arguments**
@@ -544,7 +550,7 @@ def run_command(self, *args, **kwargs):
           print("Started %s commands in %s" % (len(cmds), end-start,))
           start = datetime.datetime.now()
           for _output in output:
-              for line in _output[host]['stdout']:
+              for line in _output[host].stdout:
                   print(line)
           end = datetime.datetime.now()
           print("All commands finished in %s" % (end-start,))
@@ -560,12 +566,15 @@ def run_command(self, *args, **kwargs):
         
         ::
         
-          {'myhost1': {'exit_code': exit code if ready else None,
-                       'channel' : SSH channel of command,
-                       'stdout'  : <iterable>,
-                       'stderr'  : <iterable>,
-                       'cmd'     : <greenlet>},
-                       'exception' : None}
+          {'myhost1':
+                host=myhost1
+                exit_code=exit code if ready else None
+                channel=SSH channel of command
+                stdout=<iterable>
+                stderr=<iterable>
+                stdin=<file-like writable channel>
+                cmd=<greenlet>
+                exception=None}
         
         **Do not stop on errors, return per-host exceptions in output**
         
@@ -577,24 +586,26 @@ def run_command(self, *args, **kwargs):
         
         .. code-block:: python
         
-          {'myhost1': {'exit_code': None,
-                       'channel' : None,
-                       'stdout'  : None,
-                       'stderr'  : None,
-                       'cmd'     : None,
-                       'exception' : ConnectionErrorException(
-                           "Error connecting to host '%s:%s' - %s - retry %s/%s",
-                           host, port, 'Connection refused', 3, 3)}}
+          {'myhost1':
+                host=myhost1
+                exit_code=None
+                channel=None
+                stdout=None
+                stderr=None
+                cmd=None
+                exception=ConnectionErrorException(
+                            "Error connecting to host '%s:%s' - %s - retry %s/%s",
+                             host, port, 'Connection refused', 3, 3)}
         
         **Using stdin**
         
         .. code-block:: python
         
           output = client.run_command('read')
-          stdin = output['localhost']['stdin']
+          stdin = output['localhost'].stdin
           stdin.write("writing to stdin\\n")
           stdin.flush()
-          for line in output['localhost']['stdout']:
+          for line in output['localhost'].stdout:
               print(line)
           
           writing to stdin
@@ -682,7 +693,7 @@ def get_output(self, cmd, output):
         
           output = client.get_output()
           for host in output:
-              for line in output[host]['stdout']:
+              for line in output[host].stdout:
                   print(line)
           <stdout>
           # Get exit code after command has finished
@@ -731,7 +742,7 @@ def join(self, output):
         and retrieve exit codes"""
         for host in output:
             output[host].cmd.join()
-            if output[host].channel:
+            if output[host].channel is not None:
                 output[host].channel.recv_exit_status()
         self.get_exit_codes(output)
 
@@ -743,7 +754,7 @@ def finished(self, output):
         """
         for host in output:
             chan = output[host]['channel']
-            if chan and not chan.closed:
+            if chan is not None and not chan.closed:
                 return False
         return True
 
@@ -883,7 +894,7 @@ def _copy_remote_file(self, host, remote_file, local_file, recurse,
                 remote_file, file_w_suffix, recurse=recurse)
 
     def _make_ssh_client(self, host):
-        if not host in self.host_clients or not self.host_clients[host]:
+        if not host in self.host_clients or self.host_clients[host] is None:
             _user, _port, _password, _pkey = self._get_host_config_values(host)
             self.host_clients[host] = SSHClient(
                 host, user=_user, password=_password, port=_port, pkey=_pkey,