Add a warning category and stacklevel to rerun warnings.warn calls #2985
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
jleibs
force-pushed
the
jleibs/rerun_warnings
branch
from
4b31f1e
to
b6a0688
Compare
Wumpf
approved these changes
Aug 15, 2023
emilk
pushed a commit
that referenced
this pull request
Aug 17, 2023
…2985) Resolves: #2408 ### What: Stop overriding the global `warnings.formatwarning` Instead introduce a RerunWarning category and also set stacklevel appropriately for better warning context. Consider this example: ``` import warnings import rerun as rr warnings.warn("my warning") rr.log_points("foo", [1, 2, 3]) rr.init("foo") rr.log_points("foo", "not a point") ``` Before: wrongly annotated user-warning. No way to identify source of error. ``` WARNING:rerun:my warning WARNING:rerun:Rerun is disabled - log_points() call ignored. You must call rerun.init before using log APIs. WARNING:root:Ignoring rerun log call: Traceback (most recent call last): File "/home/jleibs/venv/lib/python3.10/site-packages/rerun_sdk/rerun/log/log_decorator.py", line 47, in wrapper return func(*args, **kwargs) File "/home/jleibs/venv/lib/python3.10/site-packages/rerun_sdk/rerun/log/points.py", line 228, in log_points positions = np.require(positions, dtype="float32") File "/home/jleibs/venv/lib/python3.10/site-packages/numpy/core/_asarray.py", line 110, in require return asanyarray(a, dtype=dtype) ValueError: could not convert string to float: 'not a point' ``` After: Consistent pythonic warnings and actionable line-numbers. ``` /home/jleibs/rerun/test.py:4: UserWarning: my warning warnings.warn("my warning") /home/jleibs/rerun/test.py:5: RerunWarning: Rerun is disabled - log_points() call ignored. You must call rerun.init before using log APIs. rr.log_points("foo", [1, 2, 3]) /home/jleibs/rerun/test.py:7: RerunWarning: Ignoring rerun log call: Traceback (most recent call last): File "/home/jleibs/rerun/rerun_py/rerun_sdk/rerun/log/log_decorator.py", line 51, in wrapper return func(*args, **kwargs) File "/home/jleibs/rerun/rerun_py/rerun_sdk/rerun/log/points.py", line 208, in log_points positions = np.require(positions, dtype="float32") File "/home/jleibs/rerun/venv/lib/python3.10/site-packages/numpy/core/_asarray.py", line 106, in require return asanyarray(a, dtype=dtype) ValueError: could not convert string to float: 'not a point' rr.log_points("foo", "not a point") ``` ### Checklist * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [x] I've included a screenshot or gif (if applicable) * [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/2985) (if applicable) - [PR Build Summary](https://build.rerun.io/pr/2985) - [Docs preview](https://rerun.io/preview/pr%3Ajleibs%2Frerun_warnings/docs) - [Examples preview](https://rerun.io/preview/pr%3Ajleibs%2Frerun_warnings/examples)
emilk
pushed a commit
that referenced
this pull request
Aug 17, 2023
…2985) Resolves: #2408 ### What: Stop overriding the global `warnings.formatwarning` Instead introduce a RerunWarning category and also set stacklevel appropriately for better warning context. Consider this example: ``` import warnings import rerun as rr warnings.warn("my warning") rr.log_points("foo", [1, 2, 3]) rr.init("foo") rr.log_points("foo", "not a point") ``` Before: wrongly annotated user-warning. No way to identify source of error. ``` WARNING:rerun:my warning WARNING:rerun:Rerun is disabled - log_points() call ignored. You must call rerun.init before using log APIs. WARNING:root:Ignoring rerun log call: Traceback (most recent call last): File "/home/jleibs/venv/lib/python3.10/site-packages/rerun_sdk/rerun/log/log_decorator.py", line 47, in wrapper return func(*args, **kwargs) File "/home/jleibs/venv/lib/python3.10/site-packages/rerun_sdk/rerun/log/points.py", line 228, in log_points positions = np.require(positions, dtype="float32") File "/home/jleibs/venv/lib/python3.10/site-packages/numpy/core/_asarray.py", line 110, in require return asanyarray(a, dtype=dtype) ValueError: could not convert string to float: 'not a point' ``` After: Consistent pythonic warnings and actionable line-numbers. ``` /home/jleibs/rerun/test.py:4: UserWarning: my warning warnings.warn("my warning") /home/jleibs/rerun/test.py:5: RerunWarning: Rerun is disabled - log_points() call ignored. You must call rerun.init before using log APIs. rr.log_points("foo", [1, 2, 3]) /home/jleibs/rerun/test.py:7: RerunWarning: Ignoring rerun log call: Traceback (most recent call last): File "/home/jleibs/rerun/rerun_py/rerun_sdk/rerun/log/log_decorator.py", line 51, in wrapper return func(*args, **kwargs) File "/home/jleibs/rerun/rerun_py/rerun_sdk/rerun/log/points.py", line 208, in log_points positions = np.require(positions, dtype="float32") File "/home/jleibs/rerun/venv/lib/python3.10/site-packages/numpy/core/_asarray.py", line 106, in require return asanyarray(a, dtype=dtype) ValueError: could not convert string to float: 'not a point' rr.log_points("foo", "not a point") ``` ### Checklist * [x] I have read and agree to [Contributor Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and the [Code of Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md) * [x] I've included a screenshot or gif (if applicable) * [x] I have tested [demo.rerun.io](https://demo.rerun.io/pr/2985) (if applicable) - [PR Build Summary](https://build.rerun.io/pr/2985) - [Docs preview](https://rerun.io/preview/pr%3Ajleibs%2Frerun_warnings/docs) - [Examples preview](https://rerun.io/preview/pr%3Ajleibs%2Frerun_warnings/examples)
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.
Resolves: #2408
What:
Stop overriding the global
warnings.formatwarningInstead introduce a RerunWarning category and also set stacklevel appropriately for better warning context.
Consider this example:
Before: wrongly annotated user-warning. No way to identify source of error.
After: Consistent pythonic warnings and actionable line-numbers.
Checklist