Made __name__ a read-only propery for BoundCommandFunc and UnboundCommandFunc Protocol classes

Also:
- Switched some types in cmd2.py from `Callable[..., Any]` to `BoundCommandFunc`
- Removed a number of `cast` calls in cmd2.py which were no longer needed

Author: tleonhardt

cmd2/cmd2.py

@@ -919,7 +919,7 @@ def register_command_set(self, cmdset: CommandSet[Any]) -> None:
 
         cmdset.on_register(self)
         methods = cast(
-            list[tuple[str, Callable[..., Any]]],
+            list[tuple[str, BoundCommandFunc]],
             inspect.getmembers(
                 cmdset,
                 predicate=lambda meth: (  # type: ignore[arg-type]
@@ -935,7 +935,7 @@ def register_command_set(self, cmdset: CommandSet[Any]) -> None:
             for cmd_func_name, command_method in methods:
                 command = cmd_func_name[len(COMMAND_FUNC_PREFIX) :]
 
-                self._install_command_function(cmd_func_name, cast(BoundCommandFunc, command_method), type(cmdset).__name__)
+                self._install_command_function(cmd_func_name, command_method, type(cmdset).__name__)
                 installed_attributes.append(cmd_func_name)
 
                 completer_func_name = COMPLETER_FUNC_PREFIX + command
@@ -953,7 +953,7 @@ def register_command_set(self, cmdset: CommandSet[Any]) -> None:
                 self._cmd_to_command_sets[command] = cmdset
 
                 # If this command is in a disabled category, then disable it
-                command_category = self._get_command_category(cast(BoundCommandFunc, command_method))
+                command_category = self._get_command_category(command_method)
                 if command_category in self.disabled_categories:
                     message_to_print = self.disabled_categories[command_category]
                     self.disable_command(command, message_to_print)
@@ -1086,17 +1086,19 @@ def unregister_command_set(self, cmdset: CommandSet[Any]) -> None:
             cmdset.on_unregister()
             self._unregister_subcommands(cmdset)
 
-            methods: list[tuple[str, Callable[..., Any]]] = inspect.getmembers(
-                cmdset,
-                predicate=lambda meth: (  # type: ignore[arg-type]
-                    isinstance(meth, Callable)  # type: ignore[arg-type]
-                    and hasattr(meth, "__name__")
-                    and meth.__name__.startswith(COMMAND_FUNC_PREFIX)
+            methods: list[tuple[str, BoundCommandFunc]] = cast(
+                list[tuple[str, BoundCommandFunc]],
+                inspect.getmembers(
+                    cmdset,
+                    predicate=lambda meth: (  # type: ignore[arg-type]
+                        isinstance(meth, Callable)  # type: ignore[arg-type]
+                        and hasattr(meth, "__name__")
+                        and meth.__name__.startswith(COMMAND_FUNC_PREFIX)
+                    ),
                 ),
             )
 
-            for cmd_func_name, command_method_raw in methods:
-                command_method = cast(BoundCommandFunc, command_method_raw)
+            for cmd_func_name, command_method in methods:
                 command = cmd_func_name[len(COMMAND_FUNC_PREFIX) :]
 
                 # Enable the command before uninstalling it to make sure we remove both
@@ -1159,17 +1161,19 @@ def check_parser_uninstallable(parser: Cmd2ArgumentParser) -> None:
                     )
                 check_parser_uninstallable(subparser)
 
-        methods: list[tuple[str, Callable[..., Any]]] = inspect.getmembers(
-            cmdset,
-            predicate=lambda meth: (  # type: ignore[arg-type]
-                isinstance(meth, Callable)  # type: ignore[arg-type]
-                and hasattr(meth, "__name__")
-                and meth.__name__.startswith(COMMAND_FUNC_PREFIX)
+        methods: list[tuple[str, BoundCommandFunc]] = cast(
+            list[tuple[str, BoundCommandFunc]],
+            inspect.getmembers(
+                cmdset,
+                predicate=lambda meth: (  # type: ignore[arg-type]
+                    isinstance(meth, Callable)  # type: ignore[arg-type]
+                    and hasattr(meth, "__name__")
+                    and meth.__name__.startswith(COMMAND_FUNC_PREFIX)
+                ),
             ),
         )
 
-        for cmd_func_name, command_method_raw in methods:
-            command_method = cast(BoundCommandFunc, command_method_raw)
+        for cmd_func_name, command_method in methods:
             # We only need to check if it's safe to remove the parser if this
             # is the actual command since command synonyms don't own it.
             if cmd_func_name == command_method.__name__:
@@ -2829,9 +2833,10 @@ def _get_commands_aliases_and_macros_choices(self) -> Choices:
 
         # Add commands
         for command in self.get_visible_commands():
-            command_func = cast(BoundCommandFunc, self.get_command_func(command))
-            description = strip_doc_annotations(command_func.__doc__).splitlines()[0] if command_func.__doc__ else ""
-            items.append(CompletionItem(command, display_meta=description))
+            command_func = self.get_command_func(command)
+            if command_func is not None:
+                description = strip_doc_annotations(command_func.__doc__).splitlines()[0] if command_func.__doc__ else ""
+                items.append(CompletionItem(command, display_meta=description))
 
         # Add aliases
         for name, value in self.aliases.items():
@@ -4347,9 +4352,10 @@ def _build_command_info(self) -> tuple[dict[str, list[str]], list[str]]:
                 help_topics.remove(command)
 
             # Store the command within its category
-            command_func = cast(BoundCommandFunc, self.get_command_func(command))
-            category = self._get_command_category(command_func)
-            cmds_cats.setdefault(category, []).append(command)
+            command_func = self.get_command_func(command)
+            if command_func is not None:
+                category = self._get_command_category(command_func)
+                cmds_cats.setdefault(category, []).append(command)
 
         return cmds_cats, help_topics
 
@@ -5816,8 +5822,8 @@ def disable_category(self, category: str, message_to_print: str) -> None:
         all_commands = self.get_all_commands()
 
         for command in all_commands:
-            command_func = cast(BoundCommandFunc, self.get_command_func(command))
-            if self._get_command_category(command_func) == category:
+            command_func = self.get_command_func(command)
+            if command_func is not None and self._get_command_category(command_func) == category:
                 self.disable_command(command, message_to_print)
 
         self.disabled_categories[category] = message_to_print

cmd2/types.py

@@ -72,9 +72,13 @@
 class BoundCommandFunc(Protocol):
     """Protocol for a command function bound to a command instance."""
 
-    __name__: str
     __qualname__: str
 
+    @property
+    def __name__(self) -> str:
+        """The name of the bound command function."""
+        ...
+
     def __call__(self, *args: Any, **kwargs: Any) -> bool | None:
         """Invoke the bound command function."""
 
@@ -84,9 +88,13 @@ def __call__(self, *args: Any, **kwargs: Any) -> bool | None:
 class UnboundCommandFunc(Protocol[CmdOrSetT, P]):
     """Protocol for an unbound command function."""
 
-    __name__: str
     __qualname__: str
 
+    @property
+    def __name__(self) -> str:
+        """The name of the unbound command function."""
+        ...
+
     def __call__(self, __self: CmdOrSetT, /, *args: P.args, **kwargs: P.kwargs) -> bool | None:
         """Invoke the unbound command function with its command instance."""
         ...

tests/test_cmd2.py

@@ -38,7 +38,6 @@
 )
 from cmd2 import rich_utils as ru
 from cmd2 import string_utils as su
-from cmd2.types import BoundCommandFunc
 
 from .conftest import (
     SHORTCUTS_TXT,
@@ -4178,7 +4177,8 @@ def test_help_disabled_no_help_func(base_app: cmd2.Cmd) -> None:
 
     # Intentionally bypass disable_command() to test the fallback in do_help()
     command = "quit"
-    command_func = cast(BoundCommandFunc, base_app.get_command_func(command))
+    command_func = base_app.get_command_func(command)
+    assert command_func is not None
     base_app.disabled_commands[command] = DisabledCommand(command_func=command_func, help_func=None, completer_func=None)
 
     _out, err = run_cmd(base_app, f"help {command}")