some __cmp__ and doctest love for socket.address
authorTero Marttila <terom@fixme.fi>
Mon, 17 Aug 2009 20:24:12 +0300
changeset 22 f6e8d5e37998
parent 21 19d212c948e0
child 23 15d8bb96b8d4
some __cmp__ and doctest love for socket.address
qmsk/net/libc.pxd
qmsk/net/py.pxd
qmsk/net/socket/address.pyx
--- a/qmsk/net/libc.pxd	Mon Aug 17 19:40:23 2009 +0300
+++ b/qmsk/net/libc.pxd	Mon Aug 17 20:24:12 2009 +0300
@@ -32,6 +32,7 @@
 cdef extern from "string.h" :
     void* memcpy (void *dest, void *src, size_t n)
     void* memset (void *s, int c, size_t n)
+    int memcmp (void *s1, void *s2, size_t n)
 
     char* strerror (int errno)
 
--- a/qmsk/net/py.pxd	Mon Aug 17 19:40:23 2009 +0300
+++ b/qmsk/net/py.pxd	Mon Aug 17 20:24:12 2009 +0300
@@ -7,6 +7,18 @@
     ## refcounting
     void Py_XDECREF (PyObject *obj)
 
+    ## object protocol
+    # __richcompare__ constants
+    enum :
+        Py_LT
+        Py_LE
+        Py_EQ
+        Py_NE
+        Py_GT
+        Py_GE
+
+    PyObject *Py_NotImplemented
+
     ## string stuff
     int PyObject_AsCharBuffer (object obj, char **buf, ssize_t *len) except -1
 
--- a/qmsk/net/socket/address.pyx	Mon Aug 17 19:40:23 2009 +0300
+++ b/qmsk/net/socket/address.pyx	Mon Aug 17 20:24:12 2009 +0300
@@ -1,4 +1,5 @@
 cimport qmsk.net.libc as libc
+cimport qmsk.net.py as py
 
 from qmsk.net.socket.address cimport *
 
@@ -106,8 +107,12 @@
         80
         >>> str(sa)
         '127.0.0.1:80'
-        >>> str(sockaddr_in())
-        '0.0.0.0:0'
+
+        >>> sockaddr_in('2001::5')
+        Traceback (most recent call last):
+          ...
+        NameError: Invalid network address for specified address family: '2001::5'
+
     """
 
     # the struct sockaddr_in
@@ -121,6 +126,9 @@
                 port        - TCP/UDP port, defaults to 0 (ephemeral)
         """
 
+        # zero
+        libc.memset(&self.sockaddr, 0, sizeof(self.sockaddr))
+
         # store our family
         # XXX: this should be a class attribute...
         self._init_family(platform.AF_INET)
@@ -162,9 +170,35 @@
         def __get__ (self) :
             return platform.ntohs(self.sockaddr.sin_port)
 
+    def __cmp__ (self, other_obj) :
+        """
+            A sockaddr_in is equal to any other sockaddr_in which has the same addr and port
+            
+            >>> assert sockaddr_in() == sockaddr_in()
+            >>> assert sockaddr_in('127.0.0.1', 80) == sockaddr_in('127.0.0.1', 80)
+            >>> addr = sockaddr_in(); assert addr == addr
+        """
+
+        if not isinstance(other_obj, sockaddr_in) :
+            return <object> py.Py_NotImplemented
+
+        cdef sockaddr_in other = other_obj
+        cdef platform.sockaddr_in *sa1 = &self.sockaddr, *sa2 = &other.sockaddr
+
+        if other is self :
+            return 0
+
+        return (
+                libc.memcmp(<void *> &sa1.sin_port, <void *> &sa2.sin_port, sizeof(sa1.sin_port))
+            or  libc.memcmp(<void *> &sa1.sin_addr, <void *> &sa2.sin_addr, sizeof(sa1.sin_addr))
+        )
+
     def __str__ (self) :
         """
             Return the literal ASCII representation for this sockaddr as an '<addr>:<port> string
+        
+            >>> str(sockaddr_in())
+            '0.0.0.0:0'
         """
         
         # format
@@ -181,20 +215,23 @@
         80
         >>> str(sa6)
         '[::1]:80'
