Added error code exception handling to session class, tests. Updated SFTP error code handling, tests.

Documentation updates, changelog.
Resolves #23

Author: Pan

Changelog.rst

@@ -1,25 +1,25 @@
 Change Log
 =============
 
-0.12.0
+0.11.0
 ++++++++
 
 Changes
 ---------
 
 * Session functions now raise exceptions.
 * Channel functions now raise specific exceptions.
-* Added exceptions for all known libssh2 error codes.
+* SCP errors now raise exceptions.
+* SFTP open handle errors now raise exceptions.
+* Added raising exceptions for all known libssh2 error codes.
 * Added ``ssh2.utils.handle_error_codes`` function for raising appropriate exception from error code.
+* Added file types to ``ssh2.sftp``.
 
-0.11.0
-+++++++
+Fixes
+------
 
-Changes
---------
+* Double de-allocation crash on objects being garbage collected in some rare cases.
 
-* SCP errors now raise exceptions.
-* SFTP open handle errors now raise exceptions.
 
 0.10.0
 ++++++++

ssh2/channel.c

@@ -45,6 +45,7 @@ cdef class Channel:
 
     @property
     def session(self):
+        """Originating session."""
         return self._session
 
     def pty(self, term="vt100"):

ssh2/channel.pyx

@@ -347,9 +347,8 @@ cdef class Session:
             channel = c_ssh2.libssh2_channel_open_session(
                 self._session)
         if channel is NULL:
