Add final set of protobuf helpers to api_core #4259

theacodes · 2017-10-25T22:51:11Z

Note: this is directly ported from gax, barring minor changes, this code has already been reviewed.

dhermes

This PR is surprisingly complex

api_core/google/api_core/protobuf_helpers.py

+
+def _resolve_subkeys(key, separator='.'):
+    """Given a key which may actually be a nested key, return the top level
+    key and any nested subkeys as separate values.


api_core/google/api_core/protobuf_helpers.py

+    if separator in key:
+        index = key.index(separator)
+        subkey = key[index + 1:]
+        key = key[:index]


api_core/google/api_core/protobuf_helpers.py

+            default is generally recommended, as protobuf messages almost
+            always have default values for unset values and it is not always
+            possible to tell the difference between a falsy value and an
+            unset one. If no default is set then raises :class:`KeyError` will


api_core/google/api_core/protobuf_helpers.py

+    # Attempt to get the value from the two types of objects we know about.
+    # If we get something else, complain.
+    if isinstance(msg_or_dict, Message):
+        answer = getattr(msg_or_dict, key, default)


api_core/google/api_core/protobuf_helpers.py

+        raise KeyError(key)
+
+    # If a subkey exists, call this method recursively against the answer.
+    if subkey and answer is not default:


api_core/google/api_core/protobuf_helpers.py

+                type(msg_or_dict)))
+
+    # We may be setting a nested key. Resolve this.
+    key, subkey = _resolve_subkeys(key)


api_core/google/api_core/protobuf_helpers.py

+    # If a subkey exists, then get that object and call this method
+    # recursively against it using the subkey.
+    if subkey is not None:
+        if isinstance(msg_or_dict, collections.MutableMapping):


api_core/google/api_core/protobuf_helpers.py

+
+
+def setdefault(msg_or_dict, key, value):
+    """Set the key on a protobuf Message or dictioanary to a given value if the


api_core/google/api_core/protobuf_helpers.py

+    current value is falsy.
+
+    Because protobuf Messages do not distinguish between unset values and
+    falsy ones particularly well, this method treats any falsy value


api_core/google/api_core/protobuf_helpers.py

+        # Clear the existing repeated protobuf message of any elements
+        # currently inside it.
+        while getattr(msg, key):
+            getattr(msg, key).pop()


api_core/google/api_core/protobuf_helpers.py

+            if isinstance(item, collections.Mapping):
+                getattr(msg, key).add(**item)
+            else:
+                getattr(msg, key).extend([item])


api_core/google/api_core/protobuf_helpers.py

+    elif isinstance(value, Message):
+        # Assign the protobuf message values to the protobuf message.
+        for item_key, item_value in value.ListFields():
+            set(getattr(msg, key), item_key.name, item_value)


api_core/google/api_core/protobuf_helpers.py

+def _set_field_on_message(msg, key, value):
+    """Set helper for protobuf Messages."""
+    # Attempt to set the value on the types of objects we know how to deal
+    # with.


api_core/google/api_core/protobuf_helpers.py

+                getattr(msg, key).add(**item)
+            else:
+                getattr(msg, key).extend([item])
+    elif isinstance(value, collections.Mapping):


Add final set of protobuf helpers to api_core

40b4489

theacodes added the api: core label Oct 25, 2017

theacodes requested review from lukesneeringer and dhermes October 25, 2017 22:51

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Oct 25, 2017

dhermes reviewed Oct 25, 2017

View reviewed changes

Address review comments

72424e4

dhermes reviewed Oct 26, 2017

View reviewed changes

Address review comments

196e9b3

theacodes merged commit 4c24da3 into googleapis:master Oct 26, 2017

theacodes deleted the api-core-proto-helpers branch October 26, 2017 19:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add final set of protobuf helpers to api_core #4259

Add final set of protobuf helpers to api_core #4259

theacodes commented Oct 25, 2017

dhermes left a comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.



		def setdefault(msg_or_dict, key, value):
		"""Set the key on a protobuf Message or dictioanary to a given value if the

Add final set of protobuf helpers to api_core #4259

Add final set of protobuf helpers to api_core #4259

Conversation

theacodes commented Oct 25, 2017

dhermes left a comment

Choose a reason for hiding this comment

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.

This comment was marked as spam.