Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .changelog/5399.fixed
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
`opentelemetry-api`: Prevent in-place mutation of `Context` via inherited `dict` methods
21 changes: 21 additions & 0 deletions opentelemetry-api/src/opentelemetry/context/context.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,27 @@ class Context(dict[str, object]):
def __setitem__(self, key: str, value: object) -> None:
raise ValueError

def __delitem__(self, key: str) -> None:
raise ValueError

def setdefault(self, key: str, default: object = None) -> object:
raise ValueError

def pop(self, key: str, *args: object) -> object:
raise ValueError

def popitem(self) -> tuple[str, object]:
raise ValueError

def clear(self) -> None:
raise ValueError

def update(self, *args: object, **kwargs: object) -> None:
raise ValueError

def __ior__(self, other: object) -> Context:
raise ValueError


class _RuntimeContext(ABC):
"""The RuntimeContext interface provides a wrapper for the different
Expand Down
18 changes: 16 additions & 2 deletions opentelemetry-api/tests/context/test_context.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,9 +54,23 @@ def test_set_value(self):
self.assertEqual(None, context.get_value("a"))

def test_context_is_immutable(self):
ctx = context.get_current()
with self.assertRaises(ValueError):
# ensure a context
context.get_current()["test"] = "cant-change-immutable"
ctx["test"] = "cant-change-immutable"
with self.assertRaises(ValueError):
del ctx["test"]
with self.assertRaises(ValueError):
ctx.pop("test")
with self.assertRaises(ValueError):
ctx.popitem()
with self.assertRaises(ValueError):
ctx.clear()
with self.assertRaises(ValueError):
ctx.update({"test": "cant-change-immutable"})
with self.assertRaises(ValueError):
ctx.setdefault("test", "cant-change-immutable")
with self.assertRaises(ValueError):
ctx |= {"test": "cant-change-immutable"}

def test_set_current(self):
context.attach(context.set_value("a", "yyy"))
Expand Down
Loading