-            handle_error_codes(c_ssh2.libssh2_session_last_errno(
+            return handle_error_codes(c_ssh2.libssh2_session_last_errno(
                 self._session))
-            return
         return PyChannel(channel, self)
 
     def direct_tcpip_ex(self, host not None, int port,
@@ -363,9 +362,8 @@ cdef class Session:
             channel = c_ssh2.libssh2_channel_direct_tcpip_ex(
                 self._session, _host, port, _shost, sport)
         if channel is NULL:
-            handle_error_codes(c_ssh2.libssh2_session_last_errno(
+            return handle_error_codes(c_ssh2.libssh2_session_last_errno(
                 self._session))
-            return
         return PyChannel(channel, self)
 
     def direct_tcpip(self, host not None, int port):
@@ -381,9 +379,8 @@ cdef class Session:
             channel = c_ssh2.libssh2_channel_direct_tcpip(
                 self._session, _host, port)
         if channel is NULL:
-            handle_error_codes(c_ssh2.libssh2_session_last_errno(
+            return handle_error_codes(c_ssh2.libssh2_session_last_errno(
                 self._session))
-            return
         return PyChannel(channel, self)
 
     def block_directions(self):
@@ -425,9 +422,8 @@ cdef class Session:
             listener = c_ssh2.libssh2_channel_forward_listen(
                 self._session, port)
         if listener is NULL:
-            handle_error_codes(c_ssh2.libssh2_session_last_errno(
+            return handle_error_codes(c_ssh2.libssh2_session_last_errno(
                 self._session))
-            return
         return PyListener(listener, self)
 
     def forward_listen_ex(self, host not None, int port,
@@ -439,9 +435,8 @@ cdef class Session:
             listener = c_ssh2.libssh2_channel_forward_listen_ex(
                 self._session, _host, port, &bound_port, queue_maxsize)
         if listener is NULL:
-            handle_error_codes(c_ssh2.libssh2_session_last_errno(
+            return handle_error_codes(c_ssh2.libssh2_session_last_errno(
                 self._session))
-            return
         return PyListener(listener, self)
 
     def sftp_init(self):
@@ -453,9 +448,8 @@ cdef class Session:
         with nogil:
             _sftp = c_sftp.libssh2_sftp_init(self._session)
         if _sftp is NULL:
-            handle_error_codes(c_ssh2.libssh2_session_last_errno(
+            return handle_error_codes(c_ssh2.libssh2_session_last_errno(
                 self._session))
-            return
         return PySFTP(_sftp, self)
 
     def last_error(self):

ssh2/session.c

@@ -26,3 +26,4 @@ cdef object PySFTP(c_sftp.LIBSSH2_SFTP *sftp, Session session)
 cdef class SFTP:
     cdef c_sftp.LIBSSH2_SFTP *_sftp
     cdef Session _session
+    cdef int _handle_error(self, int errcode, filename) except -1

ssh2/session.pyx

@@ -18,6 +18,17 @@
 """
 SFTP channel class and related SFTP flags.
 
+File types
+------------
+:var LIBSSH2_SFTP_S_IFMT: Type of file mask
+:var LIBSSH2_SFTP_S_IFIFO: Named pipe (fifo)
+:var LIBSSH2_SFTP_S_IFCHR: Character special (character device)
+:var LIBSSH2_SFTP_S_IFDIR: Directory
+:var LIBSSH2_SFTP_S_IFBLK: Block special (block device)
+:var LIBSSH2_SFTP_S_IFREG: Regular file
+:var LIBSSH2_SFTP_S_IFLNK: Symbolic link
+:var LIBSSH2_SFTP_S_IFSOCK: Socket
+
 File transfer flags
 --------------------
 :var LIBSSH2_FXF_READ: File read flag
@@ -53,14 +64,20 @@ ____________
 :var LIBSSH2_SFTP_S_IROTH: Read
 :var LIBSSH2_SFTP_S_IWOTH: Write
 :var LIBSSH2_SFTP_S_IXOTH: Execute
+
+Generic mode masks
+___________________
+
+:var LIBSSH2_SFTP_ST_RDONLY: Read only
+:var LIBSSH2_SFTP_ST_NOSUID: No suid
 """
 
 from libc.stdlib cimport malloc, free
 
 from session cimport Session
 from error_codes cimport _LIBSSH2_ERROR_BUFFER_TOO_SMALL
 from channel cimport Channel, PyChannel
-from utils cimport to_bytes, to_str_len
+from utils cimport to_bytes, to_str_len, handle_error_codes
 from sftp_handle cimport SFTPHandle, PySFTPHandle, SFTPAttributes, SFTPStatVFS
 
 from exceptions import SFTPHandleError, SFTPBufferTooSmall, SFTPIOError
@@ -70,7 +87,23 @@ cimport c_sftp
 
 
 # File types
-# TODO
+
+# Type of file mask
+LIBSSH2_SFTP_S_IFMT = c_sftp.LIBSSH2_SFTP_S_IFMT
+# named pipe (fifo)
+LIBSSH2_SFTP_S_IFIFO = c_sftp.LIBSSH2_SFTP_S_IFIFO
+# character special
+LIBSSH2_SFTP_S_IFCHR = c_sftp.LIBSSH2_SFTP_S_IFCHR
+# directory
+LIBSSH2_SFTP_S_IFDIR = c_sftp.LIBSSH2_SFTP_S_IFDIR
+# block special (block device)
+LIBSSH2_SFTP_S_IFBLK = c_sftp.LIBSSH2_SFTP_S_IFBLK
+# regular
+LIBSSH2_SFTP_S_IFREG = c_sftp.LIBSSH2_SFTP_S_IFREG
+# symbolic link
+LIBSSH2_SFTP_S_IFLNK = c_sftp.LIBSSH2_SFTP_S_IFLNK
+# socket
+LIBSSH2_SFTP_S_IFSOCK = c_sftp.LIBSSH2_SFTP_S_IFSOCK
 
 
 # File Transfer Flags
@@ -84,6 +117,7 @@ LIBSSH2_FXF_EXCL = c_sftp.LIBSSH2_FXF_EXCL
 
 
 # File mode masks
+
 # Read, write, execute/search by owner
 LIBSSH2_SFTP_S_IRWXU = c_sftp.LIBSSH2_SFTP_S_IRWXU
 LIBSSH2_SFTP_S_IRUSR = c_sftp.LIBSSH2_SFTP_S_IRUSR
@@ -100,7 +134,9 @@ LIBSSH2_SFTP_S_IROTH = c_sftp.LIBSSH2_SFTP_S_IROTH
 LIBSSH2_SFTP_S_IWOTH = c_sftp.LIBSSH2_SFTP_S_IWOTH
 LIBSSH2_SFTP_S_IXOTH = c_sftp.LIBSSH2_SFTP_S_IXOTH
 
+# Read only
 LIBSSH2_SFTP_ST_RDONLY = c_sftp.LIBSSH2_SFTP_ST_RDONLY
+# No suid
 LIBSSH2_SFTP_ST_NOSUID = c_sftp.LIBSSH2_SFTP_ST_NOSUID
 
 
@@ -124,13 +160,26 @@ cdef class SFTP:
         with nogil:
             c_sftp.libssh2_sftp_shutdown(self._sftp)
 
+    @property
+    def session(self):
+        """Originating session."""
+        return self._session
+
+    cdef int _handle_error(self, int errcode, path) except -1:
+        if errcode == c_ssh2.LIBSSH2_ERROR_EAGAIN:
+            return errcode
+        raise SFTPHandleError(
+            "Could not open file or directory %s - error code %s - %s", path,
+            errcode, self._session.last_error())
+
     def get_channel(self):
         """Get new channel from the SFTP session"""
         cdef c_ssh2.LIBSSH2_CHANNEL *_channel
         with nogil:
             _channel = c_sftp.libssh2_sftp_get_channel(self._sftp)
         if _channel is NULL:
-            return
+            return handle_error_codes(c_ssh2.libssh2_session_last_errno(
+                self._session._session))
         return PyChannel(_channel, self._session)
 
     def open_ex(self, const char *filename,
@@ -144,9 +193,8 @@ cdef class SFTP:
                 self._sftp, filename, filename_len, flags,
                 mode, open_type)
         if _handle is NULL:
-            raise SFTPHandleError(
-                "Could not open file %s - error code %s - %s", filename,
-                self._session.last_errno(), self._session.last_error())
+            return self._handle_error(c_ssh2.libssh2_session_last_errno(
+                self._session._session), filename)
         handle = PySFTPHandle(_handle, self)
         return handle
 
@@ -191,9 +239,8 @@ cdef class SFTP:
             _handle = c_sftp.libssh2_sftp_open(
                 self._sftp, _filename, flags, mode)
         if _handle is NULL:
-            raise SFTPHandleError(
-                "Could not open file %s - error code %s - %s", filename,
-                self._session.last_errno(), self._session.last_error())
+            return self._handle_error(c_ssh2.libssh2_session_last_errno(
+                self._session._session), filename)
         return PySFTPHandle(_handle, self)
 
     def opendir(self, path not None):
@@ -213,9 +260,8 @@ cdef class SFTP:
         with nogil:
             _handle = c_sftp.libssh2_sftp_opendir(self._sftp, _path)
         if _handle is NULL:
-            raise SFTPHandleError(
-                "Could not open directory %s - error code %s - %s", path,
-                self._session.last_errno(), self._session.last_error())
+            return self._handle_error(c_ssh2.libssh2_session_last_errno(
+                self._session._session), path)
         return PySFTPHandle(_handle, self)
 
     def rename_ex(self, const char *source_filename,

ssh2/sftp.c

@@ -1,9 +1,19 @@
 from .base_test import SSH2TestCase
+
 from ssh2.exceptions import SocketSendError
+from ssh2.session import Session
+from ssh2.channel import Channel
 
 
 class ChannelTestCase(SSH2TestCase):
 
+    def test_init(self):
+        self.assertEqual(self._auth(), 0)
+        chan = self.session.open_session()
+        self.assertIsInstance(chan, Channel)
+        self.assertIsInstance(chan.session, Session)
+        self.assertEqual(chan.session, self.session)
+
     def test_execute(self):
         self.assertEqual(self._auth(), 0)
         chan = self.session.open_session()