python variables pane: don't hide _ if it was changed by the user
#6297
Conversation
|
E2E Tests 🚀 |
austin3dickey
changed the title
austin3dickey
force-pushed
the
aus/underscores
branch
2 times, most recently
from
84fe67d to
4ae2174
Compare
austin3dickey
changed the title
_ if it was changed by the user
| value is different from the value in the hidden namespace. | ||
| """ | ||
| hidden = self.kernel.shell.user_ns_hidden or {} | ||
| if name == "_": |
There was a problem hiding this comment.
Originally I was planning to take this fork for any hidden variable. The hidden variable namespace includes (but isn't limited to) these variables:
hidden variables
_ih
_oh
_dh
In
Out
get_ipython
exit
quit
open
help
_exit_code
__pydevd_ret_val_dict
__warningregistry__
__nonzero__
__name__
__doc__
__package__
__loader__
__spec__
__builtin__
__builtins__
_
__
___
_i
_ii
_iii
_i1
_i2
However, we started poking around at that change and realized that some hidden variables don't play well.
_exit_codeshows up when you run a%pip installmagic that fails to install something, because at one point during that process, we start inspecting the variables and_exit_codehappens to not match the hidden-namespace_exit_code. So this code thought the user had defined it.__was behaving strangely when I ran some tests that dealt with a complicated plot, for a similar reason.- More?? There are probably more edge cases.
I believe these problems would have been fixable with more time and effort spent. But fixing those problems seems super low-value, and wasn't in the original scope of the issue anyway. So I'm proposing this PR just fixes the behavior of _. We can always revisit if someone needs another variable to show up.
There was a problem hiding this comment.
I don't see __ and _exit_code often (ever?) in the wild, but _ is pretty common. I agree this is the right level of fix for now!
|
Just adding some tests now. |
austin3dickey
force-pushed
the
aus/underscores
branch
from
23aa2b5 to
1c37675
Compare
austin3dickey
changed the title
_ if it was changed by the user_ if it was changed by the user
| @@ -75,7 +75,7 @@ def _prepare_shell(shell: PositronShell) -> None: | |||
| # manually add them to user_ns_hidden to replicate running in Positron. | |||
| shell.user_ns_hidden.update( | |||
| { | |||
| k: None | |||
| k: "" | |||
There was a problem hiding this comment.
This is closer to what actually happens outside of tests (and fixes a test for me)
There was a problem hiding this comment.
I went through this file and added a test case for the variable name _ each time we do something with a variable. This was actually really valuable because it caught a lot of stuff.
There was a problem hiding this comment.
It's useful to have varname parametrized as well instead of "x" hardcoded everywhere.
|
|
||
| # ...except hidden variables, because %reset -s doesn't touch those | ||
| assert "_" in shell.user_ns |
There was a problem hiding this comment.
I learned that %reset -s (the soft reset) does not touch the underscore variable. So when we clear all variables, which calls this:
it doesn't remove the _ from the variables pane. I decided to leave that behavior as-is instead of messing with the reset command. So now the variables pane simply reflects what's happened, in that everything gets deleted except _, even when it's been overridden by the user.
| ] | ||
|
|
||
| # All user variables are removed | ||
| assert "x" not in shell.user_ns | ||
| assert "y" not in shell.user_ns | ||
|
|
||
| # ...except hidden variables, because %reset doesn't touch those |
| ], | ||
| ) | ||
| @pytest.mark.parametrize("varname", ["x", "_"]) |
There was a problem hiding this comment.
Woah, I did not know that you can chain parametrize, very useful!
There was a problem hiding this comment.
yeah at my last job I was guilty of writing a test with like 6 different parametrizations resulting in like 3500 cases 😂 coverage was really important!!
There was a problem hiding this comment.
It's useful to have varname parametrized as well instead of "x" hardcoded everywhere.
Addresses #3366. This PR changes the Variables pane behavior in the Python extension so that it no longer hides the
_variable if it was explicitly changed by the user.An example: type
_ = 1into the console. Before this change,_wouldn't show up. Now it does.Release Notes
New Features
Bug Fixes
_to show up in the Python Variables pane if defined by the user. (python: variable named_does not show in Variables pane #3366)QA Notes
Try messing around with the
_variable; it should work like other variables in the Variables pane. Examples:(the last one requires
pip install ibis-framework)@:console @:variables