Changeset 807

Timestamp:

05/12/08 08:45:53 (8 months ago)

Author:

robin

Message:

merge changes from hg tip

Files:

• pyrun/trunk/pyrun.html (modified) (3 diffs)
• pyrun/trunk/pyrun.py (modified) (11 diffs)
• pyrun/trunk/pyrun.rst (modified) (1 diff)

pyrun/trunk/pyrun.html

@@ -297 +297 @@
-<tr class="field"><th class="docinfo-name">License:</th><td class="field-body">MIT</td>
-</tr>
-pyrun
+runtools
-</tr>
-<tr><th class="docinfo-name">Version:</th>
-1.1b
+0.2.dev
-<tr><th class="docinfo-name">Author:</th>
-<td>Robin Bryce</td></tr>
@@ -310 +310 @@
-<tr><th class="docinfo-name">Copyright:</th>
-<td><a class="first last reference" href="#copyright-c-2007-robin-bryce-all-rights-reserved">Copyright (c) 2007 Robin Bryce, All rights reserved</a></td></tr>
-<tr class="field"><th class="docinfo-name">URL:</th><td class="field-body"><a class="reference" href="http://trac.wiretooth.com/public/wiki/pyrun">http://trac.wiretooth.com/public/wiki/pyrun</a></td>
-</tr>
-<tr class="field"><th class="docinfo-name">Download-URL:</th><td class="field-body"><a class="reference" href="http://svn.wiretooth.com/svn/open/pyrun/trunk/pyrun.py">http://svn.wiretooth.com/svn/open/pyrun/trunk/pyrun.py</a></td>
-</tr>
-<tr class="field"><th class="docinfo-name">Classifiers:</th><td class="field-body">License :: OSI Approved :: MIT License</td>
-</tr>
@@ -674 +670 @@
-<h1><a class="toc-backref" href="#id5" id="changelog" name="changelog">ChangeLog</a></h1>
-<dl class="docutils">
+<dt>0.1.2:</dt>
+<dd>Changed distribution project name to runtools. pyrun remains as a standalone
+script. The runtools package contains a number of utilities that are commonly
+usefull in conjunction with pyrun.</dd>
-<dt>0.1.1:</dt>
-<dd><ul class="first last">

pyrun/trunk/pyrun.py

