From f4ed4517cf8172c6850b9868a7fa840d989985b3 Mon Sep 17 00:00:00 2001 From: Edward Lin Date: Fri, 14 May 2021 11:54:38 -0400 Subject: [PATCH 1/4] Change AttributeValue sequences from optional to nonoptional New changes will ensure that mypy users will be alerted when trying to add None to an AttributeValue array, without altering the current code that may continue to accept None. --- opentelemetry-api/src/opentelemetry/util/types.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/opentelemetry-api/src/opentelemetry/util/types.py b/opentelemetry-api/src/opentelemetry/util/types.py index ec72a287042..be171ef0ea8 100644 --- a/opentelemetry-api/src/opentelemetry/util/types.py +++ b/opentelemetry-api/src/opentelemetry/util/types.py @@ -20,10 +20,10 @@ bool, int, float, - Sequence[Optional[str]], - Sequence[Optional[bool]], - Sequence[Optional[int]], - Sequence[Optional[float]], + Sequence[str], + Sequence[bool], + Sequence[int], + Sequence[float], ] Attributes = Optional[Mapping[str, AttributeValue]] AttributesAsKey = Tuple[ From 56a948e7bba58b224644f6215ef84e87f18897c0 Mon Sep 17 00:00:00 2001 From: Edward Lin Date: Fri, 14 May 2021 14:25:44 -0400 Subject: [PATCH 2/4] Added entry to changelog --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 16610f70b16..534b0fbf408 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -36,6 +36,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ([#1809])(https://github.com/open-telemetry/opentelemetry-python/pull/1809) - Fixed sequence values in OTLP exporter not translating ([#1818](https://github.com/open-telemetry/opentelemetry-python/pull/1818)) +- Changed AttributeValue sequences to warn mypy users on adding None values to array + (TBD) ### Removed - Moved `opentelemetry-instrumentation` to contrib repository. From 31efa2d2420707d79c6375eaa3aff361c58556f5 Mon Sep 17 00:00:00 2001 From: Eddy Lin Date: Wed, 19 May 2021 17:30:55 -0400 Subject: [PATCH 3/4] Moved change log entry to unreleased section and updated link --- CHANGELOG.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 534b0fbf408..00f19750e3b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased](https://github.com/open-telemetry/opentelemetry-python/compare/v1.2.0-0.21b0...HEAD) +- Changed AttributeValue sequences to warn mypy users on adding None values to array + ([#1855](https://github.com/open-telemetry/opentelemetry-python/pull/1855)) ## [1.2.0, 0.21b0](https://github.com/open-telemetry/opentelemetry-python/releases/tag/v1.2.0-0.21b0) - 2021-05-11 @@ -36,8 +38,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ([#1809])(https://github.com/open-telemetry/opentelemetry-python/pull/1809) - Fixed sequence values in OTLP exporter not translating ([#1818](https://github.com/open-telemetry/opentelemetry-python/pull/1818)) -- Changed AttributeValue sequences to warn mypy users on adding None values to array - (TBD) ### Removed - Moved `opentelemetry-instrumentation` to contrib repository. From 0274a17fbb76e2ea2068eb8c0fe75bdade923e03 Mon Sep 17 00:00:00 2001 From: Edward Lin Date: Wed, 19 May 2021 21:43:14 -0400 Subject: [PATCH 4/4] Added "Changed" header to change log --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 00f19750e3b..9df8641b70a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased](https://github.com/open-telemetry/opentelemetry-python/compare/v1.2.0-0.21b0...HEAD) + +### Changed - Changed AttributeValue sequences to warn mypy users on adding None values to array ([#1855](https://github.com/open-telemetry/opentelemetry-python/pull/1855))