cbuild-run: add pack related commands to the command set

- filter imports needed for TYPE_CHECKING
- register cbuild-run in commander

Author: TeoMahnic

pyocd/commands/commander.py

@@ -1,5 +1,5 @@
 # pyOCD debugger
-# Copyright (c) 2015-2020 Arm Limited
+# Copyright (c) 2015-2020,2025 Arm Limited
 # Copyright (c) 2021 Chris Reed
 # SPDX-License-Identifier: Apache-2.0
 #
@@ -210,6 +210,7 @@ def connect(self) -> bool:
                         user_script=self.args.script,
                         no_config=self.args.no_config,
                         pack=self.args.pack,
+                        cbuild_run=self.args.cbuild_run,
                         target_override=self.args.target_override,
                         connect_mode=connect_mode,
                         frequency=self.args.frequency,

pyocd/target/pack/cbuild_run.py

@@ -14,6 +14,8 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+from __future__ import annotations
+
 import logging
 import yaml
 import os
@@ -23,19 +25,16 @@
 from pathlib import Path
 from copy import deepcopy
 from dataclasses import dataclass
-from typing import (cast, Optional, Set, Dict, List, Tuple, IO, Any)
+from typing import (cast, Optional, Set, Dict, List, Tuple, IO, Any, TYPE_CHECKING)
 from .flash_algo import PackFlashAlgo
 from .reset_sequence_maps import (RESET_SEQUENCE_TO_TYPE_MAP, RESET_TYPE_TO_SEQUENCE_MAP)
 from .. import (normalise_target_type_name, TARGET)
-from ...coresight.cortex_m import CortexM
 from ...coresight.coresight_target import CoreSightTarget
 from ...coresight.ap import (APAddressBase, APv1Address, APv2Address)
 from ...core import exceptions
 from ...core.target import Target
 from ...core.session import Session
-from ...core.core_target import CoreTarget
 from ...core.memory_map import (MemoryMap, MemoryType, MEMORY_TYPE_CLASS_MAP)
-from ...utility.sequencer import CallSequence
 from ...probe.debug_probe import DebugProbe
 from ...debug.svd.loader import SVDFile
 from ...debug.sequences.scope import Scope
@@ -50,6 +49,12 @@
     DebugSequenceExecutionContext
 )
 
+if TYPE_CHECKING:
+    from ...coresight.cortex_m import CortexM
+    from ...core.core_target import CoreTarget
+    from ...utility.sequencer import CallSequence
+    from ...commands.execution_context import CommandSet
+
 LOG = logging.getLogger(__name__)
 
 class CbuildRunError(exceptions.Error):
@@ -254,7 +259,7 @@ def is_reset_sequence_enabled(name: str) -> bool:
     @staticmethod
     def _cbuild_target_add_core(_self, core: CoreTarget) -> None:
         """@brief Override to set node name of added core to its pname."""
-        pname = _self._cbuild_device.processors_ap_map[cast(CortexM, core).ap.address].name
+        pname = _self._cbuild_device.processors_ap_map[cast('CortexM', core).ap.address].name
         core.node_name = pname
         CoreSightTarget.add_core(_self, core)
 
@@ -273,6 +278,10 @@ def _cbuild_target_get_gdbserver_port(self, pname: str) -> Optional[int]:
     def _cbuild_target_get_output(self) -> Dict[str, Optional[int]]:
         return self._cbuild_device.output
 
+    @staticmethod
+    def _cbuild_target_add_target_command_groups(_self, command_set: CommandSet):
+        """@brief Add pack related commands to the command set."""
+        command_set.add_command_group('pack-target')
 
 class CbuildRun:
     """@brief Parser for the .cbuild-run.yml file (CSolution Run and Debug Management)."""
@@ -611,7 +620,8 @@ def populate_target(self, target: Optional[str] = None) -> None:
                     "configure_core_reset": CbuildRunTargetMethods._cbuild_target_configure_core_reset,
                     "add_core": CbuildRunTargetMethods._cbuild_target_add_core,
                     "get_gdbserver_port": CbuildRunTargetMethods._cbuild_target_get_gdbserver_port,
-                    "get_output": CbuildRunTargetMethods._cbuild_target_get_output
+                    "get_output": CbuildRunTargetMethods._cbuild_target_get_output,
+                    "add_target_command_groups": CbuildRunTargetMethods._cbuild_target_add_target_command_groups,
         })
         TARGET[target] = tgt
 

test/commander_test.py

@@ -1,5 +1,5 @@
 # pyOCD debugger
-# Copyright (c) 2020 Arm Limited
+# Copyright (c) 2020,2025 Arm Limited
 # Copyright (c) 2021 Chris Reed
 # SPDX-License-Identifier: Apache-2.0
 #
@@ -94,6 +94,7 @@ def commander_test(board_id):
     args.script = None
     args.no_config = False
     args.pack = None
+    args.cbuild_run = None
     args.unique_id = board_id
     args.target_override = None
     args.elf = GDB_TEST_ELF