Merge pull request googleapis#2600 from dhermes/gax-logging-use-messagetodict

Use MessageToDict in logging._gax

Author: dhermes

logging/google/cloud/logging/_gax.py

@@ -18,15 +18,14 @@
 from google.gax import INITIAL_PAGE
 from google.gax.errors import GaxError
 from google.gax.grpc import exc_to_code
-from google.logging.type.log_severity_pb2 import LogSeverity
 from google.logging.v2.logging_config_pb2 import LogSink
 from google.logging.v2.logging_metrics_pb2 import LogMetric
 from google.logging.v2.log_entry_pb2 import LogEntry
+from google.protobuf.json_format import MessageToDict
 from google.protobuf.json_format import ParseDict
 from grpc import StatusCode
 
-from google.cloud._helpers import _datetime_to_pb_timestamp
-from google.cloud._helpers import _pb_timestamp_to_rfc3339
+from google.cloud._helpers import _datetime_to_rfc3339
 from google.cloud.exceptions import Conflict
 from google.cloud.exceptions import NotFound
 
@@ -77,7 +76,7 @@ def list_entries(self, projects, filter_='', order_by='',
         page_iter = self._gax_api.list_log_entries(
             projects, filter_=filter_, order_by=order_by,
             page_size=page_size, options=options)
-        entries = [_log_entry_pb_to_mapping(entry_pb)
+        entries = [MessageToDict(entry_pb)
                    for entry_pb in page_iter.next()]
         token = page_iter.page_token or None
         return entries, token
@@ -163,7 +162,7 @@ def list_sinks(self, project, page_size=0, page_token=None):
         path = 'projects/%s' % (project,)
         page_iter = self._gax_api.list_sinks(path, page_size=page_size,
                                              options=options)
-        sinks = [_log_sink_pb_to_mapping(log_sink_pb)
+        sinks = [MessageToDict(log_sink_pb)
                  for log_sink_pb in page_iter.next()]
         token = page_iter.page_token or None
         return sinks, token
@@ -221,7 +220,7 @@ def sink_get(self, project, sink_name):
             if exc_to_code(exc.cause) == StatusCode.NOT_FOUND:
                 raise NotFound(path)
             raise
-        return _log_sink_pb_to_mapping(sink_pb)
+        return MessageToDict(sink_pb)
 
     def sink_update(self, project, sink_name, filter_, destination):
         """API call:  update a sink resource.
@@ -253,7 +252,7 @@ def sink_update(self, project, sink_name, filter_, destination):
             if exc_to_code(exc.cause) == StatusCode.NOT_FOUND:
                 raise NotFound(path)
             raise
-        return _log_sink_pb_to_mapping(sink_pb)
+        return MessageToDict(sink_pb)
 
     def sink_delete(self, project, sink_name):
         """API call:  delete a sink resource.
@@ -310,7 +309,7 @@ def list_metrics(self, project, page_size=0, page_token=None):
         path = 'projects/%s' % (project,)
         page_iter = self._gax_api.list_log_metrics(
             path, page_size=page_size, options=options)
-        metrics = [_log_metric_pb_to_mapping(log_metric_pb)
+        metrics = [MessageToDict(log_metric_pb)
                    for log_metric_pb in page_iter.next()]
         token = page_iter.page_token or None
         return metrics, token
@@ -367,7 +366,7 @@ def metric_get(self, project, metric_name):
             if exc_to_code(exc.cause) == StatusCode.NOT_FOUND:
                 raise NotFound(path)
             raise
-        return _log_metric_pb_to_mapping(metric_pb)
+        return MessageToDict(metric_pb)
 
     def metric_update(self, project, metric_name, filter_, description):
         """API call:  update a metric resource.
@@ -399,7 +398,7 @@ def metric_update(self, project, metric_name, filter_, description):
             if exc_to_code(exc.cause) == StatusCode.NOT_FOUND:
                 raise NotFound(path)
             raise
-        return _log_metric_pb_to_mapping(metric_pb)
+        return MessageToDict(metric_pb)
 
     def metric_delete(self, project, metric_name):
         """API call:  delete a metric resource.
@@ -420,225 +419,14 @@ def metric_delete(self, project, metric_name):
             raise
 
 
-def _mon_resource_pb_to_mapping(resource_pb):
-    """Helper for  :func:_log_entry_pb_to_mapping`.
-
-    Performs "impedance matching" between the protobuf attrs and the keys
-    expected in the JSON API.
-    """
-    mapping = {
-        'type': resource_pb.type,
-    }
-    if resource_pb.labels:
-        mapping['labels'] = resource_pb.labels
-    return mapping
-
-
-def _value_pb_to_value(value_pb):
-    """Helper for :func:`_log_entry_pb_to_mapping`.
-
-    Performs "impedance matching" between the protobuf attrs and the keys
-    expected in the JSON API.
-    """
-    kind = value_pb.WhichOneof('kind')
-
-    if kind is None:
-        result = None
-
-    elif kind == 'string_value':
-        result = value_pb.string_value
-
-    elif kind == 'bool_value':
-        result = value_pb.bool_value
-
-    elif kind == 'number_value':
-        result = value_pb.number_value
-
-    elif kind == 'list_value':
-        result = [_value_pb_to_value(element)
-                  for element in value_pb.list_value.values]
-
-    elif kind == 'struct_value':
-        result = _struct_pb_to_mapping(value_pb.struct_value)
-
-    else:
-        raise ValueError('Value protobuf had unknown kind: %s' % (kind,))
-
-    return result
-
-
-def _struct_pb_to_mapping(struct_pb):
-    """Helper for :func:`_log_entry_pb_to_mapping`.
-
-    Performs "impedance matching" between the protobuf attrs and the keys
-    expected in the JSON API.
-    """
-    return {key: _value_pb_to_value(struct_pb.fields[key])
-            for key in struct_pb.fields}
-
-
-def _log_entry_pb_to_mapping(entry_pb):
-    """Helper for :meth:`list_entries`, et aliae
-
-    Performs "impedance matching" between the protobuf attrs and the keys
-    expected in the JSON API.
-    """
-    mapping = {
-        'logName': entry_pb.log_name,
-        'resource': _mon_resource_pb_to_mapping(entry_pb.resource),
-        'severity': LogSeverity.Name(entry_pb.severity),
-        'insertId': entry_pb.insert_id,
-        'timestamp': _pb_timestamp_to_rfc3339(entry_pb.timestamp),
-        'labels': entry_pb.labels,
-    }
-    if entry_pb.HasField('text_payload'):
-        mapping['textPayload'] = entry_pb.text_payload
-
-    if entry_pb.HasField('json_payload'):
-        mapping['jsonPayload'] = _struct_pb_to_mapping(entry_pb.json_payload)
-
-    if entry_pb.HasField('proto_payload'):
-        mapping['protoPayload'] = entry_pb.proto_payload
-
-    if entry_pb.http_request:
-        request = entry_pb.http_request
-        mapping['httpRequest'] = {
-            'requestMethod': request.request_method,
-            'requestUrl': request.request_url,
-            'status': request.status,
-            'referer': request.referer,
-            'userAgent': request.user_agent,
-            'cacheHit': request.cache_hit,
-            'requestSize': request.request_size,
-            'responseSize': request.response_size,
-            'remoteIp': request.remote_ip,
-        }
-
-    if entry_pb.operation:
-        operation = entry_pb.operation
-        mapping['operation'] = {
-            'producer': operation.producer,
-            'id': operation.id,
-            'first': operation.first,
-            'last': operation.last,
-        }
-
-    return mapping
-
-
-def _http_request_mapping_to_pb(info, request):
-    """Helper for _log_entry_mapping_to_pb
-
-    Performs "impedance matching" between the protobuf attrs and the keys
-    expected in the JSON API.
-    """
-    optional_request_keys = {
-        'requestMethod': 'request_method',
-        'requestUrl': 'request_url',
-        'status': 'status',
-        'referer': 'referer',
-        'userAgent': 'user_agent',
-        'cacheHit': 'cache_hit',
-        'requestSize': 'request_size',
-        'responseSize': 'response_size',
-        'remoteIp': 'remote_ip',
-    }
-    for key, pb_name in optional_request_keys.items():
-        if key in info:
-            setattr(request, pb_name, info[key])
-
-
-def _log_operation_mapping_to_pb(info, operation):
-    """Helper for _log_entry_mapping_to_pb
-
-    Performs "impedance matching" between the protobuf attrs and the keys
-    expected in the JSON API.
-    """
-    operation.producer = info['producer']
-    operation.id = info['id']
-
-    if 'first' in info:
-        operation.first = info['first']
-
-    if 'last' in info:
-        operation.last = info['last']
-
-
 def _log_entry_mapping_to_pb(mapping):
     """Helper for :meth:`write_entries`, et aliae
 
-    Performs "impedance matching" between the protobuf attrs and the keys
-    expected in the JSON API.
+    Performs "impedance matching" between the protobuf attrs and
+    the keys expected in the JSON API.
     """
-    # pylint: disable=too-many-branches
     entry_pb = LogEntry()
-
-    optional_scalar_keys = {
-        'logName': 'log_name',
-        'insertId': 'insert_id',
-        'textPayload': 'text_payload',
-    }
-
-    for key, pb_name in optional_scalar_keys.items():
-        if key in mapping:
-            setattr(entry_pb, pb_name, mapping[key])
-
-    if 'resource' in mapping:
-        entry_pb.resource.type = mapping['resource']['type']
-
-    if 'severity' in mapping:
-        severity = mapping['severity']
-        if isinstance(severity, str):
-            severity = LogSeverity.Value(severity)
-        entry_pb.severity = severity
-
     if 'timestamp' in mapping:
-        timestamp = _datetime_to_pb_timestamp(mapping['timestamp'])
-        entry_pb.timestamp.CopyFrom(timestamp)
-
-    if 'labels' in mapping:
-        for key, value in mapping['labels'].items():
-            entry_pb.labels[key] = value
-
-    if 'jsonPayload' in mapping:
-        ParseDict(mapping['jsonPayload'], entry_pb.json_payload)
-
-    if 'protoPayload' in mapping:
-        ParseDict(mapping['protoPayload'], entry_pb.proto_payload)
-
-    if 'httpRequest' in mapping:
-        _http_request_mapping_to_pb(
-            mapping['httpRequest'], entry_pb.http_request)
-
-    if 'operation' in mapping:
-        _log_operation_mapping_to_pb(
-            mapping['operation'], entry_pb.operation)
-
+        mapping['timestamp'] = _datetime_to_rfc3339(mapping['timestamp'])
+    ParseDict(mapping, entry_pb)
     return entry_pb
-    # pylint: enable=too-many-branches
-
-
-def _log_sink_pb_to_mapping(sink_pb):
-    """Helper for :meth:`list_sinks`, et aliae
-
-    Performs "impedance matching" between the protobuf attrs and the keys
-    expected in the JSON API.
-    """
-    return {
-        'name': sink_pb.name,
-        'destination': sink_pb.destination,
-        'filter': sink_pb.filter,
-    }
-
-
-def _log_metric_pb_to_mapping(metric_pb):
-    """Helper for :meth:`list_metrics`, et aliae
-
-    Performs "impedance matching" between the protobuf attrs and the keys
-    expected in the JSON API.
-    """
-    return {
-        'name': metric_pb.name,
-        'description': metric_pb.description,
-        'filter': metric_pb.filter,
-    }