PR: Restore buttons that control the debugger to the main toolbar #22702

ccordoba12 · 2024-10-21T15:47:28Z

Description of Changes

That's necessary because many people are accustomed to the Spyder 5 workflow, where they could control the debugger and see the Variable Explorer and IPython console at the same time.
Those buttons will be placed next to the current ones in the Debug toolbar, but they'll be shown only if there's an active debugging session in the current console.
Changes to the Toolbar plugin:
- Declare a default order for toolbars in our config system.
- If a toolbar is added or removed, toolbars will be reordered with the default order and the Working Directory will be placed to the right of all others. That's because it's not easy to visually see where that toolbar ends, so it's better to not place other toolbars to its right.
- Fix loading last visible toolbars.
- Rename/improve a couple of methods for clarity.
Changes to the Run plugin:
- Allow to place items in toolbars using the full Toolbar API. That's necessary to place the debug file/cell/selection buttons before the ones that control the debugger.
API changes:
- Add a new signal to SpyderToolbar to inform when it's rendered. That's necessary to get the widgets corresponding to the control debugger actions in the Debug toolbar, so we can hide/show them.

Visual changes

New buttons shown when a debugging session is started and hidden when it's stopped

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 · 2024-10-21T15:57:48Z

@dalthviz, could you manually check that the following things are working for you? Thanks!

The Control debugger toolbar is hidden for you when starting Spyder from this PR.
When enabled, it should be shown next to the Debug toolbar.
Change toolbars position, close and open Spyder and check the order is restored as expected.
Move a toolbar to the right of the Working Directory, close and open Spyder, and check the toolbar is moved to the left of it. That means the Working Directory will always be shown to the right of all other toolbars.

ccordoba12 · 2024-10-21T18:56:14Z

@dalthviz, in my last commit I also added some tests to cover the new functionality of the Toolbar plugin.

dalthviz · 2024-10-21T23:08:54Z

Gave this a manual check and seems like the elements described above are working 👍 However, with the changes here, now is not possible to fully save toolbars state. So things like having more than one row of toolbars will not be possible, so something like:

Will not persist between sessions

spyder/plugins/toolbar/api.py

That way it'll be easier to tell them apart.

- That's because not all toolbars are created with the create_application_toolbar method. - Also, remove repeated code between create and add app toolbars.

We'll need this to interate over the toolbars by id in the plugin

We were not correctly loading toolbars that are not visible.

- That restores the buttons available in Spyder 5, which was requested by users. - The toolbar is not visible by default to avoid showing repeated functionality in the Debugger plugin and main toolbar.

Also, fix some block comments

Also do that at first startup,

Instead, add all its buttons to the Debug toolbar

Those buttons will be visible only if there's a debugging session active in the current console.

ccordoba12 · 2024-10-25T17:26:02Z

Thanks @dalthviz for the review!

Gave this a manual check and seems like the elements described above are working 👍 However, with the changes here, now is not possible to fully save toolbars state.

This should be fixed now, so please check again.

Also, I changed the implementation according to the UX team feedback. Now the buttons that control the debugger are shown in/hidden from the Debug toolbar when a debugging session is started/stopped (see the OP), or if the current console is in a debugging session or not. That avoids a serious issue with my previous approach: users would need to know that a new toolbar is available and enable it to get the Spyder 5 UX. In addition, this approach prevents cluttering the interface because the new buttons will be hidden when not needed.

So, could you check if that's working as expected for you?

dalthviz

Thanks @ccordoba12 ! Gave a local check and seems like things are working as expected 👍 Left a couple comments with nitpicks and a question regarding the tests wait logic (taking into account that now there is a signal available to determine when a toolbar gets rendered; maybe the wait are there to give some time for the toolbars to be rendered/rerendered after some action is done to them?) .

Anyhow, leaving this approved so feel free to merge if you think is ready

dalthviz · 2024-10-26T04:02:35Z

spyder/plugins/toolbar/tests/test_toolbar.py

+
+    # Move the debug toolbar to be before the file one
+    toolbar.get_main().insertToolBar(file_toolbar, debug_toolbar)
+    qtbot.wait(500)


Maybe for some of these qtbot.wait calls over these new tests could be replaced for a qtbot.waitSignal checking for the new toolbars sig_is_rendered signal?

dalthviz · 2024-10-26T04:03:10Z

spyder/plugins/toolbar/plugin.py

        container.create_toolbars_menu()
        container.load_last_visible_toolbars()

    def on_close(self, _unused):
        container = self.get_container()
