PR: Improve UI of Plugins page in Preferences #21101

ccordoba12 · 2023-07-05T17:06:04Z

Description of Changes

Add a new ElementsTable widget to make easier for users to understand what plugins they'd like to turn on/off.

Before

After
Allow external plugins to be disabled in that page.
Use different icons and improve description for several plugins.
Sort entries in that table by plugin name but in a localized way. That meant adding a new dependency called pyuca, which can sort non-English strings correctly.
Highlight entire row of the shortcuts table in Preferences.

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

ccordoba12 · 2023-07-07T00:43:47Z

@CAM-Gerlach, could you review the plugin descriptions changed in this PR? Thanks!

dalthviz

Thanks @ccordoba12 ! Give this a check locally and seems like is working as expected (even the external plugins enable/disable functionality!) 👍

Left a comment regarding the plugins API changes which probably require an API version bump (and the respective updates in the different resources and external plugins repos). Besides that, seems to me that implementing a way to search for plugin entries with the new widget could be worthy. Other than that this LGTM 👍

dalthviz · 2023-07-07T22:16:17Z

spyder/api/plugins/new_api.py

        """
        raise NotImplementedError('A plugin name must be defined!')

-    def get_description(self):
+    @staticmethod
+    def get_description():


Since this changes base methods (get_description and get_icon) for the plugins seems like the API version should be updated?:

spyder/spyder/api/_version.py

Lines 7 to 26 in c2ce802

"""

Spyder API Version.

The API version should be modified according to the following rules:

1. If a module/class/method/function is added, then the minor version

must be increased.

2. If a module/class/method/function is removed, renamed or changes its

signature, then the major version must be increased.

3. Whenever possible, deprecation marks and alerts should be employed in

order to inform developers of breaking-compatibility changes in a

future API release. In such case, the minor version should be increased

and once the deprecated APIs disappear then the major version should be

updated.

