BloomFilter-py 0.0.6__tar.gz → 0.2.0__tar.gz

bloomfilter-py-0.2.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 OldPanda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

bloomfilter-py-0.2.0/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.1
+Name: bloomfilter-py
+Version: 0.2.0
+Summary: Yet another bloomfilter implementation in Python
+Home-page: https://github.com/OldPanda/bloomfilter-py
+Author: OldPanda
+Author-email: me@old-panda.com
+License: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# bloomfilter-py
+![](https://img.shields.io/pypi/v/bloomfilter-py.svg)
+![](https://img.shields.io/pypi/pyversions/bloomfilter-py.svg)
+[![codecov](https://codecov.io/gh/OldPanda/bloomfilter-py/branch/master/graph/badge.svg?token=RBX1JK7P7O)](https://codecov.io/gh/OldPanda/bloomfilter-py)
+[![Downloads](https://pepy.tech/badge/bloomfilter-py)](https://pepy.tech/project/bloomfilter-py)
+
+## Overview
+Yet another Bloomfilter implementation in Python, compatible with Java's Guava library.
+
+I was looking for a Python library which is capable of reading what Bloomfilter of Java's Guava library serializes and is also able to output byte array which is recognizable by Java. But unfortunately failed. Hence I developed this library by borrowing how Guava implements Bloomfilter serialization/deserialization a lot to deal with Bloomfilters on both Python and Java sides.
+
+As for Bloomfilter usage in Java world, please refer to [this post](https://www.baeldung.com/guava-bloom-filter).
+
+Here's a brief [introduction](https://en.wikipedia.org/wiki/Bloom_filter) to Bloomfilter.
+
+## Requirements
+* Python 3.7+
+
+This library is not tested under Python 3.6 and lower versions.
+
+## Install
+```
+pip install bloomfilter-py
+```
+
+## Usage Examples
+
+### Basic Usage
+```Python
+>>> from bloomfilter import BloomFilter
+>>> bloom_filter = BloomFilter(expected_insertions=500, err_rate=0.01)
+>>> for i in range(100):
+...     bloom_filter.put(i)
+...
+>>> 1 in bloom_filter
+True
+>>> 100 in bloom_filter
+False
+>>>
+```
+
+### Serialize Bloomfilter
+You can easily serialize `BloomFilter` instance to a byte array
+```Python
+>>> dumps = bloom_filter.dumps()
+>>> with open("dumps.out", "wb") as f:
+...     f.write(dumps)
+...
+>>>
+```
+
+or to a hex string
+```Python
+>>> hex_str = bloom_filter.dumps_to_hex()
+```
+
+or to a base64 encoded bytes
+```Python
+base64_bytes = bloom_filter.dumps_to_base64()
+```
+
+### Deserialize Bloomfilter
+And you can easily initialize a `BloomFilter` instance from a byte array
+```Python
+>>> with open("dumps.out", "rb") as f:
+...     bf = BloomFilter.loads(f.read())
+...
+>>> 1 in bf
+True
+>>> 100 in bf
+False
+>>>
+```
+
+or from a hex string
+```Python
+>>> bf = BloomFilter.loads_from_hex(hex_str)
+>>> 1 in bf
+True
+>>> 100 in bf
+False
+```
+
+or from a base64 encoded bytes
+```Python
+>>> bf = BloomFilter.loads_from_base64(base64_bytes)
+>>> 100 in bf
+False
+>>> 200 in bf
+False
+>>> 1 in bf
+True
+>>> 99 in bf
+True
+```

{bloomfilter-py-0.0.6 → bloomfilter-py-0.2.0}/README.md

@@ -2,6 +2,7 @@
 ![](https://img.shields.io/pypi/v/bloomfilter-py.svg)
 ![](https://img.shields.io/pypi/pyversions/bloomfilter-py.svg)
 [![codecov](https://codecov.io/gh/OldPanda/bloomfilter-py/branch/master/graph/badge.svg?token=RBX1JK7P7O)](https://codecov.io/gh/OldPanda/bloomfilter-py)
+[![Downloads](https://pepy.tech/badge/bloomfilter-py)](https://pepy.tech/project/bloomfilter-py)
 
 ## Overview
 Yet another Bloomfilter implementation in Python, compatible with Java's Guava library.
@@ -39,6 +40,7 @@ False
 ```
 
 ### Serialize Bloomfilter
+You can easily serialize `BloomFilter` instance to a byte array
 ```Python
 >>> dumps = bloom_filter.dumps()
 >>> with open("dumps.out", "wb") as f:
@@ -47,7 +49,18 @@ False
 >>>
 ```
 
+or to a hex string
+```Python
+>>> hex_str = bloom_filter.dumps_to_hex()
+```
+
+or to a base64 encoded bytes
+```Python
+base64_bytes = bloom_filter.dumps_to_base64()
+```
+
 ### Deserialize Bloomfilter
+And you can easily initialize a `BloomFilter` instance from a byte array
 ```Python
 >>> with open("dumps.out", "rb") as f:
 ...     bf = BloomFilter.loads(f.read())
@@ -58,3 +71,25 @@ True
 False
 >>>
 ```
+
+or from a hex string
+```Python
+>>> bf = BloomFilter.loads_from_hex(hex_str)
+>>> 1 in bf
+True
+>>> 100 in bf
+False
+```
+
+or from a base64 encoded bytes
+```Python
+>>> bf = BloomFilter.loads_from_base64(base64_bytes)
+>>> 100 in bf
+False
+>>> 200 in bf
+False
+>>> 1 in bf
+True
+>>> 99 in bf
+True
+```

{bloomfilter-py-0.0.6 → bloomfilter-py-0.2.0}/bloomfilter/bloomfilter.py

@@ -1,3 +1,4 @@
+import base64
 import math
 
 from bitarray import bitarray
@@ -42,11 +43,11 @@ class BloomFilter(object):
         self.strategy = strategy
 
     @classmethod
-    def loads(cls, array):
+    def loads(cls, array: bytes) -> "BloomFilter":
         """
         Initialize Bloomfilter instance given dump bytes.
 
-        :param array: Bloomfilter dumped bytes.
+        :param array: BloomFilter dumped bytes.
         :type array: bytes
         """
         strategy_ordinal = array[0]
@@ -65,9 +66,29 @@ class BloomFilter(object):
         instance.setup(num_hash_functions, data, strategy)
         return instance
 
-    def dumps(self):
+    @classmethod
+    def loads_from_hex(cls, hex_str: str) -> "BloomFilter":
+        """
+        Initialize Bloomfilter instance from hex string.
+
+        :param hex_str: BloomFilter dumped hex string.
+        :type hex_str: str
+        """
+        return cls.loads(bytes.fromhex(hex_str))
+
+    @classmethod
+    def loads_from_base64(cls, base64_encoded_bytes: bytes) -> "BloomFilter":
+        """
+        Initialize Bloomfilter instance from base64 encoded bytes.
+
+        :param base64_encoded_bytes: BloomFilter dumped bytes encoded in base64.
+        :type base64_encoded_bytes: bytes
         """
-        Serialize Bloomfilter instance.
+        return cls.loads(base64.b64decode(base64_encoded_bytes))
+
+    def dumps(self) -> bytes:
+        """
+        Serialize BloomFilter instance to bytes.
         """
         result = bytes()
         result += self.strategy.ordinal().to_bytes(1, byteorder="little")
@@ -77,6 +98,18 @@ class BloomFilter(object):
             result += self.data[i : i + 64][::-1]
         return result
 
+    def dumps_to_hex(self) -> str:
+        """
+        Serialize BloomFilter instance to hex string.
+        """
+        return self.dumps().hex()
+
+    def dumps_to_base64(self) -> bytes:
+        """
+        Serialize BloomFilter instance to base64 encoded bytes.
+        """
+        return base64.b64encode(self.dumps())
+
     @classmethod
     def num_of_bits(cls, expected_insertions, err_rate):
         """

bloomfilter-py-0.2.0/bloomfilter_py.egg-info/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.1
+Name: bloomfilter-py
+Version: 0.2.0
+Summary: Yet another bloomfilter implementation in Python
+Home-page: https://github.com/OldPanda/bloomfilter-py
+Author: OldPanda
+Author-email: me@old-panda.com
+License: MIT
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+
+# bloomfilter-py
+![](https://img.shields.io/pypi/v/bloomfilter-py.svg)
+![](https://img.shields.io/pypi/pyversions/bloomfilter-py.svg)
+[![codecov](https://codecov.io/gh/OldPanda/bloomfilter-py/branch/master/graph/badge.svg?token=RBX1JK7P7O)](https://codecov.io/gh/OldPanda/bloomfilter-py)
+[![Downloads](https://pepy.tech/badge/bloomfilter-py)](https://pepy.tech/project/bloomfilter-py)
+
+## Overview
+Yet another Bloomfilter implementation in Python, compatible with Java's Guava library.
+
+I was looking for a Python library which is capable of reading what Bloomfilter of Java's Guava library serializes and is also able to output byte array which is recognizable by Java. But unfortunately failed. Hence I developed this library by borrowing how Guava implements Bloomfilter serialization/deserialization a lot to deal with Bloomfilters on both Python and Java sides.
+
+As for Bloomfilter usage in Java world, please refer to [this post](https://www.baeldung.com/guava-bloom-filter).
+
+Here's a brief [introduction](https://en.wikipedia.org/wiki/Bloom_filter) to Bloomfilter.
+
+## Requirements
+* Python 3.7+
+
+This library is not tested under Python 3.6 and lower versions.
+
+## Install
+```
+pip install bloomfilter-py
+```
+
+## Usage Examples
+
+### Basic Usage
+```Python
+>>> from bloomfilter import BloomFilter
+>>> bloom_filter = BloomFilter(expected_insertions=500, err_rate=0.01)
+>>> for i in range(100):
+...     bloom_filter.put(i)
+...
+>>> 1 in bloom_filter
+True
+>>> 100 in bloom_filter
+False
+>>>
+```
+
+### Serialize Bloomfilter
+You can easily serialize `BloomFilter` instance to a byte array
+```Python
+>>> dumps = bloom_filter.dumps()
+>>> with open("dumps.out", "wb") as f:
+...     f.write(dumps)
+...
+>>>
+```
+
+or to a hex string
+```Python
+>>> hex_str = bloom_filter.dumps_to_hex()
+```
+
+or to a base64 encoded bytes
+```Python
+base64_bytes = bloom_filter.dumps_to_base64()
+```
+
+### Deserialize Bloomfilter
+And you can easily initialize a `BloomFilter` instance from a byte array
+```Python
+>>> with open("dumps.out", "rb") as f:
+...     bf = BloomFilter.loads(f.read())
+...
+>>> 1 in bf
+True
+>>> 100 in bf
+False
+>>>
+```
+
+or from a hex string
+```Python
+>>> bf = BloomFilter.loads_from_hex(hex_str)
+>>> 1 in bf
+True
+>>> 100 in bf
+False
+```
+
+or from a base64 encoded bytes
+```Python
+>>> bf = BloomFilter.loads_from_base64(base64_bytes)
+>>> 100 in bf
+False
+>>> 200 in bf
+False
+>>> 1 in bf
+True
+>>> 99 in bf
+True
+```

{bloomfilter-py-0.0.6 → bloomfilter-py-0.2.0}/bloomfilter_py.egg-info/SOURCES.txt

@@ -1,3 +1,4 @@
+LICENSE
 README.md
 setup.py
 bloomfilter/__init__.py

bloomfilter-py-0.2.0/bloomfilter_py.egg-info/requires.txt

@@ -0,0 +1,2 @@
+bitarray==2.6.0
+mmh3==3.0.0

{bloomfilter-py-0.0.6 → bloomfilter-py-0.2.0}/setup.py

@@ -1,7 +1,7 @@
-from setuptools import setup, find_packages
+from setuptools import find_packages, setup
 
-version = "0.0.6"
-install_requires = ["bitarray==1.6.1", "mmh3==2.5.1"]
+version = "0.2.0"
+install_requires = ["bitarray==2.6.0", "mmh3==3.0.0"]
 extras_require = {}
 
 setup(
@@ -18,7 +18,7 @@ setup(
     include_package_data=True,
     zip_safe=False,
     classifiers=[
-        "Development Status :: 4 - Beta",
+        "Development Status :: 5 - Production/Stable",
         "Intended Audience :: Developers",
         "License :: OSI Approved :: MIT License",
         "Programming Language :: Python",
@@ -26,6 +26,8 @@ setup(
         "Programming Language :: Python :: 3.7",
         "Programming Language :: Python :: 3.8",
         "Programming Language :: Python :: 3.9",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
         "Operating System :: OS Independent",
         "Topic :: Software Development :: Libraries :: Python Modules",
     ],

bloomfilter-py-0.0.6/PKG-INFO

@@ -1,82 +0,0 @@
-Metadata-Version: 2.1
-Name: bloomfilter-py
-Version: 0.0.6
-Summary: Yet another bloomfilter implementation in Python
-Home-page: https://github.com/OldPanda/bloomfilter-py
-Author: OldPanda
-Author-email: me@old-panda.com
-License: MIT
-Description: # bloomfilter-py
-        ![](https://img.shields.io/pypi/v/bloomfilter-py.svg)
-        ![](https://img.shields.io/pypi/pyversions/bloomfilter-py.svg)
-        [![codecov](https://codecov.io/gh/OldPanda/bloomfilter-py/branch/master/graph/badge.svg?token=RBX1JK7P7O)](https://codecov.io/gh/OldPanda/bloomfilter-py)
-        
-        ## Overview
-        Yet another Bloomfilter implementation in Python, compatible with Java's Guava library.
-        
-        I was looking for a Python library which is capable of reading what Bloomfilter of Java's Guava library serializes and is also able to output byte array which is recognizable by Java. But unfortunately failed. Hence I developed this library by borrowing how Guava implements Bloomfilter serialization/deserialization a lot to deal with Bloomfilters on both Python and Java sides.
-        
-        As for Bloomfilter usage in Java world, please refer to [this post](https://www.baeldung.com/guava-bloom-filter).
-        
-        Here's a brief [introduction](https://en.wikipedia.org/wiki/Bloom_filter) to Bloomfilter.
-        
-        ## Requirements
-        * Python 3.7+
-        
-        This library is not tested under Python 3.6 and lower versions.
-        
-        ## Install
-        ```
-        pip install bloomfilter-py
-        ```
-        
-        ## Usage Examples
-        
-        ### Basic Usage
-        ```Python
-        >>> from bloomfilter import BloomFilter
-        >>> bloom_filter = BloomFilter(expected_insertions=500, err_rate=0.01)
-        >>> for i in range(100):
-        ...     bloom_filter.put(i)
-        ...
-        >>> 1 in bloom_filter
-        True
-        >>> 100 in bloom_filter
-        False
-        >>>
-        ```
-        
-        ### Serialize Bloomfilter
-        ```Python
-        >>> dumps = bloom_filter.dumps()
-        >>> with open("dumps.out", "wb") as f:
-        ...     f.write(dumps)
-        ...
-        >>>
-        ```
-        
-        ### Deserialize Bloomfilter
-        ```Python
-        >>> with open("dumps.out", "rb") as f:
-        ...     bf = BloomFilter.loads(f.read())
-        ...
-        >>> 1 in bf
-        True
-        >>> 100 in bf
-        False
-        >>>
-        ```
-        
-Platform: UNKNOWN
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Operating System :: OS Independent
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown

bloomfilter-py-0.0.6/bloomfilter_py.egg-info/PKG-INFO

@@ -1,82 +0,0 @@
-Metadata-Version: 2.1
-Name: bloomfilter-py
-Version: 0.0.6
-Summary: Yet another bloomfilter implementation in Python
-Home-page: https://github.com/OldPanda/bloomfilter-py
-Author: OldPanda
-Author-email: me@old-panda.com
-License: MIT
-Description: # bloomfilter-py
-        ![](https://img.shields.io/pypi/v/bloomfilter-py.svg)
-        ![](https://img.shields.io/pypi/pyversions/bloomfilter-py.svg)
-        [![codecov](https://codecov.io/gh/OldPanda/bloomfilter-py/branch/master/graph/badge.svg?token=RBX1JK7P7O)](https://codecov.io/gh/OldPanda/bloomfilter-py)
-        
-        ## Overview
-        Yet another Bloomfilter implementation in Python, compatible with Java's Guava library.
-        
-        I was looking for a Python library which is capable of reading what Bloomfilter of Java's Guava library serializes and is also able to output byte array which is recognizable by Java. But unfortunately failed. Hence I developed this library by borrowing how Guava implements Bloomfilter serialization/deserialization a lot to deal with Bloomfilters on both Python and Java sides.
-        
-        As for Bloomfilter usage in Java world, please refer to [this post](https://www.baeldung.com/guava-bloom-filter).
-        
-        Here's a brief [introduction](https://en.wikipedia.org/wiki/Bloom_filter) to Bloomfilter.
-        
-        ## Requirements
-        * Python 3.7+
-        
-        This library is not tested under Python 3.6 and lower versions.
-        
-        ## Install
-        ```
-        pip install bloomfilter-py
-        ```
-        
-        ## Usage Examples
-        
-        ### Basic Usage
-        ```Python
-        >>> from bloomfilter import BloomFilter
-        >>> bloom_filter = BloomFilter(expected_insertions=500, err_rate=0.01)
-        >>> for i in range(100):
-        ...     bloom_filter.put(i)
-        ...
-        >>> 1 in bloom_filter
-        True
-        >>> 100 in bloom_filter
-        False
-        >>>
-        ```
-        
-        ### Serialize Bloomfilter
-        ```Python
-        >>> dumps = bloom_filter.dumps()
-        >>> with open("dumps.out", "wb") as f:
-        ...     f.write(dumps)
-        ...
-        >>>
-        ```
-        
-        ### Deserialize Bloomfilter
-        ```Python
-        >>> with open("dumps.out", "rb") as f:
-        ...     bf = BloomFilter.loads(f.read())
-        ...
-        >>> 1 in bf
-        True
-        >>> 100 in bf
-        False
-        >>>
-        ```
-        
-Platform: UNKNOWN
-Classifier: Development Status :: 4 - Beta
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Operating System :: OS Independent
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.7
-Description-Content-Type: text/markdown

bloomfilter-py-0.0.6/bloomfilter_py.egg-info/requires.txt

@@ -1,2 +0,0 @@
-bitarray==1.6.1
-mmh3==2.5.1