+


Should this blank be removed?

dalthviz · 2024-10-26T04:04:26Z

spyder/plugins/toolbar/container.py

@@ -10,7 +10,7 @@

 # Standard library imports
 from collections import OrderedDict
-from spyder.utils.qthelpers import SpyderAction
+import logging


Shouldn't import logging go first/before from collections import OrderedDict too?

ccordoba12 added type:Bug component:Debugger User Experience (UX) labels Oct 21, 2024

ccordoba12 added this to the v6.0.2 milestone Oct 21, 2024

ccordoba12 requested a review from dalthviz October 21, 2024 15:47

ccordoba12 self-assigned this Oct 21, 2024

ccordoba12 force-pushed the issue-22434 branch 2 times, most recently from c6a7fab to d86d1c8 Compare October 21, 2024 18:52

ccordoba12 force-pushed the issue-22434 branch from d86d1c8 to 5aaaeab Compare October 21, 2024 19:02

dalthviz reviewed Oct 21, 2024

View reviewed changes

spyder/plugins/toolbar/api.py Outdated Show resolved Hide resolved

ccordoba12 added 14 commits October 23, 2024 21:19

API: Add str and repr methods to ApplicationToolbar

f22de34

That way it'll be easier to tell them apart.

Toolbar: Registry toolbars when adding, not creating them

92e7f10

- That's because not all toolbars are created with the create_application_toolbar method. - Also, remove repeated code between create and add app toolbars.

Toolbar: Make get_application_toolbars return the dict of toolbars

4579a71

We'll need this to interate over the toolbars by id in the plugin

Toolbar: Add toolbars in a specific order

22ff0a6

Toolbar: Rename method for clarity

e16ef97

Toolbar: Fix loading last visible toolbars

f724222

We were not correctly loading toolbars that are not visible.

Debugger: Add a new main toolbar to control the debugger from it

0fe3589

- That restores the buttons available in Spyder 5, which was requested by users. - The toolbar is not visible by default to avoid showing repeated functionality in the Debugger plugin and main toolbar.

Toolbar: Restore toolbars order from the previous session

3f31f15

Also, fix some block comments

Testing: Add tests to cover the new functionality of the Toolbar plugin

b4b45bc

Toolbar: Only reorganize toolbars if they are added/removed

78631c4

Also do that at first startup,

Run: Allow to add items to toolbars using the full Toolbar API

d97db22

Debugger: Remove Control Debugger toolbar

16714a4

Instead, add all its buttons to the Debug toolbar

API: Add signal to inform that a SpyderToolbar is rendered

25642ed

Debugger: Show/hide buttons that control it in the main toolbar

15f1a15

Those buttons will be visible only if there's a debugging session active in the current console.

ccordoba12 force-pushed the issue-22434 branch from 5aaaeab to 15f1a15 Compare October 25, 2024 16:55

dalthviz approved these changes Oct 26, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PR: Restore buttons that control the debugger to the main toolbar #22702

PR: Restore buttons that control the debugger to the main toolbar #22702

ccordoba12 commented Oct 21, 2024 •

edited

Loading

ccordoba12 commented Oct 21, 2024

ccordoba12 commented Oct 21, 2024 •

edited

Loading

dalthviz commented Oct 21, 2024

ccordoba12 commented Oct 25, 2024 •

edited

Loading

dalthviz left a comment

dalthviz Oct 26, 2024

dalthviz Oct 26, 2024

dalthviz Oct 26, 2024

PR: Restore buttons that control the debugger to the main toolbar #22702

Are you sure you want to change the base?

PR: Restore buttons that control the debugger to the main toolbar #22702

Conversation

ccordoba12 commented Oct 21, 2024 • edited Loading

Description of Changes

Visual changes

Issue(s) Resolved

Affirmation

ccordoba12 commented Oct 21, 2024

ccordoba12 commented Oct 21, 2024 • edited Loading

dalthviz commented Oct 21, 2024

ccordoba12 commented Oct 25, 2024 • edited Loading

dalthviz left a comment

Choose a reason for hiding this comment

dalthviz Oct 26, 2024

Choose a reason for hiding this comment

dalthviz Oct 26, 2024

Choose a reason for hiding this comment

dalthviz Oct 26, 2024

Choose a reason for hiding this comment

ccordoba12 commented Oct 21, 2024 •

edited

Loading

ccordoba12 commented Oct 21, 2024 •

edited

Loading

ccordoba12 commented Oct 25, 2024 •

edited

Loading