npe2 0.7.5rc0__tar.gz → 0.7.7__tar.gz

{npe2-0.7.5rc0 → npe2-0.7.7}/.github/dependabot.yml

@@ -8,3 +8,8 @@ updates:
       interval: "weekly"
     commit-message:
       prefix: "ci(dependabot):"
+
+    groups:
+      github-actions:
+        patterns:
+          - "actions/*"

{npe2-0.7.5rc0 → npe2-0.7.7}/.github/workflows/ci.yml

@@ -36,7 +36,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
 
@@ -70,7 +70,7 @@ jobs:
           path: napari-from-github
           fetch-depth: 0
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: "3.10"
       - name: Install
@@ -90,7 +90,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: "3.x"
       - name: Build schema
@@ -110,9 +110,9 @@ jobs:
     if: always()
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: "3.x"
           cache-dependency-path: setup.cfg
@@ -138,7 +138,7 @@ jobs:
           python -Im coverage report --format=markdown --skip-empty --skip-covered >> $GITHUB_STEP_SUMMARY
 
       - name: Upload coverage data
-        uses: codecov/codecov-action@v3
+        uses: codecov/codecov-action@v4
         with:
           fail_ci_if_error: true
           token: ${{ secrets.CODECOV_TOKEN }}
@@ -155,7 +155,7 @@ jobs:
       - uses: actions/checkout@v4
 
       - name: Set up Python
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: "3.x"
 
@@ -180,7 +180,7 @@ jobs:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.TWINE_API_KEY }}
 
-      - uses: softprops/action-gh-release@v1
+      - uses: softprops/action-gh-release@v2
         if: startsWith(github.ref, 'refs/tags/')
         with:
           generate_release_notes: true

{npe2-0.7.5rc0 → npe2-0.7.7}/.github/workflows/test_conversion.yml

@@ -30,7 +30,7 @@ jobs:
 
     steps:
       - uses: tlambert03/setup-qt-libs@v1
-      - uses: actions/setup-python@v4
+      - uses: actions/setup-python@v5
         with:
           python-version: 3.9
 
@@ -61,7 +61,7 @@ jobs:
 
       - name: Test Conversion
         id: test-without-napari
-        uses: aganders3/headless-gui@v1
+        uses: aganders3/headless-gui@v2
         continue-on-error: true
         with:
           run: npe2 convert ./plugin_repo
@@ -73,13 +73,13 @@ jobs:
       - name: Test Conversion again with napari
         id: test-with-napari
         if: ${{ steps.test-without-napari.outcome == 'failure' }}
-        uses: aganders3/headless-gui@v1
+        uses: aganders3/headless-gui@v2
         with:
           run: npe2 convert ./plugin_repo
 
       - name: Test Conversion again with napari
         if: ${{ steps.test-without-napari.outcome == 'failure' && steps.test-with-napari.outcome == 'failure' }}
-        uses: aganders3/headless-gui@v1
+        uses: aganders3/headless-gui@v2
         with:
           # try without modifying directory
           run: npe2 convert -n ${{ matrix.plugin }}

{npe2-0.7.5rc0 → npe2-0.7.7}/.github/workflows/update_changelog.yml

@@ -19,7 +19,7 @@ jobs:
           token: ${{ secrets.GITHUB_TOKEN }}
           repo: napari/npe2
       - name: Create Pull Request
-        uses: peter-evans/create-pull-request@v5
+        uses: peter-evans/create-pull-request@v6
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           commit-message: Automatic changelog update

