Skip to content

Commit 7913f38

Browse files
committed
chore: improve inline comments and move code
1 parent 0ba313d commit 7913f38

File tree

2 files changed

+10
-11
lines changed

2 files changed

+10
-11
lines changed

openedx_events/event_bus/avro/deserializer.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ def _deserialized_avro_record_dict_to_object(data: dict, data_type, deserializer
5353
if arg_data_type[0] in SIMPLE_PYTHON_TYPE_TO_AVRO_MAPPING:
5454
return data
5555

56-
# Complex list items that need recursive deserialization
56+
# Complex nested types like List[List[...]], List[Dict[...]], etc.
5757
item_type = arg_data_type[0]
5858
return [_deserialized_avro_record_dict_to_object(sub_data, item_type, deserializers) for sub_data in data]
5959
elif data_type_origin is dict:
@@ -73,10 +73,10 @@ def _deserialized_avro_record_dict_to_object(data: dict, data_type, deserializer
7373
if key_type is not str:
7474
raise TypeError("Avro maps only support string keys. The key type must be 'str'.")
7575

76-
# For complex nested types like Dict[str, Dict[...]], Dict[str, List[...]], etc.
76+
# Complex nested types like Dict[str, Dict[...]], Dict[str, List[...]], etc.
7777
return {
78-
k: _deserialized_avro_record_dict_to_object(v, value_type, deserializers)
79-
for k, v in data.items()
78+
key: _deserialized_avro_record_dict_to_object(value, value_type, deserializers)
79+
for key, value in data.items()
8080
}
8181
elif hasattr(data_type, "__attrs_attrs__"):
8282
transformed = {}

openedx_events/event_bus/avro/tests/test_avro.py

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -122,8 +122,7 @@ def process_type(type_spec: Any) -> Any:
122122
defined types.
123123
124124
Args:
125-
type_spec (Any): A type specification which might be a string,
126-
dict, or list
125+
type_spec (Any): A type specification which might be a str, dict, or list
127126
128127
Returns:
129128
Any: An appropriate test value for the specified type
@@ -166,7 +165,7 @@ def process_type(type_spec: Any) -> Any:
166165
# Array type (list)
167166
elif type_name == "array":
168167
items = type_spec.get("items")
169-
# We crate a list with a single element
168+
# We create a list with a single element
170169
return [process_type(items)]
171170

172171
# Map type (dictionary/object)
@@ -252,6 +251,10 @@ def generate_test_event_data_for_data_type(data_type: Any) -> dict: # pragma: n
252251

253252
item_type = args[0]
254253

254+
# Handle List of simple types, e.g. List[str]
255+
if item_type in defaults_per_type:
256+
return [defaults_per_type[item_type]]
257+
255258
# Handle List of Dicts, e.g. List[Dict[str, str]]
256259
if get_origin(item_type) is dict:
257260
dict_key_type, dict_value_type = get_args(item_type)
@@ -270,10 +273,6 @@ def generate_test_event_data_for_data_type(data_type: Any) -> dict: # pragma: n
270273

271274
return [sample_dict]
272275

273-
# Handle List of simple types, e.g. List[str]
274-
if item_type in defaults_per_type:
275-
return [defaults_per_type[item_type]]
276-
277276
# Handle List of attrs classes, e.g. List[EventData]
278277
item_data = generate_test_event_data_for_data_type(item_type)
279278
return [item_data]

0 commit comments

Comments
 (0)