Merge branch 'develop'

Author: whtsky

.gitignore

@@ -60,3 +60,5 @@ target/
 
 #Ipython Notebook
 .ipynb_checkpoints
+
+bencoder.c

.travis.yml

@@ -8,6 +8,8 @@ python:
   - 3.5
   - pypy
 
-before_install: pip install Cython
-install: python setup.py install
+install:
+  - pip install cython
+  - cython bencoder.pyx
+  - python setup.py install
 script: nosetests

README.rst

@@ -32,3 +32,12 @@ Usage
     with open("debian-8.3.0-amd64-netinst.iso.torrent", "rb") as f:
         torrent = bdecode(f.read())
         print(torrent['announce'])
+
+ChangeLog
+----------
+
+Version 1.1.0
+~~~~~~~~~~~~~~~
+
++ Use OrderedDict instaed of dict
++ Support encoding subclasses of dict

appveyor.yml

@@ -56,53 +56,27 @@ environment:
       PYTHON_VERSION: "3.5.0"
       PYTHON_ARCH: "64"
 
-install:
-  - ECHO "Filesystem root:"
-  - ps: "ls \"C:/\""
-
-  - ECHO "Installed SDKs:"
-  - ps: "ls \"C:/Program Files/Microsoft SDKs/Windows\""
+init:
+  - "ECHO Python %PYTHON_VERSION% (%PYTHON_ARCH%bit) from %PYTHON%"
 
+install:
   # Install Python (from the official .msi of http://python.org) and pip when
   # not already installed.
   - ps: if (-not(Test-Path($env:PYTHON))) { & appveyor\install.ps1 }
-
-  # Prepend newly installed Python to the PATH of this build (this cannot be
-  # done from inside the powershell script as it would require to restart
-  # the parent CMD process).
-  - "SET PATH=%PYTHON%;%PYTHON%\\Scripts;%PATH%"
-
-  # Check that we have the expected version and architecture for Python
-  - "python --version"
-  - "python -c \"import struct; print(struct.calcsize('P') * 8)\""
-
-  # Upgrade to the latest version of pip to avoid it displaying warnings
-  # about it being out of date.
-  - "pip install --disable-pip-version-check --user --upgrade pip wheel"
-
-  # Install the build dependencies of the project. If some dependencies contain
-  # compiled extensions and are not provided as pre-built wheel packages,
-  # pip will build them from source using the MSVC compiler matching the
-  # target Python version and architecture
-  - "%CMD_IN_ENV% pip install --user cython"
+  - "%PYTHON%\\Scripts\\pip install --disable-pip-version-check --user --upgrade pip wheel cython"
 
 build_script:
-  # Build the compiled extension
-  - "%CMD_IN_ENV% python setup.py build"
+  - "%PYTHON%\\Scripts\\cython bencoder.pyx"
+  - "%PYTHON%\\python setup.py install"
 
 test_script:
-  # Run the project tests
-  - "%CMD_IN_ENV% python setup.py test"
+  - "%PYTHON%\\python setup.py test"
 
 after_test:
-  # If tests are successful, create binary packages for the project.
-  - "%CMD_IN_ENV% python setup.py bdist_wheel"
-  - "%CMD_IN_ENV% python setup.py bdist_wininst"
-  - "%CMD_IN_ENV% python setup.py bdist_msi"
+  - "%PYTHON%\\python setup.py bdist_wheel bdist_wininst bdist_msi"
   - ps: "ls dist"
 
 artifacts:
-  # Archive the generated packages in the ci.appveyor.com build report.
   - path: dist\*
 
 #on_success:

bencoder.pyx

@@ -17,6 +17,11 @@ __version__ = '1.0.0'
 import sys
 IS_PY2 = sys.version[0] == '2'
 
+try:
+    from collections import OrderedDict
+except ImportError:
+    from ordereddict import OrderedDict
+
 if IS_PY2:
     END_CHAR = 'e'
 else:
@@ -57,7 +62,7 @@ def decode_list(bytes x, int f):
 
 
 def decode_dict(bytes x, int f):
-    r, f = {}, f + 1
+    r, f = OrderedDict(), f + 1
     while x[f] != END_CHAR:
         k, f = decode_string(x, f)
         r[k], f = decode_func[x[f]](x, f)
@@ -89,6 +94,18 @@ def bdecode(bytes x):
     return r
 
 
+def encode(v, r):
+    tp = type(v)
+    if tp in encode_func:
+        return encode_func[tp](v, r)
+    else:
+        for tp, func in encode_func.items():
+            if isinstance(v, tp):
+                return func(v, r)
+    raise BTFailure("Unknown Type: %s" % tp)
+
+
+
 def encode_int(int x, list r):
     r.extend((b'i', str(x).encode(), b'e'))
 
@@ -109,19 +126,19 @@ def encode_string(x, list r):
 def encode_list(x, list r):
     r.append(b'l')
     for i in x:
-        encode_func[type(i)](i, r)
+        encode(i, r)
     r.append(b'e')
 
 
-def encode_dict(dict x, list r):
+def encode_dict(x, list r):
     r.append(b'd')
     item_list = list(x.items())
     item_list.sort()
     for k, v in item_list:
         if isinstance(k, str):
             k = k.encode()
         r.extend((str(len(k)).encode(), b':', k))
