Skip to content

Commit db45303

Browse files
committed
Rewrote MetricsInstrumentAdvisory as TypedDict
1 parent fe5fe05 commit db45303

File tree

5 files changed

+12
-13
lines changed

5 files changed

+12
-13
lines changed

opentelemetry-api/src/opentelemetry/metrics/_internal/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -379,7 +379,7 @@ def create_histogram(
379379
name: str,
380380
unit: str = "",
381381
description: str = "",
382-
advisory: MetricsInstrumentAdvisory = None,
382+
advisory: Optional[MetricsInstrumentAdvisory] = None,
383383
) -> Histogram:
384384
"""Creates a :class:`~opentelemetry.metrics.Histogram` instrument
385385
@@ -527,7 +527,7 @@ def create_histogram(
527527
name: str,
528528
unit: str = "",
529529
description: str = "",
530-
advisory: MetricsInstrumentAdvisory = None,
530+
advisory: Optional[MetricsInstrumentAdvisory] = None,
531531
) -> Histogram:
532532
with self._lock:
533533
if self._real_meter:
@@ -688,7 +688,7 @@ def create_histogram(
688688
name: str,
689689
unit: str = "",
690690
description: str = "",
691-
advisory: MetricsInstrumentAdvisory = None,
691+
advisory: Optional[MetricsInstrumentAdvisory] = None,
692692
) -> Histogram:
693693
"""Returns a no-op Histogram."""
694694
if self._is_instrument_registered(

opentelemetry-api/src/opentelemetry/metrics/_internal/instrument.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,7 @@ def __init__(
336336
name: str,
337337
unit: str = "",
338338
description: str = "",
339-
advisory: MetricsInstrumentAdvisory = None,
339+
advisory: Optional[MetricsInstrumentAdvisory] = None,
340340
) -> None:
341341
pass
342342

@@ -358,7 +358,7 @@ def __init__(
358358
name: str,
359359
unit: str = "",
360360
description: str = "",
361-
advisory: MetricsInstrumentAdvisory = None,
361+
advisory: Optional[MetricsInstrumentAdvisory] = None,
362362
) -> None:
363363
super().__init__(
364364
name, unit=unit, description=description, advisory=advisory
@@ -380,7 +380,7 @@ def __init__(
380380
name: str,
381381
unit: str = "",
382382
description: str = "",
383-
advisory: MetricsInstrumentAdvisory = None,
383+
advisory: Optional[MetricsInstrumentAdvisory] = None,
384384
) -> None:
385385
self._name = name
386386
self._unit = unit

opentelemetry-api/src/opentelemetry/util/types.py

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
from typing import Literal, Mapping, Optional, Sequence, Tuple, Union
15+
from typing import Mapping, Optional, Sequence, Tuple, TypedDict, Union
1616

1717
# This is the implementation of the "Any" type as specified by the specifications of OpenTelemetry data model for logs.
1818
# For more details, refer to the OTel specification:
@@ -56,7 +56,6 @@
5656
...,
5757
]
5858

59-
MetricsInstrumentAdvisoryKey = Literal["ExplicitBucketBoundaries"]
60-
MetricsInstrumentAdvisory = Optional[
61-
Mapping[MetricsInstrumentAdvisoryKey, AnyValue]
62-
]
59+
60+
class MetricsInstrumentAdvisory(TypedDict):
61+
ExplicitBucketBoundaries: Optional[AnyValue]

opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ def create_histogram(
202202
name: str,
203203
unit: str = "",
204204
description: str = "",
205-
advisory: MetricsInstrumentAdvisory = None,
205+
advisory: Optional[MetricsInstrumentAdvisory] = None,
206206
) -> APIHistogram:
207207
if advisory is not None:
208208
raise_error = False

opentelemetry-sdk/src/opentelemetry/sdk/metrics/_internal/instrument.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ def __init__(
227227
measurement_consumer: "opentelemetry.sdk.metrics.MeasurementConsumer",
228228
unit: str = "",
229229
description: str = "",
230-
advisory: MetricsInstrumentAdvisory = None,
230+
advisory: Optional[MetricsInstrumentAdvisory] = None,
231231
):
232232
super().__init__(
233233
name,

0 commit comments

Comments
 (0)