@@ -2 +2 @@
-# Copyright (c) 2007 Robin Bryce
-# Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php
+"""\
+%prog  [-nidDpP] [BASEPATH(s)][-m mod.name | '--'] [TARGET-OPTIONS]
+
+Discover python packages and modules under BASEPATH(s). Run the first module
+file named in `BASEPATH(s)` *OR* explicitly nominated using the `-m` option.
+
+In most cases the solo '--' is not required. It tends to be useful when you
+implicitly select the module to run AND you want to pass a non option argument
+as the first value in the command line for that module. It can also be
+necessary when the target module has short options, without long-name
+alternatives, which collide with those defined for pyrun.
+
+NOTE: Any option that is marked [NYI] is Not Yet Implemented."""
+
-
-import os, sys, types, re, traceback, inspect, imp, compiler
-
-
-
+
+
+
+
+
-
-import logging
@@ -17 +34 @@
-except ImportError:
-    pass
+
+
+OPTIONS_runex=[
+('--log-level', dict(default='WARNING', metavar='LEVEL', help=
+"""[default:%default] set the logging level, any string which names
+a log level which is defined by the logging package is allowed.
+For example any of CRITICAL, WARNING, INFO and DEBUG (in
+increasing order of verbosity)""")),
+('-q', dict(default=False, action='store_true', metavar='QUIET', help=
+"""Suppress all warnings about missing paths etc. Useful when you are
+using speculative paths and are using -p or -P to print the discoverd
+path.""")),
+
+('-p', dict(default=False, action='store_true', metavar='PRINTPATH', help=
+"Print the discovered path")),
+
+('-P', dict(default=False, action='store_true', metavar='PRINTPATH', help=
+"Print the discovered path in a PYTHONPATH compatible format")),
+
+
+('-n', dict(default=False, action='store_true', metavar='NORUN', help=
+"""NORUN. Don't run any of the modules implied by module file references in
+ the discovery path.""")),
+
+('-C', dict(default=None, type='string', metavar='SCRIPT', help=
+"""Identify a *python* SCRIPT to execute. The script need not have file
+extension but it must contain leagal python code. This option trumps -m. This
+option should only be necessary when the launcher for the python program you
+wish to run contains significant functionality. No additions are made to the
+discovery path or sys.path as a result of using this option. If the target
+script imports a related package you will need to include additional non option
+arguments to discover its path.""")),
+
+('-m', dict(default='', metavar='MODULE', help=
+"Explicitly select a module to run. (trumped by -S)")),
+
+('-d', dict(default=False, action='store_true', metavar='DEBUG', help=
+"""DEBUG session. Use `pdb.runeval` on the module code in order to enter
+an interactive debug session at the first python statement of the
+target module""")),
+
+('-D', dict(default=False, action='store_true', metavar='DEBUG', help=
+"""POSTMORTEM debugging. If the target raises an exception, start a
+    postmortem pdb debugging session.""")),
+
+('-i', dict(default=False, action='store_true', metavar='INTERACTIVE', help=
+"INTERACTIVE session with prepared sys.argv and sys.path.")),
+
+('-c', dict(default=False, metavar='STATEMENT', help=
+"""Update sys.argv and sys.path then execute the statement in a new, clean,
+module context.""")),
+
+('-x', dict(default="", metavar='EXCLUDE', help=
+"""Exclude one or more directories, separated by "%s", from the discovery
+path.""" % os.pathsep)),
+('-X', dict(default=[], metavar='PRUNE', action="append", type="string", help=
+"""Prune all paths which contain this value from the set of paths which *were*
+discovered. Specify multiple -X options if you wish too prune based on
+more than one string."""))
+
+    ]
-
-
@@ -288 +366 @@
-    def allow_descent(path):
-        for e in exclude:
-
+
+
-                log.info('Excluding: "%s" as it startswith "%s"' % (
-                    path, e
@@ -468 +547 @@
-                pthextend.extend(newpaths)
-                findpaths[:] = []
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-            continue
-
@@ -674 +754 @@
-the sys.argv the module sees."""
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    argv.insert(0, None)
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
-    if opts.x:
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
-    try:
-        source = False
@@ -753 +857 @@
-        pthextend, minfos, ia, doesnotexist = discover_path(
-                exclude, 1, *argv)
-
-        if not opts.q and doesnotexist:
-            log.warning(striplines('''\
-            Warning: your discovery path arguments referenced the following
-
+\
-            ''')
-            )
-
-
+
-
-        # If there are no unconsumed arguments: We have already determined
-        # the user does not want to run a module. So we are done.
-        inferior_argv = get_inferior_argv(
-flagOPTIONS_runex
+_get_flag_opts()
-
-        if opts.c and opts.C and not opts.q:
@@ -785 +887 @@
-        # prune and paths which contain *non empty* strings spefcified by -X
-        for X in prune:
-
-
-
-
-
-
-
+
-
-        # Allways update the sys path. pthextend is the record of what we have
@@ -847 +943 @@
-            import code
-            code.interact(banner=banner, local=locals())
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-        if not (opts.n or opts.i) and (modname or source):
-            exitval = run()
@@ -872 +973 @@
-        msg = exc_string(einfo=einfo)
-        print msg
+        # If the post mortem debug option is set (-D) and the interactive
+        # debug option (-d) is *not* set, drop into a pdb session.
-        if opts.D and not opts.d:
-            import pdb
-            pdb.post_mortem(einfo[2])
-        return -1
+
+
+def int_log_level(level):
+    """Coerce a log level to an integer.
+
+    In a manner cognizant of run time configured level names."""
+
+    try:
+        return int(level)
+    except ValueError:
+        try:
+            return getattr(logging, level)
+        except AttributeError:
+            level = logging.getLevelName(level)
+            level = logging.getLevelName(level)
+            assert isinstance(level, int)
+            return level
+
+
+def _pyrun_cl_parse_log_init(argv=None):
+    """Command line argument parsing and logging intialisation.
+
+    :Returns:
+        opts
+            optparse.OptionValues instance containing the pyrun options
+            which preceded the discover path
+        args
+            In order, pyrun discovery path, pyrun terminating options, and the
+            options and arguments for the inferior programs.
+
+    """
+    # Process the command line arguments.
+    import optparse
+    parser = optparse.OptionParser(usage=__doc__)
+    for shrt, kw in OPTIONS_runex:
+        parser.add_option(shrt, **kw)
+
+    parser.disable_interspersed_args()
+
+    opts, args = parser.parse_args(argv or sys.argv[1:])
+
+    logging.basicConfig(
+            level=int_log_level(getattr(opts, 'log_level', 'WARNING')),
+            format='%(message)s'
+            )
+    return opts, args
+
+
+def get_default_opts():
+    """Return a dictionary containing the default pyrun option values."""
+    default_opts = {}
+    for shrt, kw in OPTIONS_runex:
+        default_opts[shrt[1]] = kw['default']
+    return default_opts
+
+
+def runex(argv=None):
+    """Provides Extened `pyrun` features on the command line."""
+
+    # Process the command line arguments which appear *before* the discovery
+    # path.
+    opts, discovery_args = _pyrun_cl_parse_log_init(argv)
+    return pyrun(opts, discovery_args)
-
-
@@ -905 +1071 @@
-    return rval
-
-USAGE_runex="""\
-%prog  [-nidDpP] [BASEPATH(s)][-m mod.name | '--' | '-' ] [TARGET-OPTIONS]
-
-Discover python packages and modules under BASEPATH(s). Run the first module
-file named in `BASEPATH(s)` *OR* explicitly nominated using the `-m` option.
-BASEPATH can reference python .pth files, in which case the paths in that file
-are inserted.
-
-Note that the 'import ' lines are not supported in .pth files, that the paths
-are interpreted as relative to the directory containing the .pth file and that
-environment variables and '~' are fully expanded.
-
-In most cases the solo '--' or '-' is not required. It tends to be useful when
-you implicitly select the module to run AND you want to pass a non option
-argument as the first value in the command line for that module. It can also be
-necessary when the target module has short options, without long-name
-alternatives, which collide with those defined for pyrun.
-
-NOTE: Any option that is marked [NYI] is Not Yet Implemented."""
-
-OPTIONS_runex=[
-('--log-level', dict(default='WARNING', metavar='LEVEL', help=
-"""[default:%default] set the logging level, any string which names
-a log level which is defined by the logging package is allowed.
-For example any of CRITICAL, WARNING, INFO and DEBUG (in
-increasing order of verbosity)""")),
-('-q', dict(default=False, action='store_true', metavar='QUIET', help=
-"""Suppress all warnings about missing paths etc. Useful when you are
-using speculative paths and are using -p or -P to print the discoverd
-path.""")),
-
-('-p', dict(default=False, action='store_true', metavar='PRINTPATH', help=
-"Print the discovered path")),
-
-('-P', dict(default=False, action='store_true', metavar='PRINTPATH', help=
-"Print the discovered path in a PYTHONPATH compatible format")),
-
-
-('-n', dict(default=False, action='store_true', metavar='NORUN', help=
-"""NORUN. Don't run any of the modules implied by module file references in
- the discovery path.""")),
-
-('-C', dict(default=None, type='string', metavar='SCRIPT', help=
-"""Identify a *python* SCRIPT to execute. The script need not have file
-extension but it must contain leagal python code. This option trumps -m. This
-option should only be necessary when the launcher for the python program you
-wish to run contains significant functionality. No additions are made to the
-discovery path or sys.path as a result of using this option. If the target
-script imports a related package you will need to include additional non option
-arguments to discover its path.""")),
-
-('-m', dict(default='', metavar='MODULE', help=
-"Explicitly select a module to run. (trumped by -S)")),
-
-('-d', dict(default=False, action='store_true', metavar='DEBUG', help=
-"""DEBUG session. Use `pdb.runeval` on the module code in order to enter
-an interactive debug session at the first python statement of the
-target module""")),
-
-('-D', dict(default=False, action='store_true', metavar='DEBUG', help=
-"""POSTMORTEM debugging. If the target raises an exception, start a
-    postmortem pdb debugging session.""")),
-
-('-i', dict(default=False, action='store_true', metavar='INTERACTIVE', help=
-"INTERACTIVE session with prepared sys.argv and sys.path.")),
-
-('-c', dict(default=False, metavar='STATEMENT', help=
-"""Update sys.argv and sys.path then execute the statement in a new, clean,
-module context.""")),
-
-('-x', dict(default="", metavar='EXCLUDE', help=
-"""Exclude one or more directories, separated by "%s", from the discovery
-path.""" % os.pathsep)),
-('-X', dict(default=[], metavar='PRUNE', action="append", type="string", help=
-"""Prune all paths which contain this value from the set of paths which *were*
-discovered. Specify multiple -X options if you wish too prune based on
-more than one string."""))
-
-    ]
-
-def _get_flag_opts():
@@ -990 +1077 @@
-    )
-
-flagOPTIONS_runex=_get_flag_opts()
-
-
-if __name__=='__main__':

pyrun/trunk/pyrun.rst

@@ -6 +6 @@
-.. contents::
-
-
+_pyrun
-
-
+_pyrun
-
-Command line interface