bencodex

Bencodex reader/writer for Python


Keywords
bencode, bencodex, python, python3
License
GPL-3.0+
Install
pip install bencodex==1.0.1

Documentation

Bencodex reader/writer for Python

Build Status

This package implements Bencodex serialization format which extends Bencoding.

Usage

This package's API follows the tradition of Python's pickle and json modules:

  • bencodex.dump(obj: bencodex.BValue, fileobj: typing.BinaryIO) -> None
  • bencodex.dumps(obj: bencodex.BValue) -> bytes
  • bencodex.load(fileobj: typing.BinaryIO) -> bencodex.BValue
  • bencodex.loads(encoded: bytes) -> bencodex.BValue

Examples

>>> from bencodex import dumps, loads
>>> dumps({'name': 'Jane Doe', 'age': 30, 'nationality': ['BR', 'US']})
b'du3:agei30eu4:nameu8:Jane Doeu11:nationalitylu2:BRu2:USee'
>>> loads(_)
{'age': 30, 'name': 'Jane Doe', 'nationality': ['BR', 'US']}

License

Distributed under GPLv3 or later.