Mailman 3 May 2005 - Python-checkins

python/nondist/peps pep-0343.txt,1.15,1.16
by gvanrossum＠users.sourceforge.net May 31, 2005

May 31, 2005

Update of /cvsroot/python/python/nondist/peps In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv18549 Modified Files: pep-0343.txt Log Message: Warn readers of coming attractions. Index: pep-0343.txt =================================================================== RCS file: /cvsroot/python/python/nondist/peps/pep-0343.txt,v retrieving revision 1.15 retrieving revision 1.16 diff -u -d -r1.15 -r1.16 --- pep-0343.txt 18 May 2005 14:24:27 -0000 1.15 +++ pep-0343.txt 31 May 2005 20:27:15 -0000 1.16 @@ -15,6 +15,14 @@ decided to withdraw PEP 340 and propose a slight variant on PEP 310. +Evolutionary Note + + After ample discussion on python-dev, I'll add back a mechanism + for raising an exception in a suspended generator using a throw() + method, and a close() method which throws a new GeneratorExit + exception. Until I get a chance to update the PEP, see reference + [2]. I'm also leaning towards 'with' as the keyword. + Motivation and Summary PEP 340, Anonymous Block Statements, combined many powerful ideas: @@ -445,6 +453,8 @@ [1] http://blogs.msdn.com/oldnewthing/archive/2005/01/06/347666.aspx + [2] http://mail.python.org/pipermail/python-dev/2005-May/053885.html + Copyright This document has been placed in the public domain.

1 0

python/dist/src/Doc/lib libstdtypes.tex, 1.179, 1.180 libfuncs.tex, 1.182, 1.183
by rhettinger＠users.sourceforge.net May 31, 2005

May 31, 2005

Update of /cvsroot/python/python/dist/src/Doc/lib In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv7415 Modified Files: libstdtypes.tex libfuncs.tex Log Message: SF bug #1209411: divmod documentation shd reference // not / Index: libstdtypes.tex =================================================================== RCS file: /cvsroot/python/python/dist/src/Doc/lib/libstdtypes.tex,v retrieving revision 1.179 retrieving revision 1.180 diff -u -d -r1.179 -r1.180 --- libstdtypes.tex 31 May 2005 10:26:28 -0000 1.179 +++ libstdtypes.tex 31 May 2005 11:03:59 -0000 1.180 @@ -256,7 +256,7 @@ \lineiii{float(\var{x})}{\var{x} converted to floating point}{} \lineiii{complex(\var{re},\var{im})}{a complex number with real part \var{re}, imaginary part \var{im}. \var{im} defaults to zero.}{} \lineiii{\var{c}.conjugate()}{conjugate of the complex number \var{c}}{} - \lineiii{divmod(\var{x}, \var{y})}{the pair \code{(\var{x} / \var{y}, \var{x} \%{} \var{y})}}{(3)(4)} + \lineiii{divmod(\var{x}, \var{y})}{the pair \code{(\var{x} // \var{y}, \var{x} \%{} \var{y})}}{(3)(4)} \lineiii{pow(\var{x}, \var{y})}{\var{x} to the power \var{y}}{} \lineiii{\var{x} ** \var{y}}{\var{x} to the power \var{y}}{} \end{tableiii} Index: libfuncs.tex =================================================================== RCS file: /cvsroot/python/python/dist/src/Doc/lib/libfuncs.tex,v retrieving revision 1.182 retrieving revision 1.183 diff -u -d -r1.182 -r1.183 --- libfuncs.tex 25 May 2005 05:39:36 -0000 1.182 +++ libfuncs.tex 31 May 2005 11:04:00 -0000 1.183 @@ -297,7 +297,7 @@ consisting of their quotient and remainder when using long division. With mixed operand types, the rules for binary arithmetic operators apply. For plain and long integers, the result is the same as - \code{(\var{a} / \var{b}, \var{a} \%{} \var{b})}. + \code{(\var{a} // \var{b}, \var{a} \%{} \var{b})}. For floating point numbers the result is \code{(\var{q}, \var{a} \%{} \var{b})}, where \var{q} is usually \code{math.floor(\var{a} / \var{b})} but may be 1 less than that. In any case \code{\var{q} *

1 0

python/dist/src/Doc/lib libstdtypes.tex, 1.170.2.8, 1.170.2.9
by rhettinger＠users.sourceforge.net May 31, 2005

May 31, 2005

