cmd2 3.1.1__py3-none-any.whl → 3.1.3__py3-none-any.whl

cmd2/argparse_completer.py

@@ -539,7 +539,7 @@ class ArgparseCompleter:
         # Check if there are too many CompletionItems to display as a table
         if len(completions) <= self._cmd2_app.max_completion_items:
             # If a metavar was defined, use that instead of the dest field
-            destination = arg_state.action.metavar if arg_state.action.metavar else arg_state.action.dest
+            destination = arg_state.action.metavar or arg_state.action.dest
 
             # Handle case where metavar was a tuple
             if isinstance(destination, tuple):
@@ -587,7 +587,7 @@ class ArgparseCompleter:
             # Generate the hint table string
             console = Cmd2GeneralConsole()
             with console.capture() as capture:
-                console.print(hint_table, end="")
+                console.print(hint_table, end="", soft_wrap=False)
             self._cmd2_app.formatted_completions = capture.get()
 
         # Return sorted list of completions

cmd2/argparse_custom.py

@@ -290,7 +290,12 @@ from rich_argparse import (
     RawTextRichHelpFormatter,
     RichHelpFormatter,
 )
-from typing_extensions import Self
+
+if sys.version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
+
 
 from . import constants
 from . import rich_utils as ru
@@ -1472,7 +1477,7 @@ class Cmd2ArgumentParser(argparse.ArgumentParser):
             usage=usage,
             description=description,  # type: ignore[arg-type]
             epilog=epilog,  # type: ignore[arg-type]
-            parents=parents if parents else [],
+            parents=parents or [],
             formatter_class=formatter_class,
             prefix_chars=prefix_chars,
             fromfile_prefix_chars=fromfile_prefix_chars,

cmd2/cmd2.py

@@ -593,11 +593,14 @@ class Cmd:
         # being printed by a command.
         self.terminal_lock = threading.RLock()
 
-        # Commands that have been disabled from use. This is to support commands that are only available
-        # during specific states of the application. This dictionary's keys are the command names and its
-        # values are DisabledCommand objects.
+        # Commands disabled during specific application states
+        # Key: Command name | Value: DisabledCommand object
         self.disabled_commands: dict[str, DisabledCommand] = {}
 
+        # Categories of commands to be disabled
+        # Key: Category name | Value: Message to display
+        self.disabled_categories: dict[str, str] = {}
+
         # The default key for sorting string results. Its default value performs a case-insensitive alphabetical sort.
         # If natural sorting is preferred, then set this to NATURAL_SORT_KEY.
         # cmd2 uses this key for sorting:
@@ -755,9 +758,11 @@ class Cmd:
             list[tuple[str, Callable[..., Any]]],
             inspect.getmembers(
                 cmdset,
-                predicate=lambda meth: isinstance(meth, Callable)  # type: ignore[arg-type]
-                and hasattr(meth, '__name__')
-                and meth.__name__.startswith(COMMAND_FUNC_PREFIX),
+                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)
+                ),
             ),
         )
 
@@ -788,6 +793,12 @@ class Cmd:
                 if default_category and not hasattr(command_method, constants.CMD_ATTR_HELP_CATEGORY):
                     utils.categorize(command_method, default_category)
 
+                # If this command is in a disabled category, then disable it
+                command_category = getattr(command_method, constants.CMD_ATTR_HELP_CATEGORY, None)
+                if command_category in self.disabled_categories:
+                    message_to_print = self.disabled_categories[command_category]
+                    self.disable_command(command, message_to_print)
+
             self._installed_command_sets.add(cmdset)
 
             self._register_subcommands(cmdset)
