make display_status optional at runtime in setupext

This allow the check_for_readline to *not* print its indented status line

closes gh-361
closes gh-20

setup.py

@@ -1,262 +1,263 b''
 #!/usr/bin/env python
 # -*- coding: utf-8 -*-
 """Setup script for IPython.
 
 Under Posix environments it works like a typical setup.py script. 
 Under Windows, the command sdist is not supported, since IPython 
 requires utilities which are not available under Windows."""
 
 #-----------------------------------------------------------------------------
 #  Copyright (c) 2008-2010, IPython Development Team.
 #  Copyright (c) 2001-2007, Fernando Perez <[e-mail]>
 #  Copyright (c) 2001, Janko Hauser <[e-mail]>
 #  Copyright (c) 2001, Nathaniel Gray <[e-mail]>
 #
 #  Distributed under the terms of the Modified BSD License.
 #
 #  The full license is in the file COPYING.txt, distributed with this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Minimal Python version sanity check
 #-----------------------------------------------------------------------------
 
 import sys
 
 # This check is also made in IPython/__init__, don't forget to update both when
 # changing Python version requirements.
 if sys.version[0:3] < '2.6':
     error = """\
 ERROR: 'IPython requires Python Version 2.6 or above.'
 Exiting."""
     print >> sys.stderr, error
     sys.exit(1)
 
 # At least we're on the python version we need, move on.
 
 #-------------------------------------------------------------------------------
 # Imports
 #-------------------------------------------------------------------------------
 
 # Stdlib imports
 import os
 import shutil
 
 from glob import glob
 
 # BEFORE importing distutils, remove MANIFEST. distutils doesn't properly
 # update it when the contents of directories change.
 if os.path.exists('MANIFEST'): os.remove('MANIFEST')
 
 from distutils.core import setup
 
 # Our own imports
 from IPython.utils.path import target_update
 
 from setupbase import (
     setup_args, 
     find_packages, 
     find_package_data, 
     find_scripts,
     find_data_files,
     check_for_dependencies,
     record_commit_info,
 )
