Local checkpoint of changes to testing machinery. Work in progress.

fperez · fperez · commit 3926d6d29ae7 · 2008-07-23T16:31:35.000-07:00
diff --git a/IPython/testing/plugin/Makefile b/IPython/testing/plugin/Makefile
@@ -8,9 +8,13 @@ dtest: plugin dtexample.py
 	nosetests -vs --with-ipdoctest --doctest-tests --doctest-extension=txt \
 	dtexample.py
 
+# Note: this test is double counting!!!
+rtest: plugin dtexample.py
+	nosetests -vs --with-ipdoctest --doctest-tests test_refs.py
+
 test: plugin dtexample.py
 	nosetests -vs --with-ipdoctest --doctest-tests --doctest-extension=txt \
-	dtexample.py test*.txt
+	dtexample.py test*.py test*.txt
 
 deb: plugin dtexample.py
 	nosetests -vs --with-ipdoctest --doctest-tests --doctest-extension=txt \
diff --git a/IPython/testing/plugin/dtexample.py b/IPython/testing/plugin/dtexample.py
@@ -71,37 +71,47 @@ def ipfunc():
     return 'ipfunc'
 
 
-def ranfunc():
-    """A function with some random output.
+if 1:
+    def ranfunc():
+        """A function with some random output.
 
-       >>> 1+3 #random
-       junk goes here...
+           >>> 1+3
+           junk goes here...  #random
 
-       >>> 1+3
-       4
+           >>> 1+3
+           4
 
-       >>> 1+2 #random
-       again,  anything goes
-    """
-    return 'ranfunc'
+           >>> 1+2
+           again,  anything goes #random
+           if multiline, the random mark is only needed in teh first line.
 
+           >>> 1+3
+           4
 
-def ranf2():
-    """A function whose examples are all all random
+           >>> ranfunc()
+           'ranfunc'
+        """
+        return 'ranfunc'
 
-    Examples:
 
-    #all-random
+if 0:
+    def ranf2():
+        """A function whose examples'output are all to be ignored.
 
-       >>> 1+3 #random
-       junk goes here...
+        Examples:
 
-       >>> 1+3
-       klasdfj;
+        #all-random
 
-       >>> 1+2 #random
-       again,  anything goes
+           >>> 1+3
+           junk goes here...
 
-    """
-    return 'ranf2'
+           >>> 1+3
+           klasdfj;
+
+           >>> 1+2
+           again,  anything goes
+           blah...
+
+        """
+        return 'ranf2'
 
diff --git a/IPython/testing/plugin/ipdoctest.py b/IPython/testing/plugin/ipdoctest.py
@@ -214,6 +214,22 @@ def _find(self, tests, obj, name, module, source_lines, globs, seen):
                                globs, seen)
 
 
+# second-chance checker; if the default comparison doesn't 
+# pass, then see if the expected output string contains flags that
+# tell us to ignore the output
+class IPDoctestOutputChecker(doctest.OutputChecker):
+    def check_output(self, want, got, optionflags):
+        #print '*** My Checker!'  # dbg
+        
+        ret = doctest.OutputChecker.check_output(self, want, got, 
+                                                 optionflags)
+        if not ret:
+            if "#random" in want:
+                return True
+
+        return ret
+
+
 class DocTestCase(doctests.DocTestCase):
     """Proxy for DocTestCase: provides an address() method that
     returns the correct address for the doctest case. Otherwise
@@ -227,26 +243,23 @@ class DocTestCase(doctests.DocTestCase):
     # Subclass nose.plugins.doctests.DocTestCase to work around a bug in 
     # its constructor that blocks non-default arguments from being passed
     # down into doctest.DocTestCase
-    ## def __init__(self, test, optionflags=0, setUp=None, tearDown=None,
-    ##              checker=None, obj=None, result_var='_'):
-    ##     self._result_var = result_var
-    ##     self._nose_obj = obj
-    ##     doctest.DocTestCase.__init__(self, test, 
-    ##                                  optionflags=optionflags,
-    ##                                  setUp=setUp, tearDown=tearDown, 
-    ##                                  checker=checker)
-
-    # doctests loaded via find(obj) omit the module name
-    # so we need to override id, __repr__ and shortDescription
-    # bonus: this will squash a 2.3 vs 2.4 incompatiblity
-    def id(self):
-        name = self._dt_test.name
-        filename = self._dt_test.filename
-        if filename is not None:
-            pk = getpackage(filename)
-            if pk is not None and not name.startswith(pk):
-                name = "%s.%s" % (pk, name)
-        return name
+
+    def __init__(self, test, optionflags=0, setUp=None, tearDown=None,
+                 checker=None, obj=None, result_var='_'):
+        self._result_var = result_var
+        doctests.DocTestCase.__init__(self, test, 
+                                      optionflags=optionflags,
+                                      setUp=setUp, tearDown=tearDown, 
+                                      checker=checker)
+        # Now we must actually copy the original constructor from the stdlib
+        # doctest class, because we can't call it directly and a bug in nose
+        # means it never gets passed the right arguments.
+        
+        self._dt_optionflags = optionflags
+        self._dt_checker = checker
+        self._dt_test = test
+        self._dt_setUp = setUp
+        self._dt_tearDown = tearDown
 
 
 
@@ -325,8 +338,8 @@ def parse(self, string, name='<string>'):
         argument `name` is a name identifying this string, and is only
         used for error messages.
         """