@@ -904,9 +915,11 @@ class Cmd:
 
             methods: list[tuple[str, Callable[..., Any]]] = inspect.getmembers(
                 cmdset,
-                predicate=lambda meth: isinstance(meth, Callable)  # type: ignore[arg-type]
-                and hasattr(meth, '__name__')
-                and meth.__name__.startswith(COMMAND_FUNC_PREFIX),
+                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 in methods:
@@ -950,9 +963,11 @@ class Cmd:
 
         methods: list[tuple[str, Callable[..., Any]]] = inspect.getmembers(
             cmdset,
-            predicate=lambda meth: isinstance(meth, Callable)  # type: ignore[arg-type]
-            and hasattr(meth, '__name__')
-            and meth.__name__.startswith(COMMAND_FUNC_PREFIX),
+            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 in methods:
@@ -974,10 +989,12 @@ class Cmd:
         # find methods that have the required attributes necessary to be recognized as a sub-command
         methods = inspect.getmembers(
             cmdset,
-            predicate=lambda meth: isinstance(meth, Callable)  # type: ignore[arg-type]
-            and hasattr(meth, constants.SUBCMD_ATTR_NAME)
-            and hasattr(meth, constants.SUBCMD_ATTR_COMMAND)
-            and hasattr(meth, constants.CMD_ATTR_ARGPARSER),
+            predicate=lambda meth: (
+                isinstance(meth, Callable)  # type: ignore[arg-type]
+                and hasattr(meth, constants.SUBCMD_ATTR_NAME)
+                and hasattr(meth, constants.SUBCMD_ATTR_COMMAND)
+                and hasattr(meth, constants.CMD_ATTR_ARGPARSER)
+            ),
         )
 
         # iterate through all matching methods
@@ -1063,10 +1080,12 @@ class Cmd:
         # find methods that have the required attributes necessary to be recognized as a sub-command
         methods = inspect.getmembers(
             cmdset,
-            predicate=lambda meth: isinstance(meth, Callable)  # type: ignore[arg-type]
-            and hasattr(meth, constants.SUBCMD_ATTR_NAME)
-            and hasattr(meth, constants.SUBCMD_ATTR_COMMAND)
-            and hasattr(meth, constants.CMD_ATTR_ARGPARSER),
+            predicate=lambda meth: (
+                isinstance(meth, Callable)  # type: ignore[arg-type]
+                and hasattr(meth, constants.SUBCMD_ATTR_NAME)
+                and hasattr(meth, constants.SUBCMD_ATTR_COMMAND)
+                and hasattr(meth, constants.CMD_ATTR_ARGPARSER)
+            ),
         )
 
         # iterate through all matching methods
@@ -1250,8 +1269,14 @@ class Cmd:
         :param sep: string to write between printed text. Defaults to " ".
         :param end: string to write at end of printed text. Defaults to a newline.
         :param style: optional style to apply to output
-        :param soft_wrap: Enable soft wrap mode. If True, lines of text will not be
-                          word-wrapped or cropped to fit the terminal width. Defaults to True.
+        :param soft_wrap: Enable soft wrap mode. Defaults to True.
+                          If True, text that doesn't fit will run on to the following line,
+                          just like with print(). This is useful for raw text and logs.
+                          If False, Rich wraps text to fit the terminal width.
+                          Set this to False when printing structured Renderables like
+                          Tables, Panels, or Columns to ensure they render as expected.
+                          For example, when soft_wrap is True Panels truncate text
+                          which is wider than the terminal.
         :param emoji: If True, Rich will replace emoji codes (e.g., :smiley:) with their
                       corresponding Unicode characters. Defaults to False.
         :param markup: If True, Rich will interpret strings with tags (e.g., [bold]hello[/bold])
@@ -1751,31 +1776,45 @@ class Cmd:
         :return: a list of possible tab completions
         """
         matches = self.basic_complete(text, line, begidx, endidx, match_against)
+        if not matches:
+            return []
 
-        # Display only the portion of the match that's being completed based on delimiter
-        if matches:
-            # Set this to True for proper quoting of matches with spaces
-            self.matches_delimited = True
+        # Set this to True for proper quoting of matches with spaces
+        self.matches_delimited = True
 
-            # Get the common beginning for the matches
-            common_prefix = os.path.commonprefix(matches)
-            prefix_tokens = common_prefix.split(delimiter)
+        # Get the common beginning for the matches
+        common_prefix = os.path.commonprefix(matches)
+        prefix_tokens = common_prefix.split(delimiter)
 
-            # Calculate what portion of the match we are completing
-            display_token_index = 0
-            if prefix_tokens:
-                display_token_index = len(prefix_tokens) - 1
+        # Calculate what portion of the match we are completing
+        display_token_index = 0
+        if prefix_tokens:
+            display_token_index = len(prefix_tokens) - 1
 
-            # Get this portion for each match and store them in self.display_matches
-            for cur_match in matches:
-                match_tokens = cur_match.split(delimiter)
-                display_token = match_tokens[display_token_index]
+        # Remove from each match everything after where the user is completing.
+        # This approach can result in duplicates so we will filter those out.
+        unique_results: dict[str, str] = {}
 
-                if not display_token:
-                    display_token = delimiter
-                self.display_matches.append(display_token)
+        for cur_match in matches:
+            match_tokens = cur_match.split(delimiter)
 
-        return matches
+            filtered_match = delimiter.join(match_tokens[: display_token_index + 1])
+            display_match = match_tokens[display_token_index]
+
+            # If there are more tokens, then we aren't done completing a full item
+            if len(match_tokens) > display_token_index + 1:
+                filtered_match += delimiter
+                display_match += delimiter
+                self.allow_appended_space = False
+                self.allow_closing_quote = False
+
+            if filtered_match not in unique_results:
+                unique_results[filtered_match] = display_match
+
+        filtered_matches = list(unique_results.keys())
+        self.display_matches = list(unique_results.values())
+
+        return filtered_matches
 
     def flag_based_complete(
         self,
@@ -2233,7 +2272,7 @@ class Cmd:
             # Otherwise use pyreadline3's formatter
             else:
                 # Check if we should show display_matches
-                matches_to_display = self.display_matches if self.display_matches else matches
+                matches_to_display = self.display_matches or matches
 
                 # Add padding for visual appeal
                 matches_to_display, _ = self._pad_matches_to_display(matches_to_display)
@@ -4236,7 +4275,7 @@ class Cmd:
             header_grid = Table.grid()
             header_grid.add_row(Text(header, style=Cmd2Style.HELP_HEADER))
             header_grid.add_row(Rule(characters=self.ruler, style=Cmd2Style.TABLE_BORDER))
-            self.poutput(header_grid)
+            self.poutput(header_grid, soft_wrap=False)
 
         # Subtract 1 from maxcol to account for a one-space right margin.
         maxcol = min(maxcol, ru.console_width()) - 1
@@ -4304,7 +4343,7 @@ class Cmd:
             topics_table.add_row(command, cmd_desc)
 
         category_grid.add_row(topics_table)
-        self.poutput(category_grid)
+        self.poutput(category_grid, soft_wrap=False)
         self.poutput()
 
     def render_columns(self, str_list: list[str] | None, display_width: int = 80) -> str:
@@ -4601,7 +4640,7 @@ class Cmd:
             self.last_result[param] = settable.value
 
         self.poutput()
-        self.poutput(settable_table)
+        self.poutput(settable_table, soft_wrap=False)
         self.poutput()
 
     @classmethod
@@ -5799,7 +5838,7 @@ class Cmd:
 
         :param command: the command being enabled
         """
-        # If the commands is already enabled, then return
+        # If the command is already enabled, then return
         if command not in self.disabled_commands:
             return
 
@@ -5831,11 +5870,17 @@ class Cmd:
 
         :param category: the category to enable
         """
+        # If the category is already enabled, then return
+        if category not in self.disabled_categories:
+            return
+
         for cmd_name in list(self.disabled_commands):
             func = self.disabled_commands[cmd_name].command_function
             if getattr(func, constants.CMD_ATTR_HELP_CATEGORY, None) == category:
                 self.enable_command(cmd_name)
 
+        del self.disabled_categories[category]
+
     def disable_command(self, command: str, message_to_print: str) -> None:
         """Disable a command and overwrite its functions.
 
@@ -5846,7 +5891,7 @@ class Cmd:
                                  command being disabled.
                                  ex: message_to_print = f"{cmd2.COMMAND_NAME} is currently disabled"
         """
-        # If the commands is already disabled, then return
+        # If the command is already disabled, then return
         if command in self.disabled_commands:
             return
 
@@ -5885,6 +5930,10 @@ class Cmd:
                                  of the command being disabled.
                                  ex: message_to_print = f"{cmd2.COMMAND_NAME} is currently disabled"
         """
+        # If the category is already disabled, then return
+        if category in self.disabled_categories:
+            return
+
         all_commands = self.get_all_commands()
 
         for cmd_name in all_commands:
@@ -5892,6 +5941,8 @@ class Cmd:
             if getattr(func, constants.CMD_ATTR_HELP_CATEGORY, None) == category:
                 self.disable_command(cmd_name, message_to_print)
 
+        self.disabled_categories[category] = message_to_print
+
     def _report_disabled_command_usage(self, *_args: Any, message_to_print: str, **_kwargs: Any) -> None:
         """Report when a disabled command has been run or had help called on it.
 

cmd2/command_definition.py

@@ -63,9 +63,11 @@ def with_default_category(category: str, *, heritable: bool = True) -> Callable[
         # 3. Must be a member of the class being decorated and not one inherited from a parent declaration
         methods = inspect.getmembers(
             cls,
-            predicate=lambda meth: inspect.isfunction(meth)
-            and meth.__name__.startswith(COMMAND_FUNC_PREFIX)
-            and meth in inspect.getmro(cls)[0].__dict__.values(),
+            predicate=lambda meth: (
+                inspect.isfunction(meth)
+                and meth.__name__.startswith(COMMAND_FUNC_PREFIX)
+                and meth in inspect.getmro(cls)[0].__dict__.values()
+            ),
         )
         category_decorator = with_category(category)
         for method in methods:

cmd2/parsing.py

@@ -2,6 +2,7 @@
 
 import re
 import shlex
+import sys
 from collections.abc import Iterable
 from dataclasses import (
     dataclass,
@@ -9,7 +10,10 @@ from dataclasses import (
 )
 from typing import Any
 
-from typing_extensions import Self
+if sys.version_info >= (3, 11):
+    from typing import Self
+else:
+    from typing_extensions import Self
 
 from . import (
     constants,

cmd2/utils.py

@@ -1,7 +1,6 @@
 """Shared utility functions."""
 
 import argparse
-import collections
 import contextlib
 import functools
 import glob
@@ -192,10 +191,7 @@ def remove_duplicates(list_to_prune: list[_T]) -> list[_T]:
     :param list_to_prune: the list being pruned of duplicates
     :return: The pruned list
     """
-    temp_dict: collections.OrderedDict[_T, Any] = collections.OrderedDict()
-    for item in list_to_prune:
-        temp_dict[item] = None
-
+    temp_dict = dict.fromkeys(list_to_prune)
     return list(temp_dict.keys())
 
 

{cmd2-3.1.1.dist-info → cmd2-3.1.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: cmd2
-Version: 3.1.1
+Version: 3.1.3
 Summary: cmd2 - quickly build feature-rich and user-friendly interactive command line applications in Python
 Author: cmd2 Contributors
 License-Expression: MIT
@@ -28,6 +28,7 @@ Requires-Dist: pyperclip>=1.8.2
 Requires-Dist: pyreadline3>=3.4; platform_system == "Windows"
 Requires-Dist: rich>=14.3.0
 Requires-Dist: rich-argparse>=1.7.1
+Requires-Dist: typing-extensions; python_version == "3.10"
 Dynamic: license-file
 
 <h1 align="center">cmd2 : immersive interactive command line applications</h1>

{cmd2-3.1.1.dist-info → cmd2-3.1.3.dist-info}/RECORD

@@ -1,15 +1,15 @@
 cmd2/__init__.py,sha256=JG-jiy2MMArRTujSiU8usvQpdgQbl3KLTim4tU5SCJw,2278
-cmd2/argparse_completer.py,sha256=8hK5_QUnHgeHVY60C89kMKn2b91AUyDjyq4dykzjCRA,35680
-cmd2/argparse_custom.py,sha256=7h68TXurxjDoMsCzoZy1uyy6tvTEEi3RornPQ9ZHJoA,68767
+cmd2/argparse_completer.py,sha256=4ex9-DZI4vjTMEpg9keeWz2ufBqduPAUZlkOxdoasYA,35667
+cmd2/argparse_custom.py,sha256=_qB60hRbuCQTT1QGczulL3Fo1IqyTRlHfO4XeGUp_zY,68826
 cmd2/clipboard.py,sha256=5PSKTe3uDe2pFFEDUEMMwAmzcyPkbXXz14SOQxFFncg,515
-cmd2/cmd2.py,sha256=rHSkJ2RF9QQiYdIktd5DHJYJL-X7swwzyVqM6TMbSZU,272373
+cmd2/cmd2.py,sha256=qW4F3cuNtqRa_tPvIcUejnh9jZqjWbSypHi5RbYDM6U,274471
 cmd2/colors.py,sha256=gLAU8gjhPwZud9MNVk53RGE9ZSdwspLnye_kReeZKjc,7848
-cmd2/command_definition.py,sha256=4FQgivn-9aZegU5tbUl6XsK_G_gZTMfsbGDortz-Ir8,7992
+cmd2/command_definition.py,sha256=HNldq20DH1DArxz19VSn5oGt1xLiOuLoLdb_cu9D8hQ,8032
 cmd2/constants.py,sha256=yDcaeEG4Y2DHmLwUpV-_lEiHkiYUZEuyf9mpDdAzmkg,1773
 cmd2/decorators.py,sha256=_xxagAxlcUROLZowqjW5RYP935uNMEJyr2h8FkWalGw,17356
 cmd2/exceptions.py,sha256=J8Ck0dhusB2cfVksRLkM4WVgBTGQnPdEcU26RfBjjRw,3440
 cmd2/history.py,sha256=QNg5QOe3854hFsu9qw7QlqtnTQvmtXojOWgMZlg6JoQ,14755
-cmd2/parsing.py,sha256=-8TfpXZAZnlLbCJem_EziaC2JqZvmOkIUoera1xmM4Y,28035
+cmd2/parsing.py,sha256=8tXTn5fwzQutqq6LQqBpoC2dYqTrDjbVyJwpy7sWY-k,28116
 cmd2/plugin.py,sha256=_KD44QaHPXncT3qSOWXyzesxKvEbJp5tQeMJ569mLNw,827
 cmd2/py.typed,sha256=qrkHrYJvGoZpU2BpVLNxJB44LlhqVSKyYOwD_L_1m3s,10
 cmd2/py_bridge.py,sha256=oD7EwT59HvWSvF9FACWDi-_izkQY6mfitOYX20Y5daI,5190
@@ -19,9 +19,9 @@ cmd2/string_utils.py,sha256=7F8ORonOc2xS0ZC56hjhQcnZhonE3lDFdQxij6v54dA,4430
 cmd2/styles.py,sha256=rh7N-4A2moKDEH82Co-yTrmzAknU75d2c0oR2G1euEg,2762
 cmd2/terminal_utils.py,sha256=AOk1VjOAzxn7jou2wbALeD6FRIRlKgkQ0VCzIEY51DA,6052
 cmd2/transcript.py,sha256=5a_1HGDzhhG1I47g9QnrVNWnOI6Mt_z7jGMH7wFm2XQ,9210
-cmd2/utils.py,sha256=4jlhcHfgr8yoymP2hRPeCr7_1J37vI4MIIBkszyPK6M,32292
-cmd2-3.1.1.dist-info/licenses/LICENSE,sha256=7JL3v4rPUpHV8b0yWAOl64e9r4YmwbHgl3SH_RGbsK8,1099
-cmd2-3.1.1.dist-info/METADATA,sha256=KL2uOqWMRRCYFEWwYiSbejEAtzY0IqYTIZR7mSwgz0M,16346
-cmd2-3.1.1.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-cmd2-3.1.1.dist-info/top_level.txt,sha256=gJbOJmyrARwLhm5diXAtzlNQdxbDZ8iRJ8HJi65_5hg,5
-cmd2-3.1.1.dist-info/RECORD,,
+cmd2/utils.py,sha256=3eRyAXeD3Rb_3LiBXizusX4r_JFBhLzESQGPSf2jTw4,32179
+cmd2-3.1.3.dist-info/licenses/LICENSE,sha256=7JL3v4rPUpHV8b0yWAOl64e9r4YmwbHgl3SH_RGbsK8,1099
+cmd2-3.1.3.dist-info/METADATA,sha256=98Bhip01B0tX-qngQXy_kDpEYW6_Pt09MPlyPjocs8Y,16405
+cmd2-3.1.3.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+cmd2-3.1.3.dist-info/top_level.txt,sha256=gJbOJmyrARwLhm5diXAtzlNQdxbDZ8iRJ8HJi65_5hg,5
+cmd2-3.1.3.dist-info/RECORD,,