-from setupext.setupext import check_for_readline
+from setupext import setupext
 
 isfile = os.path.isfile
 pjoin = os.path.join
 
 #-----------------------------------------------------------------------------
 # Function definitions
 #-----------------------------------------------------------------------------
 
 def cleanup():
     """Clean up the junk left around by the build process"""
     if "develop" not in sys.argv:
         try:
             shutil.rmtree('ipython.egg-info')
         except:
             try:
                 os.unlink('ipython.egg-info')
             except:
                 pass
 
 #-------------------------------------------------------------------------------
 # Handle OS specific things
 #-------------------------------------------------------------------------------
 
 if os.name == 'posix':
     os_name = 'posix'
 elif os.name in ['nt','dos']:
     os_name = 'windows'
 else:
     print 'Unsupported operating system:',os.name
     sys.exit(1)
 
 # Under Windows, 'sdist' has not been supported.  Now that the docs build with
 # Sphinx it might work, but let's not turn it on until someone confirms that it
 # actually works.
 if os_name == 'windows' and 'sdist' in sys.argv:
     print 'The sdist command is not available under Windows.  Exiting.'
     sys.exit(1)
 
 #-------------------------------------------------------------------------------
 # Things related to the IPython documentation
 #-------------------------------------------------------------------------------
 
 # update the manuals when building a source dist
 if len(sys.argv) >= 2 and sys.argv[1] in ('sdist','bdist_rpm'):
     import textwrap
 
     # List of things to be updated. Each entry is a triplet of args for
     # target_update()
     to_update = [
                   # FIXME - Disabled for now: we need to redo an automatic way
                   # of generating the magic info inside the rst.                
                   #('docs/magic.tex',
                   #['IPython/Magic.py'],
                   #"cd doc && ./update_magic.sh" ),
 
                  ('docs/man/ipcluster.1.gz',
                   ['docs/man/ipcluster.1'],
                   'cd docs/man && gzip -9c ipcluster.1 > ipcluster.1.gz'),
 
                  ('docs/man/ipcontroller.1.gz',
                   ['docs/man/ipcontroller.1'],
                   'cd docs/man && gzip -9c ipcontroller.1 > ipcontroller.1.gz'),
 
                  ('docs/man/ipengine.1.gz',
                   ['docs/man/ipengine.1'],
                   'cd docs/man && gzip -9c ipengine.1 > ipengine.1.gz'),
 
                  ('docs/man/ipython.1.gz',
                   ['docs/man/ipython.1'],
                   'cd docs/man && gzip -9c ipython.1 > ipython.1.gz'),
 
                  ('docs/man/ipython-wx.1.gz',
                   ['docs/man/ipython-wx.1'],
                   'cd docs/man && gzip -9c ipython-wx.1 > ipython-wx.1.gz'),
 
                  ('docs/man/ipythonx.1.gz',
                   ['docs/man/ipythonx.1'],
                   'cd docs/man && gzip -9c ipythonx.1 > ipythonx.1.gz'),
 
                  ('docs/man/irunner.1.gz',
                   ['docs/man/irunner.1'],
                   'cd docs/man && gzip -9c irunner.1 > irunner.1.gz'),
 
                  ('docs/man/pycolor.1.gz',
                   ['docs/man/pycolor.1'],
                   'cd docs/man && gzip -9c pycolor.1 > pycolor.1.gz'),
                  ]
 
     # Only build the docs if sphinx is present
     try:
         import sphinx
     except ImportError:
         pass
     else:
         # The Makefile calls the do_sphinx scripts to build html and pdf, so
         # just one target is enough to cover all manual generation
 
         # First, compute all the dependencies that can force us to rebuild the
         # docs.  Start with the main release file that contains metadata
         docdeps = ['IPython/core/release.py']
         # Inculde all the reST sources
         pjoin = os.path.join
         for dirpath,dirnames,filenames in os.walk('docs/source'):
             if dirpath in ['_static','_templates']:
                 continue
             docdeps += [ pjoin(dirpath,f) for f in filenames
                          if f.endswith('.txt') ]
         # and the examples
         for dirpath,dirnames,filenames in os.walk('docs/example'):
             docdeps += [ pjoin(dirpath,f) for f in filenames
                          if not f.endswith('~') ]
         # then, make them all dependencies for the main PDF (the html will get
         # auto-generated as well).
         to_update.append(
             ('docs/dist/ipython.pdf',
              docdeps,
              "cd docs && make dist")
             )
         
     [ target_update(*t) for t in to_update ]
     
 #---------------------------------------------------------------------------
 # Find all the packages, package data, and data_files
 #---------------------------------------------------------------------------
 
 packages = find_packages()
 package_data = find_package_data()
 data_files = find_data_files()
 
 #---------------------------------------------------------------------------
 # Handle scripts, dependencies, and setuptools specific things
 #---------------------------------------------------------------------------
 
 # For some commands, use setuptools.  Note that we do NOT list install here!
 # If you want a setuptools-enhanced install, just run 'setupegg.py install'
 if len(set(('develop', 'sdist', 'release', 'bdist_egg', 'bdist_rpm',
            'bdist', 'bdist_dumb', 'bdist_wininst', 'install_egg_info',
            'build_sphinx', 'egg_info', 'easy_install', 'upload',
             )).intersection(sys.argv)) > 0:
     import setuptools
 
 # This dict is used for passing extra arguments that are setuptools 
 # specific to setup
 setuptools_extra_args = {}
 
 if 'setuptools' in sys.modules:
     setuptools_extra_args['zip_safe'] = False
     setuptools_extra_args['entry_points'] = {
         'console_scripts': find_scripts(True)
     }
     setup_args['extras_require'] = dict(
         parallel = 'pyzmq>=2.1.4',
         zmq = 'pyzmq>=2.0.10.1',
         doc='Sphinx>=0.3',
         test='nose>=0.10.1',
     )
     requires = setup_args.setdefault('install_requires', [])
-    if not check_for_readline():
+    setupext.display_status = False
+    if not setupext.check_for_readline():
         if sys.platform == 'darwin':
-                requires.append('readline')
+            requires.append('readline')
         elif sys.platform.startswith('win'):
             requires.append('pyreadline')
         else:
             pass
             # do we want to install readline here?
     
     # Script to be run by the windows binary installer after the default setup
     # routine, to add shortcuts and similar windows-only things.  Windows
     # post-install scripts MUST reside in the scripts/ dir, otherwise distutils
     # doesn't find them.
     if 'bdist_wininst' in sys.argv:
         if len(sys.argv) > 2 and \
                ('sdist' in sys.argv or 'bdist_rpm' in sys.argv):
             print >> sys.stderr, "ERROR: bdist_wininst must be run alone. Exiting."
             sys.exit(1)
         setup_args['scripts'] = [pjoin('scripts','ipython_win_post_install.py')]
 else:
     # If we are running without setuptools, call this function which will
     # check for dependencies an inform the user what is needed.  This is
     # just to make life easy for users.
     check_for_dependencies()
     setup_args['scripts'] = find_scripts(False)
 
 #---------------------------------------------------------------------------
 # Do the actual setup now
 #---------------------------------------------------------------------------
 
 setup_args['cmdclass'] = {'build_py': record_commit_info('IPython')}
 setup_args['packages'] = packages
 setup_args['package_data'] = package_data
 setup_args['data_files'] = data_files
 setup_args.update(setuptools_extra_args)
 
 
 if __name__ == '__main__':
     setup(**setup_args)
     cleanup()

