Correct warning logic (and text) for use.deprecated.format (confluentinc#1265)

edenhill · edenhill · commit ab9d21b14053 · 2022-01-20T17:29:09.000+01:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,18 @@
 # Confluent's Python client for Apache Kafka
 
+## v1.8.3
+
+v1.8.3 is a maintenance release with the following fixes:
+
+ - The warnings for `use.deprecated.format` (introduced in v1.8.2)
+   had its logic reversed, which result in warning logs to be emitted when
+   the property was correctly configured, and the log message itself also
+   contained text that had it backwards.
+   The warning is now only emitted when `use.deprecated.format` is set
+   to the old legacy encoding (`True`). #1265
+
+
+
 ## v1.8.2
 
 v1.8.2 is a maintenance release with the following fixes and enhancements:
diff --git a/src/confluent_kafka/schema_registry/protobuf.py b/src/confluent_kafka/schema_registry/protobuf.py
@@ -258,14 +258,14 @@ def __init__(self, msg_type, schema_registry_client, conf=None):
         self._use_deprecated_format = conf_copy.pop('use.deprecated.format')
         if not isinstance(self._use_deprecated_format, bool):
             raise ValueError("use.deprecated.format must be a boolean value")
-        if not self._use_deprecated_format:
+        if self._use_deprecated_format:
             warnings.warn("ProtobufSerializer: the 'use.deprecated.format' "
                           "configuration property, and the ability to use the "
                           "old incorrect Protobuf serializer heading format "
                           "introduced in confluent-kafka-python v1.4.0, "
                           "will be removed in an upcoming release in 2021 Q2. "
                           "Please migrate your Python Protobuf producers and "
-                          "consumers to 'use.deprecated.format':True as "
+                          "consumers to 'use.deprecated.format':False as "
                           "soon as possible")
 
         self._subject_name_func = conf_copy.pop('subject.name.strategy')
@@ -482,14 +482,14 @@ def __init__(self, message_type, conf=None):
         self._use_deprecated_format = conf_copy.pop('use.deprecated.format')
         if not isinstance(self._use_deprecated_format, bool):
             raise ValueError("use.deprecated.format must be a boolean value")
-        if not self._use_deprecated_format:
+        if self._use_deprecated_format:
             warnings.warn("ProtobufDeserializer: the 'use.deprecated.format' "
                           "configuration property, and the ability to use the "
                           "old incorrect Protobuf serializer heading format "
                           "introduced in confluent-kafka-python v1.4.0, "
                           "will be removed in an upcoming release in 2022 Q2. "
                           "Please migrate your Python Protobuf producers and "
-                          "consumers to 'use.deprecated.format':True as "
+                          "consumers to 'use.deprecated.format':False as "
                           "soon as possible")
 
         descriptor = message_type.DESCRIPTOR