Update of /cvsroot/python/python/dist/src/Doc/lib In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv21101 Modified Files: Tag: release24-maint libstdtypes.tex Log Message: SF bug #1202395: Description of string.lstrip() needs improvement Clarify the role of the chars argument in the strip() methods. Index: libstdtypes.tex =================================================================== RCS file: /cvsroot/python/python/dist/src/Doc/lib/libstdtypes.tex,v retrieving revision 1.170.2.8 retrieving revision 1.170.2.9 diff -u -d -r1.170.2.8 -r1.170.2.9 --- libstdtypes.tex 27 May 2005 10:45:14 -0000 1.170.2.8 +++ libstdtypes.tex 31 May 2005 10:28:07 -0000 1.170.2.9 @@ -699,11 +699,17 @@ \end{methoddesc} \begin{methoddesc}[string]{lstrip}{\optional{chars}} -Return a copy of the string with leading characters removed. If -\var{chars} is omitted or \code{None}, whitespace characters are -removed. If given and not \code{None}, \var{chars} must be a string; -the characters in the string will be stripped from the beginning of -the string this method is called on. +Return a copy of the string with leading characters removed. The +\var{chars} argument is a string specifying the set of characters +to be removed. If omitted or \code{None}, the \var{chars} argument +defaults to removing whitespace. The \var{chars} argument is not +a prefix; rather, all combinations of its values are stripped: +\begin{verbatim} + >>> ' spacious '.lstrip() + 'spacious ' + >>> 'www.example.com'.lstrip('cmowz.') + 'example.com' +\end{verbatim} \versionchanged[Support for the \var{chars} argument]{2.2.2} \end{methoddesc} @@ -745,11 +751,17 @@ \end{methoddesc} \begin{methoddesc}[string]{rstrip}{\optional{chars}} -Return a copy of the string with trailing characters removed. If -\var{chars} is omitted or \code{None}, whitespace characters are -removed. If given and not \code{None}, \var{chars} must be a string; -the characters in the string will be stripped from the end of the -string this method is called on. +Return a copy of the string with trailing characters removed. The +\var{chars} argument is a string specifying the set of characters +to be removed. If omitted or \code{None}, the \var{chars} argument +defaults to removing whitespace. The \var{chars} argument is not +a suffix; rather, all combinations of its values are stripped: +\begin{verbatim} + >>> ' spacious '.rstrip() + ' spacious' + >>> 'mississippi'.rstrip('ipz') + 'mississ' +\end{verbatim} \versionchanged[Support for the \var{chars} argument]{2.2.2} \end{methoddesc} @@ -791,11 +803,17 @@ \end{methoddesc} \begin{methoddesc}[string]{strip}{\optional{chars}} -Return a copy of the string with leading and trailing characters -removed. If \var{chars} is omitted or \code{None}, whitespace -characters are removed. If given and not \code{None}, \var{chars} -must be a string; the characters in the string will be stripped from -the both ends of the string this method is called on. +Return a copy of the string with the leading and trailing characters +removed. The \var{chars} argument is a string specifying the set of +characters to be removed. If omitted or \code{None}, the \var{chars} +argument defaults to removing whitespace. The \var{chars} argument is not +a prefix or suffix; rather, all combinations of its values are stripped: +\begin{verbatim} + >>> ' spacious '.strip() + 'spacious' + >>> 'www.example.com'.strip('cmowz.') + 'example' +\end{verbatim} \versionchanged[Support for the \var{chars} argument]{2.2.2} \end{methoddesc}

1 0

python/dist/src/Doc/lib libstdtypes.tex, 1.178, 1.179
by rhettinger＠users.sourceforge.net May 31, 2005

May 31, 2005

Update of /cvsroot/python/python/dist/src/Doc/lib In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv19835 Modified Files: libstdtypes.tex Log Message: SF bug #1202395: Description of string.lstrip() needs improvement Clarify the role of the chars argument in the strip() methods. Index: libstdtypes.tex =================================================================== RCS file: /cvsroot/python/python/dist/src/Doc/lib/libstdtypes.tex,v retrieving revision 1.178 retrieving revision 1.179 diff -u -d -r1.178 -r1.179 --- libstdtypes.tex 27 May 2005 10:43:55 -0000 1.178 +++ libstdtypes.tex 31 May 2005 10:26:28 -0000 1.179 @@ -699,11 +699,17 @@ \end{methoddesc} \begin{methoddesc}[string]{lstrip}{\optional{chars}} -Return a copy of the string with leading characters removed. If -\var{chars} is omitted or \code{None}, whitespace characters are -removed. If given and not \code{None}, \var{chars} must be a string; -the characters in the string will be stripped from the beginning of -the string this method is called on. +Return a copy of the string with leading characters removed. The +\var{chars} argument is a string specifying the set of characters +to be removed. If omitted or \code{None}, the \var{chars} argument +defaults to removing whitespace. The \var{chars} argument is not +a prefix; rather, all combinations of its values are stripped: +\begin{verbatim} + >>> ' spacious '.lstrip() + 'spacious ' + >>> 'www.example.com'.lstrip('cmowz.') + 'example.com' +\end{verbatim} \versionchanged[Support for the \var{chars} argument]{2.2.2} \end{methoddesc} @@ -745,11 +751,17 @@ \end{methoddesc} \begin{methoddesc}[string]{rstrip}{\optional{chars}} -Return a copy of the string with trailing characters removed. If -\var{chars} is omitted or \code{None}, whitespace characters are -removed. If given and not \code{None}, \var{chars} must be a string; -the characters in the string will be stripped from the end of the -string this method is called on. +Return a copy of the string with trailing characters removed. The +\var{chars} argument is a string specifying the set of characters +to be removed. If omitted or \code{None}, the \var{chars} argument +defaults to removing whitespace. The \var{chars} argument is not +a suffix; rather, all combinations of its values are stripped: +\begin{verbatim} + >>> ' spacious '.rstrip() + ' spacious' + >>> 'mississippi'.rstrip('ipz') + 'mississ' +\end{verbatim} \versionchanged[Support for the \var{chars} argument]{2.2.2} \end{methoddesc} @@ -791,11 +803,17 @@ \end{methoddesc} \begin{methoddesc}[string]{strip}{\optional{chars}} -Return a copy of the string with leading and trailing characters -removed. If \var{chars} is omitted or \code{None}, whitespace -characters are removed. If given and not \code{None}, \var{chars} -must be a string; the characters in the string will be stripped from -the both ends of the string this method is called on. +Return a copy of the string with the leading and trailing characters +removed. The \var{chars} argument is a string specifying the set of +characters to be removed. If omitted or \code{None}, the \var{chars} +argument defaults to removing whitespace. The \var{chars} argument is not +a prefix or suffix; rather, all combinations of its values are stripped: +\begin{verbatim} + >>> ' spacious '.strip() + 'spacious' + >>> 'www.example.com'.strip('cmowz.') + 'example' +\end{verbatim} \versionchanged[Support for the \var{chars} argument]{2.2.2} \end{methoddesc}

1 0

python/nondist/sandbox/setuptools setup.py, 1.6, 1.7
by pje＠users.sourceforge.net May 31, 2005

May 31, 2005

