cmd2 2.5.1__py3-none-any.whl → 2.5.3__py3-none-any.whl

cmd2/cmd2.py

@@ -3404,8 +3404,7 @@ class Cmd(cmd.Cmd):
     alias_description = "Manage aliases\n" "\n" "An alias is a command that enables replacement of a word by another string."
     alias_epilog = "See also:\n" "  macro"
     alias_parser = argparse_custom.DEFAULT_ARGUMENT_PARSER(description=alias_description, epilog=alias_epilog)
-    alias_subparsers = alias_parser.add_subparsers(dest='subcommand', metavar='SUBCOMMAND')
-    alias_subparsers.required = True
+    alias_parser.add_subparsers(dest='subcommand', metavar='SUBCOMMAND', required=True)
 
     # Preserve quotes since we are passing strings to other commands
     @with_argparser(alias_parser, preserve_quotes=True)
@@ -3573,8 +3572,7 @@ class Cmd(cmd.Cmd):
     macro_description = "Manage macros\n" "\n" "A macro is similar to an alias, but it can contain argument placeholders."
     macro_epilog = "See also:\n" "  alias"
     macro_parser = argparse_custom.DEFAULT_ARGUMENT_PARSER(description=macro_description, epilog=macro_epilog)
-    macro_subparsers = macro_parser.add_subparsers(dest='subcommand', metavar='SUBCOMMAND')
-    macro_subparsers.required = True
+    macro_parser.add_subparsers(dest='subcommand', metavar='SUBCOMMAND', required=True)
 
     # Preserve quotes since we are passing strings to other commands
     @with_argparser(macro_parser, preserve_quotes=True)

cmd2/command_definition.py

@@ -92,10 +92,31 @@ class CommandSet(object):
     """
 
     def __init__(self) -> None:
-        self._cmd: Optional[cmd2.Cmd] = None
+        # Private reference to the CLI instance in which this CommandSet running.
+        # This will be set when the CommandSet is registered and it should be
+        # accessed by child classes using the self._cmd property.
+        self.__cmd_internal: Optional[cmd2.Cmd] = None
+
         self._settables: Dict[str, Settable] = {}
         self._settable_prefix = self.__class__.__name__
 
+    @property
+    def _cmd(self) -> 'cmd2.Cmd':
+        """
+        Property for child classes to access self.__cmd_internal.
+
+        Using this property ensures that self.__cmd_internal has been set
+        and it tells type checkers that it's no longer a None type.
+
+        Override this property if you need to change its return type to a
+        child class of Cmd.
+
+        :raises: CommandSetRegistrationError if CommandSet is not registered.
+        """
+        if self.__cmd_internal is None:
+            raise CommandSetRegistrationError('This CommandSet is not registered')
+        return self.__cmd_internal
+
     def on_register(self, cmd: 'cmd2.Cmd') -> None:
         """
         Called by cmd2.Cmd as the first step to registering a CommandSet. The commands defined in this class have
@@ -103,9 +124,10 @@ class CommandSet(object):
         requiring access to the Cmd object (e.g. configure commands and their parsers based on CLI state data).
 
         :param cmd: The cmd2 main application
+        :raises: CommandSetRegistrationError if CommandSet is already registered.
         """
-        if self._cmd is None:
-            self._cmd = cmd
+        if self.__cmd_internal is None:
+            self.__cmd_internal = cmd
         else:
             raise CommandSetRegistrationError('This CommandSet has already been registered')
 
@@ -129,7 +151,7 @@ class CommandSet(object):
         Called by ``cmd2.Cmd`` after a CommandSet has been unregistered and all its commands removed from the CLI.
         Subclasses can override this to perform remaining cleanup steps.
         """
-        self._cmd = None
+        self.__cmd_internal = None
 
     @property
     def settable_prefix(self) -> str:
