Fixes for python2.5 compatibility.

IPython/testing/_doctest26.py

@@ -0,0 +1,110 b''
+"""Code taken from the Python2.6 standard library for backwards compatibility.
+
+This is just so we can use 2.6 features when running in 2.5, the code below is
+copied verbatim from the stdlib's collections and doctest modules.
+"""
+
+from keyword import iskeyword as _iskeyword
+from operator import itemgetter as _itemgetter
+import sys as _sys
+
+def namedtuple(typename, field_names, verbose=False):
+    """Returns a new subclass of tuple with named fields.
+
+    >>> Point = namedtuple('Point', 'x y')
+    >>> Point.__doc__                   # docstring for the new class
+    'Point(x, y)'
+    >>> p = Point(11, y=22)             # instantiate with positional args or keywords
+    >>> p[0] + p[1]                     # indexable like a plain tuple
+    33
+    >>> x, y = p                        # unpack like a regular tuple
+    >>> x, y
+    (11, 22)
+    >>> p.x + p.y                       # fields also accessable by name
+    33
+    >>> d = p._asdict()                 # convert to a dictionary
+    >>> d['x']
+    11
+    >>> Point(**d)                      # convert from a dictionary
+    Point(x=11, y=22)
+    >>> p._replace(x=100)               # _replace() is like str.replace() but targets named fields
+    Point(x=100, y=22)
+
+    """
+
+    # Parse and validate the field names.  Validation serves two purposes,
+    # generating informative error messages and preventing template injection attacks.
+    if isinstance(field_names, basestring):
+        field_names = field_names.replace(',', ' ').split() # names separated by whitespace and/or commas
+    field_names = tuple(map(str, field_names))
+    for name in (typename,) + field_names:
+        if not all(c.isalnum() or c=='_' for c in name):
+            raise ValueError('Type names and field names can only contain alphanumeric characters and underscores: %r' % name)
+        if _iskeyword(name):
+            raise ValueError('Type names and field names cannot be a keyword: %r' % name)
+        if name[0].isdigit():
+            raise ValueError('Type names and field names cannot start with a number: %r' % name)
+    seen_names = set()
+    for name in field_names:
+        if name.startswith('_'):
+            raise ValueError('Field names cannot start with an underscore: %r' % name)
+        if name in seen_names:
+            raise ValueError('Encountered duplicate field name: %r' % name)
+        seen_names.add(name)
+
+    # Create and fill-in the class template
+    numfields = len(field_names)
+    argtxt = repr(field_names).replace("'", "")[1:-1]   # tuple repr without parens or quotes
+    reprtxt = ', '.join('%s=%%r' % name for name in field_names)
+    dicttxt = ', '.join('%r: t[%d]' % (name, pos) for pos, name in enumerate(field_names))
+    template = '''class %(typename)s(tuple):
+        '%(typename)s(%(argtxt)s)' \n
+        __slots__ = () \n
+        _fields = %(field_names)r \n
+        def __new__(_cls, %(argtxt)s):
+            return _tuple.__new__(_cls, (%(argtxt)s)) \n
+        @classmethod
+        def _make(cls, iterable, new=tuple.__new__, len=len):
+            'Make a new %(typename)s object from a sequence or iterable'
+            result = new(cls, iterable)
+            if len(result) != %(numfields)d:
+                raise TypeError('Expected %(numfields)d arguments, got %%d' %% len(result))
+            return result \n
+        def __repr__(self):
+            return '%(typename)s(%(reprtxt)s)' %% self \n
+        def _asdict(t):
+            'Return a new dict which maps field names to their values'
+            return {%(dicttxt)s} \n
+        def _replace(_self, **kwds):
+            'Return a new %(typename)s object replacing specified fields with new values'
+            result = _self._make(map(kwds.pop, %(field_names)r, _self))
+            if kwds:
+                raise ValueError('Got unexpected field names: %%r' %% kwds.keys())
+            return result \n
+        def __getnewargs__(self):
+            return tuple(self) \n\n''' % locals()
+    for i, name in enumerate(field_names):
+        template += '        %s = _property(_itemgetter(%d))\n' % (name, i)
+    if verbose:
+        print template
+
+    # Execute the template string in a temporary namespace and
+    # support tracing utilities by setting a value for frame.f_globals['__name__']
+    namespace = dict(_itemgetter=_itemgetter, __name__='namedtuple_%s' % typename,
+                     _property=property, _tuple=tuple)
+    try:
+        exec template in namespace
+    except SyntaxError, e:
+        raise SyntaxError(e.message + ':\n' + template)
+    result = namespace[typename]
+
+    # For pickling to work, the __module__ variable needs to be set to the frame
+    # where the named tuple is created.  Bypass this step in enviroments where
+    # sys._getframe is not defined (Jython for example).
+    if hasattr(_sys, '_getframe'):
+        result.__module__ = _sys._getframe(1).f_globals.get('__name__', '__main__')
+
+    return result
+
+
+TestResults = namedtuple('TestResults', 'failed attempted')

IPython/testing/ipunittest.py

