generaloption: deprecated SimpleOption descr argument

Author: stdweird

lib/vsc/utils/generaloption.py

@@ -1706,7 +1706,7 @@ class SimpleOptionParser(ExtOptionParser):
 class SimpleOption(GeneralOption):
     PARSER = SimpleOptionParser
 
-    def __init__(self, go_dict=None, short_groupdescr=None, long_groupdescr=None, config_files=None):
+    def __init__(self, go_dict=None, descr=None, short_groupdescr=None, long_groupdescr=None, config_files=None):
         """Initialisation
         @param go_dict : General Option option dict
         @param short_descr : short description of main options
@@ -1735,13 +1735,18 @@ def __init__(self, go_dict=None, short_groupdescr=None, long_groupdescr=None, co
 
         super(SimpleOption, self).__init__(**kwargs)
 
+        if descr is not None:
+            # TODO: as there is no easy/clean way to access the version of the vsc-base package,
+            # this is equivalent to a warning
+            self.log.deprecated('SimpleOption descr argument', '2.5.0', '3.0.0')
+
     def main_options(self):
         if self.go_dict is not None:
             prefix = None
             self.add_group_parser(self.go_dict, self.descr, prefix=prefix)
 
 
-def simple_option(go_dict=None, short_groupdescr=None, long_groupdescr=None, config_files=None):
+def simple_option(go_dict=None, descr=None, short_groupdescr=None, long_groupdescr=None, config_files=None):
     """A function that returns a single level GeneralOption option parser
 
     @param go_dict : General Option option dict
@@ -1755,4 +1760,4 @@ def simple_option(go_dict=None, short_groupdescr=None, long_groupdescr=None, con
 
     the generated help will include the docstring
     """
-    return SimpleOption(go_dict=go_dict, short_groupdescr=short_groupdescr, long_groupdescr=long_groupdescr, config_files=config_files)
+    return SimpleOption(go_dict=go_dict, descr=descr, short_groupdescr=short_groupdescr, long_groupdescr=long_groupdescr, config_files=config_files)

test/run.py

@@ -87,7 +87,7 @@ def test_timeout(self):
         self.assertEqual(RUNRUN_TIMEOUT_OUTPUT, output, msg='longsleep expected output')
         self.assertTrue(stop - start < timeout + 1, msg='longsleep timeout within margin')  # give 1 sec margin
 
-        # run_nested is also 10 seconds sleep
+        # run_nested is 15 seconds sleep
         # 1st arg depth: 2 recursive starts
         # 2nd arg file: output file: format 'depth pid' (only other processes are sleep)
 
@@ -114,8 +114,8 @@ def do_test(kill_pgid):
             self.assertEqual(ec, RUNRUN_TIMEOUT_EXITCODE, msg='run_nested kill_pgid %s stopped due to timeout'  % kill_pgid)
             self.assertTrue(stop - start < timeout + 1, msg='run_nested kill_pgid %s timeout within margin' % kill_pgid)  # give 1 sec margin
             # make it's not too fast
-            time.sleep(1)
-            # there's now 5 seconds to complete the remainder
+            time.sleep(5)
+            # there's now 6 seconds to complete the remainder
             pids = range(depth+1)
             # normally this is ordered output, but you never know
             for line in open(res_fn).readlines():

test/runtests/run_nested.sh

@@ -3,7 +3,7 @@
 depth=${1:-1}
 path=${2:-/dev/null}
 
-mysleep=10
+mysleep=15
 
 echo "$depth $$ $PPID" >> $path