Implement conflict resolution

stephenfin · stephenfin · commit a2da89a8a2d6 · 2025-11-21T11:34:18.000Z
Change-Id: I9ee1e73ca7858457cd0e3343b0d191c967ad9d09
Signed-off-by: Stephen Finucane &lt;sfinucan@redhat.com&gt;
diff --git a/cliff/commandmanager.py b/cliff/commandmanager.py
@@ -18,6 +18,7 @@
 from typing import TypeAlias
 
 import stevedore
+from stevedore import extension
 
 from cliff import command
 
@@ -64,15 +65,24 @@ class CommandManager:
         plugins to be loaded. For example, ``'cliff.formatter.list'``.
     :param convert_underscores: Whether cliff should convert underscores to
         spaces in entry_point commands.
+    :param conflict_resolver: The conflict resolver to use in the event that
+        there are multiple plugins sharing the same namespace and name.
     """
 
     def __init__(
-        self, namespace: str, convert_underscores: bool = True
+        self,
+        namespace: str,
+        convert_underscores: bool = True,
+        *,
+        conflict_resolver: extension.ConflictResolverT[command.Command] = (
+            extension.ignore_conflicts
+        ),
     ) -> None:
         self.commands: dict[str, EntryPointT] = {}
         self._legacy: dict[str, str] = {}
         self.namespace = namespace
         self.convert_underscores = convert_underscores
+        self.conflict_resolver = conflict_resolver
         self.group_list: list[str] = []
         self._load_commands()
 
@@ -82,10 +92,16 @@ def _load_commands(self) -> None:
             self.load_commands(self.namespace)
 
     def load_commands(self, namespace: str) -> None:
-        """Load all the commands from an entrypoint"""
+        """Load all the commands from an entrypoint
+
+        :param namespace: The namespace to load commands from.
+        :returns: None
+        """
         self.group_list.append(namespace)
         em: stevedore.ExtensionManager[command.Command]
-        em = stevedore.ExtensionManager(namespace)
+        em = stevedore.ExtensionManager(
+            namespace, conflict_resolver=self.conflict_resolver
+        )
         for ep in em:
             LOG.debug('found command %r', ep.name)
             cmd_name = (
@@ -171,7 +187,9 @@ def get_command_names(self, group: str | None = None) -> list[str]:
         group_list: list[str] = []
         if group is not None:
             em: stevedore.ExtensionManager[command.Command]
-            em = stevedore.ExtensionManager(group)
+            em = stevedore.ExtensionManager(
+                group, conflict_resolver=self.conflict_resolver
+            )
             for ep in em:
                 cmd_name = (
                     ep.name.replace('_', ' ')
diff --git a/cliff/tests/test_commandmanager.py b/cliff/tests/test_commandmanager.py
@@ -120,7 +120,9 @@ def test_load_commands(self):
             'stevedore.ExtensionManager', mock_get_group_all
         ) as mock_manager:
             mgr = commandmanager.CommandManager('test')
-            mock_manager.assert_called_once_with('test')
+            mock_manager.assert_called_once_with(
+                'test', conflict_resolver=mock.ANY
+            )
             names = [n for n, v in mgr]
             self.assertEqual(['test'], names)
 
@@ -135,7 +137,9 @@ def test_load_commands_keep_underscores(self):
                 'test',
                 convert_underscores=False,
             )
-            mock_manager.assert_called_once_with('test')
+            mock_manager.assert_called_once_with(
+                'test', conflict_resolver=mock.ANY
+            )
             names = [n for n, v in mgr]
             self.assertEqual(['test_cmd'], names)
 
@@ -150,7 +154,9 @@ def test_load_commands_replace_underscores(self):
                 'test',
                 convert_underscores=True,
             )
-            mock_manager.assert_called_once_with('test')
+            mock_manager.assert_called_once_with(
+                'test', conflict_resolver=mock.ANY
+            )
             names = [n for n, v in mgr]
             self.assertEqual(['test cmd'], names)
 
@@ -344,6 +350,8 @@ def test_get_command_names(self):
             mock_get_group_all,
         ) as mock_manager:
             mgr = commandmanager.CommandManager('test')
-            mock_manager.assert_called_once_with('test')
+            mock_manager.assert_called_once_with(
+                'test', conflict_resolver=mock.ANY
+            )
             cmds = mgr.get_command_names('test')
             self.assertEqual(['one', 'cmd two'], cmds)
