Merge pull request #895 from python-cmd2/relocate_functions

Moved categorize() to utils.py and made set_parser_prog() non-public

1 files changed, 15 insertions, 0 deletions

diff --git a/cmd2/utils.py b/cmd2/utils.py
index 6a67c43f..971a22ce 100644
--- a/cmd2/utils.py
+++ b/cmd2/utils.py
@@ -964,3 +964,18 @@ def get_styles_in_text(text: str) -> Dict[int, str]:
         start += len(match.group())
 
     return styles
+
+
+def categorize(func: Union[Callable, Iterable[Callable]], category: str) -> None:
+    """Categorize a function.
+
+    The help command output will group this function under the specified category heading
+
+    :param func: function or list of functions to categorize
+    :param category: category to put it in
+    """
+    if isinstance(func, Iterable):
+        for item in func:
+            setattr(item, constants.CMD_ATTR_HELP_CATEGORY, category)
+    else:
+        setattr(func, constants.CMD_ATTR_HELP_CATEGORY, category)