fix: remove trailing underscore in transcoding

parthea · parthea · commit 0ebbe414bf3b · 2023-03-07T11:34:37.000Z
diff --git a/google/api_core/path_template.py b/google/api_core/path_template.py
@@ -308,9 +308,24 @@ def transcode(http_options, message=None, **request_kwargs):
             else:
                 try:
                     if message:
-                        request["body"] = getattr(leftovers, body)
+                        try:
+                            request["body"] = getattr(leftovers, body)
+                        except AttributeError as e:
+                            # gapic-generator-python appends underscores to field names
+                            # that collide with python keywords.
+                            # `_` is stripped away as it is not possible to
+                            # natively define a field with a trailing underscore in protobuf.
+                            # See related issue
+                            # https://github.com/googleapis/python-api-core/issues/227
+                            if hasattr(leftovers, body + "_"):
+                                request["body"] = getattr(leftovers, body + "_")
+                            else:
+                                raise e
                         delete_field(leftovers, body)
                     else:
+                        # gapic-generator-python appends underscores to field names
+                        # that collide with python keywords.
+                        leftovers = {key.rstrip('_') : val for key, val in leftovers.items()}
                         request["body"] = leftovers.pop(body)
                 except (KeyError, AttributeError):
                     continue
diff --git a/tests/unit/test_path_template.py b/tests/unit/test_path_template.py
@@ -413,6 +413,13 @@ def test_transcode_with_wildcard(
             {"data": {"id": 1, "info": "some info"}, "foo": "bar"},
             ["post", "/v1/no/template", {"id": 1, "info": "some info"}, {"foo": "bar"}],
         ],
+        # Single field body with trailing underscore
+        [
+            [["post", "/v1/no/template", "data"]],
+            None,
+            {"data": {"id": 1, "info": "some info"}, "foo_": "bar"},
+            ["post", "/v1/no/template", {"id": 1, "info": "some info"}, {"foo": "bar"}],
+        ],
         [
             [["post", "/v1/no/template", "oauth"]],
             auth_pb2.AuthenticationRule(
