Simple bencode parser (for Python 2, Python 3 and PyPy)
Project description
Simple bencode parser (for Python 2, Python 3 and PyPy), forked from the bencode package by Thomas Rampelberg.
Usage
Encode:
>>> import bencodepy
>>> bencodepy.encode({'title': 'Example'})
b'd5:title7:Examplee'
>>> bencodepy.encode(12)
b'i12e'
Decode:
>>> import bencodepy
>>> bencodepy.decode('d5:title7:Examplee')
{b'title': b'Example'}
>>> bencodepy.decode('i12e')
12
Decode to UTF-8:
>>> import bencodepy
>>> bc = bencodepy.Bencode(
encoding='utf-8'
)
>>> bc.decode('d5:title7:Examplee')
{'title': 'Example'}
bencode
(legacy, backwards-compatible package)
This package will continue to be provided for backwards-compatibility, but upgrading to bencodepy is recommended for more reliable decoding results.
Under-the-hood this just provides proxies to a Bencode instance created with:
Bencode(
encoding='utf-8',
encoding_fallback='value',
dict_ordered=True,
dict_ordered_sort=True
)
Encode:
>>> import bencode
>>> bencode.encode({'title': 'Example'})
'd5:title7:Examplee'
>>> bencode.encode(12)
'i12e'
Decode:
>>> import bencode
>>> bencode.decode('d5:title7:Examplee')
OrderedDict([(u'title', u'Example')])
>>> bencode.decode('i12e')
12
API
bencodepy.Bencode(encoding=None, encoding_fallback=None, dict_ordered=False, dict_ordered_sort=False)
Create instance
- encoding
Encoding to decode strings with (or None for binary)
- encoding_fallback
Fallback to binary when decoding fails on the specified string types.
key - dictionary keys
value - values
all - always fallback to binary
None - always raise decoding errors
- dict_ordered
Use OrderedDict
- dict_ordered_sort
Ensure OrderedDict is sorted
Methods:
- decode(value)
Decode bencode string value.
- encode(value)
Encode value into a bencode string.
- read(fd)
Decode bencode from file or path fd.
- write(data, fd)
Encode data to file or path fd.
bencodepy.BencodeDecoder(encoding=None, encoding_fallback=None, dict_ordered=False, dict_ordered_sort=False)
Create decoder
- encoding
Encoding to decode strings with (or None for binary)
- encoding_fallback
Fallback to binary when decoding fails on the specified string types.
key - dictionary keys
value - values
all - always fallback to binary
None - always raise decoding errors
- dict_ordered
Use OrderedDict
- dict_ordered_sort
Ensure OrderedDict is sorted
Methods:
- decode(value)
Decode bencode string value.
bencodepy.BencodeEncoder()
Create encoder
Methods:
- encode(value)
Encode value into a bencode string.
bencodepy.bencode(value)
bencodepy.encode(value)
Encode value into a bencode string with the default encoder.
bencodepy.bdecode(value)
bencodepy.decode(value)
Decode bencode string value with the default decoder.
bencodepy.bread(fd)
Decode bencode from file or path fd with the default decoder.
bencodepy.bwrite(data, fd)
Encode data to file or path fd with the default encoder.
bencode
bencode.bencode(value)
bencode.encode(value)
Encode value into the bencode format.
bencode.bdecode(value)
bencode.decode(value)
Decode bencode formatted string value.
bencode.bread(fd)
Read bencode formatted string from file or path fd.
bencode.bwrite(data, fd)
Write data as a bencode formatted string to file or path fd.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for bencode.py-4.0.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 99c06a55764e85ffe81622fdf9ee78bd737bad3ea61d119784a54bb28860d962 |
|
MD5 | 71b5854787daff26398a8a7e488273d1 |
|
BLAKE2b-256 | 159feabbc8c8a16db698d9c4bd24953763df2594b054237b89afe1ec56d3965e |