Merge pull request #204 from mdaniel/better-type-errors

Better type errors

kafka/util.py

@@ -7,6 +7,9 @@ from kafka.common import BufferUnderflowError
 
 
 def write_int_string(s):
+    if s is not None and not isinstance(s, str):
+        raise TypeError('Expected "%s" to be str\n'
+                        'data=%s' % (type(s), repr(s)))
     if s is None:
         return struct.pack('>i', -1)
     else:
@@ -14,9 +17,12 @@ def write_int_string(s):
 
 
 def write_short_string(s):
+    if s is not None and not isinstance(s, str):
+        raise TypeError('Expected "%s" to be str\n'
+                        'data=%s' % (type(s), repr(s)))
     if s is None:
         return struct.pack('>h', -1)
-    elif len(s) > 32767 and sys.version < (2,7):
+    elif len(s) > 32767 and sys.version < (2, 7):
         # Python 2.6 issues a deprecation warning instead of a struct error
         raise struct.error(len(s))
     else:
@@ -117,4 +123,5 @@ class ReentrantTimer(object):
 
         self.active.set()
         self.thread.join(self.t + 1)
+        # noinspection PyAttributeOutsideInit
         self.timer = None

setup.py

@@ -5,6 +5,7 @@ from setuptools import setup, Command
 with open('VERSION', 'r') as v:
     __version__ = v.read().rstrip()
 
+
 class Tox(Command):
 
     user_options = []
@@ -15,7 +16,8 @@ class Tox(Command):
     def finalize_options(self):
         pass
 
-    def run(self):
+    @classmethod
+    def run(cls):
         import tox
         sys.exit(tox.cmdline([]))
 
@@ -24,7 +26,7 @@ setup(
     name="kafka-python",
     version=__version__,
 
-    tests_require=["tox", "mock"],
+    tests_require=["tox", "mock", "unittest2"],
     cmdclass={"test": Tox},
 
     packages=["kafka"],

test/test_util.py

@@ -1,10 +1,10 @@
-import os
-import random
+# -*- coding: utf-8 -*-
 import struct
 import unittest2
 import kafka.util
 import kafka.common
 
+
 class UtilTest(unittest2.TestCase):
     @unittest2.skip("Unwritten")
     def test_relative_unpack(self):
@@ -16,6 +16,14 @@ class UtilTest(unittest2.TestCase):
             '\x00\x00\x00\x0bsome string'
         )
 
+    def test_write_int_string__unicode(self):
+        with self.assertRaises(TypeError) as cm:
+            kafka.util.write_int_string(u'unicode')
+        #: :type: TypeError
+        te = cm.exception
+        self.assertIn('unicode', te.message)
+        self.assertIn('to be str', te.message)
+
     def test_write_int_string__empty(self):
         self.assertEqual(
             kafka.util.write_int_string(''),
@@ -43,6 +51,14 @@ class UtilTest(unittest2.TestCase):
             '\x00\x0bsome string'
         )
 
+    def test_write_short_string__unicode(self):
+        with self.assertRaises(TypeError) as cm:
+            kafka.util.write_short_string(u'hello')
+        #: :type: TypeError
+        te = cm.exception
+        self.assertIn('unicode', te.message)
+        self.assertIn('to be str', te.message)
+
     def test_write_short_string__empty(self):
         self.assertEqual(
             kafka.util.write_short_string(''),
@@ -64,21 +80,20 @@ class UtilTest(unittest2.TestCase):
         self.assertEqual(kafka.util.read_short_string('\x00\x00', 0), ('', 2))
         self.assertEqual(kafka.util.read_short_string('\x00\x0bsome string', 0), ('some string', 13))
 
-    def test_read_int_string__insufficient_data(self):
+    def test_read_int_string__insufficient_data2(self):
         with self.assertRaises(kafka.common.BufferUnderflowError):
             kafka.util.read_int_string('\x00\x021', 0)
 
-    def test_relative_unpack(self):
+    def test_relative_unpack2(self):
         self.assertEqual(
             kafka.util.relative_unpack('>hh', '\x00\x01\x00\x00\x02', 0),
             ((1, 0), 4)
         )
 
-    def test_relative_unpack(self):
+    def test_relative_unpack3(self):
         with self.assertRaises(kafka.common.BufferUnderflowError):
             kafka.util.relative_unpack('>hh', '\x00', 0)
 
-
     def test_group_by_topic_and_partition(self):
         t = kafka.common.TopicAndPartition
 
@@ -91,12 +106,12 @@ class UtilTest(unittest2.TestCase):
         ]
 
         self.assertEqual(kafka.util.group_by_topic_and_partition(l), {
-            "a" : {
-                1 : t("a", 1),
-                2 : t("a", 2),
-                3 : t("a", 3),
+            "a": {
+                1: t("a", 1),
+                2: t("a", 2),
+                3: t("a", 3),
             },
-            "b" : {
-                3 : t("b", 3),
+            "b": {
+                3: t("b", 3),
             }
         })