@@ -1,188 +1,192 b''
 """Experimental code for cleaner support of IPython syntax with unittest.
 
 In IPython up until 0.10, we've used very hacked up nose machinery for running
 tests with IPython special syntax, and this has proved to be extremely slow.
 This module provides decorators to try a different approach, stemming from a
 conversation Brian and I (FP) had about this problem Sept/09.
 
 The goal is to be able to easily write simple functions that can be seen by
 unittest as tests, and ultimately for these to support doctests with full
 IPython syntax.  Nose already offers this based on naming conventions and our
 hackish plugins, but we are seeking to move away from nose dependencies if
 possible.
 
 This module follows a different approach, based on decorators.
 
 - A decorator called @ipdoctest can mark any function as having a docstring
   that should be viewed as a doctest, but after syntax conversion.
 
 Authors
 -------
 
 - Fernando Perez <[e-mail]>
 """
 
 from __future__ import absolute_import
 
 #-----------------------------------------------------------------------------
 #  Copyright (C) 2009  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
 #-----------------------------------------------------------------------------
 
 # Stdlib
 import re
 import sys
 import unittest
-from doctest import DocTestFinder, DocTestRunner, TestResults
+from doctest import DocTestFinder, DocTestRunner
+try:
+    from doctest import TestResults
+except:
+    from ._doctest26 import TestResults
 
 # Our own, a nose monkeypatch
 from . import nosepatch
 
 # We already have python3-compliant code for parametric tests
 if sys.version[0]=='2':
     from ._paramtestpy2 import ParametricTestCase
 else:
     from ._paramtestpy3 import ParametricTestCase
 
 from . import globalipapp
 
 #-----------------------------------------------------------------------------
 # Classes and functions
 #-----------------------------------------------------------------------------
 
 def count_failures(runner):
     """Count number of failures in a doctest runner.
 
     Code modeled after the summarize() method in doctest.
     """
     return [TestResults(f, t) for f, t in runner._name2ft.values() if f > 0 ]
 
 
 class IPython2PythonConverter(object):
     """Convert IPython 'syntax' to valid Python.
 
     Eventually this code may grow to be the full IPython syntax conversion
     implementation, but for now it only does prompt convertion."""
     
     def __init__(self):
         self.rps1 = re.compile(r'In\ \[\d+\]: ')
         self.rps2 = re.compile(r'\ \ \ \.\.\.+: ')
         self.rout = re.compile(r'Out\[\d+\]: \s*?\n?')
         self.pyps1 = '>>> '
         self.pyps2 = '... '
         self.rpyps1 = re.compile ('(\s*%s)(.*)$' % self.pyps1)
         self.rpyps2 = re.compile ('(\s*%s)(.*)$' % self.pyps2)
 
     def __call__(self, ds):
         """Convert IPython prompts to python ones in a string."""
         pyps1 = '>>> '
         pyps2 = '... '
         pyout = ''
 
         dnew = ds
         dnew = self.rps1.sub(pyps1, dnew)
         dnew = self.rps2.sub(pyps2, dnew)
         dnew = self.rout.sub(pyout, dnew)
         ip = globalipapp.get_ipython()
 
         # Convert input IPython source into valid Python.
         out = []
         newline = out.append
         for line in dnew.splitlines():
 
             mps1 = self.rpyps1.match(line)
             if mps1 is not None:
                 prompt, text = mps1.groups()
                 newline(prompt+ip.prefilter(text, False))
                 continue
 
             mps2 = self.rpyps2.match(line)
             if mps2 is not None:
                 prompt, text = mps2.groups()
                 newline(prompt+ip.prefilter(text, True))
                 continue
             
             newline(line)
         newline('')  # ensure a closing newline, needed by doctest
         #print "PYSRC:", '\n'.join(out)  # dbg
         return '\n'.join(out)
 
     #return dnew
 
 
 class Doc2UnitTester(object):
     """Class whose instances act as a decorator for docstring testing.
 
     In practice we're only likely to need one instance ever, made below (though
     no attempt is made at turning it into a singleton, there is no need for
     that).
     """
     def __init__(self, verbose=False):
         """New decorator.
 
         Parameters
         ----------
 
         verbose : boolean, optional (False)
           Passed to the doctest finder and runner to control verbosity.
         """
         self.verbose = verbose
         # We can reuse the same finder for all instances
         self.finder = DocTestFinder(verbose=verbose, recurse=False)
 
     def __call__(self, func):
         """Use as a decorator: doctest a function's docstring as a unittest.
         
         This version runs normal doctests, but the idea is to make it later run
         ipython syntax instead."""
 
         # Capture the enclosing instance with a different name, so the new
         # class below can see it without confusion regarding its own 'self'
         # that will point to the test instance at runtime
         d2u = self
 
         # Rewrite the function's docstring to have python syntax
         if func.__doc__ is not None:
             func.__doc__ = ip2py(func.__doc__)
 
         # Now, create a tester object that is a real unittest instance, so
         # normal unittest machinery (or Nose, or Trial) can find it.
         class Tester(unittest.TestCase):
             def test(self):
                 # Make a new runner per function to be tested
                 runner = DocTestRunner(verbose=d2u.verbose)
                 map(runner.run, d2u.finder.find(func, func.__name__))
                 failed = count_failures(runner)
                 if failed:
                     # Since we only looked at a single function's docstring,
                     # failed should contain at most one item.  More than that
                     # is a case we can't handle and should error out on
                     if len(failed) > 1:
                         err = "Invalid number of test results:" % failed
                         raise ValueError(err)
                     # Report a normal failure.
                     self.fail('failed doctests: %s' % str(failed[0]))
                     
         # Rename it so test reports have the original signature.
         Tester.__name__ = func.__name__
         return Tester
 
 
 def ipdocstring(func):
     """Change the function docstring via ip2py.
     """
     if func.__doc__ is not None:
         func.__doc__ = ip2py(func.__doc__)
     return func
 
         
 # Make an instance of the classes for public use
 ipdoctest = Doc2UnitTester()
 ip2py = IPython2PythonConverter()