Added args.py to handle command line options

Author: martinkilbinger

cs_util/__init__.py

@@ -23,4 +23,4 @@
 
 from warnings import warn
 
-__version__ = "0.0.6"
+__version__ = "0.1.0"

cs_util/args.py

@@ -0,0 +1,85 @@
+"""ARGS
+
+:Description: Handling of command line arguments.
+
+:Author: Martin Kilbinger <martin.kilbinger@cea.fr>
+
+
+"""
+
+
+def parse_options(p_def, short_options, types, help_strings):
+    """Parse command line options.
+
+    Parameters
+    ----------
+    p_def : dict
+        default parameter values
+    short_options : dict
+        command line options short (one character) versions
+    types : dict
+        command line options types
+    help_strings : dict
+        command line options help strings
+
+    Returns
+    -------
+    options: tuple
+        Command line options
+    """
+
+    usage  = "%prog [OPTIONS]"
+    parser = OptionParser(usage=usage)
+
+    # Loop over default parameter values
+    for key in p_def:
+
+        # Process if help string exists
+        if key in help_strings:
+
+            # Set short option
+            if key in short_options:
+                short = short_options[key]
+            else:
+                # Default is no short option
+                short = ''
+
+            # Set type
+            if key in types:
+                typ = types[key]
+            else:
+                # Default is str
+                typ = 'string'
+
+            # Special case: bool type
+            if typ == 'bool':
+                parser.add_option(
+                    f'{short}',
+                    f'--{key}',
+                    dest=key,
+                    default=False,
+                    action='store_true',
+                    help=help_strings[key].format(p_def[key]),
+                )
+            else:
+                parser.add_option(
+                    short,
+                    f'--{key}',
+                    dest=key,
+                    type=typ,
+                    default=p_def[key],
+                    help=help_strings[key].format(p_def[key]),
+                )
+
+    # Add verbose option
+    parser.add_option(
+        '-v',
+        '--verbose',
+        dest='verbose',
+        action='store_true',
+        help=f'verbose output'
+    )
+
+    options, args = parser.parse_args()
+
+    return options

cs_util/tests/test_args.py

@@ -0,0 +1,63 @@
+"""UNIT TESTS FOR ARGS SUBPACKAGE.
+
+This module contains unit tests for the args subpackage.
+
+"""
+
+import os
+
+import numpy as np
+from numpy import testing as npt
+
+from unittest import TestCase
+
+from cs_util import args
+
+class ArgsTestCase(TestCase):
+    """Test case for the ``args`` module."""
+
+    def setUp(self):
+        """Set test parameter values."""
+        self._params_def = {
+           "p_int" : 1,
+           "p_float" : 0.612,
+           "p_bool" : True,
+           "p_str" : "some_string",
+           "p_str_def" : "second_string",
+           "p_none" : "",
+        }
+        self._types = {
+            "p_int"  : "int",
+            "p_float" : "float",
+            "p_bool" : "bool",
+            "p_str" : "str",
+        }
+        self._short_options = {
+            "p_int" : "-i",
+            "p_float" : "-f",
+            "p_bool" : "-b",
+            "p_str" : "-s",
+        }
+        self._help_strings = {
+            "p_int" : "integer option, default={}",
+            "p_float" : "float option, default={}",
+            "p_bool" : "bool option, default={}",
+            "p_str" : "string option, default={}".
+        }
+
+    def tearDown(self):
+        """Unset test parameter values."""
+        self._params_def = None
+        self._types = None
+        self._short_options = None
+        self._help_strings = None
+
+    def test_parse_options(self):
+        """Test `cs_util.args.parse_options` method."""
+        options = args.parse_options(
+            self._params_def,
+            self._short_options,
+            self._types,
+            self._help_strings
+        )
+        print(options)