Merge branch 'master' into 3.0.0

Author: kmvanbrunt

.github/workflows/build.yml

@@ -2,29 +2,36 @@
 # https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
 name: "build"
 
-on: [ push, pull_request ]
+on: [push, pull_request]
 
 jobs:
   build:
     strategy:
       fail-fast: false
       matrix:
-        os: [ ubuntu-latest, macos-latest, windows-latest ]
-        python-version: [ "3.8", "3.9", "3.10", "3.11", "3.12", "3.13" ]
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ["3.8", "3.9", "3.10", "3.11", "3.12", "3.13"]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v4  # https://github.com/actions/checkout
+      - uses: actions/checkout@v4 # https://github.com/actions/checkout
         with:
           # Only a single commit is fetched by default, for the ref/SHA that triggered the workflow.
           # Set fetch-depth: 0 to fetch all history for all branches and tags.
           fetch-depth: 0 # Needed for setuptools_scm to work correctly
-      - uses: actions/setup-python@v5  # https://github.com/actions/setup-python
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
         with:
           python-version: ${{ matrix.python-version }}
           allow-prereleases: true
-      - name: Install dependencies
-        run: python -m pip install --upgrade pip setuptools setuptools-scm nox
-      - name: Run tests and post coverage results
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-        run: python -m nox --non-interactive --session tests-${{ matrix.python-version }}  # Run nox for a single version of Python
+
+      - name: Install the project
+        run: uv sync --all-extras --dev
+
+      - name: Run tests
+        run: uv run inv pytest --junit --no-pty --base
+
+      - name: Run isolated tests
+        run: uv run inv pytest --junit --no-pty --isolated

CHANGELOG.md

@@ -6,11 +6,17 @@
     See [custom_parser.py](https://github.com/python-cmd2/cmd2/blob/master/examples/custom_parser.py)
     example for more details.
 
-# 2.5.2 (November 3, 2024)
+## 2.5.3 (November 5, 2024)
+* Enhancements
+  * Changed `CommandSet._cmd` to a read-only property which never returns `None` because it
+    is meant to be called after the `CommandSet` is registered. This addresses type checker
+    errors that occurred if `CommandSet._cmd` wasn't cast or checked if `None` before use.
+
+## 2.5.2 (November 3, 2024)
 * Bug Fixes
   * Fixed default `pytest` execution when not using cmd2's custom `invoke` command via `inv pytest`
-    
-# 2.5.1 (November 2, 2024)
+
+## 2.5.1 (November 2, 2024)
 * Bug Fixes
   * Fixed readline bug when using `ipy` command with `gnureadline` and Python 3.13
 

cmd2/command_definition.py

@@ -92,20 +92,42 @@ 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
         not been added to the CLI object at this point. Subclasses can override this to perform any initialization
         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 @@ def on_unregistered(self) -> None:
         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 @@ def add_settable(self, settable: Settable) -> None:
 
         :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}')

noxfile.py

@@ -53,7 +53,6 @@ dev = [
     "doc8",
     "invoke",
     "mypy",
-    "nox",
     "pytest",
     "pytest-cov",
     "pytest-mock",
@@ -312,6 +311,7 @@ packages = ["cmd2"]
 
 [tool.uv]
 dev-dependencies = [
+    "build",
     "cmd2-ext-test",
     "codecov",
     "doc8",

pyproject.toml

@@ -49,7 +49,7 @@ def rmrf(items, verbose=True):
 
 #####
 #
-# pytest, nox, pylint, and codecov
+# pytest, pylint, and codecov
 #
 #####
 
@@ -117,17 +117,6 @@ def mypy_clean(context):
 namespace_clean.add_task(mypy_clean, 'mypy')
 
 
-@invoke.task
-def nox_clean(context):
-    """Remove nox virtualenvs and logs"""
-    # pylint: disable=unused-argument
-    with context.cd(TASK_ROOT_STR):
-        rmrf('.nox')
-
-
-namespace_clean.add_task(nox_clean, 'nox')
-
-
 #####
 #
 # documentation

tasks.py

@@ -150,8 +150,14 @@ def test_autoload_commands(command_sets_app):
 
 
 def test_custom_construct_commandsets():
-    # Verifies that a custom initialized CommandSet loads correctly when passed into the constructor
     command_set_b = CommandSetB('foo')
+
+    # Verify that _cmd cannot be accessed until CommandSet is registered.
+    with pytest.raises(CommandSetRegistrationError) as excinfo:
+        command_set_b._cmd.poutput("test")
+    assert "is not registered" in str(excinfo.value)
+
+    # Verifies that a custom initialized CommandSet loads correctly when passed into the constructor
     app = WithCommandSets(command_sets=[command_set_b])
 
     cmds_cats, cmds_doc, cmds_undoc, help_topics = app._build_command_info()