@@ -145,7 +167,7 @@ class CommandSet(object):
 
         :param settable: Settable object being added
         """
-        if self._cmd:
+        if self.__cmd_internal is not None:
             if not self._cmd.always_prefix_settables:
                 if settable.name in self._cmd.settables.keys() and settable.name not in self._settables.keys():
                     raise KeyError(f'Duplicate settable: {settable.name}')

{cmd2-2.5.1.dist-info → cmd2-2.5.3.dist-info}/METADATA

@@ -1,62 +1,81 @@
 Metadata-Version: 2.1
 Name: cmd2
-Version: 2.5.1
+Version: 2.5.3
 Summary: cmd2 - quickly build feature-rich and user-friendly interactive command line applications in Python
-Home-page: https://github.com/python-cmd2/cmd2
-Author: Catherine Devlin
-Author-email: catherine.devlin@gmail.com
-License: MIT
-Keywords: command prompt console cmd
-Platform: any
+Author: cmd2 Contributors
+License: The MIT License (MIT)
+        
+        Copyright (c) 2008-2024 Catherine Devlin and others
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in
+        all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+        THE SOFTWARE.
+        
+Keywords: CLI,cmd,command,interactive,prompt,Python
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Operating System :: OS Independent
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
 Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
-Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.8
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: pyperclip
 Requires-Dist: wcwidth
-Requires-Dist: pyreadline3 ; sys_platform=='win32'
+Requires-Dist: gnureadline ; platform_system == "Darwin"
+Requires-Dist: pyreadline3 ; platform_system == "Windows"
+Provides-Extra: build
+Requires-Dist: build ; extra == 'build'
+Requires-Dist: setuptools ; extra == 'build'
+Requires-Dist: setuptools-scm ; extra == 'build'
 Provides-Extra: dev
 Requires-Dist: codecov ; extra == 'dev'
 Requires-Dist: doc8 ; extra == 'dev'
 Requires-Dist: invoke ; extra == 'dev'
 Requires-Dist: mypy ; extra == 'dev'
-Requires-Dist: nox ; extra == 'dev'
-Requires-Dist: pytest >=4.6 ; extra == 'dev'
+Requires-Dist: pytest ; extra == 'dev'
 Requires-Dist: pytest-cov ; extra == 'dev'
 Requires-Dist: pytest-mock ; extra == 'dev'
 Requires-Dist: sphinx ; extra == 'dev'
-Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
 Requires-Dist: sphinx-autobuild ; extra == 'dev'
+Requires-Dist: sphinx-rtd-theme ; extra == 'dev'
 Requires-Dist: ruff ; extra == 'dev'
 Requires-Dist: twine ; extra == 'dev'
 Provides-Extra: docs
 Requires-Dist: setuptools ; extra == 'docs'
 Requires-Dist: setuptools-scm ; extra == 'docs'
 Requires-Dist: sphinx ; extra == 'docs'
-Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
 Requires-Dist: sphinx-autobuild ; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
 Provides-Extra: test
 Requires-Dist: codecov ; extra == 'test'
 Requires-Dist: coverage ; extra == 'test'
 Requires-Dist: pytest ; extra == 'test'
 Requires-Dist: pytest-cov ; extra == 'test'
 Requires-Dist: pytest-mock ; extra == 'test'
-Requires-Dist: gnureadline ; (sys_platform == "darwin") and extra == 'test'
 Provides-Extra: validate
 Requires-Dist: mypy ; extra == 'validate'
 Requires-Dist: ruff ; extra == 'validate'

{cmd2-2.5.1.dist-info → cmd2-2.5.3.dist-info}/RECORD

@@ -3,8 +3,8 @@ cmd2/ansi.py,sha256=BasPj_Wla0cEyjpe_zu-cn24CgVdSXK3sfxknLM1WcY,32203
 cmd2/argparse_completer.py,sha256=6z0zmODqM7vhQhI0c6JUvCmR2V4qfdWQEyTZeNIea8c,36505
 cmd2/argparse_custom.py,sha256=bbAYRr79ZSJWGchd7trmRQDHWAsSJaW0dTQMp65Mrv4,57806
 cmd2/clipboard.py,sha256=7EISono76d7djj17hbvR9cCTB7jVGSBkUjgVQiMyUjE,549
-cmd2/cmd2.py,sha256=fAw7vGAwjw0-3rWL2uUsm-MWEpQXhKxbmLdUhwf_K-4,261420
-cmd2/command_definition.py,sha256=jm15jQoskQLn5vhvxJinvjHg0KYhzydDU67Dkl734z4,6592
+cmd2/cmd2.py,sha256=u7wS8guAuSIQYWy7jnyPDkXHCzFLK8881nrvhjzgzio,261338
+cmd2/command_definition.py,sha256=U5Bx2MwsK2JWUKzmFm4u9OhRgJqp-2r2Q85qsKWCdXQ,7585
 cmd2/constants.py,sha256=O5SfjAZGgCl5-IxuHqBMmgbG3HhllxIcZBtkzzLYohA,1865
 cmd2/decorators.py,sha256=wM0PtalUseDfJVVQV2LkbZbqkZad2XudRiCmARCBWWs,20658
 cmd2/exceptions.py,sha256=DwX7rQmon4eRyX1ZK4yne4lObdPO1j5Agg3Bav6pXwU,3600
@@ -17,8 +17,8 @@ cmd2/rl_utils.py,sha256=HVPdNjuYyU67-XerPUJArmzhohzI1ABrZhU9cLc-EIs,11538
 cmd2/table_creator.py,sha256=qoxt9s3MxQkfSkp4cIPFMlVzC7kRjUU55p0ow7pFQus,47544
 cmd2/transcript.py,sha256=I0sD38RbG79Qz9GXIlfh1pHSNmWBTY2SLZAKEdSLWI4,9182
 cmd2/utils.py,sha256=M6Ojtq3QQ7NbuvgIcxmhEaN2o-OcxkI_LAXZIxu7DF4,49383
-cmd2-2.5.1.dist-info/LICENSE,sha256=QXrW0Z0merk9mncyUkn-sgRxhT8_o1dL5HEaBNH47Q4,1099
-cmd2-2.5.1.dist-info/METADATA,sha256=tkZEn7szG_8520CVj7iVaiUE9XTwkk1geaDmH16IBtM,12135
-cmd2-2.5.1.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
-cmd2-2.5.1.dist-info/top_level.txt,sha256=gJbOJmyrARwLhm5diXAtzlNQdxbDZ8iRJ8HJi65_5hg,5
-cmd2-2.5.1.dist-info/RECORD,,
+cmd2-2.5.3.dist-info/LICENSE,sha256=QXrW0Z0merk9mncyUkn-sgRxhT8_o1dL5HEaBNH47Q4,1099
+cmd2-2.5.3.dist-info/METADATA,sha256=7StjZqH093MfR0b6B-8AKVwDZDXpLr0eSg5XwwQIAoQ,13308
+cmd2-2.5.3.dist-info/WHEEL,sha256=P9jw-gEje8ByB7_hXoICnHtVCrEwMQh-630tKvQWehc,91
+cmd2-2.5.3.dist-info/top_level.txt,sha256=gJbOJmyrARwLhm5diXAtzlNQdxbDZ8iRJ8HJi65_5hg,5
+cmd2-2.5.3.dist-info/RECORD,,