mirror of
https://github.com/sqlalchemy/sqlalchemy.git
synced 2026-06-07 16:19:38 -04:00
Alexey Shamrin
33e30aacc3
* a first step to a new documentation framework, using Markdown syntax, with
some extensions (detailed in txt2myt.py docstrings):
* `rel:something` for internal links
* `{@name=something}` to override default header names (used when linking)
* `{python}` to force code block to use Python syntax highlighting (not
needed when using examples with `>>>` prompt)
* txt2myt.py -- converter from .txt to .myt
* a draft of tutorial.txt, which uses new syntax
* testdocs.py -- check examples in documentation using doctest (currently only
in tutorial.txt)
50 lines
1.4 KiB
Python
50 lines
1.4 KiB
Python
import os
|
|
import re
|
|
import doctest
|
|
|
|
def teststring(s, name, globs=None, verbose=None, report=True,
|
|
optionflags=0, extraglobs=None, raise_on_error=False,
|
|
parser=doctest.DocTestParser()):
|
|
|
|
from doctest import DebugRunner, DocTestRunner, master
|
|
|
|
# Assemble the globals.
|
|
if globs is None:
|
|
globs = {}
|
|
else:
|
|
globs = globs.copy()
|
|
if extraglobs is not None:
|
|
globs.update(extraglobs)
|
|
|
|
if raise_on_error:
|
|
runner = DebugRunner(verbose=verbose, optionflags=optionflags)
|
|
else:
|
|
runner = DocTestRunner(verbose=verbose, optionflags=optionflags)
|
|
|
|
test = parser.get_doctest(s, globs, name, name, 0)
|
|
runner.run(test)
|
|
|
|
if report:
|
|
runner.summarize()
|
|
|
|
if master is None:
|
|
master = runner
|
|
else:
|
|
master.merge(runner)
|
|
|
|
return runner.failures, runner.tries
|
|
|
|
def replace_file(s, oldfile, newfile):
|
|
engine = r"(^\s*>>>\s*[a-zA-Z_]\w*\s*=\s*create_engine\('sqlite',\s*\{'filename':\s*')" + oldfile+ "('\}\)$)"
|
|
engine = re.compile(engine, re.MULTILINE)
|
|
s, n = re.subn(engine, r'\1' + newfile + r'\2', s, 1)
|
|
if not n:
|
|
raise ValueError("Couldn't find suitable create_engine call to replace '%s' in it" % oldfile)
|
|
return s
|
|
|
|
filename = 'content/tutorial.txt'
|
|
s = open(filename).read()
|
|
s = replace_file(s, 'tutorial.db', ':memory:')
|
|
teststring(s, filename)
|
|
|