eth-bloom

Ethereum使用的布隆过滤器的一个Python实现。

这个库和存储库之前位于 https://github.com/pipermerriam/ethereum-bloom。它在2017年11月转让给了以太坊基金会的GitHub，并更名为 eth-bloom。PyPi包也从 ethereum-bloom 更名为 `eth-bloom。

在下面的文档中了解更多信息。 查看变更日志。

有关以太坊布隆过滤器的更多信息，请参阅 此处。

快速入门

python -m pip install eth-bloom

用法

BloomFilter 对象

>>> from eth_bloom import BloomFilter
>>> b = BloomFilter()
>>> b'a value' in b  # check whether a value is present
False
>>> b.add(b'a value')  # add a single value
>>> b'a value' in b
True
>>> int(b)  # cast to an integer
3458628712844765018311492773359360516229024449585949240367644166080576879632652362184119765613545163153674691520749911733485693171622325900647078772681584616740134230153806267998022370194756399579977294154062696916779055028045657302214591620589415314367270329881298073237757853875497241510733954508399863880080986777555986663988492288946856978031023631618215522505971170427986911575695114157059398791122395379400594948096
>>> bin(b)  # cast to a binary string
'0b100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000'

您还可以向布隆过滤器添加一个可迭代的项。

>>> b = BloomFilter()
>>> b'value-a' in b
False
>>> b'value-b' in b
False
>>> b.extend([b'value-a', b'value-b'])
>>> b'value-a' in b
True
>>> b'value-b' in b
True

您可以从字节字符串的可迭代对象初始化布隆过滤器。

>>> b = BloomFilter.from_iterable([b'value-a', b'value-b'])  # initialize from an iterable of values.
>>> b'value-a' in b
True
>>> b'value-b' in b
True

您可以从布隆位的整数表示初始化布隆过滤器。

>>> b = BloomFilter(3458628712844765018311492773359360516229024449585949240367644166080576879632652362184119765613545163153674691520749911733485693171622325900647078772681584616740134230153806267998022370194756399579977294154062696916779055028045657302214591620589415314367270329881298073237757853875497241510733954508399863880080986777555986663988492288946856978031023631618215522505971170427986911575695114157059398791122395379400594948096)
>>> b'a value' in b
True

您还可以合并布隆过滤器

>>> from eth_bloom import BloomFilter
>>> b1 = BloomFilter()
>>> b2 = BloomFilter()
>>> b1.add(b'a')
>>> b1.add(b'common')
>>> b2.add(b'b')
>>> b2.add(b'common')
>>> b'a' in b1
True
>>> b'b' in b1
False
>>> b'common' in b1
True
>>> b'a' in b2
False
>>> b'b' in b2
True
>>> b'common' in b2
True
>>> b3 = b1 + b2  # using addition
>>> b'a' in b3
True
>>> b'b' in b3
True
>>> b'common' in b3
True
>>> b4 = b1 | b2  # or using bitwise or
>>> b'a' in b4
True
>>> b'b' in b4
True
>>> b'common' in b4
True
>>> b1 |= b2  # or using in-place operations (works with += too)
>>> b'a' in b1
True
>>> b'b' in b1
True
>>> b'common' in b1
True

开发者设置

如果您想对eth-bloom进行黑客攻击，请查阅 Snake Charmers战术手册 了解我们如何操作

• 测试
• 拉取请求
• 文档

我们使用 pre-commit 来维护一致的代码风格。一旦安装，它将在每次提交时自动运行。您也可以使用 make lint 手动运行它。如果您需要提交跳过 pre-commit 检查的提交，可以使用 git commit --no-verify。

开发环境设置

您可以使用以下方法设置您的开发环境

git clone git@github.com:ethereum/eth-bloom.git
cd eth-bloom
virtualenv -p python3 venv
. venv/bin/activate
python -m pip install -e ".[dev]"
pre-commit install

发布设置

要发布新版本

make release bump=$$VERSION_PART_TO_BUMP$$

如何增加版本号

此存储库的版本格式为稳定的 {major}.{minor}.{patch}，以及不稳定版本为 {major}.{minor}.{patch}-{stage}.{devnum}（stage 可以是alpha或beta）。

要发布下一个版本，请指定要增加的部分，例如 make release bump=minor 或 make release bump=devnum。这通常在主分支上完成，除非发布beta（在这种情况下，beta从主分支发布，而以前的稳定分支从该分支发布）。

如果您处于beta版本，make release bump=stage 将切换到稳定版本。

要发布不稳定版本，而当前版本是稳定的，请明确指定新版本，例如 make release bump="--new-version 4.0.0-alpha.1 devnum"