Merge pull request #8 from dw/quality-control

Quality control (flake8, Travis CI, and coveralls)

Author: bbayles

.travis.yml

@@ -0,0 +1,24 @@
+sudo: false
+
+language: "python"
+
+python:
+    - "2.7"
+    - "3.4"
+    - "3.5"
+    - "3.6"
+    - "3.7-dev"
+
+install:
+    - "pip install ."
+    - "pip install -U coveralls flake8"
+
+script:
+    - "coverage run --include='cdblib/*.py' setup.py test"
+    - "flake8 ."
+
+notifications:
+    - email: false
+
+after_success:
+    - "coveralls"

cdblib/cdblib.py

@@ -215,7 +215,7 @@ def putstring(self, key, value, encoding='utf-8'):
     def putstrings(self, key, values, encoding='utf-8'):
         '''Write zero or more unicode strings to the output file. Equivalent to
         calling putstring() in a loop.'''
-        self.puts(key, (six.text_type.encode(value, encoding) for value in values))
+        self.puts(key, (six.text_type.encode(v, encoding) for v in values))
 
     def finalize(self):
         '''Write the final hash tables to the output file, and write out its
@@ -238,7 +238,7 @@ def finalize(self):
         self.fp.seek(0)
         for pair in index:
             self.fp.write(self.write_pair(*pair))
-        self.fp = None # prevent double finalize()
+        self.fp = None  # prevent double finalize()
 
 
 class Writer64(Writer):

cdblib/cdbmake.py

@@ -35,7 +35,7 @@ def __init__(self, stdin, stdout, stderr):
     def parse_args(self, args):
         try:
             opts, args = getopt.gnu_getopt(args, 'p8')
-        except getopt.error as  e:
+        except getopt.error as e:
             self.usage(str(e))
 
         for opt, arg in opts:
@@ -67,11 +67,10 @@ def parse_input(self):
             elif plus != '+':
                 self.die('bad or missing plus, line/record #%d', rec_nr)
 
-            bad = False
             try:
                 klen = int(''.join(iter(partial(read, 1), ',')), 10)
                 dlen = int(''.join(iter(partial(read, 1), ':')), 10)
-            except ValueError as e:
+            except ValueError:
                 self.die('bad or missing length, line/record #%d', rec_nr)
 
             key = read(klen)
@@ -118,4 +117,4 @@ def main(args=None, stdin=sys.stdin, stdout=sys.stdout, stderr=sys.stderr):
 
 
 if __name__ == '__main__':
-   main(sys.argv[1:])
+    main(sys.argv[1:])

cdblib/djb_hash.py

@@ -7,21 +7,21 @@
 # iterating over byte strings differently.
 if six.PY2:
     def djb_hash(s):
-        '''Return the value of DJB's hash function for the given byte string.'''
+        '''Return the value of DJB's hash function for byte string *s*'''
         h = 5381
         for c in s:
             h = (((h << 5) + h) ^ ord(c)) & 0xffffffff
         return h
 else:
-    def djb_hash(s):
-        '''Return the value of DJB's hash function for the given byte string.'''
+    def djb_hash(s):  # noqa
+        '''Return the value of DJB's hash function for byte string *s*'''
         h = 5381
         for c in s:
             h = (((h << 5) + h) ^ c) & 0xffffffff
         return h
 
 # If the C Extensions is available (Python 2 only), use it
 try:
-    from ._djb_hash import djb_hash
+    from ._djb_hash import djb_hash  # noqa
 except ImportError:
     pass

setup.cfg

@@ -0,0 +1,4 @@
+[flake8]
+filename =
+    ./cdblib/*.py
+    ./setup.py

setup.py

@@ -1,6 +1,5 @@
 #!/usr/bin/env python
 from os import environ
-from sys import version_info
 
 from setuptools import Extension, find_packages, setup
 
@@ -13,20 +12,25 @@
 else:
     ext_modules = []
 
+
+description = "Pure Python reader/writer for Dan J. Berstein's CDB format."
+
 setup(
     author='David Wilson',
     author_email='dw@botanicus.net',
-    description="Pure Python reader/writer for Dan J. Berstein's CDB format.",
+    description=description,
+    long_description=description,
     download_url='https://github.com/dw/python-pure-cdb',
     keywords='cdb file format appengine database db',
     license='MIT',
     name='pure-cdb',
+    version='2.1.0',
     packages=find_packages(include=['cdblib']),
     ext_modules=ext_modules,
     install_requires=['six>=1.0.0,<2.0.0'],
     test_suite='tests',
-    version='2.1.0',
-    entry_points = {
+    tests_require=['flake8'],
+    entry_points={
         'console_scripts': ['python-pure-cdbmake=cdblib.cdbmake:main'],
-    }
+    },
 )

tests/cdblib_test.py

@@ -40,7 +40,14 @@ def reader_to_cdbmake_md5(self, filename):
             data = infile.read()
 
         for key, value in self.reader_cls(data).iteritems():
-            md5.update(b'+%d,%d:%s->%s\n' % (len(key), len(value), key, value))
+            # Hack to work around lack of bytes.format() in Python 3.4
+            data = '+{},{}:{}->{}\n'.format(
+                len(key),
+                len(value),
+                key.decode('utf-8'),
+                value.decode('utf-8')
+            )
+            md5.update(data.encode('utf-8'))
 
         md5.update(b'\n')