make_doctests.py

"""
A hacktackular (tm) script for extracting runnable code from the docs and
writing them to 'doctests.py'.  This was easier than figuring out how to
manipulate the doctest system to do the same thing, but it is an unsustainable
model.  As such, this file should be deleted once we have functioning doctests.
"""
import os
import re

leftarrows = re.compile(r"^ *>>> ")
leftdots = re.compile(r"^ *\.\.\. ")
docskip = re.compile(r'doctest: \+SKIP')


def test_line(line):
    if docskip.search(line):
        return False
    elif leftarrows.search(line):
        return True
    elif leftdots.search(line):
        if line.count('...') == 1:
            return True


def strip_line(line):
    return leftdots.sub("", leftarrows.sub("", line))


with open('doctests.py', 'w') as doctests:
    for root, dirs, files in os.walk('.'):
        for fn in files:
            if os.path.splitext(fn)[1] == '.rst':
                with open(os.path.join(root, fn), 'r') as f:
                    lines = f.read().splitlines()

                pylines = [strip_line(L)
                           for L in lines if test_line(L)]
                doctests.write("# {fn}\n".format(fn=fn))
                doctests.writelines(pylines)