setupext/setupext.py

@@ -1,157 +1,163 b''
 # encoding: utf-8
 
 __docformat__ = "restructuredtext en"
 
 #-------------------------------------------------------------------------------
 #  Copyright (C) 2008  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 #-------------------------------------------------------------------------------
 
 #-------------------------------------------------------------------------------
 # Imports
 #-------------------------------------------------------------------------------
 
 import sys, os
 from textwrap import fill
 
 display_status=True
 
-if display_status:
-    def print_line(char='='):
-        print char * 76
-
-    def print_status(package, status):
-        initial_indent = "%22s: " % package
-        indent = ' ' * 24
-        print fill(str(status), width=76,
-                   initial_indent=initial_indent,
-                   subsequent_indent=indent)
-
-    def print_message(message):
-        indent = ' ' * 24 + "* "
-        print fill(str(message), width=76,
-                   initial_indent=indent,
-                   subsequent_indent=indent)
-
-    def print_raw(section):
-        print section
-else:
-    def print_line(*args, **kwargs):
-        pass
-    print_status = print_message = print_raw = print_line
+def check_display(f):
+    """decorator to allow display methods to be muted by mod.display_status"""
+    def maybe_display(*args, **kwargs):
+        if display_status:
+            return f(*args, **kwargs)
+    return maybe_display
+
+@check_display
+def print_line(char='='):
+    print char * 76
+
+@check_display
+def print_status(package, status):
+    initial_indent = "%22s: " % package
+    indent = ' ' * 24
+    print fill(str(status), width=76,
+               initial_indent=initial_indent,
+               subsequent_indent=indent)
+
+@check_display
+def print_message(message):
+    indent = ' ' * 24 + "* "
+    print fill(str(message), width=76,
+               initial_indent=indent,
+               subsequent_indent=indent)
+
+@check_display
+def print_raw(section):
+    print section
 
 #-------------------------------------------------------------------------------
 # Tests for specific packages
 #-------------------------------------------------------------------------------
 
 def check_for_ipython():
     try:
         import IPython
     except ImportError:
         print_status("IPython", "Not found")
         return False
     else:
         print_status("IPython", IPython.__version__)
         return True
 
 def check_for_sphinx():
     try:
         import sphinx
     except ImportError:
         print_status('sphinx', "Not found (required for building documentation)")
         return False
     else:
         print_status('sphinx', sphinx.__version__) 
         return True
 
 def check_for_pygments():
     try:
         import pygments
     except ImportError:
         print_status('pygments', "Not found (required for syntax highlighting documentation)")
         return False
     else:
         print_status('pygments', pygments.__version__)
         return True
 
 def check_for_nose():
     try:
         import nose
     except ImportError:
         print_status('nose', "Not found (required for running the test suite)")
         return False
     else:
         print_status('nose', nose.__version__)
         return True
 
 def check_for_pexpect():
     try:
         import pexpect
     except ImportError:
         print_status("pexpect", "no (required for running standalone doctests)")
         return False
     else:
         print_status("pexpect", pexpect.__version__)
         return True
 
 def check_for_httplib2():
     try:
         import httplib2
     except ImportError:
         print_status("httplib2", "no (required for blocking http clients)")
         return False
     else:
         print_status("httplib2","yes")
         return True
 
 def check_for_sqlalchemy():
     try:
         import sqlalchemy
     except ImportError:
         print_status("sqlalchemy", "no (required for the ipython1 notebook)")
         return False
     else:
         print_status("sqlalchemy","yes")
         return True
 
 def check_for_simplejson():
     try:
         import simplejson
     except ImportError:
         print_status("simplejson", "no (required for the ipython1 notebook)")
         return False
     else:
         print_status("simplejson","yes")
         return True
 
 def check_for_pyzmq():
     try:
         import zmq
     except ImportError:
         print_status('pyzmq', "no (required for qtconsole and parallel computing capabilities)")
         return False
     else:
         if zmq.__version__ < '2.0.10':
             print_status('pyzmq', "no (require >= 2.0.10 for qtconsole and parallel computing capabilities)")
             
         else:
             print_status("pyzmq", zmq.__version__)
             return True
 
 def check_for_readline():
     try:
         import readline
     except ImportError:
         try:
             import pyreadline
         except ImportError:
             print_status('readline', "no (required for good interactive behavior)")
             return False
         else:
             print_status('readline', "yes pyreadline-"+pyreadline.release.version)
             return True
     else:
         print_status('readline', "yes")
         return True