PR: Improve `Maintain focus in the editor` option and unmaximize plugins when running/debugging code #18928

ccordoba12 · 2022-08-03T22:36:44Z

Description of Changes

Avoid giving focus to the IPython console when it's undocked, the user runs/debugs code and Maintain focus to editor is enabled.
Keep focus in the editor in any run or debug operation and that option is enabled.
Unmaximize any plugin before running or debugging code.
Correctly set the state of the Maximize button when unmaximizing a plugin programmatically from other plugins (this was totally broken).
Add sig_unmaximize_plugin_requested to SpyderPluginV2 so that plugins can request to unmaximize the currently maximized plugin from others programmatically.
Add unmaximize_dockwidget and unmaximize_other_dockwidget methods to the Layout plugin. Also move switch_to_plugin to it.
Expand tests to catch possible regressions in the future.

Issue(s) Resolved

Affirmation

By submitting this Pull Request or typing my (user)name below,
I affirm the Developer Certificate of Origin
with respect to all commits and content included in this PR,
and understand I am releasing the same under Spyder's MIT (Expat) license.

I certify the above statement is true and correct: @ccordoba12

This is to be consistent with the same behavior for cells.

…ebug commands

Now we maintain the focus in the editor after running or debugging files, cells or selections.

This allows us to correctly set its state when calling switch_to_plugin from plugins programmatically.

- The lack of this made that the calls to switch_to_plugin did nothing when plugins were maximized. - Fix several bugs with switch_to_plugin and the interaction between new and old API plugins.

pep8speaks · 2022-08-03T22:36:52Z

Hello @ccordoba12! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

In the file spyder/plugins/ipythonconsole/widgets/debugging.py:

Line 202:43: E114 indentation is not a multiple of four (comment)
Line 202:43: E116 unexpected indentation (comment)

Comment last updated at 2022-08-09 00:09:43 UTC

Instead add unmaximize_dockwidget to Layouts and use it where needed.

This goes well with the already existing method close_window

- This makes all these operations consistent with respect to unmaximizing plugins. Before only running and debugging a file did that. - Also expand and simplify tests due to this change

spyder/plugins/ipythonconsole/plugin.py

- That makes easier to call that method from other plugins. - Fix call to run_script from Files/Projects, which was broken after adding the focus_to_editor arg to it.

dalthviz

Thanks @ccordoba12 ! Checking locally seems like the changes are working as expected and I left some questions regarding code placement.

Otherwise this LGTM 👍

spyder/plugins/projects/plugin.py

spyder/app/mainwindow.py

spyder/plugins/ipythonconsole/plugin.py

Co-authored-by: Daniel Althviz Moré <d.althviz10@uniandes.edu.co>

dalthviz · 2022-08-08T18:40:36Z

Checking locally this again seems like closing the Tour leaves the Maximize toolbar button in a incoherent state (it remains checked although the unmaximized action was done). Also, after closing the tour, should the plugins previously maximized be again maximized @ccordoba12 ? Maybe this was an issue before?

That way it'll be easier for external plugin developers to ask for this programmatically.

ccordoba12 · 2022-08-09T00:09:48Z

Checking locally this again seems like closing the Tour leaves the Maximize toolbar button in a incoherent state (it remains checked although the unmaximized action was done)

Thanks @dalthviz for manually checking that! I only connected the new sig_unmaximize_plugin_requested signal for dockable plugins, but the Tours plugin is not dockable. That's why it was not having effect.

I fixed that in my last commit and force pushed it again.

Also, after closing the tour, should the plugins previously maximized be again maximized @ccordoba12 ? Maybe this was an issue before?

Yep, that was the case before. Since that's a minor thing, I think we should leave it for later.

dalthviz

👍🏼

Fixes #3221

ccordoba12 added 7 commits August 3, 2022 11:31

IPython console: Don't give it focus when undocked

6e7e27d

Editor: Use 'Maintain focus in editor' option when running files too

773f93e

This is to be consistent with the same behavior for cells.

Editor/IPython console: Use 'Maintain focus in editor' when running d…

2d5a906

…ebug commands

Editor: Update text of an option to better reflect how it works

3e9197e

Now we maintain the focus in the editor after running or debugging files, cells or selections.

API: Fix calls to switch_to_plugin when plugins are docked/undocked

b5a1d90

Main Window: Use layouts.maximize_action to maximize/unmaximize plugins

6cc42d3

This allows us to correctly set its state when calling switch_to_plugin from plugins programmatically.

Layout: Set maximized state when plugins are maximized

1965292

- The lack of this made that the calls to switch_to_plugin did nothing when plugins were maximized. - Fix several bugs with switch_to_plugin and the interaction between new and old API plugins.

ccordoba12 added this to the v5.3.3 milestone Aug 3, 2022

ccordoba12 requested a review from dalthviz August 3, 2022 22:36

ccordoba12 self-assigned this Aug 3, 2022

