workshop_checklist.py

#!/usr/bin/env python
# -*- coding: utf-8 -*-
"""Minimal test script to check for modules needed in python workshop.

Execute this code at the command line by typing:

python workshop_checklist.py

If it does NOT say 'OK' at the end, copy the *entire* output of the run and
send it to the course instructor for help.
"""

# Standard library imports
import glob
import os
import platform
import sys

from io import StringIO

# Third-party imports
import nose
import nose.tools as nt

##############################################################################
# Code begins

# Global list of modules to check for imporability.  Simply comment out any
# that we don't want to check, or add any package (by its actual import name)
# that you want to include in the checks.
MODULES_TO_CHECK = [ # The basic packages we always need
                     'IPython',
                     'numpy',
                     'scipy', 'scipy.io',
                     'matplotlib',
                     'nose',
                     'pandas',
                     'sympy',
                     # 'networkx',
                     # Potentially more delicate packages
                     # 'Cython',
                     #'mayavi.mlab',
                     # Data analysis packages
                     #'pandas',
                     #'statsmodels',
                     #'sklearn',
                     #'scikits.image',
                     ]

#-----------------------------------------------------------------------------
# Generic utility functions
def sys_info():
    """Summarize some info about the system"""

    print('==================')
    print('System information')
    print('==================')
    print('os.name      :', os.name)
    #print 'os.uname     :', os.uname()
    print('platform     :', sys.platform)
    print('platform+    :', platform.platform())
    print('prefix       :', sys.prefix)
    print('exec_prefix  :', sys.exec_prefix)
    print('executable   :', sys.executable)
    print('version_info :', sys.version_info)
    print('version      :', sys.version)
    print('==================')


#-----------------------------------------------------------------------------
# Tests

def check_import(mname):
    "Check that the given name imports correctly"
    
    namespace = {}
    exec("import %s as m" % mname, namespace)
    m = namespace["m"]

    ## python2: exec "import %s as m" % mname

    if mname == 'matplotlib':
        m.use('Agg')
        m.rcParams['figure.subplot.top']= 0.85
    
    try:
        vinfo = m.__version__
    except AttributeError:
        vinfo = '*no info*'

    print('MOD: {mname}, version: {vinfo}'.format(mname=mname,vinfo=vinfo))


def test_py3():
    "Test that we are using Python version 3.4 or greater"
    assert sys.version_info.major >= 3
    assert sys.version_info.minor >= 4

# Test generators are best written without docstrings, because nose can then
# show the parameters being used.
def test_imports():
    for mname in MODULES_TO_CHECK:
        yield check_import,mname


# Test generator, don't put a docstring in it
def test_loadtxt():
    import numpy as np
    import numpy.testing as npt

    # Examples taken from the loadtxt docstring
    array = np.array
    
    c = StringIO("0 1\n2 3")
    a1 = np.loadtxt(c)
    a2 = np.array([[ 0.,  1.],
                   [ 2.,  3.]])
    yield npt.assert_array_equal,a1,a2

    d = StringIO("M 21 72\nF 35 58")
    a1 = np.loadtxt(d, dtype={'names': ('gender', 'age', 'weight'),
                         'formats': ('S1', 'i4', 'f4')})
    
    a2 = np.array([('M', 21, 72.0), ('F', 35, 58.0)],
                  dtype=[('gender', '|S1'), ('age', '<i4'), ('weight', '<f4')])
    yield npt.assert_array_equal,a1,a2

    c = StringIO("1,0,2\n3,0,4")
    x,y = np.loadtxt(c, delimiter=',', usecols=(0,2), unpack=True)
    yield npt.assert_array_equal,x,np.array([ 1.,  3.])
    yield npt.assert_array_equal,y,np.array([ 2.,  4.])


def test_plot():
    "Simple plot generation."
    from matplotlib import pyplot as plt
    plt.figure()
    plt.plot([1,2,3])
    plt.xlabel('some numbers')
    plt.savefig('tmp_test_plot.png')


def test_plot_math():
    "Plots with math"
    from matplotlib import pyplot as plt
    plt.figure()
    plt.plot([1,2,3],label='data')
    t=(r'And X is $\sum_{i=0}^\infty \gamma_i + \frac{\alpha^{i^2}}{\gamma}'
       r'+ \cos(2 \theta^2)$')
    plt.title(t)
    plt.legend()
    plt.grid()
    plt.savefig('tmp_test_plot_math.png')


def cleanup_pngs():
    """Remove temporary pngs made by our plotting tests"""

    for f in glob.glob('tmp_test_plot*.png'):
        try:
            if os.path.isfile(f):
                os.remove(f)
        except OSError:
            print('*** Error: could not remove this file: {}'.format(f))
            

#-----------------------------------------------------------------------------
# Main routine, executed when this file is run as a script
#
if __name__ == '__main__':
    print("Running tests:")
    # This call form is ipython-friendly
    nose.runmodule(argv=[__file__, '-vvs'], exit=False)
    print("""
***************************************************************************
                           TESTS FINISHED
***************************************************************************

If the printout above did not finish in 'OK' but instead says 'FAILED', copy
and send the *entire* output (all info above and summary below) to the
instructor for help.
""")
    sys_info()
    cleanup_pngs()