npe2 TODOs

[kne42]

Background

This is an effort to document what work needs to be done to round out existing work for npe2 menu and keybinding contributions.

Checklist

• app-model menu refactors implemented
  • decision to be made for NAP 6 on what menus should be contributable to
  • file menu (use app-model for file menu #4865)
  • plugins menu (Use app model for plugins menu #4991)
  • window menu (WIP Use app-model for Window menu #4977)
• new keybindings system implemented
  • consensus gathered on backend handling of keybindings, multi-part keybindings, and special cases in to-be-created NAP (see discussion in Incorrect processing of keybindings consisting of a combination of modifiers without a key #5747)
  • bug fixes related to proper display of keybindings as text (fix various keybinding/shortcut bugs #5604)
  • keybinding contributions handled from npe2 manifest (on-hold enable npe2 keybinding contributions #5338)
  • enable editing of plugin-set keybindings via GUI (on-hold enable npe2 keybinding contributions #5338)
• npe1 code extracted into functions and separated into single file or module for easier deprecation and removal (on-hold Remove all napari_plugin_engine code, use npe2 (adaptor) entirely #4692)
• action manager removed, since old action system is replaced by app-model's

Dependencies

• menus
  • custom action / wrapper that allows one to take the output of a function and do something with it
  • file menu
    • open sample menu needs to be able to take the output of the action to populate the viewer [see custom action]
  • plugins menu
    • widgets menus need to be able to take the output of the action to create the widget [see custom action]
    • NAP 6 needs live demo to gather consensus, requires [custom action] for demo
  • window menu
    • testing errors: pytest fixture problem where init_qactions are persisting across tests
  • for npe1 deprecation, the menu contributions don't need to be completed, just the internal app-model menu migrations
• keybindings
  • NAP needs to be created and consensus gathered to determine how we will handle keybindings on the backend
  • a design for the new GUI for setting shortcuts may be needed

API Changes

Once these changes have been made, npe1 will need to be deprecated and eventually removed. The action manager will also be removed. Existing APIs for keybindings will be changed as documented in the to-be-created keybinding NAP.

[lucyleeow]

Just a question, is #4860 still relevant or would this succeed it?

[kne42]

This is meant as a successor in the sense that it's more up-to-date on current blockers, dependencies, and tasks. I think #4860 still has some relevancy for documentation as this issue is for technical work.

[lucyleeow]

Makes sense, thanks!

[aganders3]

Thanks for collecting this in one place! There's one small typo - the Window Menu app-model PR is #4977 (OP links #4997).