"""

VERSION_INFO = (0, 9, 1)

__version__ = '.'.join(map(str, VERSION_INFO))

Also, since this changes de API maybe could be worthy to also eventualy update the related plugin resources (docs, example repo, plugins repos, etc) so maybe creating issues in the respective repos could be worthy to keep track of this change?

Since this changes base methods (get_description and get_icon) for the plugins seems like the API version should be updated?

Yep, you're right. I'll push a commit to bump our API version.

Also, since this changes de API maybe could be worthy to also eventualy update the related plugin resources (docs, example repo, plugins repos, etc) so maybe creating issues in the respective repos could be worthy to keep track of this change?

I think the best we can do for now is to document the API changes in our changelog (I'll also add an entry there), so that plugin authors and ourselves remember what's been added/removed in version 6. Then, when we finally release it, we could do what you propose (I think right now it's premature to do that because more API could be necessary).

ccordoba12 · 2023-07-10T18:24:47Z

Besides that, seems to me that implementing a way to search for plugin entries with the new widget could be worthy.

Agreed. I'll add that functionality when using ElementsTable to build the list of detected environments in Preferences > Main Interpreter

Other than that this LGTM 👍🏽

Great!

Also, pinging @jitseniesen about this one because it requires changes to external plugins to be compatible with Spyder 6 (see the entry I added in New API features in the Spyder 6 changelog).

Also, fix a linting warning.

This will help us to display a set of elements with title, description, icon and an associated widget (e.g. a checkbox)

…vered row

…nstantiation Also, improve description of some plugins and add new icons for others.

- I saw that these changes are necessary after using the widget for the Plugins config page. - Wrap description text in case it's too long. - Add some left padding to items to make icons look centered. - Increase size of the column widget so that widgets are not so close to the right border. - Adjust columns and rows size in showEvent/resizeEvent so that the widget looks good at different sizes.

Also, improve some docstrings of methods changed in the new API

Also, use it in the Plugins config page to show which ones are core plugins.

…lements This simplifies its construction a bit.

Also, use that option to center additional_info in ElementsTable.

Instead, I replaced that with the new fonts API.

Also, sort external and internal plugins alphabetically for easy searching.

We need to use the Pyuca package for that, so I added it as a new dependency.

Also, add entry to the Spyder 6 changelog describing them and other entries with the new features merged since alpha1.

CAM-Gerlach

Sorry for the delay; I got a big backlog of GitHub notifications and didn't see this. Here's my UI text pass.

General common changes:

Focus on clearly describing the user-facing functionality rather than lower-level implementation details (which will be mostly of interest to those already aware of them)
Use more consistent framing and verbiage
Use clearer, more idiomatic and more concise phrasing
Describe additional key points of several features

spyder/api/plugin_registration/_confpage.py

spyder/api/plugins/new_api.py

spyder/app/tests/spyder-boilerplate/spyder_boilerplate/spyder/plugin.py

spyder/plugins/breakpoints/plugin.py

spyder/plugins/switcher/plugin.py

spyder/plugins/toolbar/plugin.py

spyder/plugins/tours/plugin.py

spyder/plugins/variableexplorer/plugin.py

spyder/plugins/workingdirectory/plugin.py

ccordoba12

Thanks @CAM-Gerlach for your suggestions! I agree with most of them, except for the ones I left a comment for below.

spyder/api/plugin_registration/_confpage.py

spyder/plugins/completion/plugin.py

spyder/plugins/ipythonconsole/plugin.py

spyder/plugins/maininterpreter/plugin.py

spyder/plugins/preferences/plugin.py

ccordoba12

Last suggestion, then it should be ready for me.

spyder/plugins/completion/plugin.py

spyder/plugins/outlineexplorer/plugin.py

spyder/plugins/preferences/plugin.py

CAM-Gerlach

UI text LGTM, thanks (including your last suggestion)

spyder/plugins/completion/plugin.py

ccordoba12 · 2023-07-27T16:51:55Z

@dalthviz, are you ok with merging this one?

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

CAM-Gerlach · 2024-12-23T08:39:31Z

Before/after in table format

Before	After

ccordoba12 added type:Enhancement component:Preferences User Interface (UI) labels Jul 5, 2023

ccordoba12 self-assigned this Jul 5, 2023

ccordoba12 added this to the v6.0alpha2 milestone Jul 5, 2023

ccordoba12 requested review from dalthviz and CAM-Gerlach July 7, 2023 00:29

dalthviz reviewed Jul 7, 2023

View reviewed changes

ccordoba12 force-pushed the plugins-table branch from 45ed105 to 6aa8c67 Compare July 10, 2023 18:36

ccordoba12 added 19 commits July 23, 2023 22:50

Widgets: Remove unnecessary code in HTMLDelegate

c9b6131

Also, fix a linting warning.

Widgets: Add a new ElementsTable widget

06b99d4

This will help us to display a set of elements with title, description, icon and an associated widget (e.g. a checkbox)

Widgets: Add a subclass of QTableView that can highlight an entire ho…

8d8ada4

…vered row

Widgets: Highlight entire row on hover in ElementsTable

ce8fe43

Make get_description and get_icon plugin methods accessible without i…

b9045f2

…nstantiation Also, improve description of some plugins and add new icons for others.

Preferences: Use ElementsTable in the Plugins page

c46f3c3

Add a workaround to enable/disable external plugins

d3af6bd

Testing: Fix Spyder boilerplate plugin

6f4e9cd

Also, improve some docstrings of methods changed in the new API

Widgets: Add a new additional information column to ElementsTable

c28c125

Also, use it in the Plugins config page to show which ones are core plugins.

Widgets: Detect if ElementsTable needs additional features from its e…

00e5b05

…lements This simplifies its construction a bit.

Widgets: Add option to center text vertically in HTMLDelegate

123877a

Also, use that option to center additional_info in ElementsTable.

Widgets: Remove hard-coded font size in ElementsModel

37626a2

Instead, I replaced that with the new fonts API.

Widgets: Readjust ElementsTable layout when parent widget is maximized

b531c29

Widgets: Directly use elements attribute where needed in ElementsTable

9adc27e

Preferences: Show external plugins first in Plugins page

5dcb6b9

Also, sort external and internal plugins alphabetically for easy searching.

Preferences: Sort plugins in Plugins page for non-English languages

77ff71b

We need to use the Pyuca package for that, so I added it as a new dependency.

Shortcuts: Highlight entire row in ShortcutsTable

5dba927

API: Bump version to account for the changes required from plugins

8fae526

Also, add entry to the Spyder 6 changelog describing them and other entries with the new features merged since alpha1.

ccordoba12 force-pushed the plugins-table branch from 6aa8c67 to 8fae526 Compare July 24, 2023 03:55

CAM-Gerlach reviewed Jul 24, 2023

View reviewed changes

ccordoba12 commented Jul 25, 2023

View reviewed changes

ccordoba12 commented Jul 26, 2023

View reviewed changes

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

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

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

CAM-Gerlach approved these changes Jul 26, 2023

View reviewed changes

ccordoba12 commented Jul 27, 2023

View reviewed changes

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

ccordoba12 force-pushed the plugins-table branch from 14a8d1e to d5265cf Compare July 27, 2023 16:45

Improve descriptions for most plugins

617c15c

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

ccordoba12 force-pushed the plugins-table branch from d5265cf to 617c15c Compare July 27, 2023 19:07

ccordoba12 merged commit 68cdfdf into spyder-ide:master Jul 28, 2023

ccordoba12 deleted the plugins-table branch July 28, 2023 01:21

jitseniesen mentioned this pull request Jul 28, 2023

Update plugin for compability with Spyder 6.0.0alpha2 spyder-ide/spyder-unittest#215

Closed

This was referenced Aug 2, 2023

Config page for Shortcuts always shows shortcuts in black regardless of interface theme #21206

Closed

PR: Fix showing text in the dark theme for keyboard sequences in the Shortcurts page (Preferences) #21215

Merged

jitseniesen mentioned this pull request Nov 7, 2023

Update plugin and tests for Spyder 6.0.0a2 and 6.0.0a3 spyder-ide/spyder-unittest#218

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

PR: Improve UI of Plugins page in Preferences #21101

PR: Improve UI of Plugins page in Preferences #21101

ccordoba12 commented Jul 5, 2023 •

edited

Loading

ccordoba12 commented Jul 7, 2023

dalthviz left a comment •

edited

Loading

dalthviz Jul 7, 2023

ccordoba12 Jul 10, 2023

ccordoba12 commented Jul 10, 2023 •

edited

Loading

CAM-Gerlach left a comment

ccordoba12 left a comment

ccordoba12 left a comment •

edited

Loading

CAM-Gerlach left a comment

ccordoba12 commented Jul 27, 2023

CAM-Gerlach commented Dec 23, 2024

	"""
	Spyder API Version.

	The API version should be modified according to the following rules:

	1. If a module/class/method/function is added, then the minor version
	must be increased.

	2. If a module/class/method/function is removed, renamed or changes its
	signature, then the major version must be increased.

	3. Whenever possible, deprecation marks and alerts should be employed in
	order to inform developers of breaking-compatibility changes in a
	future API release. In such case, the minor version should be increased
	and once the deprecated APIs disappear then the major version should be
	updated.
	"""

	VERSION_INFO = (0, 9, 1)
	__version__ = '.'.join(map(str, VERSION_INFO))

PR: Improve UI of Plugins page in Preferences #21101

PR: Improve UI of Plugins page in Preferences #21101

Conversation

ccordoba12 commented Jul 5, 2023 • edited Loading

Description of Changes

Issue(s) Resolved

Affirmation

ccordoba12 commented Jul 7, 2023

dalthviz left a comment • edited Loading

Choose a reason for hiding this comment

dalthviz Jul 7, 2023

Choose a reason for hiding this comment

ccordoba12 Jul 10, 2023

Choose a reason for hiding this comment

ccordoba12 commented Jul 10, 2023 • edited Loading

CAM-Gerlach left a comment

Choose a reason for hiding this comment

ccordoba12 left a comment

Choose a reason for hiding this comment

ccordoba12 left a comment • edited Loading

Choose a reason for hiding this comment

CAM-Gerlach left a comment

Choose a reason for hiding this comment

ccordoba12 commented Jul 27, 2023

CAM-Gerlach commented Dec 23, 2024

ccordoba12 commented Jul 5, 2023 •

edited

Loading

dalthviz left a comment •

edited

Loading

ccordoba12 commented Jul 10, 2023 •

edited

Loading

ccordoba12 left a comment •

edited

Loading