Editing ModtoolArchitecture

''' THIS PORTION HAS NOT BEEN MERGED WITH THE PYTHON3 BRANCH YET.'''
<br><br>

This article explains the current architecture of gr_modtool in the python3 branch.<br>

For this tutorial, one must have the dependencies <code>click</code>, <code>click-plugins</code> installed.<br>
<code>pip3 install click</code><br>
<code>pip3 install click-plugins</code>

= What is gr_modtool? =

While developing an [[OutOfTreeModules|Out Of Tree module]], there's a lot of boring, monotonous work involved: boilerplate code, makefile editing, etc. gr_modtool is a script which aims to help with all these things by automatically editing makefiles, using templates, and doing as much work as possible for the developer such that one can jump straight into the DSP coding.

Note that gr_modtool makes a lot of assumptions on how the code looks like. The more the module is custom and has specific changes, the less useful gr_modtool will be, but it is probably the best place to start with any new module or block. One can go through the [[BlocksCodingGuide|block coding guide]] for getting an insight of coding the block.

gr_modtool is available in the GNU Radio source tree and is installed by default.

= Plug-in Architecture = 

gr-modtool uses the [http://click.pocoo.org/6/ Click] Python package for its command line interface. Some of the advantages of using Click for CLI are:-
* Click is fully nestable and composable.
* Click supports prompting of custom values.
* Click works the same in Python 2 as well as in Pythonn3.
* Click comes with useful helpers like ANSI colors.
* Click is very simple to code and visualize.

Click is based on decorators and therefore enables simple syntax for calling high order internal functions.<br><br>
gr_modtool uses the class <code>[http://click.pocoo.org/6/api/#click.Group click.Group]</code> as the parent class for its base module's <code>CommandCLI</code> class. The parent class functions <code>list_commands</code> and <code>get_command</code> have been overridden in the child class to enable a plug-in architecture for gr_modtool.<br>

The function <code>list_commands</code> lists all the commands for the gr_modtool. It first searches for the in-tree commands, the commands in its own directory, and then searches for other registered <code>[http://click.pocoo.org/5/api/#click.command commands]</code> through external plug-ins or otherwise (in case of the modtool, they are only registered through external plug-ins).<br>
The function <code>get_command</code> returns a command object by the user input command. It first tries to import the module for the command by searching the in-tree modules, then checks for the registration of command via other sources. If the module is found in-tree, then the <code>cli()</code> function of the respective module is called.

== Request-Response cycle ==

Initially all commands with <code>gr_modtool</code> in the command-line interface entered by the user pass through the <code>cli()</code> function of <code>modtool_base.py</code>. If no further command is provided in the command-line, the help page is displayed with all the in-tree plug-ins commands as well as the commands from the external plug-ins, if any. <br>

If a command (after gr_modtool) is provided in the interface which has a corresponding module <code>modtool_command.py</code>, where the command is the user input command, the <code>cli()</code> function of the corresponding module is invoked with the context of the group instance in the base module.<br>

The function is decorated by the decorator, <code>@click.command()</code>, which adds the functionalities of the class <code>[http://click.pocoo.org/5/api/#click.command click.Command]</code> and automatically attaches the decorated <code>[http://click.pocoo.org/5/options/ options]</code> and <code>[http://click.pocoo.org/5/arguments/ arguments]</code> to it. The user input values of all these parameters are then passed to the <code>run()</code> function of the respective module defined in its core class.<br>

Note: The basic difference between arguments and options is that arguments are positional and mandatory by default unlike options, although arguments can also be made optional as in the case with the modtool scripts. Moreover, <code>documentation</code> of the argument is not generated by click and it has to be done manually.

== Key Notes ==

* A decorator function <code>common_params</code> is present in the base module to remove the redundancy of adding the same options in every module. These options are not provided as the options to the base command group '''intentionally''' because they actually make sense with the command itself, otherwise the command <code>gr_modtool add -t general --skip-lib</code> will look like <code>gr_modtool add --skip-lib -t general</code> which is not user-friendly. Therefore, these parameters will show up in the help page of the respective command rather than the command group.
* A decorator <code>block_name</code> is present in the base module which adds an argument (non-mandatory) '''block_name''' to the particular command that uses it.
* The help page for a particular command can be shown with <code>--help</code> in the CLI. For eg:- <code>gr_modtool add --help</code>.
* For commands, a short help snippet is generated. By default, it is the first sentence of the help message of the command, unless it is too long. This can also be overridden by <code>short_help</code> provided with command. For example, <code>@click.command('newmod', short_help=ModToolNewModule().description)</code> shows the help of the command <code>newmod</code> generated in the help page (<code>gr_modtool --help</code> or simply <code>gr_modtool</code>) as the '''description''' variable of the class <code>ModToolNewModule</code>. The main '''help-text''' ,when you request the command's help page with commands like <code>gr_modtool makexml --help</code>, is the '''document string''' of the function attached to the decorator <code>@click.command</code>.
* For options, the help documentation can be added by <code>help</code> parameter in the decorator <code>@click.option()</code>. For example, <code>@click.option('--copyright', help="Name of the copyright holder (you or your company) MUST be a quoted string.")</code>.
<br>
The help page of gr_modtool looks like:-
<pre>% gr_modtool
Usage: gr_modtool [OPTIONS] COMMAND [ARGS]...

  A tool for editing GNU Radio out-of-tree modules.

Options:
  --help  Show this message and exit.

Commands:
  add      Adds a block to the out-of-tree module.
  disable  Disable selected block in module.
  info     Return information about a given module
  makexml  Generate XML files for GRC block bindings.
  newmod   Create new empty module, use add to add blocks.
  rename   Rename a block inside a module.
  rm       Remove a block from a module.

  Manipulate with GNU Radio modules source code tree. Call it without
  options to run specified command interactively</pre>

The help page of the command '''add''' of gr_modtool looks like:-
<pre> % gr_modtool add --help
Usage: gr_modtool add [OPTIONS] BLOCK_NAME

  Adds a block to the out-of-tree module.

Options:
  -t, --block-type [sink|source|sync|decimator|interpolator|general|tagged_stream|hier|noblock]
                                  One of sink, source, sync, decimator,
                                  interpolator, general, tagged_stream, hier,
                                  noblock.
  --license-file TEXT             File containing the license header for every
                                  source code file.
  --copyright TEXT                Name of the copyright holder (you or your
                                  company) MUST be a quoted string.
  --argument-list TEXT            The argument list for the constructor and
                                  make functions.
  --add-python-qa                 If given, Python QA code is automatically
                                  added if possible.
  --add-cpp-qa                    If given, C++ QA code is automatically added
                                  if possible.
  --skip-cmakefiles               If given, only source files are written, but
                                  CMakeLists.txt files are left unchanged.
  -l, --lang [cpp|c++|python]     Programming Language
  -d, --directory TEXT            Base directory of the module. Defaults to
                                  the cwd.
  --skip-lib                      Don't do anything in the lib/ subdirectory.
  --skip-swig                     Don't do anything in the swig/ subdirectory.
  --skip-python                   Don't do anything in the python/
                                  subdirectory.
  --skip-grc                      Don't do anything in the grc/ subdirectory.
  --scm-mode [yes|no|auto]        Use source control management [ yes | no |
                                  auto ]).
  -y, --yes                       Answer all questions with 'yes'. This can
                                  overwrite and delete your files, so be
                                  careful.
  --help                          Show this message and exit.</pre>

Note:- For more information regarding help-texts : [http://click.pocoo.org/5/documentation/ click-documentation].
<br>

== Adding a module in-tree ==

Here is an example of coding a '''click command''':-
<pre>
@click.command('newmod', short_help=ModToolNewModule().description)
@click.option('--srcdir',
              help="Source directory for the module template.")
@ModTool.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 overrides the current module's name (normally is autodetected).
    """
    args = DictToObject(kwargs)
    try:
        ModToolNewModule().run(args)
    except ModToolException as err:
        print(err, file=sys.stderr)
        exit(1)
</pre>
Here, the available '''options''' with the command are <code>srcdir</code> and all the options that the function of the class <code>ModTool</code>, <code>common_params</code>, adds to it. <br><br>

So, to add a module in-tree, all that one has to do is to create module as <code>module_command.py</code> with a function <code>cli()</code> in the '''modtool''' directory, add options and arguments to it with <code>@click.option()</code> and <code>@click.argument()</code> decorators and specify the functional details with the obtained value of parameters.<br>
Note: Instead of <code>**kwargs</code>, one can specify the particular options.

= External Plug-ins =

<code>gr_modtool</code> supports the addition of external plug-ins, if required by the user. To achieve this functionality, it uses <code>pkg_resources.iter_entry_points</code> to load an external plug-in and a python package <code>click-plugins</code> to register commands to the base group and show <code>Broken Plug-in</code> if the plug-in is not be loaded properly.

== Adding a plug-in ==

To add an external plug-in to the modtool, all that one has to do is to create a package directory with a file <code>setup.py</code> and specify the <code>entry_point</code> as <code>gnuradio.modtool.plugins</code> through the functional definition of our choice.<br>
For example:-<br>
If package directory <code>ext_plug</code> looks like
<pre>
ext_plug
....setup.py
....core.py
</pre>
the <code>setup.py</code> should look like:-
<pre>
from setuptools import setup


setup(
    py_modules=['core'],
    entry_points='''
        [gnuradio.modtool.cli.plugins]
        cmd=core:cmd
    '''
)
</pre>
Here <code>core</code> is the module name and <code>cmd</code> is the function inside <code>core.py</code> that is executed.<br>
Note: Any other specifications to <code>setup.py</code> can be added like '''name''', '''version''', etc.

== Writing a plug-in ==

Writing an external plug-in is quite simple. All that one has to do is create a function with the name specified in the <code>entry_point</code> and decorate it with <code>@click.command()</code>, if just an external command is to be added, or  <code>@click.group()</code>, if a command group is to be added.<br>
For eg:- For the previous package, <code>core.py</code> can be like
<pre>
import click


@click.command()
def cmd():
    """
    The external command functionality
    """ 
    pass
</pre>
Now, one just needs to install this package by running <code>pip3 install ext_plug/</code> and the external plugin is ready to use.<br>
Now, on running <code>gr_modtool --help</code>, we get
<pre>
% gr_modtool --help
Usage: gr_modtool [OPTIONS] COMMAND [ARGS]...

  A tool for editing GNU Radio out-of-tree modules.

Options:
  --help  Show this message and exit.

Commands:
  add      Adds a block to the out-of-tree module.
  cmd      The external command functionality
  disable  Disable selected block in module.
  info     Return information about a given module
  makexml  Generate XML files for GRC block bindings.
  newmod   Create new empty module, use add to add blocks.
  rename   Rename a block inside a module.
  rm       Remove a block from a module.

  Manipulate with GNU Radio modules source code tree. Call it without
  options to run specified command interactively
</pre>
If the plug-in is not loaded due to reasons like an incorrect entry_point setup, the help page will duly indicate that.<br>
For example:-<br>
If the <code>setup.py</code> file for the above-mentioned package looks like
<pre>
from setuptools import setup


setup(
    py_modules=['core'],
    entry_points='''
        [gnuradio.modtool.plugins]
        cmd=core:cmdddd
    '''
)
</pre>
the plug-in will not load to incorrect functional definition in the <code>entry_points</code>.<br>
Now, on running <code>gr_modtool --help</code>, we get
<pre>
% gr_modtool --help
Usage: gr_modtool [OPTIONS] COMMAND [ARGS]...

  A tool for editing GNU Radio out-of-tree modules.

Options:
  --help  Show this message and exit.

Commands:
  add      Adds a block to the out-of-tree module.
  cmd      † Warning: could not load plugin. See `gr_modtool cmd --help`.
  disable  Disable selected block in module.
  info     Return information about a given module
  makexml  Generate XML files for GRC block bindings.
  newmod   Create new empty module, use add to add blocks.
  rename   Rename a block inside a module.
  rm       Remove a block from a module.

  Manipulate with GNU Radio modules source code tree. Call it without
  options to run specified command interactively
</pre>
So, <code>gr_modtool</code> makes even the adding an external plug-in highly interactive.<br><br>

Information regarding creating an out of tree module and in-tree commands is available [[OutOfTreeModules|here]].