Fixed error in categorize() which would not handle a bound method in an Iterable.

Author: kmvanbrunt

cmd2/utils.py

@@ -694,7 +694,7 @@ def categorize(func: Callable[..., Any] | Iterable[Callable[..., Any]], category
     The help command output will group the passed function under the
     specified category heading
 
-    :param func: function or list of functions to categorize
+    :param func: function or Iterable of functions to categorize
     :param category: category to put it in
 
     Example:
@@ -710,13 +710,13 @@ def do_echo(self, arglist):
     For an alternative approach to categorizing commands using a decorator, see [cmd2.decorators.with_category][]
 
     """
-    if isinstance(func, Iterable):
-        for item in func:
-            setattr(item, constants.COMMAND_ATTR_HELP_CATEGORY, category)
-    elif inspect.ismethod(func):
-        setattr(func.__func__, constants.COMMAND_ATTR_HELP_CATEGORY, category)
-    else:
-        setattr(func, constants.COMMAND_ATTR_HELP_CATEGORY, category)
+    funcs = func if isinstance(func, Iterable) else (func,)
+
+    for cur_func in funcs:
+        if inspect.ismethod(cur_func):
+            setattr(cur_func.__func__, constants.COMMAND_ATTR_HELP_CATEGORY, category)
+        else:
+            setattr(cur_func, constants.COMMAND_ATTR_HELP_CATEGORY, category)
 
 
 def get_defining_class(meth: Callable[..., Any]) -> type[Any] | None:

tests/test_utils.py

@@ -411,22 +411,24 @@ def func1() -> None:
     cu.categorize(func1, category)
     assert getattr(func1, attr_name) == category
 
-    # Test iterable of functions
-    def func2() -> None:
-        pass
+    # Test single method
+    class Foo:
+        def foo_method(self) -> None:
+            pass
 
-    def func3() -> None:
-        pass
+    f = Foo()
+    cu.categorize(f.foo_method, category)
+    assert getattr(Foo.foo_method, attr_name) == category
 
-    cu.categorize([func2, func3], category)
-    assert getattr(func2, attr_name) == category
-    assert getattr(func3, attr_name) == category
+    # Test iterable
+    def func2() -> None:
+        pass
 
-    # Test bound method
-    class Foo:
-        def bar(self) -> None:
+    class Bar:
+        def bar_method(self) -> None:
             pass
 
-    f = Foo()
-    cu.categorize(f.bar, category)
-    assert getattr(Foo.bar, attr_name) == category
+    b = Bar()
+    cu.categorize([func2, b.bar_method], category)
+    assert getattr(func2, attr_name) == category
+    assert getattr(Bar.bar_method, attr_name) == category