diff options
| author | Swapnil Negi <swapnil.negi09@gmail.com> | 2019-01-04 18:29:50 +0100 |
|---|---|---|
| committer | Andrej Rode <mail@andrejro.de> | 2019-01-04 18:58:02 +0100 |
| commit | 055287896c8c97eb0cdda825559e217d8db54a14 (patch) | |
| tree | 613262f5ed45ba4eaadf1bd76009aa16ad22806f /gr-utils/python/modtool/cli/newmod.py | |
| parent | 2fcf3b8afe51092003b7f916edb9e5d6372d4842 (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/newmod.py')
| -rw-r--r-- | gr-utils/python/modtool/cli/newmod.py | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/gr-utils/python/modtool/cli/newmod.py b/gr-utils/python/modtool/cli/newmod.py new file mode 100644 index 0000000000..56fb9e0433 --- /dev/null +++ b/gr-utils/python/modtool/cli/newmod.py @@ -0,0 +1,72 @@ +# +# 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. +# +""" Create a whole new out-of-tree module """ + +from __future__ import print_function +from __future__ import absolute_import +from __future__ import unicode_literals + +import re +import os + +import click + +from gnuradio import gr +from ..core import ModToolNewModule +from .base import common_params, run, cli_input, ModToolException + + +@click.command('newmod', short_help=ModToolNewModule.description) +@click.option('--srcdir', + help="Source directory for the module template.") +@common_params +@click.argument('module_name', metavar="MODULE-NAME", nargs=1, required=False) +def cli(**kwargs): + """ + \b + Create a new out-of-tree module + + The argument MODULE-NAME is the name of the module to be added. + """ + kwargs['cli'] = True + self = ModToolNewModule(**kwargs) + get_modname(self) + self.dir = os.path.join(self.dir, 'gr-{}'.format(self.info['modname'])) + try: + os.stat(self.dir) + except OSError: + pass # This is what should happen + else: + raise ModToolException('The given directory exists.') + if self.srcdir is None: + self.srcdir = '/usr/local/share/gnuradio/modtool/templates/gr-newmod' + self.srcdir = gr.prefs().get_string('modtool', 'newmod_path', self.srcdir) + if not os.path.isdir(self.srcdir): + raise ModToolException('Could not find gr-newmod source dir.') + run(self) + +def get_modname(self): + """ Get the name of the new module to be added """ + if self.info['modname'] is None: + while not self.info['modname'] or self.info['modname'].isspace(): + self.info['modname'] = cli_input('Name of the new module: ') + if not re.match('[a-zA-Z0-9_]+$', self.info['modname']): + raise ModToolException('Invalid module name.') |