Commits

Lynn Rees committed 89ff654

[svn] made a copy

Comments (0)

Files changed (3)

branches/0.1/trunk/ez_setup.py

+#!python
+"""Bootstrap setuptools installation
+
+If you want to use setuptools in your package's setup.py, just include this
+file in the same directory with it, and add this to the top of your setup.py::
+
+    from ez_setup import use_setuptools
+    use_setuptools()
+
+If you want to require a specific version of setuptools, set a download
+mirror, or use an alternate download directory, you can do so by supplying
+the appropriate options to ``use_setuptools()``.
+
+This file can also be run as a script to install or upgrade setuptools.
+"""
+import sys
+DEFAULT_VERSION = "0.6a9"
+DEFAULT_URL     = "http://cheeseshop.python.org/packages/%s/s/setuptools/" % sys.version[:3]
+
+md5_data = {
+    'setuptools-0.5a13-py2.3.egg': '85edcf0ef39bab66e130d3f38f578c86',
+    'setuptools-0.5a13-py2.4.egg': 'ede4be600e3890e06d4ee5e0148e092a',
+    'setuptools-0.6a1-py2.3.egg': 'ee819a13b924d9696b0d6ca6d1c5833d',
+    'setuptools-0.6a1-py2.4.egg': '8256b5f1cd9e348ea6877b5ddd56257d',
+    'setuptools-0.6a2-py2.3.egg': 'b98da449da411267c37a738f0ab625ba',
+    'setuptools-0.6a2-py2.4.egg': 'be5b88bc30aed63fdefd2683be135c3b',
+    'setuptools-0.6a3-py2.3.egg': 'ee0e325de78f23aab79d33106dc2a8c8',
+    'setuptools-0.6a3-py2.4.egg': 'd95453d525a456d6c23e7a5eea89a063',
+    'setuptools-0.6a4-py2.3.egg': 'e958cbed4623bbf47dd1f268b99d7784',
+    'setuptools-0.6a4-py2.4.egg': '7f33c3ac2ef1296f0ab4fac1de4767d8',
+    'setuptools-0.6a5-py2.3.egg': '748408389c49bcd2d84f6ae0b01695b1',
+    'setuptools-0.6a5-py2.4.egg': '999bacde623f4284bfb3ea77941d2627',
+    'setuptools-0.6a6-py2.3.egg': '7858139f06ed0600b0d9383f36aca24c',
+    'setuptools-0.6a6-py2.4.egg': 'c10d20d29acebce0dc76219dc578d058',
+    'setuptools-0.6a7-py2.3.egg': 'cfc4125ddb95c07f9500adc5d6abef6f',
+    'setuptools-0.6a7-py2.4.egg': 'c6d62dab4461f71aed943caea89e6f20',
+    'setuptools-0.6a8-py2.3.egg': '2f18eaaa3f544f5543ead4a68f3b2e1a',
+    'setuptools-0.6a8-py2.4.egg': '799018f2894f14c9f8bcb2b34e69b391',
+    'setuptools-0.6a9-py2.3.egg': '8e438ad70438b07b0d8f82cae42b278f',
+    'setuptools-0.6a9-py2.4.egg': '8f6e01fc12fb1cd006dc0d6c04327ec1',
+}
+
+import sys, os
+
+def _validate_md5(egg_name, data):
+    if egg_name in md5_data:
+        from md5 import md5
+        digest = md5(data).hexdigest()
+        if digest != md5_data[egg_name]:
+            print >>sys.stderr, (
+                "md5 validation of %s failed!  (Possible download problem?)"
+                % egg_name
+            )
+            sys.exit(2)
+    return data    
+
+
+def use_setuptools(
+    version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir,
+    download_delay=15
+):
+    """Automatically find/download setuptools and make it available on sys.path
+
+    `version` should be a valid setuptools version number that is available
+    as an egg for download under the `download_base` URL (which should end with
+    a '/').  `to_dir` is the directory where setuptools will be downloaded, if
+    it is not already available.  If `download_delay` is specified, it should
+    be the number of seconds that will be paused before initiating a download,
+    should one be required.  If an older version of setuptools is installed,
+    this routine will print a message to ``sys.stderr`` and raise SystemExit in
+    an attempt to abort the calling script.  
+    """
+    try:
+        import setuptools
+        if setuptools.__version__ == '0.0.1':
+            print >>sys.stderr, (
+            "You have an obsolete version of setuptools installed.  Please\n"
+            "remove it from your system entirely before rerunning this script."
+            )
+            sys.exit(2)
+    except ImportError:
+        egg = download_setuptools(version, download_base, to_dir, download_delay)
+        sys.path.insert(0, egg)
+        import setuptools; setuptools.bootstrap_install_from = egg
+
+    import pkg_resources
+    try:
+        pkg_resources.require("setuptools>="+version)
+
+    except pkg_resources.VersionConflict:
+        # XXX could we install in a subprocess here?
+        print >>sys.stderr, (
+            "The required version of setuptools (>=%s) is not available, and\n"
+            "can't be installed while this script is running. Please install\n"
+            " a more recent version first."
+        ) % version
+        sys.exit(2)
+
+def download_setuptools(
+    version=DEFAULT_VERSION, download_base=DEFAULT_URL, to_dir=os.curdir,
+    delay = 15
+):
+    """Download setuptools from a specified location and return its filename
+
+    `version` should be a valid setuptools version number that is available
+    as an egg for download under the `download_base` URL (which should end
+    with a '/'). `to_dir` is the directory where the egg will be downloaded.
+    `delay` is the number of seconds to pause before an actual download attempt.
+    """
+    import urllib2, shutil
+    egg_name = "setuptools-%s-py%s.egg" % (version,sys.version[:3])
+    url = download_base + egg_name
+    saveto = os.path.join(to_dir, egg_name)
+    src = dst = None
+    if not os.path.exists(saveto):  # Avoid repeated downloads
+        try:
+            from distutils import log
+            if delay:
+                log.warn("""
+---------------------------------------------------------------------------
+This script requires setuptools version %s to run (even to display
+help).  I will attempt to download it for you (from
+%s), but
+you may need to enable firewall access for this script first.
+I will start the download in %d seconds.
+---------------------------------------------------------------------------""",
+                    version, download_base, delay
+                ); from time import sleep; sleep(delay)
+            log.warn("Downloading %s", url)
+            src = urllib2.urlopen(url)
+            # Read/write all in one block, so we don't create a corrupt file
+            # if the download is interrupted.
+            data = _validate_md5(egg_name, src.read())
+            dst = open(saveto,"wb"); dst.write(data)
+        finally:
+            if src: src.close()
+            if dst: dst.close()
+    return os.path.realpath(saveto)
+
+def main(argv, version=DEFAULT_VERSION):
+    """Install or upgrade setuptools and EasyInstall"""
+
+    try:
+        import setuptools
+    except ImportError:
+        import tempfile, shutil
+        tmpdir = tempfile.mkdtemp(prefix="easy_install-")
+        try:
+            egg = download_setuptools(version, to_dir=tmpdir, delay=0)
+            sys.path.insert(0,egg)
+            from setuptools.command.easy_install import main
+            main(list(argv)+[egg])
+        finally:
+            shutil.rmtree(tmpdir)
+    else:
+        if setuptools.__version__ == '0.0.1':
+            # tell the user to uninstall obsolete version
+            use_setuptools(version)
+
+    req = "setuptools>="+version
+    import pkg_resources
+    try:
+        pkg_resources.require(req)
+    except pkg_resources.VersionConflict:
+        try:
+            from setuptools.command.easy_install import main
+        except ImportError:
+            from easy_install import main
+        main(list(argv)+[download_setuptools(delay=0)])
+        sys.exit(0) # try to force an exit
+    else:
+        if argv:
+            from setuptools.command.easy_install import main
+            main(argv)
+        else:
+            print "Setuptools version",version,"or greater has been installed."
+            print '(Run "ez_setup.py -U setuptools" to reinstall or upgrade.)'
+
+
+            
+def update_md5(filenames):
+    """Update our built-in md5 registry"""
+
+    import re
+    from md5 import md5
+
+    for name in filenames:
+        base = os.path.basename(name)
+        f = open(name,'rb')       
+        md5_data[base] = md5(f.read()).hexdigest()
+        f.close()
+
+    data = ["    %r: %r,\n" % it for it in md5_data.items()]
+    data.sort()
+    repl = "".join(data)
+
+    import inspect
+    srcfile = inspect.getsourcefile(sys.modules[__name__])
+    f = open(srcfile, 'rb'); src = f.read(); f.close()
+
+    match = re.search("\nmd5_data = {\n([^}]+)}", src)
+    if not match:
+        print >>sys.stderr, "Internal error!"
+        sys.exit(2)
+
+    src = src[:match.start(1)] + repl + src[match.end(1):]
+    f = open(srcfile,'w')
+    f.write(src)
+    f.close()
+
+
+if __name__=='__main__':
+    if len(sys.argv)>2 and sys.argv[1]=='--md5update':
+        update_md5(sys.argv[2:])
+    else:
+        main(sys.argv[1:])
+

branches/0.1/trunk/setup.py

+# Copyright (c) 2006 L. C. Rees.  All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions are met:
+#
+# 1.  Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+# 2.  Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+# 3.  Neither the name of the Portable Site Information Project nor the names
+# of its contributors may be used to endorse or promote products derived from
+# this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+'''setup - setuptools based setup for wsgize.'''
+
+import ez_setup
+ez_setup.use_setuptools()
+
+try:
+    from setuptools import setup
+except:
+    from distutils.core import setup
+
+setup(name='wsgize',
+      version='0.1',
+      description='''Utilities for "WSGIzing" Python callables.''',
+      long_description='''Utilities for "WSGIzing" Python callables including:
+
+   * An HTTP response generator
+   * A decorator for autogenerating WSGI start_response callables, headers, and
+     iterators for a WSGI callable
+   * A decorator for making arbitrary Python callables WSGI callables
+   * A secondary dispatcher.''',
+      author='L. C. Rees',
+      author_email='lcrees@gmail.com',
+      license='BSD',
+      py_modules=['wsgize', 'ez_setup', 'setup'],
+      packages = [],
+      zip_safe = True,
+      keywords='WSGI dispatch middleware web HTTP decorators',
+      classifiers=['Development Status :: 3 - Alpha',
+                    'Environment :: Web Environment',
+                    'License :: OSI Approved :: BSD License',
+                    'Natural Language :: English',
+                    'Operating System :: OS Independent',
+                    'Programming Language :: Python',
+                    'Topic :: Internet :: WWW/HTTP :: WSGI :: Middleware'])

