Changeset 82

Timestamp:

06/29/06 20:11:31 (3 years ago)

Author:

robin

Message:

--

Files:

• optrun/trunk/lib/optrun/cliapi.py (modified) (4 diffs)
• optrun/trunk/lib/optrun/clitool.py (modified) (14 diffs)
• optrun/trunk/lib/optrun/noseplug.py (added)

optrun/trunk/lib/optrun/cliapi.py

@@ -4 +4 @@
-__all__=(
-        'COMMON_OPTS fmt_msg get_log get_program_name '
-
+
+
-        'build_parser run_wrapper run_common '
-        ).split()
-
-
+, types
-
-COMMON_OPTS=[
@@ -50 +51 @@
-            opt.append({})
-        parser.add_option(*opt[:-1], **opt[-1])
+
+def prune_shortopts(options):
+    for opt in options:
+        if opt[0].startswith('--'):
+            if len(opt) > 2:
+                yield (opt[0],) + opt[2:]
+            else:
+                yield opt
+        elif len(opt) > 2:
+            yield opt[1:]
+        # else: only a short option was provided, so prune the complete option
+        # DO NOT guess based on opt[2]['dest']
+
+def prefix_longopts(prefix, options, applytodestname=True):
+    """decorate each option by inserting prefix after the '--'
+
+    If the optparse kwargs contain `dest` and `applytodestname` is True
+    then the prefix is also applied to the `dest` kw value. Otherwise,
+    we leave it to optparse (it will define `dest` based on the 
+    longopt name by default, and as we decorate before calling `add_option`
+    everything works out. be aware that if you set `applytodest` to False
+    AND you use need the reverse transform YOU are responsible for 
+    normalising the option value attribute names prior to performing 
+    the reverse transform).
+    
+    NOTE: assumes options does not contain any short options. see
+    `prune_shortopts`
+    """
+    for opt in options:
+        if applytodestname:
+            opt[1].__setitem__('dest',
+                '%s%s' % (prefix.lower().replace('-','_'), 
+                    opt[1].get('dest',
+                        opt[0][2:].lower().replace('-','_'))))
+        yield ('--%s%s' % (prefix, opt[0][2:]),) + opt[1:]
-
-def update_options(optlista, optlistb):
@@ -171 +207 @@
-    return parser
-
+def option_defaults(notsetmarker=AttributeError, *optlists):
+    """Extracts the default values from a set of option lists.
+
+    returns a type instance that has attributes corresponding to each
+    of the unique options in optlists. both long and short options are 
+    reflected.eg., ::
+
+        options = option_defaults(
+            [('-q','--quiet', dict(default=True),
+             ('-v','--Verbose-Output', dict(default=False)],
+            [('-u','--user', dict(default='anon'),
+             ('--host', '-h' dict(default='localhost')),
+             ('-P', dict(default='8080')),
+             ('--password', dict())])
+        assert options.q == True and options.quiet is options.q
+        # case is *NOT* preserved on long options, and '-' becomes '_'
+        assert options.v == False and options.verbose_output is options.v
+        assert options.u == 'anon' and options.user is options.u
+        assert options.h == 'localhost' and options.host is options.h
+        assert options.P == '8080' # case is preserved on short options.
+        assert not hasattr(options, 'password')
+        # if any value for which `value is AttributeError` evaluates false
+        # as the first argument to option_defaults then you can avoid
+        # AttributeError for options that have no default specified.
+
+    the type instance is created as `type('options', (), defaults)` where
+    defaults is the dictionary of default values keyed by short options and
+    long options with the leanding '-' chars removed and underscores replaced
+    with '_'. 
+    
+    **NOTE** All long options names are filtered through `lower`, short options
+    are NOT.
+        
+    `notsetmarker`: If `notsetmarker` *is* AttributeError, then no value
+    is set on the returned object. If you attempt to read the value you
+    will get `AttributeError` from the python runtime. 
+
+    IN ALL OTHER CASES, ie notsetmarker *is not* AttributeError, the 
+    value of `notsetmarker` is set on the returned instance.
+
+    """
+    
+    optlist=reduce(update_options, optlists)
+    defaults={}
+    for opt in optlist:
+        loptk=shoptk=None
+        if opt[0].startswith('--'):
+            loptk=opt[0][2:].lower().replace('-','_')
+            if len(opt) > 2:
+                shoptk=opt[1][1:] # dont lower, and assume len(opt[1]) == 2
+                default=opt[2].get('default', notsetmarker)
+            else:
+                default=opt[1].get('default', notsetmarker)
+        elif opt[0].startswith('-'):
+            shoptk=opt[0][1:] # dont lower, and assume len(opt[1]) == 2
+            if len(opt) > 2:
+                loptk=opt[1][2:].lower().replace('-','_')
+                default=opt[2].get('default', notsetmarker)
+            else:
+                default=opt[1].get('default', notsetmarker)
+        else:
+            raise ValueError, (
+                'One or more argument optlist have incorrect '
+                'format.'
+                )
+        if default is AttributeError:
+            continue
+        if loptk:
+            defaults[loptk]=default
+        if shoptk:
+            defaults[shoptk]=default
+    return type('options',(),defaults)
+
-
-def run_common(argv, commandmap, msgfmtmap=dict(
@@ -211 +320 @@
-    options, args = parser.parse_args(argv[1:])
-    runner, runxargs, runxkwargs = commandmap[command][4:]
-prog
+get_prog_name()
- 
-

optrun/trunk/lib/optrun/clitool.py

@@ -1 +1 @@
-#!/usr/bin/env python
+import signal,errno
-import os, sys, optparse, logging, itertools
-
-from optrun.cliapi import *
-
+__all__=(
+        'pidfile_name write_pidfile read_pidfile pollpid_unix kill_unix '
+        'daemonize_posix '
+        'start_unix start_unix_not_optrun stop_unix main_unix_boilerplate '
+        'minimal_daemon_example '
+        'COMMON_UNIX_OPTS START_UNIX_OPTS STOP_UNIX_OPTS MAIN_UNIX_OPTS '
+        #COMMANDMAP is typicaly defined by many modules so its not included in
+        #all
+        ).split()
-
-def pidfile_name(options, program=None):
-options.pidfile
+getattr(options, 'pidfile', None)
-    if not pidfile:
-        if program is not None:
@@ -13 +23 @@
-            argv=sys.argv
-        program = get_program_name(argv)
-options.pidfile_prefix
+getattr(options, 'pidfile_prefix', '')
-    return pidfile
-
@@ -21 +31 @@
-        pidf.write(str(pid))
-        pidf.close()
-True
+(os.path.abspath(pidfile), True)
-    except IOError, e:
-        if log:
-            log.warning(str(e))
-
-
-
-
-
-
+
+
+
-    if pidfile and os.path.exists(pidfile):
-        try:
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    else:
-
-
-
+
+
+
+
+
+
+
-        if readpidfile:
-            log.info("killing pid [%s], read from [%s]" % (pid,pidfile))
@@ -48 +100 @@
-            os.kill(pid, getattr(signal, killsignalname))
-        except OSError, e:
-
+ and allwaysremovestalepidfile
-                log.info("removing stale pidfile [%s], process [%s] is gone" % (
-                        pidfile, pid))
-                os.remove(pidfile)
+                haveremovedpidfile = True
-            elif e[0] == errno.ESRCH:
-                log.info("process [%s] is gone" % pid)
+        if removepidfile and readpidfile and not haveremovedpidfile:
+            os.remove(pidfile)
-    return pidfile
-
@@ -86 +141 @@
-        for ifirst,a in enumerate(sys.argv):
-            if a == args[0]:
-
+
+
+
-                break
-        assert ifirst
+        # if the sub command is not found in sys.argv the caller has
+        # intercepted start and munged args
+        if ifirst == len(sys.argv) - 1 and sys.argv[ifirst] != args[0]:
+            ifirst = len(sys.argv)
-        args = args[:2] + sys.argv[2:ifirst] + args[2:]
-    log.info("launching [%s] len(args)=%s, args: %s" % (
@@ -100 +161 @@
-    return 0
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
-def start_unix_not_optrun(progname, options, args, conf):
-    """start a process that does not support 'optrun' main options"""
@@ -154 +181 @@
- 
-def stop_unix(progname, options, args, conf):
-
-
+
+
+
-        print ('1st argument must be the program name, '
-                'ie., the first argument passed to start, OR '
@@ -162 +190 @@
-        return -1
-    # prefer pidfile
-Non
+prognam
-    if not options.firstarg_is_not_pid: # incase the command *is* a number
-        try:
@@ -180 +208 @@
-    first order of business
-    """
-args
+progname
-    pidfile = pidfile_name(options, progname)
-    if options.daemonize:
@@ -190 +218 @@
-    return 0
-
-
+
+
-    def main(progname, options, args, conf):
-
+
+
+
-        from time import time, sleep
-        try:
@@ -224 +255 @@
-STOP_UNIX_OPTS=[
-    ('--pid',dict(default=None,help='process id to kill',type='int')),
+    ('--pidfile-prefix',dict(default='optrun')),
+    ('--pidfile',dict(default=None,help='where to persist the process id')),
+ 
-    ('--firstarg-is-not-pid', dict(default=False, action='store_true',
-        help='if your program is an executable file whose name '
@@ -233 +267 @@
-
-COMMANDMAP = dict(
-(
+[
-        build_parser, (dict(
-            usage='''usage: %prog mainopts | %prog main mainopts'''),
-            COMMON_OPTS, COMMON_UNIX_OPTS, START_UNIX_OPTS, 
-            MAIN_UNIX_OPTS), {},
-)
-(
+]
+[
-        build_parser, (dict(
-            usage="""\
@@ -247 +281 @@
-eg., %prog start -- echo 'trvial subprocess'"""),
-           COMMON_OPTS, COMMON_UNIX_OPTS, START_UNIX_OPTS), {},
-)
-(
+]
+[
-        build_parser, (dict(
-            usage="""\
@@ -255 +289 @@
-stop a unix program"""),
-            COMMON_OPTS, COMMON_UNIX_OPTS, STOP_UNIX_OPTS), {},
-)
-
+]
+
-def run(argv=None):
-   run_common(argv, COMMANDMAP)
-
-
-if __name__=='__main__':
-    run()
+
+if 0:
+    keepopts = dict([a.split('=')[0] for a in args[1:] if not a[0] == '-'])
+    forwardargs = []
+    for opt in itertools.chain(
+        COMMON_OPTS, COMMON_UNIX_OPTS, START_UNIX_OPTS, MAIN_UNIX_OPTS):
+        # think optparse supports both shortopt, longopt, and longopt, shortopt
+        # as the first two arguments so we don't predjudice that by defining
+        # the order here by implication of our test logic.
+        longopt=None
+        shortopt=None
+        if opt[0][1] == '-':
+            longopt=opt[0]
+        else:
+            shortopt=opt[0]
+        if not isinstance(opt[1], dict):
+            if opt[1][1] == '-':
+                assert not longopt
+                longopt=opt[1]
+            else:
+                assert not shortopt
+                shortopt=opt[1]
+            shortopt=opt[1]
+        if longopt in keepopts or shortopt in keepopts:
+            continue
+        value = (longopt and options.get_option(longopt) or
+                 shortopt and options.get_option(shortopt))
+        if longopt and shortopt or longopt:
+            forwardargs.append("%s=%s" % (longopt, str(value)))
+        else:
+            forward
+        value=options.get_option(opt[0]) or options.get_option(o1)
+        forwardargs.append(opt[0])
+        if o1 is not opt[0]:
+            forwardopts.append(opt[1])
+