summaryrefslogtreecommitdiff
path: root/gr-utils/python/modtool/cli/rename.py
diff options
context:
space:
mode:
authorSwapnil Negi <swapnil.negi09@gmail.com>2019-01-04 18:29:50 +0100
committerAndrej Rode <mail@andrejro.de>2019-01-04 18:58:02 +0100
commit055287896c8c97eb0cdda825559e217d8db54a14 (patch)
tree613262f5ed45ba4eaadf1bd76009aa16ad22806f /gr-utils/python/modtool/cli/rename.py
parent2fcf3b8afe51092003b7f916edb9e5d6372d4842 (diff)
modtool: gr-modtool overhaul GSoC 2018
This commit contains all the changes done during the 2018 GSoC "gr-modtool overhaul". Changes include: - Rewrite of gr-modtool based on Python Click - Split of gr-modtool in cli and core - Adherence to new GNU Radio 3.8 API for OOTs - Pylint improvements - Py3k and Py2k compatibility This feature is merged in a squash-merge due to big refactoring on the head and base branch and the impossibility to unclutter both.
Diffstat (limited to 'gr-utils/python/modtool/cli/rename.py')
-rw-r--r--gr-utils/python/modtool/cli/rename.py83
1 files changed, 83 insertions, 0 deletions
diff --git a/gr-utils/python/modtool/cli/rename.py b/gr-utils/python/modtool/cli/rename.py
new file mode 100644
index 0000000000..d88c30a75d
--- /dev/null
+++ b/gr-utils/python/modtool/cli/rename.py
@@ -0,0 +1,83 @@
+#
+# Copyright 2018 Free Software Foundation, Inc.
+#
+# This file is part of GNU Radio
+#
+# GNU Radio is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3, or (at your option)
+# any later version.
+#
+# GNU Radio is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with GNU Radio; see the file COPYING. If not, write to
+# the Free Software Foundation, Inc., 51 Franklin Street,
+# Boston, MA 02110-1301, USA.
+#
+""" Module to rename blocks """
+
+from __future__ import print_function
+from __future__ import absolute_import
+from __future__ import unicode_literals
+
+import re
+
+import click
+
+from ..core import get_block_candidates, ModToolRename
+from ..tools import SequenceCompleter
+from .base import common_params, block_name, run, cli_input, ModToolException
+
+
+@click.command('rename', short_help=ModToolRename.description)
+@common_params
+@block_name
+@click.argument('new-name', metavar="NEW-BLOCK-NAME", nargs=1, required=False)
+def cli(**kwargs):
+ """
+ \b
+ Rename a block inside a module.
+
+ The argument NEW-BLOCK-NAME is the new name of the block.
+ """
+ kwargs['cli'] = True
+ self = ModToolRename(**kwargs)
+ click.secho("GNU Radio module name identified: " + self.info['modname'], fg='green')
+ # first make sure the old block name is provided
+ get_oldname(self)
+ click.secho("Block/code to rename identifier: " + self.info['oldname'], fg='green')
+ self.info['fulloldname'] = self.info['modname'] + '_' + self.info['oldname']
+ # now get the new block name
+ get_newname(self)
+ click.secho("Block/code identifier: " + self.info['newname'], fg='green')
+ self.info['fullnewname'] = self.info['modname'] + '_' + self.info['newname']
+ run(self)
+
+def get_oldname(self):
+ """ Get the old block name to be replaced """
+ block_candidates = get_block_candidates()
+ if self.info['oldname'] is None:
+ with SequenceCompleter(block_candidates):
+ while not self.info['oldname'] or self.info['oldname'].isspace():
+ self.info['oldname'] = cli_input("Enter name of block/code to rename "+
+ "(without module name prefix): ")
+ if self.info['oldname'] not in block_candidates:
+ choices = [x for x in block_candidates if self.info['oldname'] in x]
+ if len(choices) > 0:
+ click.secho("Suggested alternatives: "+str(choices), fg='yellow')
+ raise ModToolException("Blockname for renaming does not exists!")
+ if not re.match('[a-zA-Z0-9_]+', self.info['oldname']):
+ raise ModToolException('Invalid block name.')
+
+def get_newname(self):
+ """ Get the new block name """
+ if self.info['newname'] is None:
+ while not self.info['newname'] or self.info['newname'].isspace():
+ self.info['newname'] = cli_input("Enter name of block/code "+
+ "(without module name prefix): ")
+ if not re.match('[a-zA-Z0-9_]+', self.info['newname']):
+ raise ModToolException('Invalid block name.')