Use protobuf objects with types instead of dicts (#211)

Author: aabmass

dev-constraints.txt

@@ -1,5 +1,8 @@
 black==22.3.0
 flake8==3.9.2
+# 3rd party package until https://github.com/googleapis/python-api-common-protos/issues/135 is
+# fixed
+googleapis-common-protos-stubs==2.1.0
 isort==5.8.0
 mypy-extensions==0.4.3
 mypy==0.982

opentelemetry-exporter-gcp-monitoring/mypy.ini

@@ -3,19 +3,5 @@ namespace_packages = True
 explicit_package_bases = True
 mypy_path = $MYPY_CONFIG_FILE_DIR/src
 
-[mypy-opentelemetry.sdk.*]
-ignore_missing_imports = True
-
 [mypy-google.auth.*]
 ignore_missing_imports = True
-
-[mypy-google.cloud.*]
-ignore_missing_imports = True
-
-[mypy-google.api.*]
-ignore_missing_imports = True
-
-[mypy-google.rpc.*]
-ignore_missing_imports = True
-
-

opentelemetry-exporter-gcp-monitoring/src/opentelemetry/exporter/cloud_monitoring/__init__.py

@@ -156,37 +156,37 @@ def _get_metric_descriptor(
         if descriptor_type in self._metric_descriptors:
             return self._metric_descriptors[descriptor_type]
 
-        descriptor = {  # type: ignore[var-annotated] # TODO #56
-            "name": None,
-            "type": descriptor_type,
-            "display_name": metric.name,
-            "description": metric.description,
-            "labels": [],
-        }
+        descriptor = MetricDescriptor(
+            type=descriptor_type,
+            display_name=metric.name,
+            description=metric.description or "",
+        )
         seen_keys: Set[str] = set()
         for data_point in metric.data.data_points:
             for key in data_point.attributes or {}:
                 if key in seen_keys:
                     continue
                 seen_keys.add(key)
-                descriptor["labels"].append(LabelDescriptor(key=_normalize_label_key(key)))  # type: ignore[union-attr] # TODO #56
+                descriptor.labels.append(
+                    LabelDescriptor(key=_normalize_label_key(key))
+                )
 
         if self.unique_identifier:
-            descriptor["labels"].append(  # type: ignore[union-attr] # TODO #56
+            descriptor.labels.append(
                 LabelDescriptor(key=UNIQUE_IDENTIFIER_KEY)
             )
 
         data = metric.data
         if isinstance(data, Sum):
-            descriptor["metric_kind"] = (
+            descriptor.metric_kind = (
                 MetricDescriptor.MetricKind.CUMULATIVE
                 if data.is_monotonic
                 else MetricDescriptor.MetricKind.GAUGE
             )
         elif isinstance(data, Gauge):
-            descriptor["metric_kind"] = MetricDescriptor.MetricKind.GAUGE
+            descriptor.metric_kind = MetricDescriptor.MetricKind.GAUGE
         elif isinstance(data, Histogram):
-            descriptor["metric_kind"] = MetricDescriptor.MetricKind.CUMULATIVE
+            descriptor.metric_kind = MetricDescriptor.MetricKind.CUMULATIVE
         else:
             # Exhaustive check
             _: NoReturn = data
@@ -198,13 +198,13 @@ def _get_metric_descriptor(
 
         first_point = data.data_points[0] if len(data.data_points) else None
         if isinstance(first_point, NumberDataPoint):
-            descriptor["value_type"] = (
+            descriptor.value_type = (
                 MetricDescriptor.ValueType.INT64
                 if isinstance(first_point.value, int)
                 else MetricDescriptor.ValueType.DOUBLE
             )
         elif isinstance(first_point, HistogramDataPoint):
-            descriptor["value_type"] = MetricDescriptor.ValueType.DISTRIBUTION
+            descriptor.value_type = MetricDescriptor.ValueType.DISTRIBUTION
         elif first_point is None:
             pass
         else:
@@ -215,22 +215,21 @@ def _get_metric_descriptor(
                 type(first_point).__name__,
             )
 
-        proto_descriptor = MetricDescriptor(**descriptor)
         try:
-            descriptor = self.client.create_metric_descriptor(
+            response_descriptor = self.client.create_metric_descriptor(
                 CreateMetricDescriptorRequest(
-                    name=self.project_name, metric_descriptor=proto_descriptor
+                    name=self.project_name, metric_descriptor=descriptor
                 )
             )
         # pylint: disable=broad-except
         except Exception as ex:
             logger.error(
                 "Failed to create metric descriptor %s",
-                proto_descriptor,
+                descriptor,
                 exc_info=ex,
             )
             return None
-        self._metric_descriptors[descriptor_type] = descriptor
+        self._metric_descriptors[descriptor_type] = response_descriptor
         return descriptor
 
     @staticmethod

opentelemetry-exporter-gcp-trace/mypy.ini

@@ -3,19 +3,5 @@ namespace_packages = True
 explicit_package_bases = True
 mypy_path = $MYPY_CONFIG_FILE_DIR/src
 
-[mypy-opentelemetry.sdk.*]
-ignore_missing_imports = True
-
 [mypy-google.auth.*]
 ignore_missing_imports = True
-
-[mypy-google.cloud.*]
-ignore_missing_imports = True
-
-[mypy-google.api.*]
-ignore_missing_imports = True
-
-[mypy-google.rpc.*]
-ignore_missing_imports = True
-
-

opentelemetry-exporter-gcp-trace/src/opentelemetry/exporter/cloud_trace/__init__.py

@@ -230,8 +230,8 @@ def _translate_to_cloud_trace(
                         MAX_SPAN_ATTRS,
                         add_agent_attr=True,
                     ),
-                    links=_extract_links(span.links),  # type: ignore[has-type]
-                    status=_extract_status(span.status),  # type: ignore[arg-type]
+                    links=_extract_links(span.links),
+                    status=_extract_status(span.status),
                     time_events=_extract_events(span.events),
                     span_kind=_extract_span_kind(span.kind),
                 )
@@ -281,7 +281,7 @@ def _extract_status(status: trace_api.Status) -> Optional[status_pb2.Status]:
         status_proto = status_pb2.Status(code=code_pb2.OK)
     elif status.status_code is StatusCode.ERROR:
         status_proto = status_pb2.Status(
-            code=code_pb2.UNKNOWN, message=status.description
+            code=code_pb2.UNKNOWN, message=status.description or ""
         )
     # future added value
     else:
@@ -290,7 +290,7 @@ def _extract_status(status: trace_api.Status) -> Optional[status_pb2.Status]:
             status.status_code,
         )
         status_proto = status_pb2.Status(
-            code=code_pb2.UNKNOWN, message=status.description
+            code=code_pb2.UNKNOWN, message=status.description or ""
         )
 
     return status_proto

opentelemetry-propagator-gcp/mypy.ini

@@ -2,7 +2,3 @@
 namespace_packages = True
 explicit_package_bases = True
 mypy_path = $MYPY_CONFIG_FILE_DIR/src
-
-[mypy-opentelemetry.sdk.*]
-ignore_missing_imports = True
-

opentelemetry-resourcedetector-gcp/mypy.ini

@@ -2,7 +2,3 @@
 namespace_packages = True
 explicit_package_bases = True
 mypy_path = $MYPY_CONFIG_FILE_DIR/src
-
-[mypy-opentelemetry.sdk.*]
-ignore_missing_imports = True
-

tox.ini

@@ -34,6 +34,9 @@ dev_deps =
   types-protobuf
   types-requests
   types-setuptools
+  # 3rd party package until https://github.com/googleapis/python-api-common-protos/issues/135
+  # is fixed
+  googleapis-common-protos-stubs
 
 ; CircleCI won't show results if I put them in .test-results directly
 test_results_dir = {toxinidir}/.test-results/test-results