ccordoba12 changed the title ~~PR: Fix Maintain focus in the editor option and unmaximize plugins when running/debugging code~~ PR: Improve Maintain focus in the editor option and unmaximize plugins when running/debugging code Aug 4, 2022

ccordoba12 added 5 commits August 3, 2022 23:28

Main window: Remove maximize_dockwidget method

ef8ef78

Instead add unmaximize_dockwidget to Layouts and use it where needed.

API: Add method to call create_window directly from plugins

b699690

This goes well with the already existing method close_window

Testing: Expand test_maximize_minimize_plugins to cover much more cases

72f5819

Testing: Expand test_focus_to_editor option to cover more cases

f1cef1f

IPython console: Unmaximize plugins before any run or debug operation

3862d93

- This makes all these operations consistent with respect to unmaximizing plugins. Before only running and debugging a file did that. - Also expand and simplify tests due to this change

ccordoba12 force-pushed the issue-3221 branch from 3bdf3e4 to 3862d93 Compare August 4, 2022 04:31

dalthviz reviewed Aug 4, 2022

View reviewed changes

spyder/plugins/ipythonconsole/plugin.py Outdated Show resolved Hide resolved

ccordoba12 added 2 commits August 4, 2022 16:57

IPython console: Add default values to most args of run_script

8ea1fba

- That makes easier to call that method from other plugins. - Fix call to run_script from Files/Projects, which was broken after adding the focus_to_editor arg to it.

Testing: Fix an error on Windows

52090d0

dalthviz reviewed Aug 5, 2022

View reviewed changes

spyder/plugins/projects/plugin.py Outdated Show resolved Hide resolved

spyder/app/mainwindow.py Outdated Show resolved Hide resolved

dalthviz added type:Enhancement component:Main Window type:Bug labels Aug 5, 2022

ccordoba12 added 3 commits August 6, 2022 11:13

Projects: Move logic to unmaximize any other plugin to the Layout plugin

da2a8d2

Main Window: Move logic to switch to plugins to the Layout plugin

f458f22

Testing: Simplify test_maximize_minimize_plugins

a4206fb

dalthviz reviewed Aug 8, 2022

View reviewed changes

spyder/plugins/ipythonconsole/plugin.py Outdated Show resolved Hide resolved

IPython console: Remove missing word in docstring

7dc3231

Co-authored-by: Daniel Althviz Moré <d.althviz10@uniandes.edu.co>

Use a signal to request unmaximizing plugins

fcbf425

That way it'll be easier for external plugin developers to ask for this programmatically.

ccordoba12 force-pushed the issue-3221 branch from 379b4cf to fcbf425 Compare August 9, 2022 00:09

dalthviz approved these changes Aug 9, 2022

View reviewed changes

dalthviz merged commit 3e1accc into spyder-ide:5.x Aug 9, 2022

ccordoba12 deleted the issue-3221 branch August 9, 2022 15:54

dalthviz added a commit that referenced this pull request Aug 9, 2022

Merge from 5.x: PR #18928

cad4dcc

Fixes #3221

This was referenced Aug 10, 2022

PR: Unmaximize debugger plugin when clicking on debug toolbar buttons #19005

Merged

PR: Add the ability to request unmaximizing plugins from widgets and remove redeclared signals/connections in widgets #19008

Merged

ccordoba12 mentioned this pull request Oct 5, 2022

PR: Fix keyboard shortcut to switch to the Editor #19703

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PR: Improve `Maintain focus in the editor` option and unmaximize plugins when running/debugging code #18928

PR: Improve `Maintain focus in the editor` option and unmaximize plugins when running/debugging code #18928

ccordoba12 commented Aug 3, 2022 •

edited

Loading

pep8speaks commented Aug 3, 2022 •

edited

Loading

dalthviz left a comment

dalthviz commented Aug 8, 2022 •

edited

Loading

ccordoba12 commented Aug 9, 2022

dalthviz left a comment

PR: Improve Maintain focus in the editor option and unmaximize plugins when running/debugging code #18928

PR: Improve Maintain focus in the editor option and unmaximize plugins when running/debugging code #18928

Conversation

ccordoba12 commented Aug 3, 2022 • edited Loading

Description of Changes

Issue(s) Resolved

Affirmation

pep8speaks commented Aug 3, 2022 • edited Loading

Comment last updated at 2022-08-09 00:09:43 UTC

dalthviz left a comment

Choose a reason for hiding this comment

dalthviz commented Aug 8, 2022 • edited Loading

ccordoba12 commented Aug 9, 2022

dalthviz left a comment

Choose a reason for hiding this comment

PR: Improve `Maintain focus in the editor` option and unmaximize plugins when running/debugging code #18928

PR: Improve `Maintain focus in the editor` option and unmaximize plugins when running/debugging code #18928

ccordoba12 commented Aug 3, 2022 •

edited

Loading

pep8speaks commented Aug 3, 2022 •

edited

Loading

dalthviz commented Aug 8, 2022 •

edited

Loading