{npe2-0.7.5rc0 → npe2-0.7.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: npe2
-Version: 0.7.5rc0
+Version: 0.7.7
 Summary: napari plugin engine v2
 Project-URL: homepage, https://github.com/napari/npe2
 Project-URL: repository, https://github.com/napari/npe2

{npe2-0.7.5rc0 → npe2-0.7.7}/_docs/example_plugin/some_module.py

@@ -5,11 +5,10 @@ from typing import TYPE_CHECKING, Any, Dict, List, Optional
 from magicgui import magic_factory
 from qtpy.QtWidgets import QWidget
 
-from npe2.types import LayerData, PathOrPaths, ReaderFunction
-
 if TYPE_CHECKING:
     import napari.types
     import napari.viewer
+    from npe2.types import LayerData, PathOrPaths, ReaderFunction
 
 
 def write_points(path: str, layer_data: Any, attributes: Dict[str, Any]) -> List[str]:
@@ -20,7 +19,7 @@ def write_points(path: str, layer_data: Any, attributes: Dict[str, Any]) -> List
     return [path]
 
 
-def get_reader(path: PathOrPaths) -> Optional[ReaderFunction]:
+def get_reader(path: "PathOrPaths") -> Optional["ReaderFunction"]:
     # If we recognize the format, we return the actual reader function
     if isinstance(path, str) and path.endswith(".xyz"):
         return xyz_file_reader
@@ -28,7 +27,7 @@ def get_reader(path: PathOrPaths) -> Optional[ReaderFunction]:
     return None
 
 
-def xyz_file_reader(path: PathOrPaths) -> List[LayerData]:
+def xyz_file_reader(path: "PathOrPaths") -> List["LayerData"]:
     data = ...  # somehow read data from path
     layer_attributes = {"name": "etc..."}
     return [(data, layer_attributes)]
@@ -64,7 +63,7 @@ def threshold(
     return (image > threshold).astype(int)
 
 
-def create_fractal() -> List[LayerData]:
+def create_fractal() -> List["LayerData"]:
     """An example of a  Sample Data Function.
 
     Note: Sample Data with URIs don't need python code.

{npe2-0.7.5rc0 → npe2-0.7.7}/_docs/templates/_npe2_widgets_guide.md.jinja

@@ -1,8 +1,11 @@
 (widgets-contribution-guide)=
 ## Widgets
 
-Widget plugins allow developers to contribute novel graphical
-elements (aka "widgets") to the user interface.  These widgets can request
+Widget plugin contributions allow developers to add novel graphical
+elements (aka "widgets") to the user interface. For a full introduction to
+creating `napari` widgets see [](creating-widgets).
+
+Widgets can request
 access to the viewer instance in which they are docked, enabling a broad
 range of functionality: essentially, anything that can be done with the
 napari `Viewer` and `Layer` APIs can be accomplished with widgets.
@@ -58,6 +61,16 @@ specification:
    hook specification.  In the new `npe2` pattern, one uses the `autogenerate`
    field in the [WidgetContribution](contributions-widgets).
 
+For more examples see [](creating-widgets) and
+[GUI gallery examples](https://napari.org/stable/_tags/gui.html) (only a subset
+involve widgets). Additionally,
+[cookiecutter-napari-plugin](https://github.com/napari/cookiecutter-napari-plugin)
+has more robust widget examples that you can adapt to your needs.
+
+```{note}
+Notice that `napari` type annotations are strings and not imported. This is to
+avoid including `napari` as a plugin dependency when not strictly required.
+```
 
 ### Widget example
 

{npe2-0.7.5rc0 → npe2-0.7.7}/src/npe2/_plugin_manager.py

@@ -4,7 +4,7 @@ import contextlib
 import os
 import urllib
 import warnings
-from collections import Counter
+from collections import Counter, defaultdict
 from fnmatch import fnmatch
 from importlib import metadata
 from logging import getLogger
@@ -38,6 +38,7 @@ from .types import PathLike, PythonName
 if TYPE_CHECKING:
     from .manifest.contributions import (
         CommandContribution,
+        MenuCommand,
         MenuItem,
         ReaderContribution,
         SampleDataContribution,
@@ -235,6 +236,9 @@ class PluginManager:
         self._manifests: Dict[PluginName, PluginManifest] = {}
         self.events = PluginManagerEvents(self)
         self._npe1_adapters: List[NPE1Adapter] = []
+        self._command_menu_map: Dict[
+            str, Dict[str, Dict[str, List[MenuCommand]]]
+        ] = defaultdict(dict)
 
         # up to napari 0.4.15, discovery happened in the init here
         # so if we're running on an older version of napari, we need to discover
@@ -358,14 +362,28 @@ class PluginManager:
             self._npe1_adapters.append(manifest)
         else:
             self._contrib.index_contributions(manifest)
+            self._populate_command_menu_map(manifest)
         self.events.plugins_registered.emit({manifest})
 
+    def _populate_command_menu_map(self, manifest: PluginManifest):
+        # map of manifest -> command -> menu_id -> list[items]
+        self._command_menu_map[manifest.name] = defaultdict(lambda: defaultdict(list))
+        menu_map = self._command_menu_map[manifest.name]  # just for conciseness below
+        for menu_id, menu_items in manifest.contributions.menus.items() or ():
+            # command IDs are keys in map
+            # each value is a dict menu_id: list of MenuCommands
+            # for the command and menu
+            for item in menu_items:
+                if (command_id := getattr(item, "command", None)) is not None:
+                    menu_map[command_id][menu_id].append(item)
+
     def unregister(self, key: PluginName):
         """Unregister plugin named `key`."""
         if key not in self._manifests:
             raise ValueError(f"No registered plugin named {key!r}")  # pragma: no cover
         self.deactivate(key)
         self._contrib.remove_contributions(key)
+        self._command_menu_map.pop(key)
         self._manifests.pop(key)
 
     def activate(self, key: PluginName) -> PluginContext:
@@ -448,6 +466,7 @@ class PluginManager:
         mf = self._manifests.get(plugin_name)
         if mf is not None:
             self._contrib.index_contributions(mf)
+            self._populate_command_menu_map(mf)
         self.events.enablement_changed({plugin_name}, {})
 
     def disable(self, plugin_name: PluginName) -> None:
@@ -467,6 +486,7 @@ class PluginManager:
 
         self._disabled_plugins.add(plugin_name)
         self._contrib.remove_contributions(plugin_name)
+        self._command_menu_map.pop(plugin_name, None)
         self.events.enablement_changed({}, {plugin_name})
 
     def is_disabled(self, plugin_name: str) -> bool:

{npe2-0.7.5rc0 → npe2-0.7.7}/tests/test_plugin_manager.py

@@ -236,3 +236,33 @@ def test_plugin_context_dispose_error(caplog):
     pm.get_context("test").register_disposable(dummy_error)
     pm.deactivate("test")
     assert caplog.records[0].msg == "Error while disposing test; This is an error"
+
+
+def test_command_menu_map(uses_sample_plugin, plugin_manager: PluginManager):
+    """Test that the command menu map is correctly populated."""
+    pm = PluginManager.instance()
+    assert SAMPLE_PLUGIN_NAME in pm._manifests
+    assert SAMPLE_PLUGIN_NAME in pm._command_menu_map
+
+    # contains correct commands
+    command_menu_map = pm._command_menu_map[SAMPLE_PLUGIN_NAME]
+    assert "my-plugin.hello_world" in command_menu_map
+    assert "my-plugin.another_command" in command_menu_map
+
+    # commands point to correct menus
+    assert len(cmd_menu := command_menu_map["my-plugin.hello_world"]) == 1
+    assert "/napari/layer_context" in cmd_menu
+    assert len(cmd_menu := command_menu_map["my-plugin.another_command"]) == 1
+    assert "mysubmenu" in cmd_menu
+
+    # enable/disable
+    pm.disable(SAMPLE_PLUGIN_NAME)
+    assert SAMPLE_PLUGIN_NAME not in pm._command_menu_map
+    pm.enable(SAMPLE_PLUGIN_NAME)
+    assert SAMPLE_PLUGIN_NAME in pm._command_menu_map
+
+    # register/unregister
+    pm.unregister(SAMPLE_PLUGIN_NAME)
+    assert SAMPLE_PLUGIN_NAME not in pm._command_menu_map
+    pm.register(SAMPLE_PLUGIN_NAME)
+    assert SAMPLE_PLUGIN_NAME in pm._command_menu_map