-        >>> str(sockaddr_in6())
-        '[::]:0'
+        
     """
 
     cdef platform.sockaddr_in6 sockaddr
 
-    def __init__ (self, object addr=None, platform.in_port_t port=0) :
+    def __init__ (self, object addr=None, platform.in_port_t port=0, unsigned int scope_id = 0) :
         """
             Construct using given literal IPv6 address and TCP/UDP port
 
                 addr        - IPv6 address, defaults to platform.in6addr_any (::)
                 port        - TCP/UDP port, defaults to 0 (ephemeral)
+                scope_id    - (optional) scope ID representing interface index for link-local addresses
         """
 
+        # zero
+        libc.memset(&self.sockaddr, 0, sizeof(self.sockaddr))
+
         # store our family
         # XXX: this should be a class attribute...
         self._init_family(platform.AF_INET6)
@@ -214,6 +251,9 @@
             # set as INADDR_ANY
             self.sockaddr.sin6_addr = platform.in6addr_any
 
+        # scope ID
+        self.sockaddr.sin6_scope_id = scope_id
+
     cdef int _get_sockaddr (self, platform.sockaddr **sa_ptr, platform.socklen_t *sa_len) except -1 :
         if sa_ptr :
             sa_ptr[0] = <platform.sockaddr *> &self.sockaddr
@@ -230,20 +270,87 @@
 
     property port :
         """
-            The integer port number
+            The integer port number.
+
+            This will represent it correctly in host byte order.
         """
 
         def __get__ (self) :
             return platform.ntohs(self.sockaddr.sin6_port)
 
 
+    property flowinfo :
+        """
+            The integer flowinfo
+
+            XXX: byteorder?
+        """
+
+        def __get__ (self) :
+            return self.sockaddr.sin6_flowinfo
+
+
+    property scope_id :
+        """
+            The scope ID - corresponds to an interface index for link-scope addresses.
+
+            This should be in host byte order...
+        """
+
+        def __get__ (self) :
+            return self.sockaddr.sin6_scope_id
+
+    def __cmp__ (self, other_obj) :
+        """
+            A sockaddr_in6 is equal to any other sockaddr_in6 which has the same addr, port and scope ID.
+
+            XXX: flowinfo?
+
+            XXX: A sockaddr_in6 is also equal to a sockaddr_in if the sockaddr_in6 represents the given v4-mapped address.
+            
+            >>> assert sockaddr_in6() == sockaddr_in6()
+            >>> assert sockaddr_in6('0:0:0::1', 80) == sockaddr_in6('::1', 80)
+            >>> assert sockaddr_in6('::127.0.0.1') == sockaddr_in('127.0.0.1')
+        """
+
+        if not isinstance(other_obj, sockaddr_in6) :
+            return <object> py.Py_NotImplemented
+
+        cdef sockaddr_in6 other = other_obj
+        cdef platform.sockaddr_in6 *sa1 = &self.sockaddr, *sa2 = &other.sockaddr
+
+        if other is self :
+            return 0
+
+        return (
+                libc.memcmp(<void *> &sa1.sin6_port,        <void *> &sa2.sin6_port,        sizeof(sa1.sin6_port))
+            or  libc.memcmp(<void *> &sa1.sin6_addr,        <void *> &sa2.sin6_addr,        sizeof(sa1.sin6_addr))
+            or  libc.memcmp(<void *> &sa1.sin6_scope_id,    <void *> &sa2.sin6_scope_id,    sizeof(sa1.sin6_scope_id))
+        )
+
     def __str__ (self) :
         """
             Return the literal ASCII representation for this sockaddr as a '[<addr>]:<port> string
+
+            >>> str(sockaddr_in6())
+            '[::]:0'
+
+            >>> str(sockaddr_in6('2001:0::05:1'))
+            '[2001::5:1]'
+
+            >>> str(sockaddr_in6('fe80::abcd', scope_id=5))
+            '[fe80::abcd%5]'
         """
-        
-        # format
-        return "[%s]:%s" % self.getnameinfo()
+
+        addr, port = self.getnameinfo()
+        scope_id = self.scope_id
+
+        # format with scope_id
+        return "[%s%s]:%s" % (
+            addr,
+            "%%%d" % scope_id if scope_id else "",
+            port
+        )
 
 # mapping of AF -> sockaddr, user-modifyable
 SOCKADDR_BY_FAMILY = {