X-Git-Url: https://git.distorted.org.uk/~mdw/mLib-python/blobdiff_plain/579d01693c86259110fe7a2c2a6f005f1bdbad5b..HEAD:/unihash.pyx

diff --git a/unihash.pyx b/unihash.pyx
index b1cb979..8ededb0 100644
--- a/unihash.pyx
+++ b/unihash.pyx
@@ -1,48 +1,50 @@
-# -*-pyrex-*-
-#
-# $Id$
-#
-# Universal hashing interface
-#
-# (c) 2005 Straylight/Edgeware
-#
+### -*-pyrex-*-
+###
+### Universal hashing interface
+###
+### (c) 2005 Straylight/Edgeware
+###
 
-#----- Licensing notice -----------------------------------------------------
-#
-# This file is part of the Python interface to mLib.
-#
-# mLib/Python is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-# 
-# mLib/Python is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-# 
-# You should have received a copy of the GNU General Public License
-# along with mLib/Python; if not, write to the Free Software Foundation,
-# Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+###----- Licensing notice ---------------------------------------------------
+###
+### This file is part of the Python interface to mLib.
+###
+### mLib/Python is free software; you can redistribute it and/or modify
+### it under the terms of the GNU General Public License as published by
+### the Free Software Foundation; either version 2 of the License, or
+### (at your option) any later version.
+###
+### mLib/Python is distributed in the hope that it will be useful,
+### but WITHOUT ANY WARRANTY; without even the implied warranty of
+### MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+### GNU General Public License for more details.
+###
+### You should have received a copy of the GNU General Public License
+### along with mLib/Python; if not, write to the Free Software Foundation,
+### Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
 
 def setglobalkey(uint32 k):
+  """setglobalkey(K): set global hash key"""
   unihash_setkey(&unihash_global, k)
 
 cdef class Key:
+  """Key(K): universal hashing key"""
   cdef unihash_info _i
   cdef uint32 _k
-  def __new__(me, uint32 k):
+  def __cinit__(me, uint32 k):
     unihash_setkey(&me._i, k)
     me._k = k
   property k:
+    """K.k -> INT: the key value"""
     def __get__(me):
       return _u32(me._k)
 
 cdef class Unihash:
+  """Unihash([key = None]): universal hashing context"""
   cdef uint32 _a
   cdef readonly Key key
   cdef unihash_info *_i
-  def __new__(me, key = None):
+  def __cinit__(me, key = None):
     cdef Key k
     me.key = key
     if key is None:
@@ -52,11 +54,13 @@ cdef class Unihash:
       me._i = &k._i
     me._a = UNIHASH_INIT(me._i)
   def chunk(me, data):
+    """U.chunk(STR): hash the STR"""
     cdef void *p
-    cdef int n
-    PyObject_AsReadBuffer(data, &p, &n)
+    cdef Py_ssize_t n
+    PyObject_AsReadBuffer(data, <cvp *>&p, &n)
     me._a = unihash_hash(me._i, me._a, p, n)
   def done(me):
+    """U.done() -> INT: the hash of the data"""
     return _u32(me._a)
 
-#----- That's all, folks ----------------------------------------------------
+###----- That's all, folks --------------------------------------------------