Show origin of subcommands (#19)

Author: ryanking13

.github/workflows/main.yml

@@ -20,8 +20,7 @@ jobs:
       - name: Install
         shell: bash -l {0}
         run: |
-          python -m pip install -e .
-          python -m pip install pytest
+          python -m pip install -e ".[test]"
       - name: Test
         shell: bash -l {0}
         run: |

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.2.2] - unreleased
+### Changed
+ - `pyodide --help` will now group subcommands by their package name.
+   ([#19](https://github.com/pyodide/pyodide-cli/pull/19))
+
 ## [0.2.1] - 2022-12-20
 ### Added
  - Define `pyodide_cli.app.typer_click_object` when `pyodide_cli` is imported from within sphinx,

pyodide_cli/app.py

@@ -1,4 +1,6 @@
 import sys
+from importlib.metadata import EntryPoint
+from importlib.metadata import distribution as importlib_distribution
 from importlib.metadata import entry_points
 
 import typer  # type: ignore[import]
@@ -29,16 +31,29 @@ def callback(
     pass
 
 
+def entrypoint_to_pkgname(entrypoint: EntryPoint) -> str:
+    """Find package name from entrypoint"""
+
+    top_level = entrypoint.value.split(".")[0]
+    dist = importlib_distribution(top_level)
+    return dist.metadata["name"]
+
+
 def register_plugins():
     """Register subcommands via the ``pyodide.cli`` entry-point"""
     eps = entry_points(group="pyodide.cli")
-    plugins = {ep.name: ep.load() for ep in eps}
-    for plugin_name, module in plugins.items():
+    plugins = {ep.name: (ep.load(), ep) for ep in eps}
+    for plugin_name, (module, ep) in plugins.items():
+        pkgname = entrypoint_to_pkgname(ep)
         if isinstance(module, typer.Typer):
-            app.add_typer(module, name=plugin_name)
+            app.add_typer(
+                module, name=plugin_name, rich_help_panel=f"Registered by: {pkgname}"
+            )
         elif callable(module):
             typer_kwargs = getattr(module, "typer_kwargs", {})
-            app.command(plugin_name, **typer_kwargs)(module)
+            app.command(
+                plugin_name, rich_help_panel=f"Registered by: {pkgname}", **typer_kwargs
+            )(module)
         else:
             raise RuntimeError(f"Invalid plugin: {plugin_name}")
 

pyodide_cli/tests/plugin-test/plugin_test/main.py

@@ -0,0 +1,2 @@
+def main():
+    pass

pyodide_cli/tests/plugin-test/pyproject.toml

@@ -0,0 +1,11 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "plugin-test"
+version = "1.0.0"
+authors = []
+
+[project.entry-points."pyodide.cli"]
+plugin_test = "plugin_test.main:main"

pyodide_cli/tests/test_cli.py

@@ -1,6 +1,22 @@
+import pathlib
+import subprocess
 from multiprocessing import Process, Queue
 from subprocess import check_output
 
+import pytest
+
+
+@pytest.fixture(scope="module")
+def plugins():
+
+    test_plugin = pathlib.Path(__file__).parent / "plugin-test"
+
+    subprocess.run(["pip", "install", str(test_plugin)])
+
+    yield
+
+    subprocess.run(["pip", "uninstall", "-y", test_plugin.name])
+
 
 def test_cli_help():
     output = check_output(["pyodide", "--help"]).decode("utf-8")
@@ -33,3 +49,11 @@ def func(q: Queue, with_sphinx=False):
     p.join()
     app_dir = q.get()
     assert "typer_click_object" in app_dir
+
+
+def test_plugin_origin(plugins):
+
+    output = check_output(["pyodide", "--help"]).decode("utf-8")
+    msg = "Registered by: plugin-test"
+
+    assert msg in output

setup.cfg

@@ -24,6 +24,10 @@ install_requires =
     typer[all]
     rich
 
+[options.extras_require]
+test =
+    pytest
+
 [options.entry_points]
 console_scripts =
     pyodide = pyodide_cli.__main__:main