Add informations on cli output about module

If the operation or fact is not found, it will display the ones
available, and if no one is avaible, Warn the user about the possibility
that he have a py file or a folder with the same name as the module

Author: maisim

pyinfra_cli/util.py

@@ -15,6 +15,7 @@
 import gevent
 
 from pyinfra import logger, state
+from pyinfra.api import FactBase
 from pyinfra.api.command import PyinfraCommand
 from pyinfra.api.exceptions import PyinfraError
 from pyinfra.api.host import HostData
@@ -153,6 +154,34 @@ def parse_cli_arg(arg):
     return arg
 
 
+def get_module_available_items(module: ModuleType) -> dict[str, list[str]]:
+    """
+    Lists operations and facts available in a module.
+
+    Args:
+        module (ModuleType): The module to inspect.
+
+    Returns:
+        dict: A dictionary with keys 'operations' and 'facts', each containing a list of names.
+    """
+    available_items: dict[str, list[str]] = {
+        "operations": [],
+        "facts": [],
+    }
+
+    for name, obj in module.__dict__.items():
+        if (
+            isinstance(obj, type)
+            and any([issubclass(obj, OperationMeta), issubclass(obj, FactBase)])
+            and obj.__module__ == module.__name__
+        ):
+            available_items["operations" if issubclass(obj, OperationMeta) else "facts"].append(
+                name
+            )
+
+    return available_items
+
+
 def try_import_module_attribute(path, prefix=None, raise_for_none=True):
     if ":" in path:
         # Allow a.module.name:function syntax
@@ -189,7 +218,38 @@ def try_import_module_attribute(path, prefix=None, raise_for_none=True):
     attr = getattr(module, attr_name, None)
     if attr is None:
         if raise_for_none:
-            raise CliError(f"No such attribute in module {possible_modules[0]}: {attr_name}")
+            extra_info = []
+            module_name = getattr(module, "__name__", str(module))
+
+            if prefix == "pyinfra.operations":
+                # List classes of type OperationMeta
+                available_operations = get_module_available_items(module)["operations"]
+                if available_operations:
+                    extra_info.append(
+                        f"Available operations in module are: {', '.join(available_operations)}"
+                    )
+                else:
+                    extra_info.append(
+                        "No operations found. Maybe you have a file or folder named "
+                        f"`{str(module_name)}` in the current folder ?"
+                    )
+
+            elif prefix == "pyinfra.facts":
+                # List classes of type FactBase
+                available_facts = get_module_available_items(module)["facts"]
+                if available_facts:
+                    extra_info.append(
+                        f"Available facts in module are: {', '.join(available_facts)}"
+                    )
+                else:
+                    extra_info.append(
+                        "No facts found. Maybe you have a file or folder named "
+                        f"`{str(module_name)}` in the current folder ?"
+                    )
+
+            message = [f"No such attribute in module {possible_modules[0]}: {attr_name}"]
+
+            raise CliError("\n".join(message + extra_info))
         return
 
     return attr

tests/test_cli/test_cli_exceptions.py

@@ -44,7 +44,13 @@ def test_no_fact_module(self):
     def test_no_fact_cls(self):
         self.assert_cli_exception(
             ["my-server.net", "fact", "server.NotAFact"],
-            "No such attribute in module server: NotAFact",
+            (
+                "No such attribute in module server: NotAFact\n"
+                "Available facts in module are: User, Home, Path, TmpDir, Hostname, Kernel, "
+                "KernelVersion, Os, OsVersion, Arch, Command, Which, Date, MacosVersion, Mounts, "
+                "KernelModules, LsbRelease, OsRelease, Sysctl, Groups, Users, LinuxDistribution, "
+                "Selinux, LinuxGui, Locales, SecurityLimits"
+            ),
         )
 
 

tests/test_cli/test_cli_util.py

@@ -36,7 +36,11 @@ def test_setup_no_op(self):
         with self.assertRaises(CliError) as context:
             get_func_and_args(("server.no",))
 
-        assert context.exception.message == "No such attribute in module server: no"
+        assert context.exception.message == (
+            "No such attribute in module server: no\n"
+            "No operations found. Maybe you have a file or folder named "
+            "`pyinfra.operations.server` in the current folder ?"
+        )
 
     def test_setup_op_and_args(self):
         commands = ("pyinfra.operations.server.user", "one", "two", "hello=world")