refactor: address PR reviews

openedx_events/event_bus/avro/deserializer.py

@@ -41,25 +41,25 @@ def _deserialized_avro_record_dict_to_object(data: dict, data_type, deserializer
     elif data_type in PYTHON_TYPE_TO_AVRO_MAPPING:
         return data
     elif data_type_origin == list:
-        # returns types of list contents
-        # if data_type == List[int], arg_data_type = (int,)
+        # Returns types of list contents.
+        # Example: if data_type == List[int], arg_data_type = (int,)
         arg_data_type = get_args(data_type)
         if not arg_data_type:
             raise TypeError(
                 "List without annotation type is not supported. The argument should be a type, for eg., List[int]"
             )
-        # check whether list items type is in basic types.
+        # Check whether list items type is in basic types.
         if arg_data_type[0] in SIMPLE_PYTHON_TYPE_TO_AVRO_MAPPING:
             return data
     elif data_type_origin == dict:
-        # returns types of dict contents
-        # if data_type == Dict[str, int], arg_data_type = (str, int)
+        # Returns types of dict contents.
+        # Example: if data_type == Dict[str, int], arg_data_type = (str, int)
         arg_data_type = get_args(data_type)
         if not arg_data_type:
             raise TypeError(
                 "Dict without annotation type is not supported. The argument should be a type, for eg., Dict[str, int]"
             )
-        # check whether dict items type is in basic types.
+        # Check whether dict items type is in basic types.
         if arg_data_type[1] in SIMPLE_PYTHON_TYPE_TO_AVRO_MAPPING:
             return data
     elif hasattr(data_type, "__attrs_attrs__"):

openedx_events/event_bus/avro/schema.py

@@ -63,7 +63,7 @@ def _create_avro_field_definition(data_key, data_type, previously_seen_types,
         field["type"] = field_type
     # Case 2: data_type is a simple type that can be converted directly to an Avro type
     elif data_type in PYTHON_TYPE_TO_AVRO_MAPPING:
-        if PYTHON_TYPE_TO_AVRO_MAPPING[data_type] in ["record", "map", "array"]:
+        if PYTHON_TYPE_TO_AVRO_MAPPING[data_type] in ["map", "array"]:
             # pylint: disable-next=broad-exception-raised
             raise Exception("Unable to generate Avro schema for dict or array fields without annotation types.")
         avro_type = PYTHON_TYPE_TO_AVRO_MAPPING[data_type]