Deprecate subclassing dict #707
Conversation
omegaconf/_utils.py
Outdated
| warnings.warn( | ||
| "Subclassing of `Dict` by Structured Config classes is deprecated", | ||
| UserWarning, | ||
| stacklevel=2, | ||
| stacklevel=1, | ||
| ) |
There was a problem hiding this comment.
With stacklevel=2 we get a warning that looks like this:
$ python tmp.py
/home/jbss/omegaconf.git/omegaconf/_utils.py:373: UserWarning: Subclassing of `Dict` by Structured Config classes is deprecated
dict_subclass_data = extract_dict_subclass_data(obj=obj, parent=dummy_parent)With stacklevel=1 we get a warning that looks like this:
$ python tmp.py
/home/jbss/omegaconf.git/omegaconf/_utils.py:240: UserWarning: Subclassing of `Dict` by Structured Config classes is deprecated
warnings.warn(I changed 2 -> 1 because I thought the dict_subclass_data = extract_dict_subclass_data(...) was confusing...
There was a problem hiding this comment.
The exact interesting stack frame is probably not in a fixed depth.
Try to get it to issue the line calling OmegaConf.create() in the simple case.
Also, add the name of the type subclassing Dict to the warning.
It seems that there are no conflicts 👍 |
tests/test_errors.py
Outdated
| def test_dict_subclass_error() -> None: | ||
| src = Str2Int() | ||
| src["bar"] = "qux" # type: ignore | ||
| # expected.finalize(cfg) |
tests/test_errors.py
Outdated
| def test_dict_subclass_error() -> None: | ||
| src = Str2Int() |
There was a problem hiding this comment.
Add a comment explaining what this function is testing and why it's a separate function.
Closes #663