generic and specific avro examples (confluentinc#1381)

emasab · web-flow · commit d18907598af6 · 2022-07-01T11:43:18.000+02:00
* generic and specific avro examples
moved protobuf to a similiar folder

* removed empty __init__.py
diff --git a/examples/Makefile b/examples/Makefile
@@ -1,5 +1,5 @@
-user_pb2.py: user.proto
-	protoc -I=. --python_out=. ./user.proto;
+user_pb2.py: protobuf/user.proto
+	cd protobuf && protoc -I=. --python_out=. ./user.proto;
 
 clean:
-	rm -f $(TARGET_DIR)/*_pb2.py
+	rm -f $(TARGET_DIR)/protobuf/*_pb2.py
diff --git a/examples/avro-cli.py b/examples/avro-cli.py
@@ -16,25 +16,17 @@
 #
 
 import argparse
+import os
 from uuid import uuid4
 
 from six.moves import input
 
 from confluent_kafka import avro
 
 # Parse Schema used for serializing User class
-record_schema = avro.loads("""
-    {
-        "namespace": "confluent.io.examples.serialization.avro",
-        "name": "User",
-        "type": "record",
-        "fields": [
-            {"name": "name", "type": "string"},
-            {"name": "favorite_number", "type": "int"},
-            {"name": "favorite_color", "type": "string"}
-        ]
-    }
-""")
+path = os.path.realpath(os.path.dirname(__file__))
+with open(f"{path}/avro/user_specific.avsc") as f:
+    record_schema = avro.loads(f.read())
 
 
 class User(object):
diff --git a/examples/avro/user_generic.avsc b/examples/avro/user_generic.avsc
@@ -0,0 +1,18 @@
+{
+    "name": "User",
+    "type": "record",
+    "fields": [
+        {
+            "name": "name",
+            "type": "string"
+        },
+        {
+            "name": "favorite_number",
+            "type": "long"
+        },
+        {
+            "name": "favorite_color",
+            "type": "string"
+        }
+    ]
+}
diff --git a/examples/avro/user_specific.avsc b/examples/avro/user_specific.avsc
@@ -0,0 +1,19 @@
+{
+    "namespace": "confluent.io.examples.serialization.avro",
+    "name": "User",
+    "type": "record",
+    "fields": [
+        {
+            "name": "name",
+            "type": "string"
+        },
+        {
+            "name": "favorite_number",
+            "type": "long"
+        },
+        {
+            "name": "favorite_color",
+            "type": "string"
+        }
+    ]
+}
diff --git a/examples/avro_consumer.py b/examples/avro_consumer.py
@@ -20,6 +20,7 @@
 # This is a simple example of the SerializingProducer using Avro.
 #
 import argparse
+import os
 
 from confluent_kafka import DeserializingConsumer
 from confluent_kafka.schema_registry import SchemaRegistryClient
@@ -66,19 +67,16 @@ def dict_to_user(obj, ctx):
 
 def main(args):
     topic = args.topic
+    is_specific = args.specific == "true"
 
-    schema_str = """
-    {
-        "namespace": "confluent.io.examples.serialization.avro",
-        "name": "User",
-        "type": "record",
-        "fields": [
-            {"name": "name", "type": "string"},
-            {"name": "favorite_number", "type": "int"},
-            {"name": "favorite_color", "type": "string"}
-        ]
-    }
-    """
+    if is_specific:
+        schema = "user_specific.avsc"
+    else:
+        schema = "user_generic.avsc"
+
+    path = os.path.realpath(os.path.dirname(__file__))
+    with open(f"{path}/avro/{schema}") as f:
+        schema_str = f.read()
 
     sr_conf = {'url': args.schema_registry}
     schema_registry_client = SchemaRegistryClient(sr_conf)
@@ -110,8 +108,8 @@ def main(args):
                       "\tfavorite_number: {}\n"
                       "\tfavorite_color: {}\n"
                       .format(msg.key(), user.name,
-                              user.favorite_color,
-                              user.favorite_number))
+                              user.favorite_number,
+                              user.favorite_color))
         except KeyboardInterrupt:
             break
 
@@ -129,5 +127,7 @@ def main(args):
                         help="Topic name")
     parser.add_argument('-g', dest="group", default="example_serde_avro",
                         help="Consumer group")
+    parser.add_argument('-p', dest="specific", default="true",
+                        help="Avro specific record")
 
     main(parser.parse_args())
diff --git a/examples/avro_producer.py b/examples/avro_producer.py
@@ -20,6 +20,7 @@
 # This is a simple example of the SerializingProducer using Avro.
 #
 import argparse
+import os
 from uuid import uuid4
 
 from six.moves import input
@@ -99,19 +100,17 @@ def delivery_report(err, msg):
 
 def main(args):
     topic = args.topic
+    is_specific = args.specific == "true"
+
+    if is_specific:
+        schema = "user_specific.avsc"
+    else:
+        schema = "user_generic.avsc"
+
+    path = os.path.realpath(os.path.dirname(__file__))
+    with open(f"{path}/avro/{schema}") as f:
+        schema_str = f.read()
 
-    schema_str = """
-    {
-        "namespace": "confluent.io.examples.serialization.avro",
-        "name": "User",
-        "type": "record",
-        "fields": [
-            {"name": "name", "type": "string"},
-            {"name": "favorite_number", "type": "int"},
-            {"name": "favorite_color", "type": "string"}
-        ]
-    }
-    """
     schema_registry_conf = {'url': args.schema_registry}
     schema_registry_client = SchemaRegistryClient(schema_registry_conf)
 
@@ -158,5 +157,7 @@ def main(args):
                         help="Schema Registry (http(s)://host[:port]")
     parser.add_argument('-t', dest="topic", default="example_serde_avro",
                         help="Topic name")
+    parser.add_argument('-p', dest="specific", default="true",
+                        help="Avro specific record")
 
     main(parser.parse_args())
diff --git a/examples/json_consumer.py b/examples/json_consumer.py
@@ -116,8 +116,8 @@ def main(args):
                       "\tfavorite_number: {}\n"
                       "\tfavorite_color: {}\n"
                       .format(msg.key(), user.name,
-                              user.favorite_color,
-                              user.favorite_number))
+                              user.favorite_number,
+                              user.favorite_color))
         except KeyboardInterrupt:
             break
 
diff --git a/examples/protobuf/user.proto b/examples/protobuf/user.proto
diff --git a/examples/protobuf/user_pb2.py b/examples/protobuf/user_pb2.py
diff --git a/examples/protobuf_consumer.py b/examples/protobuf_consumer.py
@@ -31,8 +31,8 @@
 #
 import argparse
 
-# Protobuf generated class; resides at ./user_pb2.py
-import user_pb2
+# Protobuf generated class; resides at ./protobuf/user_pb2.py
+import protobuf.user_pb2 as user_pb2
 from confluent_kafka import DeserializingConsumer
 from confluent_kafka.schema_registry.protobuf import ProtobufDeserializer
 from confluent_kafka.serialization import StringDeserializer
diff --git a/examples/protobuf_producer.py b/examples/protobuf_producer.py
@@ -34,8 +34,8 @@
 
 from six.moves import input
 
-# Protobuf generated class; resides at ./user_pb2.py
-import user_pb2
+# Protobuf generated class; resides at ./protobuf/user_pb2.py
+import protobuf.user_pb2 as user_pb2
 from confluent_kafka import SerializingProducer
 from confluent_kafka.serialization import StringSerializer
 from confluent_kafka.schema_registry import SchemaRegistryClient
@@ -75,7 +75,7 @@ def main(args):
 
     protobuf_serializer = ProtobufSerializer(user_pb2.User,
                                              schema_registry_client,
-                                             {'use.deprecated.format': True})
+                                             {'use.deprecated.format': False})
 
     producer_conf = {'bootstrap.servers': args.bootstrap_servers,
                      'key.serializer': StringSerializer('utf_8'),
diff --git a/examples/user_pb2.py b/examples/user_pb2.py
diff --git a/src/confluent_kafka/admin/__init__.py b/src/confluent_kafka/admin/__init__.py
@@ -402,10 +402,14 @@ def describe_acls(self, acl_binding_filter, **kwargs):
                   must match.
                   String attributes match exact values or any string if set to None.
                   Enums attributes match exact values or any value if equal to `ANY`.
-                  If :class:`ResourcePatternType` is set to :attr:`ResourcePatternType.MATCH` returns ACL bindings with:
-                  :attr:`ResourcePatternType.LITERAL` pattern type with resource name equal to the given resource name;
-                  :attr:`ResourcePatternType.LITERAL` pattern type with wildcard resource name that matches the given resource name; 
-                  :attr:`ResourcePatternType.PREFIXED` pattern type with resource name that is a prefix of the given resource name
+                  If :class:`ResourcePatternType` is set to :attr:`ResourcePatternType.MATCH`
+                  returns ACL bindings with:
+                  :attr:`ResourcePatternType.LITERAL` pattern type with resource name equal
+                  to the given resource name;
+                  :attr:`ResourcePatternType.LITERAL` pattern type with wildcard resource name
+                  that matches the given resource name;
+                  :attr:`ResourcePatternType.PREFIXED` pattern type with resource name
+                  that is a prefix of the given resource name
         :param float request_timeout: The overall request timeout in seconds,
                   including broker lookup, request transmission, operation time
                   on broker, and response. Default: `socket.timeout.ms*1000.0`
@@ -433,10 +437,14 @@ def delete_acls(self, acl_binding_filters, **kwargs):
                   to match ACLs to delete.
                   String attributes match exact values or any string if set to None.
                   Enums attributes match exact values or any value if equal to `ANY`.
-                  If :class:`ResourcePatternType` is set to :attr:`ResourcePatternType.MATCH` deletes ACL bindings with:
-                  :attr:`ResourcePatternType.LITERAL` pattern type with resource name equal to the given resource name;
-                  :attr:`ResourcePatternType.LITERAL` pattern type with wildcard resource name that matches the given resource name; 
-                  :attr:`ResourcePatternType.PREFIXED` pattern type with resource name that is a prefix of the given resource name
+                  If :class:`ResourcePatternType` is set to :attr:`ResourcePatternType.MATCH`
+                  deletes ACL bindings with:
+                  :attr:`ResourcePatternType.LITERAL` pattern type with resource name
+                  equal to the given resource name;
+                  :attr:`ResourcePatternType.LITERAL` pattern type with wildcard resource name
+                  that matches the given resource name;
+                  :attr:`ResourcePatternType.PREFIXED` pattern type with resource name
+                  that is a prefix of the given resource name
         :param float request_timeout: The overall request timeout in seconds,
                   including broker lookup, request transmission, operation time
                   on broker, and response. Default: `socket.timeout.ms*1000.0`
