Skip to main content

Python module to decode Bencoded data

Project description

A python module for decoding bencoded data

Bencoding

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

Usage

Decoding bencoded data is simple.

>>> import bendcode
>>> bendcode.decode('i123e')
123
>>> bendcode.decode('4:John')
'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)
'i123e'
>>> bendcode.encode('John')
'4:John'
>>> bendcode.encode([123, 'bro'])
'li123e3:broe'
>>> bendcode.encode({'hello': 123})
'd5:helloi123ee'
>>> 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\bendcode.py", line 39, in match_string
    raise MalformedBencodeError('Failed to match string in ' + str(raw))
bendcode.exceptions.MalformedBencodeError: Failed to match string in abc

Tests

Run tests using the following code

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

OK

Issues

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

License

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

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

bendcode-1.1.0.zip (16.1 kB view details)

Uploaded Source

File details

Details for the file bendcode-1.1.0.zip.

File metadata

  • Download URL: bendcode-1.1.0.zip
  • Upload date:
  • Size: 16.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for bendcode-1.1.0.zip
Algorithm Hash digest
SHA256 989b54d7bf2883bcba956d8808aaffe49b976bf82ea48598ed14927b3cfe5fe7
MD5 00bae35d1ea913e6c6345eb8518a13d2
BLAKE2b-256 08801bb338770a52f2f3d621c319671edda99e27401052606654ae7c202df0ec

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page