Add show_debug notification

[seankmartin]

Description

This PR is to add a show_debug notification function, to round out the existing functionality to show info, warning, and error.
I've been looking into plugin debugging in relation to #2948. I noticed that there was no show_debug function, which I thought might be a nice way to help debugging as the console log level preferences in napari can be set to info level to hide these.
Open to thoughts though if there is a reason it would be preferred not to have this function! I could use an alternative if so, outside of core, something like:

import napari
def alt_show_debug(message: str):
    napari.utils.notifications.notification_manager.dispatch(
        napari.utils.notifications.Notification(
            message, severity=napari.utils.notifications.NotificationSeverity.DEBUG
        )
    )

Type of change

• New feature (non-breaking change which adds functionality)

References

Related to #2948 as I noticed it during writing this guide.

How has this been tested?

• The test suite for my feature follows the structure for the existing show_x notification functionality

Final checklist:

• My PR is the minimum possible work for the desired functionality
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• I have added tests that prove my fix is effective or that my feature works
• If I included new strings, I have used trans. to make them localizable.
  For more information see our translations guide.

[github-actions]

Click here to download the docs artifacts
docs
(zip file)

[codecov]

Codecov Report

Merging #5101 (dce9466) into main (6bf6803) will increase coverage by 0.00%.
The diff coverage is 100.00%.

@@           Coverage Diff           @@
##             main    #5101   +/-   ##
=======================================
  Coverage   89.35%   89.36%           
=======================================
  Files         601      601           
  Lines       51153    51158    +5     
=======================================
+ Hits        45707    45716    +9     
+ Misses       5446     5442    -4     

Impacted Files	Coverage Δ
napari/utils/_tests/test_notification_manager.py	100.00% <100.00%> (ø)
napari/utils/notifications.py	83.13% <100.00%> (+0.19%)	⬆️
napari/_qt/qt_viewer.py	78.78% <0.00%> (-0.21%)	⬇️
napari/_qt/dialogs/qt_package_installer.py	81.81% <0.00%> (+0.39%)	⬆️
napari/utils/theme.py	94.04% <0.00%> (+0.59%)	⬆️
napari/utils/info.py	85.10% <0.00%> (+1.06%)	⬆️
napari/_qt/__init__.py	56.66% <0.00%> (+6.66%)	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[kcpevey]

Thanks @seankmartin for this PR!

I'm adding @brisvag or @Czaki as reviewers since it seems this went overlooked. If there is someone else who would be better to review, feel free to swap!

[brisvag]

Good, seems pretty straightforward to me. I'm not sure I understand how to enable/disable this when actually using napari. Is the default loglevel WARN?

[seankmartin]

As I understand it (please correct me if wrong!)

There are two default log levels set here

napari/napari/settings/_application.py

Lines 104 to 115 in ee94c35

	gui_notification_level: NotificationSeverity = Field(
	NotificationSeverity.INFO,
	title=trans._("GUI notification level"),
	description=trans._(
	"Select the notification level for the user interface."
	),
	)
	console_notification_level: NotificationSeverity = Field(
	NotificationSeverity.NONE,
	title=trans._("Console notification level"),
	description=trans._("Select the notification level for the console."),
	)

1. gui_notification_level - by default info.
2. console_notification_level - by default none (so it prints every log message).

By default show_debug(msg) would print to console, but not show it in the GUI message popup box in the bottom right of the viewer.

To change the level in napari and see the show_debug output, you can directly set it

settings = napari.get_settings()
settings.application.console_notification_level = "debug"
settings.application.gui_notification_level = "debug"

Or if using the GUI, you can set it in Preferences -> Application -> GUI notification level / Console notification level.

[brisvag]

Great, thanks for the rundown! Seems useful to me :)