-        encode_func[type(v)](v, r)
+        encode(v, r)
     r.append(b'e')
 
 
@@ -132,11 +149,12 @@ encode_func = {
     list: encode_list,
     tuple: encode_list,
     dict: encode_dict,
+    OrderedDict: encode_dict,
     bool: encode_bool,
 }
 
 
 def bencode(x):
     r = []
-    encode_func[type(x)](x, r)
+    encode(x, r)
     return b''.join(r)

release.sh

@@ -1,2 +1,3 @@
+cython bencoder.pyx
 python setup.py sdist --formats=zip,gztar bdist_wheel register
 twine upload dist/*

setup.py

@@ -1,21 +1,16 @@
-import sys
+import platform
 
 from setuptools import setup
 from setuptools.extension import Extension
-from setuptools.dist import Distribution
-Distribution(dict(setup_requires='Cython'))
 
-try:
-    from Cython.Distutils import build_ext
-except ImportError:
-    print('Could not import Cython.Distutils. Install `cython` and rerun.')
-    sys.exit(1)
-
-ext_modules = [Extension('bencoder', ['bencoder.pyx'])]
+version = platform.python_version_tuple()
+install_requires = []
+if version < ('2', '7'):
+    install_requires.append('ordereddict>=1.1')
 
 setup(
     name='bencoder.pyx',
-    version='1.0.0',
+    version='1.1.0',
     description='Yet another bencode implementation in Cython',
     long_description=open('README.rst', 'r').read(),
     author='whtsky',
@@ -44,9 +39,8 @@
         'Programming Language :: Python :: Implementation :: PyPy',
         'Topic :: Software Development :: Libraries :: Python Modules',
     ],
-    cmdclass={'build_ext': build_ext},
-    ext_modules=ext_modules,
-    setup_requires=['Cython'],
+    ext_modules=[Extension('bencoder', ['bencoder.c'])],
+    install_requires=install_requires,
     tests_require=['nose'],
     test_suite='nose.collector',
 )

tests/test_decode.py

@@ -1,6 +1,12 @@
 # -*- coding: utf-8 -*-
 
 from bencoder import bdecode
+import os
+
+TORRENT_PATH = os.path.join(
+    os.path.abspath(os.path.dirname(__file__)),
+    "debian-8.3.0-amd64-netinst.iso.torrent"
+)
 
 
 def test_decode_str():
@@ -22,6 +28,15 @@ def test_decode_dict():
     assert bdecode(b'd2:ka2:va2:kbi2ee') == od
 
 
+def test_ordered_dict():
+    from bencoder import OrderedDict
+    rv = bdecode(b'd2:ka2:va2:kbi2ee')
+    assert isinstance(rv, OrderedDict)
+    assert list(rv.keys()) == [b'ka', b'kb']
+    assert list(bdecode(b'd2:kc2:va2:kei2ee').keys()) == [b'kc', b'ke']
+    assert list(bdecode(b'd2:ke2:va2:kci2ee').keys()) == [b'ke', b'kc']
+
+
 def test_encode_complex():
     od = dict()
     od[b'KeyA'] = [b'listitemA', {b'k': b'v'}, 3]
@@ -33,12 +48,7 @@ def test_encode_complex():
 
 
 def test_decode_debian_torrent():
-    import os
-    torrent_path = os.path.join(
-            os.path.abspath(os.path.dirname(__file__)),
-            "debian-8.3.0-amd64-netinst.iso.torrent"
-    )
-    with open(torrent_path, "rb") as f:
+    with open(TORRENT_PATH, "rb") as f:
         torrent = bdecode(f.read())
     assert torrent[b'announce'] == b'http://bttracker.debian.org:6969/announce'
     assert torrent[b'comment'] == b'"Debian CD from cdimage.debian.org"'

tests/test_encode.py

@@ -1,6 +1,12 @@
 # -*- coding: utf-8 -*-
 
-from bencoder import bencode
+from bencoder import bencode, bdecode
+import os
+
+TORRENT_PATH = os.path.join(
+    os.path.abspath(os.path.dirname(__file__)),
+    "debian-8.3.0-amd64-netinst.iso.torrent"
+)
 
 
 def test_encode_str():
@@ -33,6 +39,16 @@ def test_encode_dict():
     assert bencode(od) == b'd2:ka2:va2:kbi2ee'
 
 
+def test_encode_dict_subclass():
+    class AAA(dict):
+        pass
+
+    od = dict()
+    od['ka'] = 'va'
+    od['kb'] = 2
+    assert bencode(od) == b'd2:ka2:va2:kbi2ee'
+
+
 def test_encode_complex():
     od = dict()
     od['KeyA'] = ['listitemA', {'k': 'v'}, 3]
@@ -41,3 +57,11 @@ def test_encode_complex():
     od['KeyD'] = 'AString'
     expected_result = b'd4:KeyAl9:listitemAd1:k1:vei3ee4:KeyBd1:k1:ve4:KeyCi3e4:KeyD7:AStringe'
     assert bencode(od) == expected_result
+
+
+def test_infohash():
+    import hashlib
+    with open(TORRENT_PATH, "rb") as f:
+        torrent = bdecode(f.read())
+    infohash = hashlib.sha1(bencode(torrent[b'info'])).hexdigest()
+    assert infohash == "4194e473d6c49630e1c6247d6716076809bb96ae"