-
-        print 'Parse string:\n',string # dbg
+        
+        #print 'Parse string:\n',string # dbg
 
         string = string.expandtabs()
         # If all lines begin with the same indentation, then strip it.
@@ -390,9 +403,6 @@ def parse(self, string, name='<string>'):
             charno = m.end()
         # Add any remaining post-example text to `output`.
         output.append(string[charno:])
-
-        #print 'OUT:',output  # dbg
-
         return output
 
     def _parse_example(self, m, name, lineno,ip2py=False):
@@ -517,8 +527,39 @@ def loadTestsFromExtensionModule(self,filename):
             sys.path.pop()
         return tests
 
+    # NOTE: the method below is almost a copy of the original one in nose, with
+    # a  few modifications to control output checking.
+    
+    def loadTestsFromModule(self, module):
+        #print 'lTM',module  # dbg
+
+        if not self.matches(module.__name__):
+            log.debug("Doctest doesn't want module %s", module)
+            return
+        tests = self.finder.find(module)
+        if not tests:
+            return
+        tests.sort()
+        module_file = module.__file__
+        if module_file[-4:] in ('.pyc', '.pyo'):
+            module_file = module_file[:-1]
+        for test in tests:
+            if not test.examples:
+                continue
+            if not test.filename:
+                test.filename = module_file
+
+            #yield DocTestCase(test)
+
+            # always use whitespace and ellipsis options
+            optionflags = doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS
+            checker = IPDoctestOutputChecker()
+            yield DocTestCase(test, 
+                              optionflags=optionflags,
+                              checker=checker)
+
     def loadTestsFromFile(self, filename):
-        print 'lTF',filename  # dbg
+        #print 'lTF',filename  # dbg
 
         if is_extension_module(filename):
             for t in self.loadTestsFromExtensionModule(filename):
@@ -571,38 +612,6 @@ def wantFile(self,filename):
         else:
             return doctests.Doctest.wantFile(self,filename)
 
-    # NOTE: the method below is almost a copy of the original one in nose, with
-    # a  few modifications to control output checking.
-    
-    def loadTestsFromModule(self, module):
-        #print 'lTM',module  # dbg
-
-        if not self.matches(module.__name__):
-            log.debug("Doctest doesn't want module %s", module)
-            return
-        tests = self.finder.find(module)
-        if not tests:
-            return
-        tests.sort()
-        module_file = module.__file__
-        if module_file[-4:] in ('.pyc', '.pyo'):
-            module_file = module_file[:-1]
-        for test in tests:
-            if not test.examples:
-                continue
-            if not test.filename:
-                test.filename = module_file
-            yield DocTestCase(test)
-
-            # always use whitespace and ellipsis options
-            optionflags = doctest.NORMALIZE_WHITESPACE | doctest.ELLIPSIS
-            #checker = DoctestOutputChecker()
-            checker = None
-            yield DocTestCase(test, 
-                              optionflags=optionflags,
-                              checker=checker)
-
-
 
 class IPythonDoctest(ExtensionDoctest):
     """Nose Plugin that supports doctests in extension modules.
diff --git a/IPython/testing/plugin/show_refs.py b/IPython/testing/plugin/show_refs.py
@@ -0,0 +1,17 @@
+"""Simple script to show reference holding behavior.
+
+This is used by a companion test case.
+"""
+
+import gc
+
+class C(object):
+  def __del__(self):
+      print 'deleting object...'
+
+c = C()
+
+c_refs = gc.get_referrers(c)
+ref_ids = map(id,c_refs)
+
+print 'c referrers:',map(type,c_refs)
diff --git a/IPython/testing/plugin/test_refs.py b/IPython/testing/plugin/test_refs.py
@@ -0,0 +1,11 @@
+def test_refs():
+    """DocTest reference holding issues when running scripts.
+
+    In [32]: run show_refs.py
+    c referrers: [<type 'dict'>]
+
+    In [33]: map(type,gc.get_referrers(c))
+    Out[33]: [<type 'dict'>]
+
+    """
+    pass
