Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Python module to decode Bencoded data

Project Description

A python module for decoding bencoded data


Bencoding is a meta data representation format fot the BitTorrent Protocol (BTP). The Augmented BNF syntax for Bencoding is given below

dictionary = "d" 1*(string anytype) "e"
  list       = "l" 1*anytype "e"
  integer    = "i" signumber "e"
  string     = number ":" <number long sequence of any CHAR>
  anytype    = dictionary / list / integer / string
  signumber  = "-" number / number
  number     = 1*DIGIT
  CHAR       = %x00-FF
  DIGIT      = "0" / "1" / "2" / "3" / "4" /
               "5" / "6" / "7" / "8" / "9"

Source: BTP RFC


Decoding bencoded data is simple.

>>> import bendcode
>>> bendcode.decode('i123e')
>>> bendcode.decode('4:John')
>>> bendcode.decode('li234ei123ee')
[234, 123]
>>> bendcode.decode('d1:ai123e1:bi234ee')
{'a': 123, 'b': 234}

You can decode invidual types too !

>>> import bendcode
>>> bendcode.match_string('3:abc')
('abc', '')
>>> bendcode.match_int('i-123e')
(-123, '')
>>> bendcode.match_list('li123ee')
([123], '')
>>> bendcode.match_dict('d1:a1:bei123e')
({'a': 'b'}, 'i123e')

Note: The match_* series of functions return a tuple (first_possbile_match, remaining_unmatched_string)

Bendcode can encode too

>>> import bendcode
>>> bendcode.encode(123)
>>> bendcode.encode('John')
>>> bendcode.encode([123, 'bro'])
>>> bendcode.encode({'hello': 123})
>>> bendcode.encode(None)

You decide whether to raise an exception or not for any functions mentioned above by setting the fail_silently parameter to True or False

>>> import bendcode
>>> bendcode.match_string('abc')
(None, 'abc')
>>> bendcode.match_string('abc', fail_silently=False)
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "bendcode\", line 39, in match_string
    raise MalformedBencodeError('Failed to match string in ' + str(raw))
bendcode.exceptions.MalformedBencodeError: Failed to match string in abc


Run tests using the following code

>>> from bendcode import tests
>>> tests.run_tests()
Ran 34 tests in 0.015s



If you find any bug, feel free to create an issue here.


BenDcode uses GNU v2 License. Read the terms of the license here.

Release History

Release History

This version
History Node


History Node


Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date (16.1 kB) Copy SHA256 Checksum SHA256 Source May 28, 2015

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting