Could testing in Python be simplified?

10 comments    Posted on May 28th, 2011

Edited on May 29 : After writing this article, Christian Heimes pointed out to me that the debug method on unttest.TestCase allows you to run tests interactively. The idiot in me didn’t do enough research before writing this rant. I’m leaving this post up to provide some context for future visitors/googlers who are looking for a quick way debug their test cases interactively.


One lesson I’ve learned over many years of observation and programming in Python is that the easier I make writing and running tests for my programs, the faster I can produce bug-free software. That is why I start most projects nowadays with two pre-baked files: main.py and tests.py.

With this setup and tools like Nose, testing code in Python for me is nearly pain free. Recently however, I notice one aspect of the unittest package in Python’s standard libary drives me absolutely crazy:

Why is there no simple method to run a single test case from within an interactive python shell?

As developers, this is important because if we are going to make writing tests an integral part of
our development workflow, one needs some way to actually run the damn test without dropping out of
our Python sessions and breaking out of our mental flow.

Being forced to run tests solely from the commandline also means we can’t take advantage of features like ipython’s ability to automatically drop into a pdb debugging session when an error occurs. This is extremely useful for when you want to introspect one or two variables to determine why a test failure occurred.

In general, it seems like the unittest library’s lack of a simple function to run single test cases in an interactive shell dis-incentivizes programmers from writing tests and detracts from python’s whole “rapid iteration” ethos.

After googling around and failing to find any good alternatives, I’ve finally settled on writing my own utility function to run single test cases:

def runtest(testCase, methodName):
    """ Runs a test case from within interactive shell """

    tc = testCase(methodName)
    getattr(tc, "setUp", lambda:None)()
    try:
        getattr(tc, methodName)()
    finally:
        getattr(tc, "tearDown", lambda:None)()

I add this function to every single project that I create now, and the qualitative feel of writing tests just feels so much more natural now. I also find myself writing more tests and running them more often with this function in my projects.

Give it a try, and let me know whether this has any effect for you. I’d love to hear your feedback on how it affects your development workflow.



Textmate hack: A keyboard shortcut for opening files in a new window

one comment    Posted on May 11th, 2011

Textmate has no split windows, and you can’t open the same file within a project in a new window without resorting to using the mouse. Here’s what I mean:

textmate open in new window

Situations often arise where you have to refrence one file while editing another. Maybe you want to view a header file while editing its implementation code. Or maybe you want a TODO list in one window while working on the rest of your code base.

In these scenarios tabbed editing becomes extremely painful, and the alternative of mousing around to open a new window has always felt like a clunky solution to me. Here’s a hack to create a keyboard shortcut for opening files in new windows. Oh what a hack it is:

#!/bin/sh

tof=`echo $TM_FILEPATH`
echo $tof

mate "$tof" .RANDOM_STRING_DOES_NOT_MATTER && osascript <<EOF
tell application "System Events"
    delay 0.2
    tell application "TextMate" to activate
    keystroke "t" using {command down}
    keystroke return
    keystroke "d" using {command down, control down, option down}
end tell
EOF

To use this, create a new bundle command, add this code to it, and associate your keyboard shortcut to the command.