Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate subclassing dict #707

Merged
merged 14 commits into from
May 11, 2021
Merged

Deprecate subclassing dict #707

Changes from 1 commit
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
f397888
update docs for subclassing Dict
Jasha10 May 6, 2021
54c1c65
issue deprecation warning on Dict subclass construction
Jasha10 May 6, 2021
ae6cb72
remove documentation for extending Dict
Jasha10 May 7, 2021
c6054db
make warns_dict_subclass_deprecated global-scoped
Jasha10 May 7, 2021
26f35d5
Merge branch 'master' into deprecate_subclassing_dict
Jasha10 May 7, 2021
61fda90
catch additional warnings
Jasha10 May 7, 2021
0e5d046
change warning stacklevel 2 -> 1
Jasha10 May 8, 2021
ea0aa29
make the UserWarning point to issue #663
Jasha10 May 8, 2021
6eeb616
stacklevel 1 -> 9 (point to the line calling OmegaConf.create)
Jasha10 May 10, 2021
71ad2b6
clean up control flow and include class name in warning msg
Jasha10 May 10, 2021
11c210e
test_errors.py:test_dict_subclass_error
Jasha10 May 10, 2021
b58bcd5
add docstring to test_dict_subclass_error function
Jasha10 May 11, 2021
192c9db
delete extraneous comment
Jasha10 May 11, 2021
04f8a6d
add news fragment
Jasha10 May 11, 2021
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
2 changes: 1 addition & 1 deletion omegaconf/_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -240,7 +240,7 @@ def extract_dict_subclass_data(obj: Any, parent: Any) -> Optional[Dict[str, Any]
warnings.warn(
"Subclassing of `Dict` by Structured Config classes is deprecated",
UserWarning,
stacklevel=2,
stacklevel=1,
)
Copy link
Collaborator Author

@Jasha10 Jasha10 May 8, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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...

Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done in 6eeb616 and 71ad2b6.


if isinstance(obj, type):
Expand Down