Implement level trait for plugin/extension managers (jupyterlab#15512)

This matches the `level` CLI option for `labextension` command.

Also do not collect tests from `.ipynb_checkpoints`.

docs/source/user/extensions.rst

@@ -377,6 +377,13 @@ running the ``jupyter labextension enable`` or ``jupyter labextension disable``
    :class: jp-screenshot
    :alt: An example search result in the plugin extension listing.
 
+
+Plugins can be enabled/disabled on ``system``, ``sys-prefix`` (default) or
+``user`` level, which influences where the ``page_config.json`` configuration
+file is written to (see ``config` section in results of ``jupyter --paths``).
+To change the level for the plugin manager and the default extension manager
+use ``PluginManager.level`` trait (extension manager inherits from plugin manager).
+
 .. _locking_plugins:
 
 Locking and Unlocking Plugins

jupyterlab/extensions/manager.py

@@ -11,6 +11,7 @@
 
 import tornado
 from jupyterlab_server.translation_utils import translator
+from traitlets import Enum
 from traitlets.config import Configurable, LoggingConfigurable
 
 from jupyterlab.commands import (
@@ -192,13 +193,22 @@ class PluginManager(LoggingConfigurable):
         options: Plugin manager options
     """
 
+    level = Enum(
+        values=["sys_prefix", "user", "system"],
+        default_value="sys_prefix",
+        help="Level at which to manage plugins: sys_prefix, user, system",
+    ).tag(config=True)
+
     def __init__(
         self,
         app_options: Optional[dict] = None,
         ext_options: Optional[dict] = None,
         parent: Optional[Configurable] = None,
     ) -> None:
         super().__init__(parent=parent)
+        self.log.debug(
+            "Plugins in %s will managed on the %s level", self.__class__.__name__, self.level
+        )
         self.app_options = _ensure_options(app_options)
         plugin_options_field = {f.name for f in fields(PluginManagerOptions)}
         plugin_options = {
@@ -255,7 +265,7 @@ async def disable(self, plugins: Union[str, List[str]]) -> ActionResult:
             )
         try:
             for plugin in plugins:
-                disable_extension(plugin, app_options=self.app_options)
+                disable_extension(plugin, app_options=self.app_options, level=self.level)
             return ActionResult(status="ok", needs_restart=["frontend"])
         except Exception as err:
             return ActionResult(status="error", message=repr(err))
@@ -281,7 +291,7 @@ async def enable(self, plugins: Union[str, List[str]]) -> ActionResult:
             )
         try:
             for plugin in plugins:
-                enable_extension(plugin, app_options=self.app_options)
+                enable_extension(plugin, app_options=self.app_options, level=self.level)
             return ActionResult(status="ok", needs_restart=["frontend"])
         except Exception as err:
             return ActionResult(status="error", message=repr(err))

jupyterlab/labapp.py

@@ -867,6 +867,7 @@ def initialize_handlers(self):  # noqa
                                 "lock_rules": lock_rules,
                                 "all_locked": self.lock_all_plugins,
                             },
+                            parent=self,
                         )
                     },
                 )

jupyterlab/tests/test_extensions.py

@@ -8,7 +8,7 @@
 from traitlets.config import Config, Configurable
 
 from jupyterlab.extensions import PyPIExtensionManager, ReadOnlyExtensionManager
-from jupyterlab.extensions.manager import ExtensionManager, ExtensionPackage
+from jupyterlab.extensions.manager import ExtensionManager, ExtensionPackage, PluginManager
 
 from . import fake_client_factory
 
@@ -340,3 +340,32 @@ async def test_PyPiExtensionManager_custom_server_url():
     manager = PyPIExtensionManager(parent=parent)
 
     assert manager.base_url == BASE_URL
+
+
+LEVELS = ["user", "sys_prefix", "system"]
+
+
+@pytest.mark.parametrize("level", LEVELS)
+async def test_PyPiExtensionManager_custom_level(level):
+    parent = Configurable(config=Config({"PyPIExtensionManager": {"level": level}}))
+    manager = PyPIExtensionManager(parent=parent)
+    assert manager.level == level
+
+
+@pytest.mark.parametrize("level", LEVELS)
+async def test_PyPiExtensionManager_inherits_custom_level(level):
+    parent = Configurable(config=Config({"PluginManager": {"level": level}}))
+    manager = PyPIExtensionManager(parent=parent)
+    assert manager.level == level
+
+
+@pytest.mark.parametrize("level", LEVELS)
+async def test_PluginManager_custom_level(level):
+    parent = Configurable(config=Config({"PluginManager": {"level": level}}))
+    manager = PluginManager(parent=parent)
+    assert manager.level == level
+
+
+async def test_PluginManager_default_level():
+    manager = PluginManager()
+    assert manager.level == "sys_prefix"

pyproject.toml

@@ -213,7 +213,7 @@ npm = ["node", "yarn.js"]
 
 [tool.pytest.ini_options]
 testpaths = "jupyterlab/tests"
-norecursedirs = "node_modules .git _build"
+norecursedirs = "node_modules .git _build .ipynb_checkpoints"
 addopts = "--pdbcls=IPython.terminal.debugger:Pdb -v --junitxml=junit.xml"
 ignore = "tests examples"