Update of /cvsroot/python/python/nondist/sandbox/setuptools In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv17479 Modified Files: setup.py Log Message: Release 0.3a3 Index: setup.py =================================================================== RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/setup.py,v retrieving revision 1.6 retrieving revision 1.7 diff -u -d -r1.6 -r1.7 --- setup.py 29 May 2005 22:14:30 -0000 1.6 +++ setup.py 31 May 2005 00:34:54 -0000 1.7 @@ -7,9 +7,9 @@ setup( name="setuptools", - version="0.3a2", + version="0.3a3", - description="Distutils enhancements", + description="Distutils packaging and installation enhancements", author="Phillip J. Eby", author_email="peak(a)eby-sarna.com", license="PSF or ZPL",

1 0

python/nondist/sandbox/setuptools EasyInstall.txt, NONE, 1.1 easy_install.py, 1.9, 1.10 TODO.txt, 1.3, NONE
by pje＠users.sourceforge.net May 31, 2005

May 31, 2005

Update of /cvsroot/python/python/nondist/sandbox/setuptools In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv11166 Modified Files: easy_install.py Added Files: EasyInstall.txt Removed Files: TODO.txt Log Message: Ditch outdated TODO file, move docs to a new 'EasyInstall.txt' file. Fix installation report for .egg files/directories. --- NEW FILE: EasyInstall.txt --- ============ Easy Install ============ Easy Install is a python module (``easy_install``) that lets you automatically download, build, install, and manage Python packages. (Please share your experiences with us! Whether you encountered success or difficulty installing a particular package, please add your notes to the `Experience Reports <http://peak.telecommunity.com/DevCenter/PackageNotes>`_ page. You'll need to register for a Wiki ID if you don't already have one; you can do that from the `User Preferences <http://peak.telecommunity.com/DevCenter/UserPreferences>`_ page. Thanks!) .. contents:: **Table of Contents** Using "Easy Install" ==================== Installing "Easy Install" ------------------------- Unix-like Systems (including Mac OS X and Cygwin) Download either the `Python 2.3 easy_install shell script <http://peak.telecommunity.com/dist/ez_install-0.3a3-py2.3-unix.sh>`_ or the `Python 2.4 easy_install shell script <http://peak.telecommunity.com/dist/ez_install-0.3a3-py2.4-unix.sh>`_. Place the file somewhere on your PATH, after renaming it to ``easy_install``. Note that these scripts assume you have ``python2.3`` or ``python2.4`` accessible via the ``PATH`` environment variable. Then, you can use ``easy_install`` to finish its own installation, by running one of the following, depending on your Python version:: # Python 2.3 easy_install http://peak.telecommunity.com/dist/setuptools-0.3a3-py2.3.egg # Python 2.4 easy_install http://peak.telecommunity.com/dist/setuptools-0.3a3-py2.4.egg All Other Systems Download the `easy_install (aka setuptools) source distribution <http://peak.telecommunity.com/dist/setuptools-0.3a3.zip>`_, and follow the normal procedure for installing a source package with distutils. An ``easy_install.py`` script will be installed in the normal location for Python scripts on your platform. In the examples below, you'll need to replace references to ``easy_install`` with the correct invocation to run ``easy_install.py`` on your system. If you have Python 2.4 or better, you can also use ``python -m easy_install``, which will have the same effect, but which may be easier for you to type. Downloading and Installing a Package ------------------------------------ For basic use of ``easy_install``, you need only supply the filename or URL of a source distribution or .egg file (`Python Egg`__). __ http://peak.telecommunity.com/DevCenter/PythonEggs **Example 1**. Download a source distribution, automatically building and installing it:: easy_install http://example.com/path/to/MyPackage-1.2.3.tgz **Example 2**. Install an already-downloaded .egg file:: easy_install /my_downloads/OtherPackage-3.2.1-py2.3.egg Easy Install recognizes distutils *source* (not binary) distribution files with extensions of .tgz, .tar, .tar.gz, .tar.bz2, or .zip. And of course it handles already-built .egg distributions. By default, packages are installed to the running Python installation's ``site-packages`` directory, unless you provide the ``-d`` or ``--install-dir`` option to specify an alternative directory. Packages installed to ``site-packages`` are added to an ``easy-install.pth`` file, so that Python will be able to import the package by default. If you do not want this to happen, you should use the ``-m`` or ``--multi`` option, which allows multiple versions of the same package to be selected at runtime. Note that installing to a directory other than ``site-packages`` already implies the ``-m`` option, so if you cannot install to ``site-packages``, please see the `Command-Line Options`_ section below (under ``--multi``) to find out how to select packages at runtime. Upgrading a Package ------------------- You don't need to do anything special to upgrade a package: just install the new version. If you're using ``-m`` or ``--multi`` (or installing outside of ``site-packages``), the runtime system automatically selects the newest available version of a package. If you're installing to ``site-packages`` and not using ``-m``, installing a package automatically replaces its older version in the ``easy-install.pth`` file, so that Python will import the latest version by default. ``easy_install`` never actually deletes packages (unless you're installing a package with the same name and version number as an existing package), so if you want to get rid of older versions of a package, please see `Uninstalling Packages`_, below. Changing the Active Version (``site-packages`` installs only) ------------------------------------------------------------- If you've upgraded a package, but need to revert to a previously-installed version, you can do so like this:: easy_install PackageName==1.2.3 Where ``1.2.3`` is replaced by the exact version number you wish to switch to. Note that the named package and version must already have been installed to ``site-packages``. If you'd like to switch to the latest version of ``PackageName``, you can do so like this:: easy_install PackageName This will activate the latest installed version. Uninstalling Packages --------------------- If you have replaced a package with another version, then you can just delete the package(s) you don't need by deleting the PackageName-versioninfo.egg file or directory (found in the installation directory). If you want to delete the currently installed version of a package (or all versions of a package), you should first run:: easy_install -m PackageName This will ensure that Python doesn't continue to search for a package you're planning to remove. After you've done this, you can safely delete the .egg files or directories. Reference Manual ================ Command-Line Options -------------------- ``--zip, -z`` Enable installing the package as a zip file. This can significantly increase Python's overall import performance if you're installing to ``site-packages`` and not using the ``--multi`` option, because Python process zipfile entries on ``sys.path`` much faster than it does directories. So, if you don't use this option, and you install a lot of packages, some of them may be slower to import. But, this option is disabled by default, unless you're installing from an already-built binary zipfile (``.egg`` file). This is to avoid problems when using packages that dosn't support running from a zip file. Such packages usually access data files in their package directories using the Python ``__file__`` or ``__path__`` attribute, instead of the ``pkg_resources`` API. So, if you find that a package doesn't work properly when used with this option, you may want to suggest to the author that they switch to using the ``pkg_resources`` resource API, which will allow their package to work whether it's installed as a zipfile or not. (Note: this option only affects the installation of newly-built packages that are not already installed in the target directory; if you want to convert an existing installed version from zipped to unzipped or vice versa, you'll need to delete the existing version first.) ``--multi-version, -m`` "Multi-version" mode. Specifying this option prevents ``easy_install`` from adding an ``easy-install.pth`` entry for the package being installed, and if an entry for any version the package already exists, it will be removed upon successful installation. In multi-version mode, no specific version of the package is available for importing, unless you use ``pkg_resources.require()`` to put it on ``sys.path``. This can be as simple as:: from pkg_resources import require require("SomePackage", "OtherPackage", "MyPackage") which will put the latest installed version of the specified packages on ``sys.path`` for you. (For more advanced uses, like selecting specific versions and enabling optional dependencies, see the ``pkg_resources`` API doc.) Note that if you install to a directory other than ``site-packages``, this option is automatically in effect, because ``.pth`` files can only be used in ``site-packages`` (at least in Python 2.3 and 2.4). So, if you use the ``--install-dir`` or ``-i`` options, you must also use ``require()`` to enable packages at runtime ``--install-dir=DIR, -d DIR`` Set the installation directory. It is up to you to ensure that this directory is on ``sys.path`` at runtime, and to use ``pkg_resources.require()`` to enable the installed package(s) that you need. ``--build-directory=DIR, -b DIR`` (New in 0.3a3) Set the directory used to download, extract, and install the package. The directory is not cleared before or after installation, so the downloaded packages and extracted contents will remain there afterwards, allowing you to read any documentation, examples, scripts, etc. that may have been included with the source distribution (if any). Release Notes/Change History ============================ 0.3a3 * Added ``--build-directory=DIR/-b DIR`` option. * Added "installation report" that explains how to use 'require()' when doing a multiversion install or alternate installation directory. * Added SourceForge mirror auto-select (Contributed by Ian Bicking) * Added "sandboxing" that stops a setup script from running if it attempts to write to the filesystem outside of the build area * Added more workarounds for packages with quirky ``install_data`` hacks 0.3a2 * Added subversion download support for ``svn:`` and ``svn+`` URLs, as well as automatic recognition of HTTP subversion URLs (Contributed by Ian Bicking) * Added new options to ``bdist_egg`` to allow tagging the egg's version number with a subversion revision number, the current date, or an explicit tag value. Run ``setup.py bdist_egg --help`` to get more information. * Misc. bug fixes 0.3a1 Initial release. Future Plans ============ * Support packages that include scripts * Automatic package download URL discovery via PyPI/CheeseShop Index: easy_install.py =================================================================== RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/easy_install.py,v retrieving revision 1.9 retrieving revision 1.10 diff -u -d -r1.9 -r1.10 --- easy_install.py 30 May 2005 23:52:33 -0000 1.9 +++ easy_install.py 31 May 2005 00:24:45 -0000 1.10 @@ -1,165 +1,42 @@ #!python """\ -Easy Install -============ - -Easy Install is a python module (easy_install) that lets you automatically -download, build, install, and manage Python packages. - -.. contents:: **Table of Contents** - - -Downloading and Installing a Package ------------------------------------- - -For basic use of ``easy_install``, you need only supply the filename or URL of -a source distribution or .egg file (`Python Egg`__). - -__ http://peak.telecommunity.com/DevCenter/PythonEggs - -**Example 1**. Download a source distribution, automatically building and -installing it:: - - easy_install http://example.com/path/to/MyPackage-1.2.3.tgz - -**Example 2**. Install an already-downloaded .egg file:: - - easy_install /my_downloads/OtherPackage-3.2.1-py2.3.egg - -Easy Install recognizes distutils *source* (not binary) distribution files with -extensions of .tgz, .tar, .tar.gz, .tar.bz2, or .zip. And of course it handles -already-built .egg distributions. - -By default, packages are installed to the running Python installation's -``site-packages`` directory, unless you provide the ``-d`` or ``--install-dir`` -option to specify an alternative directory. - -Packages installed to ``site-packages`` are added to an ``easy-install.pth`` -file, so that Python will be able to import the package by default. If you do -not want this to happen, you should use the ``-m`` or ``--multi`` option, which -allows multiple versions of the same package to be selected at runtime. - -Note that installing to a directory other than ``site-packages`` already -implies the ``-m`` option, so if you cannot install to ``site-packages``, -please see the `Options`_ section below (under ``--multi``) to find out how to -select packages at runtime. - -Upgrading a Package -------------------- - -You don't need to do anything special to upgrade a package: just install the -new version. If you're using ``-m`` or ``--multi`` (or installing outside of -``site-packages``), the runtime system automatically selects the newest -available version of a package. If you're installing to ``site-packages`` and -not using ``-m``, installing a package automatically replaces its older version -in the ``easy-install.pth`` file, so that Python will import the latest version -by default. - -``easy_install`` never actually deletes packages (unless you're installing a -package with the same name and version number as an existing package), so if -you want to get rid of older versions of a package, please see `Uninstalling -Packages`_, below. - - -Changing the Active Version (``site-packages`` installs only) -------------------------------------------------------------- - -If you've upgraded a package, but need to revert to a previously-installed -version, you can do so like this:: - - easy_install PackageName==1.2.3 - -Where ``1.2.3`` is replaced by the exact version number you wish to switch to. -Note that the named package and version must already have been installed to -``site-packages``. - -If you'd like to switch to the latest version of ``PackageName``, you can do so -like this:: - - easy_install PackageName - -This will activate the latest installed version. - - -Uninstalling Packages ---------------------- - -If you have replaced a package with another version, then you can just delete -the package(s) you don't need by deleting the PackageName-versioninfo.egg file -or directory (found in the installation directory). - -If you want to delete the currently installed version of a package (or all -versions of a package), you should first run:: +Easy Install +------------ - easy_install -m PackageName +A tool for doing automatic download/extract/build of distutils-based Python +packages. For detailed documentation, see the accompanying EasyInstall.txt +file, or visit the `EasyInstall home page`__. -This will ensure that Python doesn't continue to search for a package you're -planning to remove. After you've done this, you can safely delete the .egg -files or directories. +__ http://peak.telecommunity.com/DevCenter/EasyInstall +""" -Options -------- +import sys +import os.path +import pkg_resources +import re +import zipimport +import zipfile +import tarfile +import shutil +import urlparse +import urllib +import tempfile +import __builtin__ -``--zip, -z`` - Enable installing the package as a zip file. This can significantly - increase Python's overall import performance if you're installing to - ``site-packages`` and not using the ``--multi`` option, because Python - process zipfile entries on ``sys.path`` much faster than it does - directories. So, if you don't use this option, and you install a lot of - packages, some of them may be slower to import. +from distutils.sysconfig import get_python_lib +from shutil import rmtree # must have, because it can be called from __del__ +from pkg_resources import * - But, this option is disabled by default, unless you're installing from an - already-built binary zipfile (``.egg`` file). This is to avoid problems - when using packages that dosn't support running from a zip file. Such - packages usually access data files in their package directories using the - Python ``__file__`` or ``__path__`` attribute, instead of the - ``pkg_resources`` API. So, if you find that a package doesn't work properly - when used with this option, you may want to suggest to the author that they - switch to using the ``pkg_resources`` resource API, which will allow their - package to work whether it's installed as a zipfile or not. +_os = sys.modules[os.name] +_open = open - (Note: this option only affects the installation of newly-built packages - that are not already installed in the target directory; if you want to - convert an existing installed version from zipped to unzipped or vice - versa, you'll need to delete the existing version first.) -``--multi-version, -m`` - "Multi-version" mode. Specifying this option prevents ``easy_install`` from - adding an ``easy-install.pth`` entry for the package being installed, and - if an entry for any version the package already exists, it will be removed - upon successful installation. In multi-version mode, no specific version of - the package is available for importing, unless you use - ``pkg_resources.require()`` to put it on ``sys.path``. This can be as - simple as:: - from pkg_resources import require - require("SomePackage", "OtherPackage", "MyPackage") - which will put the latest installed version of the specified packages on - ``sys.path`` for you. (For more advanced uses, like selecting specific - versions and enabling optional dependencies, see the ``pkg_resources`` API - doc.) Note that if you install to a directory other than ``site-packages``, - this option is automatically in effect, because ``.pth`` files can only be - used in ``site-packages`` (at least in Python 2.3 and 2.4). So, if you use - the ``--install-dir`` or ``-i`` options, you must also use ``require()`` to - enable packages at runtime -``--install-dir=DIR, -d DIR`` - Set the installation directory. It is up to you to ensure that this - directory is on ``sys.path`` at runtime, and to use - ``pkg_resources.require()`` to enable the installed package(s) that you - need. -""" -import sys, os.path, pkg_resources, re, zipimport, zipfile, tarfile, shutil -import urlparse, urllib, tempfile, __builtin__ -from distutils.sysconfig import get_python_lib -from shutil import rmtree # must have, because it can be called from __del__ -from pkg_resources import * -_os = sys.modules[os.name] -_open = open class Installer: @@ -247,7 +124,7 @@ def install_eggs(self, dist_filename): # .egg dirs or files are already built, so just return them if dist_filename.lower().endswith('.egg'): - return self.install_egg(dist_filename,True) + return [self.install_egg(dist_filename,True)] # Anything else, try to extract and build if os.path.isfile(dist_filename): --- TODO.txt DELETED ---

1 0

python/nondist/sandbox/setuptools easy_install.py, 1.8, 1.9
by pje＠users.sourceforge.net May 30, 2005

May 30, 2005

Update of /cvsroot/python/python/nondist/sandbox/setuptools In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv26408 Modified Files: easy_install.py Log Message: Add option to allow specifying a download/extract/build directory, which will be kept after installation completes. Added an "installation report" that tells you how to use 'require()' to activate a particular package version. Installer.install_eggs() now returns a list of Distribution objects for the eggs it found and installed, so that the command-line tool can print an installation report for each one. Index: easy_install.py =================================================================== RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/easy_install.py,v retrieving revision 1.8 retrieving revision 1.9 diff -u -d -r1.8 -r1.9 --- easy_install.py 30 May 2005 23:20:34 -0000 1.8 +++ easy_install.py 30 May 2005 23:52:33 -0000 1.9 @@ -166,13 +166,15 @@ """Manage a download/build/install process""" pth_file = None + cleanup = False def __init__(self, instdir=None, zip_ok=False, multi=None, tmpdir=None): - if tmpdir is None: tmpdir = tempfile.mkdtemp(prefix="easy_install-") - - self.tmpdir = tmpdir + self.cleanup = True + elif not os.path.isdir(tmpdir): + os.makedirs(tmpdir) + self.tmpdir = os.path.realpath(tmpdir) site_packages = get_python_lib() if instdir is None or self.samefile(site_packages,instdir): @@ -194,15 +196,13 @@ self.multi = multi def close(self): - if os.path.isdir(self.tmpdir): + if self.cleanup and os.path.isdir(self.tmpdir): rmtree(self.tmpdir,True) def __del__(self): self.close() - - def samefile(self,p1,p2): if hasattr(os.path,'samefile') and ( os.path.exists(p1) and os.path.exists(p2) @@ -269,14 +269,14 @@ setup_script = setups[0] self._run_setup(setup_script) + + eggs = [] for egg in glob( os.path.join(os.path.dirname(setup_script),'dist','*.egg') ): - self.install_egg(egg, self.zip_ok) - - - + eggs.append(self.install_egg(egg, self.zip_ok)) + return eggs @@ -339,7 +339,7 @@ sys.path.insert(0,os.getcwd()) DirectorySandbox(self.tmpdir).run( lambda: execfile( - setup_script, + "setup.py", {'__file__':setup_script, '__name__':'__main__'} ) ) @@ -391,22 +391,22 @@ os.mkdir(destination) self._extract_zip(egg_path, destination) - if self.pth_file is not None: - if os.path.isdir(destination): - dist = Distribution.from_filename( - destination, metadata=PathMetadata( - destination, os.path.join(destination,'EGG-INFO') - ) + if os.path.isdir(destination): + dist = Distribution.from_filename( + destination, metadata=PathMetadata( + destination, os.path.join(destination,'EGG-INFO') ) - else: - metadata = EggMetadata(zipimport.zipimporter(destination)) - dist = Distribution.from_filename(destination,metadata=metadata) + ) + else: + metadata = EggMetadata(zipimport.zipimporter(destination)) + dist = Distribution.from_filename(destination,metadata=metadata) - # remove old - map(self.pth_file.remove, self.pth_file.get(dist.key,())) + if self.pth_file is not None: + map(self.pth_file.remove, self.pth_file.get(dist.key,())) # drop old if not self.multi: self.pth_file.add(dist) # add new self.pth_file.save() + return dist def _download_url(self, scheme, url): @@ -531,6 +531,47 @@ + def installation_report(self, dist): + """Helpful installation message for display to package users""" + + msg = "Installed %(eggloc)s to %(instdir)s" + if self.multi: + msg += """ + +Because this distribution was installed --multi-version or --install-dir, +before you can import modules from this package in an application, you +will need to 'import pkg_resources' and then use a 'require()' call +similar to one of these examples, in order to select the desired version: + + pkg_resources.require("%(name)s") # latest installed version + pkg_resources.require("%(name)s==%(version)s") # this exact version + pkg_resources.require("%(name)s>=%(version)s") # this version or higher +""" + if not self.samefile(get_python_lib(),self.instdir): + msg += """ + +Note also that the installation directory must be on sys.path at runtime for +this to work. (e.g. by being the application's script directory, by being on +PYTHONPATH, or by being added to sys.path by your code.) +""" + eggloc = os.path.basename(dist.path) + instdir = os.path.realpath(self.instdir) + name = dist.name + version = dist.version + return msg % locals() + + + + + + + + + + + + + class AbstractSandbox: """Wrap 'os' module and 'open()' builtin for virtualizing setup scripts""" @@ -670,7 +711,7 @@ def _remap_input(self,operation,path,*args,**kw): """Called for path inputs""" if operation in self.write_ops and not self._ok(path): - self._violation(operation, path, *args, **kw) + self._violation(operation, os.path.realpath(path), *args, **kw) return path def _remap_pair(self,operation,src,dst,*args,**kw): @@ -740,7 +781,6 @@ def main(argv, factory=Installer): from optparse import OptionParser - parser = OptionParser(usage = "usage: %prog [options] url [url...]") parser.add_option("-d", "--install-dir", dest="instdir", default=None, help="install package to DIR", metavar="DIR") @@ -753,27 +793,69 @@ action="store_true", dest="multi", default=None, help="make apps have to require() a version") + parser.add_option("-b", "--build-directory", dest="tmpdir", metavar="DIR", + default=None, + help="download/extract/build in DIR; keep the results") (options, args) = parser.parse_args() try: if not args: parser.error("No urls, filenames, or requirements specified") - for spec in args: - inst = factory(options.instdir, options.zip_ok, options.multi) + inst = factory( + options.instdir, options.zip_ok, options.multi, options.tmpdir + ) try: print "Downloading", spec downloaded = inst.download(spec) print "Installing", os.path.basename(downloaded) - inst.install_eggs(downloaded) + for dist in inst.install_eggs(downloaded): + print inst.installation_report(dist) finally: inst.close() except RuntimeError, v: print >>sys.stderr,"error:",v sys.exit(1) + if __name__ == '__main__': main(sys.argv[1:]) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

1 0

[Python-checkins] python/nondist/sandbox/setuptools/setuptools/command bdist_egg.py, 1.11, 1.12
by pje＠users.sourceforge.net May 30, 2005

May 30, 2005

Update of /cvsroot/python/python/nondist/sandbox/setuptools/setuptools/command In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv9371/setuptools/command Modified Files: bdist_egg.py Log Message: Ensure that the distribution name written to PKG-INFO is the same as the name you'll use in 'require()' operations for that distribution. Index: bdist_egg.py =================================================================== RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/setuptools/command/bdist_egg.py,v retrieving revision 1.11 retrieving revision 1.12 diff -u -d -r1.11 -r1.12 --- bdist_egg.py 30 May 2005 06:46:01 -0000 1.11 +++ bdist_egg.py 30 May 2005 23:22:10 -0000 1.12 @@ -174,15 +174,15 @@ egg_info = os.path.join(archive_root,'EGG-INFO') self.mkpath(egg_info) self.mkpath(self.egg_info) - log.info("writing %s" % os.path.join(self.egg_info,'PKG-INFO')) if not self.dry_run: metadata = self.distribution.metadata metadata.version, oldver = self.egg_version, metadata.version + metadata.name, oldname = self.egg_name, metadata.name try: metadata.write_pkg_info(self.egg_info) finally: - metadata.version = oldver + metadata.name, metadata.version = oldname, oldver native_libs = os.path.join(self.egg_info,"native_libs.txt") if ext_outputs:

1 0

python/nondist/sandbox/setuptools easy_install.py, 1.7, 1.8
by pje＠users.sourceforge.net May 30, 2005

May 30, 2005

Update of /cvsroot/python/python/nondist/sandbox/setuptools In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv8435 Modified Files: easy_install.py Log Message: Add setup script "sandboxing" -- abort a setup script if it tries to write to the filesystem outside of the installer's temporary directory. This is accomplished by temporarily replacing 'os.*' functions and the 'open' builtin with path-validation wrappers. Index: easy_install.py =================================================================== RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/easy_install.py,v retrieving revision 1.7 retrieving revision 1.8 diff -u -d -r1.7 -r1.8 --- easy_install.py 30 May 2005 03:37:50 -0000 1.7 +++ easy_install.py 30 May 2005 23:20:34 -0000 1.8 @@ -154,12 +154,12 @@ """ import sys, os.path, pkg_resources, re, zipimport, zipfile, tarfile, shutil -import urlparse, urllib, tempfile +import urlparse, urllib, tempfile, __builtin__ from distutils.sysconfig import get_python_lib from shutil import rmtree # must have, because it can be called from __del__ from pkg_resources import * - - +_os = sys.modules[os.name] +_open = open class Installer: @@ -337,8 +337,11 @@ try: sys.argv[:] = [setup_script, '-q', 'bdist_egg'] sys.path.insert(0,os.getcwd()) - execfile(setup_script, - {'__file__':setup_script, '__name__':'__main__'} + DirectorySandbox(self.tmpdir).run( + lambda: execfile( + setup_script, + {'__file__':setup_script, '__name__':'__main__'} + ) ) except SystemExit, v: if v.args and v.args[0]: @@ -364,9 +367,6 @@ - - - def install_egg(self, egg_path, zip_ok): destination = os.path.join(self.instdir, os.path.basename(egg_path)) @@ -531,6 +531,170 @@ +class AbstractSandbox: + """Wrap 'os' module and 'open()' builtin for virtualizing setup scripts""" + + _active = False + + def __init__(self): + self._attrs = [ + name for name in dir(_os) + if not name.startswith('_') and hasattr(self,name) + ] + + def _copy(self, source): + for name in self._attrs: + setattr(os, name, getattr(source,name)) + + def run(self, func): + """Run 'func' under os sandboxing""" + try: + self._copy(self) + __builtin__.open = __builtin__.file = self._open + self._active = True + return func() + finally: + self._active = False + __builtin__.open = __builtin__.file = _open + self._copy(_os) + + + def _mk_dual_path_wrapper(name): + original = getattr(_os,name) + def wrap(self,src,dst,*args,**kw): + if self._active: + src,dst = self._remap_pair(name,src,dst,*args,**kw) + return original(src,dst,*args,**kw) + return wrap + + + for name in ["rename", "link", "symlink"]: + if hasattr(_os,name): locals()[name] = _mk_dual_path_wrapper(name) + + + def _mk_single_path_wrapper(name, original=None): + original = original or getattr(_os,name) + def wrap(self,path,*args,**kw): + if self._active: + path = self._remap_input(name,path,*args,**kw) + return original(path,*args,**kw) + return wrap + + _open = _mk_single_path_wrapper('file', _open) + for name in [ + "stat", "listdir", "chdir", "open", "chmod", "chown", "mkdir", + "remove", "unlink", "rmdir", "utime", "lchown", "chroot", "lstat", + "startfile", "mkfifo", "mknod", "pathconf", "access" + ]: + if hasattr(_os,name): locals()[name] = _mk_single_path_wrapper(name) + + + def _mk_single_with_return(name): + original = getattr(_os,name) + def wrap(self,path,*args,**kw): + if self._active: + path = self._remap_input(name,path,*args,**kw) + return self._remap_output(name, original(path,*args,**kw)) + return original(path,*args,**kw) + return wrap + + for name in ['readlink', 'tempnam']: + if hasattr(_os,name): locals()[name] = _mk_single_with_return(name) + + def _mk_query(name): + original = getattr(_os,name) + def wrap(self,*args,**kw): + retval = original(*args,**kw) + if self._active: + return self._remap_output(name, retval) + return retval + return wrap + + for name in ['getcwd', 'tmpnam']: + if hasattr(_os,name): locals()[name] = _mk_query(name) + + def _validate_path(self,path): + """Called to remap or validate any path, whether input or output""" + return path + + def _remap_input(self,operation,path,*args,**kw): + """Called for path inputs""" + return self._validate_path(path) + + def _remap_output(self,operation,path): + """Called for path outputs""" + return self._validate_path(path) + + def _remap_pair(self,operation,src,dst,*args,**kw): + """Called for path pairs like rename, link, and symlink operations""" + return ( + self._remap_input(operation+'-from',src,*args,**kw), + self._remap_input(operation+'-to',dst,*args,**kw) + ) + + +class DirectorySandbox(AbstractSandbox): + """Restrict operations to a single subdirectory - pseudo-chroot""" + + write_ops = dict.fromkeys([ + "open", "chmod", "chown", "mkdir", "remove", "unlink", "rmdir", + "utime", "lchown", "chroot", "mkfifo", "mknod", "tempnam", + ]) + + def __init__(self,sandbox): + self._sandbox = os.path.realpath(sandbox) + self._prefix = os.path.join(self._sandbox,'') + AbstractSandbox.__init__(self) + + def _violation(self, operation, *args, **kw): + raise SandboxViolation(operation, args, kw) + + def _open(self, path, mode='r', *args, **kw): + if mode not in ('r', 'rt', 'rb', 'rU') and not self._ok(path): + self._violation("open", path, mode, *args, **kw) + return _open(path,mode,*args,**kw) + + def tmpnam(self): + self._violation("tmpnam") + + def _ok(self,path): + active = self._active + try: + self._active = False + realpath = os.path.realpath(path) + if realpath==self._sandbox or realpath.startswith(self._prefix): + return True + finally: + self._active = active + + def _remap_input(self,operation,path,*args,**kw): + """Called for path inputs""" + if operation in self.write_ops and not self._ok(path): + self._violation(operation, path, *args, **kw) + return path + + def _remap_pair(self,operation,src,dst,*args,**kw): + """Called for path pairs like rename, link, and symlink operations""" + if not self._ok(src) or not self._ok(dst): + self._violation(operation, src, dst, *args, **kw) + return (src,dst) + + +class SandboxViolation(RuntimeError): + """A setup script attempted to modify the filesystem outside the sandbox""" + + def __str__(self): + return """SandboxViolation: %s%r %s + +The package setup script has attempted to modify files on your system +that are not within the EasyInstall build area, and has been aborted. + +This package cannot be safely installed by EasyInstall, and may not +support alternate installation locations even if you run its setup +script by hand. Please inform the package's author and the EasyInstall +maintainers to find out if a fix or workaround is available.""" % self.args + + class PthDistributions(AvailableDistributions): """A .pth file with Distribution paths in it"""

1 0

[Python-checkins] python/nondist/sandbox/setuptools/setuptools/command bdist_egg.py, 1.10, 1.11
by pje＠users.sourceforge.net May 30, 2005

May 30, 2005

Update of /cvsroot/python/python/nondist/sandbox/setuptools/setuptools/command In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv9321/setuptools/command Modified Files: bdist_egg.py Log Message: Reorganize bdist_egg's handling of 'install_data' to better deal with the various kludges legacy packages are using to install data in their package directories. Some use absolute paths in 'distribution.data_files', while others create various subclasses of 'install_data', each with their own way of finding out what directory to use! So 'bdist_egg' now does all its 'install_lib' activity before 'install_data', and pokes the desired build directory into a wide variety of places, so that all of the known kludges so far will work correctly. It also checks for absolute paths in 'data_files' (carefully working around other packages' 'data_files' kludges!) and converts them back to relative ones, if they are subpaths of site-packages. Clearly, we need to get the word out about 'package_files' in Python 2.4 and above, and suggest using 'setuptools' for Python 2.3. Index: bdist_egg.py =================================================================== RCS file: /cvsroot/python/python/nondist/sandbox/setuptools/setuptools/command/bdist_egg.py,v retrieving revision 1.10 retrieving revision 1.11 diff -u -d -r1.10 -r1.11 --- bdist_egg.py 29 May 2005 22:05:39 -0000 1.10 +++ bdist_egg.py 30 May 2005 06:46:01 -0000 1.11 @@ -7,7 +7,7 @@ from distutils.core import Command from distutils.util import get_platform from distutils.dir_util import create_tree, remove_tree, ensure_relative,mkpath -from distutils.sysconfig import get_python_version +from distutils.sysconfig import get_python_version, get_python_lib from distutils.errors import * from distutils import log from pkg_resources import parse_requirements, get_platform @@ -95,19 +95,39 @@ ])) f.close() + def do_install_data(self): + self.get_finalized_command('install').install_lib = self.bdist_dir + site_packages = os.path.normcase(os.path.realpath(get_python_lib())) + old, self.distribution.data_files = self.distribution.data_files,[] + for item in old: + if isinstance(item,tuple) and len(item)==2: + if os.path.isabs(item[0]): + realpath = os.path.realpath(item[0]) + normalized = os.path.normcase(realpath) + if normalized==site_packages or normalized.startswith( + site_packages+os.sep + ): + item = realpath[len(site_packages)+1:], item[1] + # XXX else: raise ??? + self.distribution.data_files.append(item) + try: + install = self.reinitialize_command('install_data') + # kludge for setups that use a 3-tuple inst_data + install.install_dir = install.install_base = \ + install.install_data = install.install_lib = self.bdist_dir + install.force = 0; install.root = None + log.info("installing package data to %s" % self.bdist_dir) + self.run_command('install_data') + finally: + self.distribution.data_files = old def run(self): + if not self.skip_build: self.run_command('build') - if self.distribution.data_files: - install = self.reinitialize_command('install_data') - install.install_dir = self.bdist_dir - install.force = 0 - install.root = None - log.info("installing package data to %s" % self.bdist_dir) - self.run_command('install_data') - + # We run install_lib before install_data, because some data hacks + # pull their data path from the install_lib command. install = self.reinitialize_command('install_lib', reinit_subcommands=1) install.install_dir = self.bdist_dir install.skip_build = self.skip_build @@ -120,7 +140,6 @@ log.info("installing library code to %s" % self.bdist_dir) self.run_command('install_lib') - to_compile = [] for ext_name in ext_outputs: filename,ext = os.path.splitext(ext_name) @@ -133,6 +152,9 @@ if to_compile: install.byte_compile(to_compile) + if self.distribution.data_files: + self.do_install_data() + # And make an archive relative to the root of the # pseudo-installation tree. archive_basename = "%s-%s-py%s" % ( self.egg_name.replace('-','_'), @@ -213,6 +235,15 @@ return match.group(1) + + + + + + + + + def make_zipfile (zip_filename, base_dir, verbose=0, dry_run=0): """Create a zip file from all the files under 'base_dir'. The output zip file will be named 'base_dir' + ".zip". Uses either the "zipfile" @@ -244,3 +275,13 @@ return zip_filename + + + + + + + + + +

1 0