Change TypeError to ValueError for invalid input

edenhill · edenhill · commit c87cc7f42c28 · 2018-05-31T16:42:54.000+02:00
diff --git a/confluent_kafka/__init__.py b/confluent_kafka/__init__.py
@@ -139,16 +139,18 @@ def __init__(self, restype, name,
         :param name str: Resource name, depending on restype.
                           For RESOURCE_BROKER the resource name is the broker id.
         :param set_config dict: Configuration to set/overwrite. Dict of str, str.
-        :param add_config dict: Configuration to add/append. Dict of str, str. Requires broker version >=2.0.
-        :param del_config list: Configuration to delete/revert to default. List of str. Requires broker version >=2.0.
+        :param add_config dict: Configuration to add/append. Dict of str, str.
+                                Requires broker version with KIP-248 support.
+        :param del_config list: Configuration to delete/revert to default. List of str.
+                                Requires broker version with KIP-248 support.
         :param described_configs dict: For internal use only.
         :param error KafkaError: For internal use only.
 
         When alter_configs(incremental=False) only set_config is permitted,
         and any configuration parameter not specified will be reverted to
         its default value.
 
-        With alter_configs(incremental=True) (requires broker version >=2.0),
+        With alter_configs(incremental=True) (requires broker version with KIP-248 support)
         only the configuration parameters specified through set, add or del
         will be modified.
         """
@@ -222,7 +224,7 @@ def add_config(self, name, value):
         """
         Append value to configuration entry.
 
-        Requires broker version >=2.0.0 and alter_configs(.., incremental=True).
+        Requires broker version with KIP-248 support and alter_configs(.., incremental=True).
 
         :param name str: Configuration property name
         :param value str: Configuration value
@@ -233,7 +235,7 @@ def del_config(self, name):
         """
         Delete configuration entry, reverting it to the default value.
 
-        Requires broker version >=2.0.0 and alter_configs(.., incremental=True).
+        Requires broker version with KIP-248 support and alter_configs(.., incremental=True).
 
         :param name str: Configuration property name
         """
@@ -331,7 +333,7 @@ def _make_futures(futmap_keys, class_check, make_result_fn):
         futmap = {}
         for key in futmap_keys:
             if class_check is not None and not isinstance(key, class_check):
-                raise TypeError("Expected list of {}".format(type(class_check)))
+                raise ValueError("Expected list of {}".format(type(class_check)))
             futmap[key] = concurrent.futures.Future()
             if not futmap[key].set_running_or_notify_cancel():
                 raise RuntimeError("Future was cancelled prematurely")
@@ -492,8 +494,7 @@ def alter_configs(self, resources, **kwargs):
                   reverting all other configuration for the resource back
                   to their default values.
                   Use incremental=True to change the behaviour so that only the
-                  passed configuration is modified.
-                  Requires broker version >=2.0.
+                  passed configuration is modified, requires broker version with KIP-248 support.
 
         :warning: Multiple resources and resource types may be specified,
                   but at most one resource of type RESOURCE_BROKER is allowed
@@ -508,7 +509,7 @@ def alter_configs(self, resources, **kwargs):
                   without altering the configuration. Default: False
         :param incremental bool: If true, only update the specified configuration
                   entries, not reverting unspecified configuration.
-                  This requires broker version >=2.0. Default: False
+                  This requires broker version with KIP-248 support. Default: False
 
         :returns: a dict of futures for each resource, keyed by the ConfigResource.
         :rtype dict(<ConfigResource, future>):
@@ -531,14 +532,14 @@ class ClusterMetadata (object):
     ClusterMetadata as returned by list_topics() contains information
     about the Kafka cluster, brokers, and topics.
 
+    This class is typically not user instantiated.
+
     :ivar cluster_id: Cluster id string, if supported by broker, else None.
     :ivar controller_id: Current controller broker id, or -1.
     :ivar brokers: Map of brokers indexed by the int broker id. Value is BrokerMetadata object.
     :ivar topics: Map of topics indexed by the topic name. Value is TopicMetadata object.
     :ivar orig_broker_id: The broker this metadata originated from.
     :ivar orig_broker_name: Broker name/address this metadata originated from.
-
-    This class is typically not user instantiated.
     """
     def __init__(self):
         self.cluster_id = None
@@ -559,11 +560,11 @@ class BrokerMetadata (object):
     """
     BrokerMetadata contains information about a Kafka broker.
 
+    This class is typically not user instantiated.
+
     :ivar id: Broker id.
     :ivar host: Broker hostname.
     :ivar port: Broker port.
-
-    This class is typically not user instantiated.
     """
     def __init__(self):
         self.id = -1
@@ -581,11 +582,11 @@ class TopicMetadata (object):
     """
     TopicMetadata contains information about a Kafka topic.
 
+    This class is typically not user instantiated.
+
     :ivar topic: Topic name.
     :ivar partitions: Map of partitions indexed by partition id. Value is PartitionMetadata object.
     :ivar error: Topic error, or None. Value is a KafkaError object.
-
-    This class is typically not user instantiated.
     """
     def __init__(self):
         self.topic = None
@@ -606,6 +607,8 @@ class PartitionMetadata (object):
     """
     PartitionsMetadata contains information about a Kafka partition.
 
+    This class is typically not user instantiated.
+
     :ivar id: Partition id.
     :ivar leader: Current leader broker for this partition, or -1.
     :ivar replicas: List of replica broker ids for this partition.
@@ -616,8 +619,6 @@ class PartitionMetadata (object):
               leader, replicas and isrs may temporarily not be reported
               in ClusterMetadata.brokers. Always check the availability
               of a broker id in the brokers dict.
-
-    This class is typically not user instantiated.
     """
     def __init__(self):
         self.partition = -1
diff --git a/confluent_kafka/src/Admin.c b/confluent_kafka/src/Admin.c
@@ -174,7 +174,7 @@ static int Admin_set_replica_assignment (const char *forApi, void *c_obj,
         if (!PyList_Check(ra) ||
             (int)PyList_Size(ra) < min_count ||
             (int)PyList_Size(ra) > max_count) {
-                PyErr_Format(PyExc_TypeError,
+                PyErr_Format(PyExc_ValueError,
                              "replica_assignment must be "
                              "a list of int lists with an "
                              "outer size of %s", err_count_desc);
@@ -192,7 +192,7 @@ static int Admin_set_replica_assignment (const char *forApi, void *c_obj,
                 if (!PyList_Check(replicas) ||
                     (replica_cnt = (size_t)PyList_Size(replicas)) < 1) {
                         PyErr_Format(
-                                PyExc_TypeError,
+                                PyExc_ValueError,
                                 "replica_assignment must be "
                                 "a list of int lists with an "
                                 "outer size of %s", err_count_desc);
@@ -208,7 +208,7 @@ static int Admin_set_replica_assignment (const char *forApi, void *c_obj,
 
                         if (!cfl_PyInt_Check(replica)) {
                                 PyErr_Format(
-                                        PyExc_TypeError,
+                                        PyExc_ValueError,
                                         "replica_assignment must be "
                                         "a list of int lists with an "
                                         "outer size of %s", err_count_desc);
@@ -239,7 +239,7 @@ static int Admin_set_replica_assignment (const char *forApi, void *c_obj,
 
                 if (err) {
                         PyErr_SetString(
-                                PyExc_TypeError, errstr);
+                                PyExc_ValueError, errstr);
                         return 0;
                 }
         }
@@ -266,7 +266,7 @@ Admin_config_dict_to_c (void *c_obj, PyObject *dict, const char *op_name) {
                 rd_kafka_resp_err_t err;
 
                 if (!(ks = cfl_PyObject_Unistr(ko))) {
-                        PyErr_Format(PyExc_TypeError,
+                        PyErr_Format(PyExc_ValueError,
                                      "expected %s config name to be unicode "
                                      "string", op_name);
                         return 0;
@@ -281,7 +281,7 @@ Admin_config_dict_to_c (void *c_obj, PyObject *dict, const char *op_name) {
                         PyObject *vs = NULL, *vs8 = NULL;
                         if (!(vs = cfl_PyObject_Unistr(vo)) ||
                             !(v = cfl_PyUnistr_AsUTF8(vs, &vs8))) {
-                                PyErr_Format(PyExc_TypeError,
+                                PyErr_Format(PyExc_ValueError,
                                              "expect %s config value for %s "
                                              "to be unicode string",
                                              op_name, k);
@@ -358,7 +358,7 @@ static PyObject *Admin_create_topics (Handle *self, PyObject *args,
                 return NULL;
 
         if (!PyList_Check(topics) || (tcnt = (int)PyList_Size(topics)) < 1) {
-                PyErr_SetString(PyExc_TypeError,
+                PyErr_SetString(PyExc_ValueError,
                                 "Expected non-empty list of NewTopic objects");
                 return NULL;
         }
@@ -392,7 +392,7 @@ static PyObject *Admin_create_topics (Handle *self, PyObject *args,
                 if (r == -1)
                         goto err; /* Exception raised by IsInstance() */
                 else if (r == 0) {
-                        PyErr_SetString(PyExc_TypeError,
+                        PyErr_SetString(PyExc_ValueError,
                                         "Expected list of NewTopic objects");
                         goto err;
                 }
@@ -402,7 +402,7 @@ static PyObject *Admin_create_topics (Handle *self, PyObject *args,
                                                    newt->replication_factor,
                                                    errstr, sizeof(errstr));
                 if (!c_objs[i]) {
-                        PyErr_Format(PyExc_TypeError,
+                        PyErr_Format(PyExc_ValueError,
                                      "Invalid NewTopic(%s): %s",
                                      newt->topic, errstr);
                         i++;
@@ -411,7 +411,7 @@ static PyObject *Admin_create_topics (Handle *self, PyObject *args,
 
                 if (newt->replica_assignment) {
                         if (newt->replication_factor != -1) {
-                                PyErr_SetString(PyExc_TypeError,
+                                PyErr_SetString(PyExc_ValueError,
                                                 "replication_factor and "
                                                 "replica_assignment are "
                                                 "mutually exclusive");
@@ -501,7 +501,7 @@ static PyObject *Admin_delete_topics (Handle *self, PyObject *args,
                 return NULL;
 
         if (!PyList_Check(topics) || (tcnt = (int)PyList_Size(topics)) < 1) {
-                PyErr_SetString(PyExc_TypeError,
+                PyErr_SetString(PyExc_ValueError,
                                 "Expected non-empty list of topic strings");
                 return NULL;
         }
@@ -527,7 +527,7 @@ static PyObject *Admin_delete_topics (Handle *self, PyObject *args,
 
                 if (topic == Py_None ||
                     !(utopic = cfl_PyObject_Unistr(topic))) {
-                        PyErr_Format(PyExc_TypeError,
+                        PyErr_Format(PyExc_ValueError,
                                      "Expected list of topic strings, "
                                      "not %s",
                                      ((PyTypeObject *)PyObject_Type(topic))->
@@ -605,7 +605,7 @@ static PyObject *Admin_create_partitions (Handle *self, PyObject *args,
                 return NULL;
 
         if (!PyList_Check(topics) || (tcnt = (int)PyList_Size(topics)) < 1) {
-                PyErr_SetString(PyExc_TypeError,
+                PyErr_SetString(PyExc_ValueError,
                                 "Expected non-empty list of "
                                 "NewPartitions objects");
                 return NULL;
@@ -642,7 +642,7 @@ static PyObject *Admin_create_partitions (Handle *self, PyObject *args,
                 if (r == -1)
                         goto err; /* Exception raised by IsInstance() */
                 else if (r == 0) {
-                        PyErr_SetString(PyExc_TypeError,
+                        PyErr_SetString(PyExc_ValueError,
                                         "Expected list of "
                                         "NewPartitions objects");
                         goto err;
@@ -652,7 +652,7 @@ static PyObject *Admin_create_partitions (Handle *self, PyObject *args,
                                                        newp->new_total_count,
                                                        errstr, sizeof(errstr));
                 if (!c_objs[i]) {
-                        PyErr_Format(PyExc_TypeError,
+                        PyErr_Format(PyExc_ValueError,
                                      "Invalid NewPartitions(%s): %s",
                                      newp->topic, errstr);
                         goto err;
@@ -732,7 +732,7 @@ static PyObject *Admin_describe_configs (Handle *self, PyObject *args,
 
         if (!PyList_Check(resources) ||
             (cnt = (int)PyList_Size(resources)) < 1) {
-                PyErr_SetString(PyExc_TypeError,
+                PyErr_SetString(PyExc_ValueError,
                                 "Expected non-empty list of ConfigResource "
                                 "objects");
                 return NULL;
@@ -775,7 +775,7 @@ static PyObject *Admin_describe_configs (Handle *self, PyObject *args,
                 if (r == -1)
                         goto err; /* Exception raised by IsInstance() */
                 else if (r == 0) {
-                        PyErr_SetString(PyExc_TypeError,
+                        PyErr_SetString(PyExc_ValueError,
                                         "Expected list of "
                                         "ConfigResource objects");
                         goto err;
@@ -790,7 +790,7 @@ static PyObject *Admin_describe_configs (Handle *self, PyObject *args,
                 c_objs[i] = rd_kafka_ConfigResource_new(
                         (rd_kafka_ResourceType_t)restype, resname);
                 if (!c_objs[i]) {
-                        PyErr_Format(PyExc_TypeError,
+                        PyErr_Format(PyExc_ValueError,
                                      "Invalid ConfigResource(%d,%s)",
                                      restype, resname);
                         free(resname);
@@ -871,7 +871,7 @@ static PyObject *Admin_alter_configs (Handle *self, PyObject *args,
 
         if (!PyList_Check(resources) ||
             (cnt = (int)PyList_Size(resources)) < 1) {
-                PyErr_SetString(PyExc_TypeError,
+                PyErr_SetString(PyExc_ValueError,
                                 "Expected non-empty list of ConfigResource "
                                 "objects");
                 return NULL;
@@ -926,7 +926,7 @@ static PyObject *Admin_alter_configs (Handle *self, PyObject *args,
                 if (r == -1)
                         goto err; /* Exception raised by IsInstance() */
                 else if (r == 0) {
-                        PyErr_SetString(PyExc_TypeError,
+                        PyErr_SetString(PyExc_ValueError,
                                         "Expected list of "
                                         "ConfigResource objects");
                         goto err;
@@ -941,7 +941,7 @@ static PyObject *Admin_alter_configs (Handle *self, PyObject *args,
                 c_objs[i] = rd_kafka_ConfigResource_new(
                         (rd_kafka_ResourceType_t)restype, resname);
                 if (!c_objs[i]) {
-                        PyErr_Format(PyExc_TypeError,
+                        PyErr_Format(PyExc_ValueError,
                                      "Invalid ConfigResource(%d,%s)",
                                      restype, resname);
                         free(resname);
diff --git a/tests/test_Admin.py b/tests/test_Admin.py
@@ -121,16 +121,16 @@ def test_delete_topics_api():
     fs = a.delete_topics(["mytopic"])
     # ignore the result
 
-    with pytest.raises(TypeError):
+    with pytest.raises(Exception):
         a.delete_topics(None)
 
-    with pytest.raises(TypeError):
+    with pytest.raises(Exception):
         a.delete_topics("mytopic")
 
-    with pytest.raises(TypeError):
+    with pytest.raises(Exception):
         a.delete_topics([])
 
-    with pytest.raises(TypeError):
+    with pytest.raises(ValueError):
         a.delete_topics([None, "mytopic"])
 
     fs = a.delete_topics(["mytopic", "other"])
@@ -167,7 +167,7 @@ def test_create_partitions_api():
     with pytest.raises(Exception):
         a.create_partitions("mytopic")
 
-    with pytest.raises(TypeError):
+    with pytest.raises(Exception):
         a.create_partitions([])
 
     with pytest.raises(Exception):
@@ -204,16 +204,16 @@ def test_describe_configs_api():
     fs = a.describe_configs([ConfigResource(confluent_kafka.RESOURCE_BROKER, "3")])
     # ignore the result
 
-    with pytest.raises(TypeError):
+    with pytest.raises(Exception):
         a.describe_configs(None)
 
-    with pytest.raises(TypeError):
+    with pytest.raises(Exception):
         a.describe_configs("something")
 
-    with pytest.raises(TypeError):
+    with pytest.raises(Exception):
         a.describe_configs([])
 
-    with pytest.raises(TypeError):
+    with pytest.raises(ValueError):
         a.describe_configs([None, ConfigResource(confluent_kafka.RESOURCE_TOPIC, "mytopic")])
 
     fs = a.describe_configs([ConfigResource(confluent_kafka.RESOURCE_TOPIC, "mytopic"),
@@ -235,16 +235,16 @@ def test_alter_configs_api():
                                          set_config={"some": "config"})])
     # ignore the result
 
-    with pytest.raises(TypeError):
+    with pytest.raises(Exception):
         a.alter_configs(None)
 
-    with pytest.raises(TypeError):
+    with pytest.raises(Exception):
         a.alter_configs("something")
 
-    with pytest.raises(TypeError):
+    with pytest.raises(ValueError):
         a.alter_configs([])
 
-    with pytest.raises(TypeError):
+    with pytest.raises(ValueError):
         a.alter_configs([None, ConfigResource("topic", "mytopic",
                                               add_config={"something": "else"})])
 
