TODO list for integration of app-model

[tlambert03]

🧰 Task

list of todos after #4784

• continue replacing procedural QtMenus with app-model registered ones (note PR use app-model for view menu #4826 provides the base changes and tests required for the menu migration to app-model and all other PRs are based off of this original PR. It should thus be merged first)

  • view menu: use app-model for view menu #4826
  • file menu: use app-model for file menu #4865
  • help menu: Migrate help menu to use app model #4922
  • window menu: Migrate Window menu to app-model #6905
  • plugins menu: Use app model for plugins menu #4991
  • Debug: Migrate Debug menu to app-model #6915

• allow registration of app keybindings that aren't attached to a specific python object (like viewer or layers). I think this could be done gradually. to start, we could by put a object that implements the KeymapProvider interface at the beginning or end of the ChainMap used to lookup keybindings. In the longer run, the app-model keybindings registry would be the source of keybindings, and key_bindings.KeymapHandler would be retired.

• extract keypress control from the vispy canvas (Reclaim keypress events from vispy, and clarify what actually handles keypresses. #3087)

• add documentation to napari.org/plugins that explains how to add menu items, including a list of "contributable" menu ids, (similar to this)

• add documentation to napari.org/plugins explaining exactly what names they can use in their when context clauses in their manifests (like this page for vscode). Related issue: Document ContextKeys docs#146, also for reference Talley has mentioned wanting to (auto)generate docs using the descriptions in the ContextKeys: Update layer list context keys #4499 (comment)

• add documentation explaining how to use superqt.fonticons to declare icons (and figure out the best way for those icons to change color with the theme)

• decide on and add documentation to explain exactly what types may be used as type hints for dependency injection in a plugin command function. (these are the names that are declared in the the app.injection_store.namespace)

• replace action manager with commands registry, determine if any deprecation is needed

• consider putting the notification system in the app-model (perhaps upstream)

• create 3 tiers of keybinding scope: default (napari), plugins, and user keybindings (in order of increasing priority)

• rename _qt.get_app to get_qapp... however that's publicly exported, and that needs to be considered

• consider using Actions for layer mode buttons

• move to expressing keybindings using app-models keycodes instead of vispy's (the app-model tests and demos have a lot of examples of how to express keypresses using the KeyMod and KeyCode enums)

• suggestion: context object for layerlist and viewer to be moved to app model #4919

• Task: add tests for all app-model registered action callbacks #4979

[liu-ziyang]

@tlambert03 Thanks for putting this together! do you mind if I convert this issue to a project board so we can track and collaborate?

[Czaki]

• rename _qt.get_app to get_qapp... however that's publicly exported, and that needs to be considered

the napari.qt could still export get_app with a deprecation warning.

[lucyleeow]

Small addition:

Update docs/guides/contexts_expressions to explain their use in context of app-model.

(I am assuming that after full transition to app-model we won't be using the old system at all anymore?)

Edit: I see all the Expr stuff has been moved to app-model so contexts and expressions in napari is definitely out of date.

[lucyleeow]

Documenting some planning/tasks related to app-model integration.

Tasks post #4991 :

• Fix for loop in npe1 samples menu _rebuild_npe1_samples_menu
• Use partial in _rebuild_npe1_samples_menu
• Better organization of Actions in napari codebase #6516 - in first instance remove use of enums for commandID and menuIDs (which removes 2 files)
• Move providers from _providers.py to _qproviders.py #6585
• Remove lambdas in Window._add_menus (see: Use app model for plugins menu #4991 (comment) for details)

Other related tasks, where I am not sure of priority/order to be worked on:

• Allow pass to QModelMenu constructor dict with mapping from types to instances pyapp-kit/app-model#176
• Migrate Window menu to app-model #6905
• Migrate Debug menu to app-model #6915
• Enable widget_iterator and sample_iterator to be per plugin and provide command info #6326 (this may be fixed with menu contributions / nap 6 implementation)
• Split key binding dispatch implementation #6204 (note action manager deprecation occurs here)

Tasks once npe1 deprecated (only listing items relevant/related to this body of work):

• deprecate npe1 when adding widgets in _run and deprecate _add_plugin_function_widget and add_plugin_dock_widget (no function/dock widget distinction in npe2
• remove npe1 widget tests
• remove npe1 sample and plugin menu code

Lower priority (?) related tasks:

• FEATURE: add partial (args/kwargs) field to Action? pyapp-kit/app-model#52
• Providers/processors should return PublicOnlyProxy #6524
• Add magicgui.widgets.Widget to combine_widgets error message #6232
• Two get_app functions #6054 (I would like to see this fixed)
• Shapes Convert to Labels layer list contextual menu is greyed out for new layer, need to reselect the layer #6643
• Updating the context documentation (required once we allow expose when and enablement conditionals to plugins):
  • Document ContextKeys docs#146
  • Update context_expressions.md now that expressions moved to app-model docs#369
• Hide Toggle Fullscreen for MacOS which adds its own fullscreen menu item #6240 (once we have keybindings implemented)
• Remove lambdas in help menu actions _help_actions.py #6744 (maybe this would be best worked on after FEATURE: add partial (args/kwargs) field to Action? pyapp-kit/app-model#52 )
• Test processors #6847
• How to handle headless app-model actions #6917
• Test app-model actions #6941
• Add dynamic plugin docs: Add documentation of make_napari_viewer and DynamicPlugin docs#150 (comment)
• Move layer actions under Qt #6946
• Migrate _add_viewer_dock_widget(menu) to use app-model #6964
• Update string_list.json post the app-model changes

cc @Czaki @DragaDoncila in case I missed something.

[DragaDoncila]

@lucyleeow I think #6643 should also be listed somewhere in here, probably in the lower priority tasks, since we have a workaround for now. Thank you for the exceptional recordkeeping 🙏 🎉

[lucyleeow]

Done and added some more!