make immutable attributes consistent #1909
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
codeboten
requested review from
a team,
aabmass and
ocelotl
and removed request for
a team
7 tasks
ocelotl
approved these changes
Jun 10, 2021
added 2 commits
June 10, 2021 14:26
…m:codeboten/opentelemetry-python into codeboten/consistent-immutable-attributes
We mention these are immutable so I wouldn't expect users to be surprised when they modify and don't see the modifications. I agree that we should be consistent. |
srikanthccv
approved these changes
Jun 11, 2021
| @@ -139,7 +140,7 @@ def __init__( | |||
| attributes: types.Attributes = None, | |||
| ) -> None: | |||
| super().__init__(context) | |||
| self._attributes = attributes | |||
| self._attributes = _create_immutable_attributes(attributes) | |||
There was a problem hiding this comment.
Can you update the docstring for Link and Event about immutability like we do for Resource?
lzchen
approved these changes
Jun 11, 2021
ocelotl
approved these changes
Jun 14, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This change ensures Event, Link and Resource attributes are made immutable in a consistent fashion. Note that this does change the behaviour to raise a
TypeErrorwhen someone tries to modify a resource or link attribute, but I believe this is the correct behaviour, rather than silently failing to modify the attributes.Fixes #1907
Type of change
Please delete options that are not relevant.
Does This PR Require a Contrib Repo Change?
Answer the following question based on these examples of changes that would require a Contrib Repo Change:
The OTel specification has changed which prompted this PR to update the method interfaces of
opentelemetry-api/oropentelemetry-sdk/The method interfaces of
test/utilhave changedScripts in
scripts/that were copied over to the Contrib repo have changedConfiguration files that were copied over to the Contrib repo have changed (when consistency between repositories is applicable) such as in
pyproject.tomlisort.cfg.flake8When a new
.github/CODEOWNERis addedMajor changes to project information, such as in:
README.mdCONTRIBUTING.mdNo.
Checklist: