[IMP] list_depends: allow to sort topologically

Using https://docs.python.org/3/library/graphlib.html

docs/cli.md

@@ -134,6 +134,7 @@ $ manifestoo list-depends [OPTIONS]
 * `--include-selected`: Print the selected addons along with their dependencies.
 * `--ignore-missing`: Do not fail if dependencies are not found in addons path. This only applies to top level (selected) addons and transitive dependencies.
 * `--as-pip-requirements`
+* `--sorting [alphabetical|topological]`: Sorting order for dependencies, by default: alphabetical. Topological sorting is useful when seeking a migration order.
 * `--help`: Show this message and exit.
 
 ## `manifestoo list-external-dependencies`

src/manifestoo/addon_sorter.py

@@ -0,0 +1,44 @@
+from typing import Dict, Iterable, Set
+
+import typer
+from graphlib import TopologicalSorter
+
+from manifestoo_core.addons_set import AddonsSet
+
+from . import echo
+
+
+class AddonSorter:
+    @staticmethod
+    def from_name(name: str) -> "AddonSorter":
+        if name == "alphabetical":
+            return AddonSorterAlphabetical()
+        elif name == "topological":
+            return AddonSorterTopological()
+        else:
+            echo.error(f"Unknown sorter {name}", err=False)
+            raise typer.Exit(1)
+
+    def sort(
+        self, addons_selection: Iterable[str], addon_set: AddonsSet
+    ) -> Iterable[str]:
+        return addons_selection
+
+
+class AddonSorterAlphabetical(AddonSorter):
+    def sort(
+        self, addons_selection: Iterable[str], addon_set: AddonsSet
+    ) -> Iterable[str]:
+        return sorted(addons_selection)
+
+
+class AddonSorterTopological(AddonSorter):
+    def sort(
+        self, addons_selection: Iterable[str], addon_set: AddonsSet
+    ) -> Iterable[str]:
+        result_dict: Dict[str, Set[str]] = {}
+        for addon_name in addons_selection:
+            addon = addon_set.get(addon_name)
+            result_dict[addon_name] = set(addon.manifest.depends) if addon else set()
+        topological_sorted_res = TopologicalSorter(result_dict)
+        return list(topological_sorted_res.static_order())

src/manifestoo/commands/list_depends.py

@@ -1,7 +1,8 @@
-from typing import Iterable, Set, Tuple
+from typing import Iterable, Optional, Set, Tuple
 
 from manifestoo_core.addons_set import AddonsSet
 
+from ..addon_sorter import AddonSorter, AddonSorterAlphabetical
 from ..addons_selection import AddonsSelection
 from ..dependency_iterator import dependency_iterator
 
@@ -11,7 +12,10 @@ def list_depends_command(
     addons_set: AddonsSet,
     transitive: bool = False,
     include_selected: bool = False,
+    addon_sorter: Optional[AddonSorter] = None,
 ) -> Tuple[Iterable[str], Iterable[str]]:
+    if not addon_sorter:
+        addon_sorter = AddonSorterAlphabetical()
     result: Set[str] = set()
     missing: Set[str] = set()
     for addon_name, addon in dependency_iterator(
@@ -23,4 +27,4 @@ def list_depends_command(
             missing.add(addon_name)
         else:
             result.update(set(addon.manifest.depends) - set(addons_selection))
-    return sorted(result), missing
+    return addon_sorter.sort(result, addons_set), missing

src/manifestoo/main.py

@@ -7,6 +7,7 @@
 from manifestoo_core.odoo_series import OdooSeries, detect_from_addons_set
 
 from . import echo
+from .addon_sorter import AddonSorter
 from .commands.check_dev_status import check_dev_status_command
 from .commands.check_licenses import check_licenses_command
 from .commands.interactive_tree import interactive_tree_command
@@ -266,16 +267,28 @@ def list_depends(
         "--as-pip-requirements",
         show_default=False,
     ),
+    sorting: str = typer.Option(
+        "alphabetical",
+        "--sorting",
+        "--sort",
+        help=(
+            "Choice between 'alphabetical' and 'topological'."
+            "Topological sorting is useful when seeking a migration order."
+        ),
+        show_default=True,
+    ),
 ) -> None:
     """Print the dependencies of selected addons."""
     main_options: MainOptions = ctx.obj
     if as_pip_requirements:
         not_implemented("--as-pip-requirement")
+    addon_sorter = AddonSorter.from_name(sorting)
     result, missing = list_depends_command(
         main_options.addons_selection,
         main_options.addons_set,
         transitive,
         include_selected,
+        addon_sorter,
     )
     if missing and not ignore_missing:
         echo.error("not found in addons path: " + ",".join(sorted(missing)))