Skip to content

Fix KeyError in _EncodeCustomFieldNames when field name is a substring #336

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
YonathanZetune merged 1 commit into from
Sep 17, 2026
Merged

Fix KeyError in _EncodeCustomFieldNames when field name is a substring #336

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apitools/base/py/encoding_helper.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -691,7 +691,7 @@ def _EncodeCustomFieldNames(message, encoded_value):
if field_remappings:
decoded_value = json.loads(encoded_value)
for python_name, json_name in field_remappings:
if python_name in encoded_value:
if python_name in decoded_value:
decoded_value[json_name] = decoded_value.pop(python_name)
encoded_value = json.dumps(decoded_value)
return encoded_value
Expand Down
16 changes: 16 additions & 0 deletions apitools/base/py/encoding_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,7 @@ class SomeEnum(messages.Enum):
another_field = messages.StringField(3)
repeated_enum = messages.EnumField(SomeEnum, 4, repeated=True)
repeated_field = messages.StringField(5, repeated=True)
field = messages.StringField(6)


class MessageWithPackageAndRemappings(messages.Message):
Expand Down Expand Up @@ -236,6 +237,8 @@ class AdditionalProperty(messages.Message):
'another_field', 'anotherField')
encoding.AddCustomJsonFieldMapping(MessageWithRemappings,
'repeated_field', 'repeatedField')
encoding.AddCustomJsonFieldMapping(MessageWithRemappings,
'field', 'remappedField')


class EncodingTest(unittest.TestCase):
Expand Down Expand Up @@ -644,6 +647,19 @@ def testMultipleRemapping(self):
self.assertEqual(
msg, encoding.JsonToMessage(MessageWithRemappings, json_message))

def testSubstringFieldRemapping(self):
# 'field' is a substring of 'another_field' and 'repeated_field',
# as well as a substring of the string value below. When 'field' is
# unset, encoding must not raise KeyError.
msg = MessageWithRemappings(
another_field='value containing field substring')
json_message = encoding.MessageToJson(msg)
self.assertEqual(
'{"anotherField": "value containing field substring"}',
json_message)
self.assertEqual(
msg, encoding.JsonToMessage(MessageWithRemappings, json_message))

def testRepeatedRemapping(self):
# Should allow remapping if the mapping remains the same.
encoding.AddCustomJsonEnumMapping(MessageWithRemappings.SomeEnum,
Expand Down
Loading