import re from typing import Any, Callable, Dict, List, Union import pytest from pytest import raises from omegaconf import DictConfig, ListConfig, OmegaConf, ReadonlyConfigError @pytest.mark.parametrize( # type: ignore "src, func, expectation", [ pytest.param( {}, lambda c: c.__setitem__("a", 1), raises(ReadonlyConfigError, match="a"), id="dict_setitem", ), pytest.param( {"a": {"b": {"c": 1}}}, lambda c: c.__getattr__("a").__getattr__("b").__setitem__("c", 1), raises(ReadonlyConfigError, match="a.b.c"), id="dict_nested_setitem", ), pytest.param( {}, lambda c: OmegaConf.update(c, "a.b", 10, merge=True), raises(ReadonlyConfigError, match="a"), id="dict_update", ), pytest.param( {"a": 10}, lambda c: c.__setattr__("a", 1), raises(ReadonlyConfigError, match="a"), id="dict_setattr", ), pytest.param( {"a": 10}, lambda c: c.pop("a"), raises(ReadonlyConfigError, match="a"), id="dict_pop", ), pytest.param( {"a": 10}, lambda c: c.__delitem__("a"), raises(ReadonlyConfigError, match="a"), id="dict_delitem", ), # list pytest.param( [], lambda c: c.__setitem__(0, 1), raises(ReadonlyConfigError, match="0"), id="list_setitem", ), pytest.param( [], lambda c: OmegaConf.update(c, "0.b", 10, merge=True), raises(ReadonlyConfigError, match="[0]"), id="list_update", ), pytest.param( [10], lambda c: c.pop(), raises(ReadonlyConfigError), id="list_pop" ), pytest.param( [0], lambda c: c.__delitem__(0), raises(ReadonlyConfigError, match="[0]"), id="list_delitem", ), ], ) def test_readonly( src: Union[Dict[str, Any], List[Any]], func: Callable[[Any], Any], expectation: Any ) -> None: c = OmegaConf.create(src) OmegaConf.set_readonly(c, True) with expectation: func(c) assert c == src @pytest.mark.parametrize("src", [{}, []]) # type: ignore def test_readonly_flag(src: Union[Dict[str, Any], List[Any]]) -> None: c = OmegaConf.create(src) assert not OmegaConf.is_readonly(c) OmegaConf.set_readonly(c, True) assert OmegaConf.is_readonly(c) OmegaConf.set_readonly(c, False) assert not OmegaConf.is_readonly(c) OmegaConf.set_readonly(c, None) assert not OmegaConf.is_readonly(c) def test_readonly_nested_list() -> None: c = OmegaConf.create([[1]]) assert isinstance(c, ListConfig) assert not OmegaConf.is_readonly(c) assert not OmegaConf.is_readonly(c[0]) OmegaConf.set_readonly(c, True) assert OmegaConf.is_readonly(c) assert OmegaConf.is_readonly(c[0]) OmegaConf.set_readonly(c, False) assert not OmegaConf.is_readonly(c) assert not OmegaConf.is_readonly(c[0]) OmegaConf.set_readonly(c, None) assert not OmegaConf.is_readonly(c) assert not OmegaConf.is_readonly(c[0]) OmegaConf.set_readonly(c[0], True) assert not OmegaConf.is_readonly(c) assert OmegaConf.is_readonly(c[0]) def test_readonly_list_insert() -> None: c = OmegaConf.create([]) OmegaConf.set_readonly(c, True) with raises(ReadonlyConfigError, match="[0]"): c.insert(0, 10) assert c == [] def test_readonly_list_insert_deep() -> None: src: List[Dict[str, Any]] = [dict(a=[dict(b=[])])] c = OmegaConf.create(src) assert isinstance(c, ListConfig) OmegaConf.set_readonly(c, True) with raises(ReadonlyConfigError, match=re.escape("[0].a[0].b[0]")): c[0].a[0].b.insert(0, 10) assert c == src def test_readonly_list_append() -> None: c = OmegaConf.create([]) OmegaConf.set_readonly(c, True) with raises(ReadonlyConfigError, match="[0]"): c.append(10) assert c == [] def test_readonly_list_change_item() -> None: c = OmegaConf.create([1, 2, 3]) assert isinstance(c, ListConfig) OmegaConf.set_readonly(c, True) with raises(ReadonlyConfigError, match="[1]"): c[1] = 10 assert c == [1, 2, 3] def test_readonly_list_pop() -> None: c = OmegaConf.create([1, 2, 3]) assert isinstance(c, ListConfig) OmegaConf.set_readonly(c, True) with raises(ReadonlyConfigError, match="[1]"): c.pop(1) assert c == [1, 2, 3] def test_readonly_list_del() -> None: c = OmegaConf.create([1, 2, 3]) assert isinstance(c, ListConfig) OmegaConf.set_readonly(c, True) with raises(ReadonlyConfigError, match="[1]"): del c[1] assert c == [1, 2, 3] def test_readonly_list_sort() -> None: c = OmegaConf.create([3, 1, 2]) assert isinstance(c, ListConfig) OmegaConf.set_readonly(c, True) with raises(ReadonlyConfigError): c.sort() assert c == [3, 1, 2] def test_readonly_from_cli() -> None: c = OmegaConf.create({"foo": {"bar": [1]}}) assert isinstance(c, DictConfig) OmegaConf.set_readonly(c, True) cli = OmegaConf.from_dotlist(["foo.bar=[2]"]) cfg2 = OmegaConf.merge(c, cli) assert OmegaConf.is_readonly(c) assert OmegaConf.is_readonly(cfg2) @pytest.mark.parametrize( # type: ignore "cfg1, cfg2", [ pytest.param({"foo": {"bar": 10}}, {"foo": {"bar": 20}}, id="override_value"), pytest.param({"foo": {"bar": 10}}, {"foo": {"yup": 20}}, id="adding_key"), pytest.param({"a": 1}, {"b": 2}, id="adding_key"), pytest.param({"a": 1}, OmegaConf.create({"b": 2}), id="adding_key"), ], ) def test_merge_with_readonly(cfg1: Dict[str, Any], cfg2: Dict[str, Any]) -> None: c = OmegaConf.create(cfg1) OmegaConf.set_readonly(c, True) with raises(ReadonlyConfigError): c.merge_with(cfg2) @pytest.mark.parametrize( # type: ignore "readonly_key, cfg1, cfg2, expected", [ pytest.param( "", {"foo": {"bar": 10}}, {"foo": {}}, {"foo": {"bar": 10}}, id="merge_empty_dict", ), pytest.param( "foo", {"foo": {"bar": 10}}, {"xyz": 10}, {"foo": {"bar": 10}, "xyz": 10}, id="merge_different_node", ), ], ) def test_merge_with_readonly_nop( readonly_key: str, cfg1: Dict[str, Any], cfg2: Dict[str, Any], expected: Dict[str, Any], ) -> None: c = OmegaConf.create(cfg1) OmegaConf.set_readonly(OmegaConf.select(c, readonly_key), True) c.merge_with(cfg2) assert c == OmegaConf.create(expected)