Changeset 759

Timestamp:

07/21/07 00:49:41 (1 year ago)

Author:

robin

Message:

--

Files:

• pyrun/trunk/README.txt (modified) (3 diffs)
• pyrun/trunk/examples/_testutils.py (added)
• pyrun/trunk/examples/discover_and_run.html (modified) (8 diffs)
• pyrun/trunk/examples/discover_and_run.rst (modified) (8 diffs)
• pyrun/trunk/pkg-info.rst (modified) (1 diff)
• pyrun/trunk/pyrun.html (modified) (6 diffs, 1 prop)
• pyrun/trunk/pyrun.rst (modified) (1 diff)

pyrun/trunk/README.txt

@@ -16 +16 @@
-  ``python ~/pyrun.py  ~/my/python/libs ~/my/python/scripts/go.py``
-
-' module with a sys.path automatically
-
-
-
-path will not contain any duplicates. Each entry in the path extension will b
-
+` module with a sys.path
+
+
+
+built. The resulting path will not contain any duplicates. Each entry in th
+path extension will be 
-
- * It is a directory on the file system with one or more child directories
@@ -28 +28 @@
- * OR It is an egg path
-
-
-
-python module files are included in the arguments then pyrun will 'run' th
-ast one listed. sys.path and sys.argv are adjusted so that your module is
-
-for 
+e
+ python
+module files are included in the arguments then pyrun will 'run' the first on
+isted. `sys.path` and `sys.argv` are adjusted so that your module is the
+
+
-
-
+l
-immediately after the module name then you can use `--` to explicitly delimit
-the end of the arguments to pyrun. For example, the distribution
@@ -49 +49 @@
-For egg paths only the *best* version of each egg is allowed onto the extended
-path, and only if the egg is compatible with the current `sys.executable`
- 
+
-the pkg_resources.py module distributed by the setuptools project.
-
-
-
-if you have time on 
+
+
+
-
-
-The issue tracker for this package can be found at:
-
-
-
+
+
-
-Provides facilities which are generally useful for implementing command line
-interfaces and utilities.

pyrun/trunk/examples/discover_and_run.html

@@ -290 +290 @@
-<h1 class="title">discover_and_run</h1>
-
+<p>All of the command line programs provided by this package are essentially thin
+wrappers around the <cite>pyrun.discover_and_run</cite> function. This section provides
+<cite>doctest</cite> based discussion and examples. These examples are also part of the
+pyrun test suite.</p>
-<p>Lets setup a fake set of python packages and use it to illustrate some basics.</p>
-<blockquote>
@@ -295 +299 @@
-&gt;&gt;&gt; import os, sys
-&gt;&gt;&gt; from os.path import join
-&gt;&gt;&gt; from tempfile import mkdtemp
-&gt;&gt;&gt; from distutils.dir_util import mkpath
-&gt;&gt;&gt; import pyrun
-tmpdir = mkdtemp(prefix='pyrun-tmp')
+from _testutils import mktmpfiles, printpaths
-&gt;&gt;&gt; sysver_cur = sys.version[:3]
-&gt;&gt;&gt; sysver_notcompatible = '.'.join(map(str,
-...   [sys.version_info[0], sys.version_info[1] + 1]))
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
-</pre>
-</blockquote>
@@ -331 +323 @@
-<pre class="doctest-block">
-&gt;&gt;&gt; pth, minfos, ia = pyrun.discover_and_run(['pyrun', tmpdir], run_module=False)
-
-
+
+
+
+
+
-</pre>
-</blockquote>
@@ -342 +337 @@
-...     join(tmpdir, 'B'), tmpdir], run_module=False
-...     )
-
-
-
+
+
+
+
+
-</pre>
-</blockquote>
@@ -353 +350 @@
-&gt;&gt;&gt; pth, minfos, ia = pyrun.discover_and_run(['pyrun', tmpdir,
-...     join(tmpdir, 'Modules', 'module_a.py')], run_module=False)
-
-
-
+
+
+
+
+
+
-</pre>
-</blockquote>
@@ -365 +365 @@
-...     join(tmpdir, 'Modules', 'module_a.py'),
-...     join(tmpdir, 'Modules', 'module_b.py')], run_module=False)
-
-
-
+
+
+
+
+
+
-</pre>
-</blockquote>
@@ -379 +382 @@
-viable, especialy given the module loading facilities in the runpy standard
-lib module. I suspect the &quot;force to front&quot; rule is essential for covering
-
-
+</p>
+<p>
-because the discovery of eggs does not look at egg contents - only file and
-directory names.</p>
-<blockquote>
-<pre class="doctest-block">
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-<blockquote>
-<pre class="doctest-block">
-&gt;&gt;&gt; pth, minfos, ia = pyrun.discover_and_run(['pyrun', tmpdir], run_module=False)
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-<blockquote>
-<pre class="doctest-block">
@@ -414 +419 @@
-...     join(tmpdir, 'B'), tmpdir], run_module=False
-...     )
-
-
-
+
+
+
+
+
+
+
-</pre>
-</blockquote>

pyrun/trunk/examples/discover_and_run.rst

@@ -1 +1 @@
-discover_and_run
-................
+
+All of the command line programs provided by this package are essentially thin
+wrappers around the `pyrun.discover_and_run` function. This section provides
+`doctest` based discussion and examples. These examples are also part of the
+pyrun test suite.
-
-Lets setup a fake set of python packages and use it to illustrate some basics.
@@ -6 +11 @@
-    >>> import os, sys
-    >>> from os.path import join
-    >>> from tempfile import mkdtemp
-    >>> from distutils.dir_util import mkpath
-    >>> import pyrun
-tmpdir = mkdtemp(prefix='pyrun-tmp')
+from _testutils import mktmpfiles, printpaths
-    >>> sysver_cur = sys.version[:3]
-    >>> sysver_notcompatible = '.'.join(map(str,
-    ...   [sys.version_info[0], sys.version_info[1] + 1]))
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-This search gives an os dependent ordering of all packages under A and B
@@ -40 +34 @@
-
-    >>> pth, minfos, ia = pyrun.discover_and_run(['pyrun', tmpdir], run_module=False)
-
-
+
+
+
+
+
-
-This search forces paths under 'B' to be considered first, again note that
@@ -49 +46 @@
-    ...     join(tmpdir, 'B'), tmpdir], run_module=False
-    ...     )
-
-
-
+
+
+
+
+
-
-Modules is not present in either of the above resulting paths because python
@@ -58 +57 @@
-    >>> pth, minfos, ia = pyrun.discover_and_run(['pyrun', tmpdir,
-    ...     join(tmpdir, 'Modules', 'module_a.py')], run_module=False)
-
-
-
+
+
+
+
+
+
-
-This search mentions two module files explicitly, in addition to the root
@@ -68 +70 @@
-    ...     join(tmpdir, 'Modules', 'module_a.py'),
-    ...     join(tmpdir, 'Modules', 'module_b.py')], run_module=False)
-
-
-
+
+
+
+
+
+
-
-The discovery algorithm currently forces paths discovered from module files
@@ -79 +84 @@
-directory does not cause duplicates.
-More elaborate schemes for addressing the shadowning problem are definitely
-
+l
-lib module. I suspect the "force to front" rule is essential for covering
-*my* use case which is "just fix my path and run that script damit!"
+
+
-Lets drop some eggs into the mix. We dont use real eggs for these examples
-because the discovery of eggs does not look at egg contents - only file and
-directory names.
-
-
-
-
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-
-
+
+
-
-    >>> pth, minfos, ia = pyrun.discover_and_run(['pyrun', tmpdir], run_module=False)
-
-
-
+
+
+
+
+
+
+
-
-The
+A
-
-    >>> pth, minfos, ia = pyrun.discover_and_run(['pyrun',
-    ...     join(tmpdir, 'B'), tmpdir], run_module=False
-    ...     )
-
-
-
+
+
+
+
+
+
+
-
-Note that irrespective which order we visit the A and B sub trees, we always
@@ -124 +138 @@
-interpreter. But, for now, no special care is taken to deal with platform
-specific eggs (linux-i686 vs whatver windows eggs use.)
+
+

pyrun/trunk/pkg-info.rst

@@ -5 +5 @@
-:Author-email: robinbryce@gmail.com
-:Requires-Python: 2.5
-sys.path discovery and execution of python modules and packages. 
+A convenient way to run python modules, packages and scripts with a dynamically discovered sys.path. Particularly useful when you want to make use of packages without installing them first, or to circumvent bootstrapping issues with complicated collections of python software.
-:Copyright: `Copyright (c) 2007 Robin Bryce, All rights reserved`_
-:URL: http://trac.wiretooth.com/public/wiki/pyrun

pyrun/trunk/pyrun.html

@@ -330 +330 @@
-<div class="abstract topic">
-<p class="topic-title first">Abstract</p>
-sys.path discovery and execution of python modules and packages
+A convenient way to run python modules, packages and scripts with a dynamically discovered sys.path. Particularly useful when you want to make use of packages without installing them first, or to circumvent bootstrapping issues with complicated collections of python software
-</div>
-<div class="contents topic">
@@ -336 +336 @@
-<ul class="simple">
-<li><a class="reference" href="#pyrun" id="id1" name="id1">pyrun</a></li>
-
-
+
+
+
+
+
-</ul>
-</div>
@@ -354 +357 @@
-``python ~/pyrun.py  ~/my/python/libs ~/my/python/scripts/go.py``
-</pre>
-' module with a sys.path automatically
-
-
-
-path will not contain any duplicates. Each entry in the path extension will b
-
+</cite> module with a sys.path
+
+
+
+built. The resulting path will not contain any duplicates. Each entry in th
+path extension will be 
-<blockquote>
-<ul class="simple">
@@ -368 +371 @@
-</ul>
-</blockquote>
-
-
-python module files are included in the arguments then pyrun will 'run' th
-ast one listed. sys.path and sys.argv are adjusted so that your module is
-
-for 
-
+e
+ python
+module files are included in the arguments then pyrun will 'run' the first on
+isted. <cite>sys.path</cite> and <cite>sys.argv</cite> are adjusted so that your module is the
+
+
+l
-immediately after the module name then you can use <cite>--</cite> to explicitly delimit
-the end of the arguments to pyrun. For example, the distribution
@@ -389 +392 @@
-version. The measure of <cite>best egg</cite> uses the same algorithm as used by
-the pkg_resources.py module distributed by the setuptools project.</p>
-But, NOTE that the current version does not filter out incompatible
-
-if you have time on 
+NOTE: The current version does not filter out incompatible <cite>platforms</cite> for eggs
+
+
-<p>The issue tracker for this package can be found at:
-
-
-
-
+
+
-</div>
-<div class="section">
@@ -403 +404 @@
-convenience scripts. You can access the most commonly useful features of
-pyrun, without installing the package, by running the pyrun.py file directly.</p>
-</div>
-<div class="section">
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-<p>NEXTREVISION</p>
-<blockquote>

pyrun/trunk/pyrun.rst

@@ -10 +10 @@
-.. include:: INSTALL.txt
-
+.. include:: examples/discover_and_run.rst
+
-.. include:: ChangeLog
-