west: runners: Add a deprecation action to the core code

In order to allow for further options to be deprecated with minimal
impact, add a deprecation argparse Action and a callable instantiator
that can be used to deprecate options in favor of new ones.

Signed-off-by: Carles Cufi <[email protected]>

Author: carlescufi

scripts/west_commands/runners/core.py

@@ -288,6 +288,17 @@ class _ToggleAction(argparse.Action):
     def __call__(self, parser, args, ignored, option):
         setattr(args, self.dest, not option.startswith('--no-'))
 
+class DeprecatedAction(argparse.Action):
+
+    def __call__(self, parser, namespace, values, option_string=None):
+        _logger.warning(f'Argument {self.option_strings[0]} is deprecated, '
+                        f'use {self._replacement} instead.')
+        setattr(namespace, self.dest, values)
+
+def depr_action(*args, replacement=None, **kwargs):
+    action = DeprecatedAction(*args, **kwargs)
+    setattr(action, '_replacement', replacement)
+    return action
 
 class ZephyrBinaryRunner(abc.ABC):
     '''Abstract superclass for binary runners (flashers, debuggers).

scripts/west_commands/runners/jlink.py

@@ -5,6 +5,7 @@
 '''Runner for debugging with J-Link.'''
 
 import argparse
+from functools import partial
 import logging
 import os
 from pathlib import Path
@@ -13,7 +14,7 @@
 import sys
 import tempfile
 
-from runners.core import ZephyrBinaryRunner, RunnerCaps
+from runners.core import ZephyrBinaryRunner, RunnerCaps, depr_action
 
 try:
     from pylink.library import Library
@@ -83,6 +84,8 @@ def do_add_parser(cls, parser):
 
         # Optional:
         parser.add_argument('--id', required=False, dest='dev_id',
+                            action=partial(depr_action,
+                                           replacement='-i/--dev-id'),
                             help='Deprecated: use -i/--dev-id instead')
         parser.add_argument('--iface', default='swd',
                             help='interface to use, default is swd')

scripts/west_commands/runners/nrfjprog.py

@@ -5,14 +5,15 @@
 
 '''Runner for flashing with nrfjprog.'''
 
+from functools import partial
 import os
 from pathlib import Path
 import shlex
 import subprocess
 import sys
 from re import fullmatch, escape
 
-from runners.core import ZephyrBinaryRunner, RunnerCaps
+from runners.core import ZephyrBinaryRunner, RunnerCaps, depr_action
 
 try:
     from intelhex import IntelHex
@@ -80,6 +81,8 @@ def do_add_parser(cls, parser):
                             action='store_true',
                             help='use reset instead of pinreset')
         parser.add_argument('--snr', required=False, dest='dev_id',
+                            action=partial(depr_action,
+                                           replacement='-i/--dev-id'),
                             help='Deprecated: use -i/--dev-id instead')
         parser.add_argument('--tool-opt', default=[], action='append',
                             help='''Additional options for nrfjprog,

scripts/west_commands/runners/pyocd.py

@@ -4,11 +4,12 @@
 
 '''Runner for pyOCD .'''
 
+from functools import partial
 import os
 from os import path
 
 from runners.core import ZephyrBinaryRunner, RunnerCaps, \
-    BuildConfiguration
+    BuildConfiguration, depr_action
 
 DEFAULT_PYOCD_GDB_PORT = 3333
 DEFAULT_PYOCD_TELNET_PORT = 4444
@@ -111,6 +112,8 @@ def do_add_parser(cls, parser):
         parser.add_argument('--tui', default=False, action='store_true',
                             help='if given, GDB uses -tui')
         parser.add_argument('--board-id', dest='dev_id',
+                            action=partial(depr_action,
+                                           replacement='-i/--dev-id'),
                             help='Deprecated: use -i/--dev-id instead')
         parser.add_argument('--tool-opt',
                             help='''Additional options for pyocd Commander,