branches/0.1/trunk/wsgize.py

+# Copyright (c) 2005, the Lawrence Journal-World
+# Copyright (c) 2006 L. C. Rees
+# All rights reserved.
+#
+# Redistribution and use in source and binary forms, with or without modification,
+# are permitted provided that the following conditions are met:
+#
+#    1. Redistributions of source code must retain the above copyright notice, 
+#       this list of conditions and the following disclaimer.
+#    
+#    2. Redistributions in binary form must reproduce the above copyright 
+#       notice, this list of conditions and the following disclaimer in the
+#       documentation and/or other materials provided with the distribution.
+#
+#    3. Neither the name of Django nor the names of its contributors may be used
+#       to endorse or promote products derived from this software without
+#       specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+# ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+# WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+# ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+# ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+'''Utilities for "WSGIzing" Python callables including:
+
+    * An WSGI-compliant HTTP response generator
+    * A decorator for making non-WSGI Python callables (functions, classes classes overriding __call__) into WSGI callables
+    * A secondary WSGI dispatcher.
+    * A decorator for autogenerating WSGI start_response response codes and headers and compliant iterators for WSGI callables
+'''
+
+import sys
+from BaseHTTPServer import BaseHTTPRequestHandler as _bhrh
+
+thing = set('Allow', 'Content-Encoding', 'Content-Language', 'Content-Length', 'Content-Location', 'Content-MD5',
+ 'Content-Range', 'Content-Type', 'Expires', 'Last-Modified', 'Cache-Control', 'Connection', 'Date', 'Pragma',
+ 'Trailer', 'Transfer-Encoding', 'Upgrade', 'Via', 'Warning', 'Accept-Ranges', 'Age', 'ETag', 'Location',
+ 'Proxy-Authenticate', 'Retry-After', 'Server', 'Vary', 'WWW-Authenticate')
+ 
+ 
+
+def wsgize(**kw):
+    '''Decorator for Wsgize.
+
+    @param application Application to decorate.
+    '''
+    def decorator(application):
+        return Wsgize(application, **kw)
+    return decorator
+
+def wsgiwrap(**kw):
+    '''Decorator for WsgiWrap.
+
+    @param application Application to decorate.
+    '''    
+    def decorator(application):
+        return WsgiWrap(application, **kw)
+    return decorator
+
+def response(code):
+    '''Returns a WSGI response string.
+
+    code HTTP response (integer)
+    '''
+    return '%i %s' % (code, _bhrh.responses[code][0])       
+
+    
+class Wsgize(object):
+
+    '''Autogenerates WSGI start_response callables, headers, and iterators for
+    a WSGI callables.
+    '''    
+
+    def __init__(self, app, **kw):
+        '''@param application WSGI callable
+        @param kw Keyword arguments
+        '''
+        self.application = app
+        # Get HTTP response
+        self.start_response = response(kw.get('response', 200))
+        # Generate headers
+        exheaders = kw.get('headers', dict())
+        headers = list((key, exheaders[key]) for key in exheaders)
+        self.headers = [('Content-type', kw.get('mime', 'text/html'))] + headers
+        self.exc_info = kw.get('exc_info', None)
+        # Key for kwargs passed through environ dictionary
+        self.kwargkey = kw.get('kwargs', 'wsgize.kwargs')
+        # Key for kargs passed through environ dictionary
+        self.argkey = kw.get('args', 'wsgize.args')
+
+    def __call__(self, environ, start_response):
+        '''Passes WSGI params to a callable and autogenrates the start_response.'''
+        data = self.application(environ, start_response)
+        start_response(self.start_response, self.headers, self.exc_info)
+        if hasattr(data, '__iter__'):
+            # Wrap strings in non-string iterator
+            if isinstance(data, basestring): data = [data]
+            return data
+        else:
+            raise TypeError('Data returned by callable must be iterable or string.')        
+
+
+class WsgiWrap(Wsgize):
+
+    '''Makes arbitrary Python callables WSGI callables.'''     
+
+    def __call__(self, environ, start_response):
+        '''Makes a Python callable a WSGI callable.'''
+        # Get any arguments
+        args = environ.get(self.argkey, False)
+        # Get any keyword arguments
+        kw = environ.get(self.kwargkey, False)
+        # Pass args/kwargs to non-WSGI callable
+        if args and kw:
+            data = self.application(*args, **kw)
+        elif args:
+            data = self.application(*args)
+        elif kw:
+            data = self.application(**kw)
+        start_response(self.start_response, self.headers, self.exc_info)
+        if isinstance(data, basestring): data = [data]
+        return data
+
+
+class WsgiRoute(object):
+
+    '''Secondary WSGI dispatcher.'''
+
+    def __init__(self, *args, **kw):
+        '''@param table Dictionary of names and callables.'''
+        self.table, self.modpath = args[0], kw.get('modpath', '')
+        # Get key for callable
+        self.kwargkey = kw.get('kwargkey', 'wsgize.callable')
+        syspaths = kw.get('syspaths', None)
+        # Add any additional sys paths
+        if syspaths is not None:
+            for path in syspaths: sys.path.append(path)
+
+    def __call__(self, environ, start_response):
+        '''Passes WSGI params to a callable based on a keyword.'''
+        callback = self.lookup(environ[self.kwargkey])
+        return callback(environ, start_response)           
+
+    def get_mod_func(self, callback):
+        '''Breaks a callable name out from a module name.
+
+        @param callback Name of a callback        
+        '''
+        # Add shortcut to module if present
+        if self.modpath != '': callback = '.'.join([self.modpath, callback])
+        dot = callback.rindex('.')
+        return callback[:dot], callback[dot+1:]
+
+    def lookup(self, kw):
+        '''Fetches a callable based on keyword.
+
+        kw Keyword
+        '''
+        callable = self.table[kw]
+        if not isinstance(callable, basestring):
+            return callable
+        else:
+            return self.get_callback(callable)
+        raise ImportError()    
+
+    def get_callback(self, callback):
+        '''Loads a callable from system path.
+
+        callback A callback's name'''        
+        mod_name, func_name = self.get_mod_func(callback)
+        try:
+            return getattr(__import__(mod_name, '', '', ['']), func_name)
+        except ImportError, error:
+            raise ImportError(
+                'Could not import %s. Error was: %s' % (mod_name, str(error)))
+        except AttributeError, error:
+            raise AttributeError(
+                'Tried %s in module %s. Error was: %s' % (func_name,
+                 mod_name, str(error)))
+
+
+__all__ = ['response', 'Wsgize', 'WsgiWrap', 'WsgiRoute', 'wsgize', 'wsgiwrap']