Source code for leo.plugins.dtest

#@+node:ekr.20070119094733.1: * @file
#@+<< docstring >>
#@+node:ekr.20070119094733.4: ** << docstring >>
""" Sends code to the doctest module and reports the result.

When the Dtest plugin is enabled, the ``dtest`` command is active.

    Alt-X dtest

will run doctest on a file consisting of the current node and it's children.
If text is selected only the selection is tested.

From Wikipedia::

    'Doctest' is a module included in the Python programming language's
    standard library that allows for easy generation of tests based on
    output from the standard Python interpreter. - doctest page - Jim Fulton's presentation::

    Literate Testing:
    Automated Testing with doctest

#@-<< docstring >>
#@+<< imports >>
#@+node:ekr.20070119094733.2: ** <<imports>>
# import leo.core.leoPlugins as leoPlugins
    # Uses BaseLeoPlugin.
from leo.core.leoPlugins import BaseLeoPlugin

import doctest
import os
import leo.core.leoGlobals as g
#@-<< imports >>
#@+<< version history >>
#@+node:ekr.20070119094733.3: ** << version history >>

# v 0.1 EKR: modified slightly from original by ktenney.
# v 0.2 EKR: modified from mod_dtest by ktenney:
# - Converted to @thin
# - Use section references for code that must be in a particular place.
#@-<< version history >>

#@+node:ekr.20070119094733.5: ** init
[docs]def init (): '''Return True if the plugin has loaded successfully.''' g.registerHandler('after-create-leo-frame', DT) g.plugin_signon(__name__) return True
#@+node:ekr.20070119094733.6: ** class DT
[docs]class DT(BaseLeoPlugin): """Sends code to the doctest module and reports the result If text is selected, tests only the selection. >>> print("hello world") hello world >>>'hello world') >>> print(c.p.h) Docstring >>> import notfound Traceback (most recent call last): ... ImportError: No module named notfound >>> """ #@+others #@+node:ekr.20070119094733.8: *3* __init__ def __init__(self, tag, keywords): """Init doctest plugin """ BaseLeoPlugin.__init__(self, tag, keywords) self.setCommand('dt', self.dtest) self.c = keywords['c'] #@+node:ekr.20070119094733.9: *3* dtest
[docs] def dtest(self, event): """The handler for dtest """ import leo.core.leoGlobals as g # get a valid temporary filename createfile, tempfilename = g.create_temp_file() createfile.close() selected = False # if text is selected, only test selection if self.c.frame.body.hasTextSelection(): selected = True selection = self.c.frame.body.getSelectedText() tempfile = open(tempfilename, 'w') tempfile.write(selection) tempfile.close() # if no selection, test this subtree else: self.c.importCommands.flattenOutline(tempfilename) tempfile = open(tempfilename) text = tempfile.readlines() tempfile.close() # strip trailing whitespace, an annoying source of doctest failures text = [line.rstrip() for line in text] text = "\n".join(text) tempfile = open(tempfilename, 'w') tempfile.write(text) tempfile.close() import copy # build globals dictionary globals = {'c':copy.copy(self.c), 'g':g} # run doctest on temporary file failures, tests = doctest.testfile(tempfilename, module_relative = False, optionflags = doctest.ELLIPSIS, globs = globals) #@+<<report summary of results>> #@+node:ekr.20070119094733.10: *4* <<report summary of results>> if selected:'Result of running doctest on selected text;') else:'Result of running doctest on this subtree;') if failures == 0:"%s tests run successfully" % tests) if failures == 1: g.error("There was one failure in %s tests" % tests) if failures > 1: g.error("%s failures in %s tests" % (failures, tests)) #@-<<report summary of results>> #clean up temp file os.remove(tempfilename)
#@-others #@-others #@-leo