Updated SFTP readdir to be used in non-blocking mode, added integration test.

Fixed use of SFTP opendir as context manager.
Updated sftp non-blocking read and added non-blocking readdir example.
Updated changelog.

Author: Pan

Changelog.rst

@@ -2,27 +2,31 @@ Change Log
 =============
 
 0.5.0
-------
+++++++
 
 Changes
-_________
+----------
 
-* Implemented SFTP statvfs and SFTP handle fstatvfs methods and integration tests.
+* Implemented SFTP statvfs and SFTP handle fstatvfs methods.
 * Implemented SFTPStatVFS extension class for file system statistics.
 * SFTP read and readdir functions now return size/error code along with data.
 * SFTP handle fstat now returns attributes.
-* Implemented SFTP handle readdir* methods as python generators,
-* SFTP openddir can now be used as a context manager.
+* Implemented SFTP handle readdir* methods as python generators.
 * Block directions function renamed to match libssh2.
 * Example scripts.
 * All session authentication methods now raise ``AuthenticationError`` on failure.
 
+Fixes
+---------
+
+* SFTP readdir functions can now be used in non-blocking mode
+* Use of SFTP openddir via context manager
 
 0.4.0
-------
++++++++++
 
 Changes
-________
+---------
 
 * Implemented SCP send and recv methods, all versions.
 * Conditional compilation of features requiring newer versions of libssh2.
@@ -34,21 +38,21 @@ ________
 
 
 0.3.1
-------
+++++++++++
 
 Changes
-_________
+----------
 
 * Added context manager to SFTP handle
 * Implemented SFTP write, seek, stat, fstat and last_error methods.
 * Implemented SFTPAttribute object creation and de-allocation - added unit test.
 
 
 0.3.0
---------
+++++++++
 
 Changes
-________
+----------
 
 * Updated API
 * Updated session, channel, agent and pkey to accept any string type arguments.

examples/nonblocking_sftp_read.py

@@ -1,6 +1,6 @@
 #!/usr/bin/python
 
-"""Example script for SFTP read"""
+"""Example script for non-blocking SFTP read"""
 
 from __future__ import print_function
 
@@ -62,8 +62,9 @@ def main():
         size, data = fh.read()
     for size, data in fh:
         pass
-    # fh.close()
-    # Handle is closed when object is garbage collected
+    # Handle is also closed when object is garbage collected.
+    # It is safe to close it explicitly as well.
+    fh.close()
     print("Finished file read in %s" % (datetime.now() - now,))
 
 

examples/nonblocking_sftp_readdir.py

@@ -0,0 +1,57 @@
+#!/usr/bin/python
+
+"""Example script for non-blocking SFTP readdir"""
+
+from __future__ import print_function
+
+import argparse
+import socket
+import os
+import pwd
+from datetime import datetime
+
+from ssh2.session import Session
+from ssh2.utils import wait_socket
+from ssh2.error_codes import LIBSSH2_ERROR_EAGAIN
+
+
+USERNAME = pwd.getpwuid(os.geteuid()).pw_name
+
+parser = argparse.ArgumentParser()
+
+
+parser.add_argument('dir', help="Directory to read")
+parser.add_argument('--host', dest='host',
+                    default='localhost',
+                    help='Host to connect to')
+parser.add_argument('--port', dest='port', default=22,
+                    help="Port to connect on", type=int)
+parser.add_argument('-u', dest='user', default=USERNAME,
+                    help="User name to authenticate as")
+
+
+def main():
+    args = parser.parse_args()
+    sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+    sock.connect((args.host, args.port))
+    s = Session()
+    s.handshake(sock)
+    s.agent_auth(args.user)
+    sftp = s.sftp_init()
+    now = datetime.now()
+    print("Starting read for remote dir %s" % (args.dir,))
+    with sftp.opendir(args.dir) as fh:
+        # Can set blocking to false at any point, as long as the
+        # libssh2 operations support running in non-blocking mode.
+        s.set_blocking(False)
+        for size, buf, attrs in fh.readdir():
+            if size == LIBSSH2_ERROR_EAGAIN:
+                print("Would block on readdir, waiting on socket..")
+                wait_socket(sock, s)
+                continue
+            print(buf)
+    print("Finished read dir in %s" % (datetime.now() - now,))
+
+
+if __name__ == "__main__":
+    main()