Support CF.INFO BF.INFO command (#15)

Author: dengliming

redisbloom/client.py

@@ -6,6 +6,42 @@
 def bool_ok(response):
     return nativestr(response) == 'OK'
 
+class BFInfo(object):
+    capacity = None
+    size = None
+    filterNum = None
+    insertedNum = None
+    expansionRate = None
+
+    def __init__(self, args):
+        response = dict(zip(map(nativestr, args[::2]), args[1::2]))
+        self.capacity = response['Capacity']
+        self.size = response['Size']
+        self.filterNum = response['Number of filters']
+        self.insertedNum = response['Number of items inserted']
+        self.expansionRate = response['Expansion rate']
+
+class CFInfo(object):
+    size = None
+    bucketNum = None
+    filterNum = None
+    insertedNum = None
+    deletedNum = None
+    bucketSize = None
+    expansionRate = None
+    maxIteration = None
+
+    def __init__(self, args):
+        response = dict(zip(map(nativestr, args[::2]), args[1::2]))
+        self.size = response['Size']
+        self.bucketNum = response['Number of buckets']
+        self.filterNum = response['Number of filters']
+        self.insertedNum = response['Number of items inserted']
+        self.deletedNum = response['Number of items deleted']
+        self.bucketSize = response['Bucket size']
+        self.expansionRate = response['Expansion rate']
+        self.maxIteration = response['Max iterations']
+
 class CMSInfo(object):
     width = None
     depth = None
@@ -63,6 +99,7 @@ class Client(Redis): #changed from StrictRedis
     BF_MEXISTS = 'BF.MEXISTS'
     BF_SCANDUMP = 'BF.SCANDUMP'
     BF_LOADCHUNK = 'BF.LOADCHUNK'
+    BF_INFO = 'BF.INFO'
 
     CF_RESERVE = 'CF.RESERVE'
     CF_ADD = 'CF.ADD'
@@ -74,6 +111,7 @@ class Client(Redis): #changed from StrictRedis
     CF_COUNT = 'CF.COUNT'
     CF_SCANDUMP = 'CF.SCANDUMP'
     CF_LOADDUMP = 'CF.LOADDUMP'
+    CF_INFO = 'CF.INFO'
 
     CMS_INITBYDIM = 'CMS.INITBYDIM'
     CMS_INITBYPROB = 'CMS.INITBYPROB'
@@ -105,6 +143,7 @@ def __init__(self, *args, **kwargs):
             #self.BF_MEXISTS : spaceHolder,
             #self.BF_SCANDUMP : spaceHolder,
             #self.BF_LOADCHUNK : spaceHolder,
+            self.BF_INFO : BFInfo,
 
             self.CF_RESERVE : bool_ok,
             #self.CF_ADD : spaceHolder,
@@ -116,6 +155,7 @@ def __init__(self, *args, **kwargs):
             #self.CF_COUNT : spaceHolder,
             #self.CF_SCANDUMP : spaceHolder,
             #self.CF_LOADDUMP : spaceHolder,
+            self.CF_INFO : CFInfo,
 
 
             self.CMS_INITBYDIM : bool_ok,
@@ -276,6 +316,13 @@ def bfLoadChunk(self, key, iter, data):
 
         return self.execute_command(self.BF_LOADCHUNK, *params)
 
+    def bfInfo(self, key):
+        """
+        Returns capacity, size, number of filters, number of items inserted, and expansion rate.
+        """
+
+        return self.execute_command(self.BF_INFO, key)
+
 
 ################## Cuckoo Filter Functions ######################
 
@@ -381,6 +428,13 @@ def cfLoadChunk(self, key, iter, data):
 
         return self.execute_command(self.CF_LOADDUMP, *params)
 
+    def cfInfo(self, key):
+        """
+        Returns size, number of buckets, number of filter, number of items inserted, number of items deleted,
+        bucket size, expansion rate, and max iteration.
+        """
+
+        return self.execute_command(self.CF_INFO, key)
 
 ################## Count-Min Sketch Functions ######################
 

test_commands.py

@@ -55,6 +55,10 @@ def testBFInsert(self):
         self.assertEqual(1, rb.bfExists('bloom', 'foo'))
         self.assertEqual(0, rb.bfExists('bloom', 'noexist'))
         self.assertEqual([1, 0], i(rb.bfMExists('bloom', 'foo', 'noexist')))
+        info = rb.bfInfo('bloom')
+        self.assertEqual(2, info.insertedNum)
+        self.assertEqual(1000, info.capacity)
+        self.assertEqual(1, info.filterNum)
 
     def testBFDumpLoad(self):
         # Store a filter
@@ -116,6 +120,10 @@ def testCFAddInsert(self):
         self.assertEqual([1], rb.cfInsert('empty1', ['foo'], capacity=1000))
         self.assertEqual([1], rb.cfInsertNX('empty2', ['bar'], capacity=1000))
         self.assertRaises(ResponseError, run_func(rb.cfInsert, 'noexist', ['foo']))
+        info = rb.cfInfo('captest')
+        self.assertEqual(5, info.insertedNum)
+        self.assertEqual(0, info.deletedNum)
+        self.assertEqual(1, info.filterNum)
 
     def testCFExistsDel(self):
         self.assertTrue(rb.cfCreate('cuckoo', 1000))
@@ -137,7 +145,7 @@ def testCMS(self):
         self.assertEqual([10, 15], rb.cmsIncrBy('dim', ['foo', 'bar'], [5, 15]))
         self.assertEqual([10, 15], rb.cmsQuery('dim', 'foo', 'bar'))   
         info = rb.cmsInfo('dim')
-        self.assertEqual(1000, info.width)     
+        self.assertEqual(1000, info.width)
         self.assertEqual(5, info.depth)     
         self.assertEqual(25, info.count)