2007-01-24 22:24:01 +08:00
|
|
|
import py
|
|
|
|
|
html = py.xml.html
|
|
|
|
|
from py.__.apigen.linker import Linker
|
|
|
|
|
from py.__.apigen.htmlgen import *
|
|
|
|
|
from py.__.apigen.tracer.docstorage import DocStorage, DocStorageAccessor
|
|
|
|
|
from py.__.apigen.tracer.tracer import Tracer
|
|
|
|
|
from py.__.apigen.project import Project
|
|
|
|
|
from py.__.test.web import webcheck
|
|
|
|
|
from py.__.apigen.conftest import option
|
|
|
|
|
|
|
|
|
|
def run_string_sequence_test(data, seq):
|
|
|
|
|
currpos = -1
|
|
|
|
|
for s in seq:
|
|
|
|
|
newpos = data.find(s)
|
|
|
|
|
if currpos >= newpos:
|
|
|
|
|
if newpos == -1:
|
|
|
|
|
message = 'not found'
|
|
|
|
|
else:
|
|
|
|
|
message = 'unexpected position: %s' % (newpos,)
|
|
|
|
|
py.test.fail('string %r: %s' % (s, message))
|
|
|
|
|
currpos = newpos
|
|
|
|
|
|
|
|
|
|
def setup_fs_project():
|
|
|
|
|
temp = py.test.ensuretemp('apigen_example')
|
|
|
|
|
temp.ensure("pkg/func.py").write(py.code.Source("""\
|
|
|
|
|
def func(arg1):
|
|
|
|
|
"docstring"
|
|
|
|
|
"""))
|
|
|
|
|
temp.ensure('pkg/someclass.py').write(py.code.Source("""\
|
|
|
|
|
class SomeClass(object):
|
|
|
|
|
" docstring someclass "
|
|
|
|
|
def __init__(self, somevar):
|
|
|
|
|
self.somevar = somevar
|
|
|
|
|
|
|
|
|
|
def get_somevar(self):
|
|
|
|
|
" get_somevar docstring "
|
|
|
|
|
return self.somevar
|
|
|
|
|
SomeInstance = SomeClass(10)
|
|
|
|
|
"""))
|
|
|
|
|
temp.ensure('pkg/somesubclass.py').write(py.code.Source("""\
|
|
|
|
|
from someclass import SomeClass
|
|
|
|
|
class SomeSubClass(SomeClass):
|
|
|
|
|
" docstring somesubclass "
|
|
|
|
|
def get_somevar(self):
|
|
|
|
|
return self.somevar + 1
|
|
|
|
|
"""))
|
|
|
|
|
temp.ensure('pkg/somenamespace.py').write(py.code.Source("""\
|
|
|
|
|
def foo():
|
|
|
|
|
return 'bar'
|
|
|
|
|
def baz(qux):
|
|
|
|
|
return qux
|
|
|
|
|
"""))
|
|
|
|
|
temp.ensure("pkg/__init__.py").write(py.code.Source("""\
|
|
|
|
|
from py.initpkg import initpkg
|
|
|
|
|
initpkg(__name__, exportdefs = {
|
|
|
|
|
'main.sub.func': ("./func.py", "func"),
|
|
|
|
|
'main.SomeClass': ('./someclass.py', 'SomeClass'),
|
|
|
|
|
'main.SomeInstance': ('./someclass.py', 'SomeInstance'),
|
|
|
|
|
'main.SomeSubClass': ('./somesubclass.py', 'SomeSubClass'),
|
|
|
|
|
'main.SomeSubClass': ('./somesubclass.py', 'SomeSubClass'),
|
|
|
|
|
'other': ('./somenamespace.py', '*'),
|
|
|
|
|
})
|
|
|
|
|
"""))
|
|
|
|
|
return temp, 'pkg'
|
|
|
|
|
|
|
|
|
|
def get_dsa(fsroot, pkgname):
|
|
|
|
|
py.std.sys.path.insert(0, str(fsroot))
|
|
|
|
|
pkg = __import__(pkgname)
|
|
|
|
|
ds = DocStorage()
|
|
|
|
|
ds.from_pkg(pkg)
|
|
|
|
|
dsa = DocStorageAccessor(ds)
|
|
|
|
|
return ds, dsa
|
|
|
|
|
|
|
|
|
|
def _checkhtml(htmlstring):
|
|
|
|
|
if isinstance(htmlstring, unicode):
|
|
|
|
|
htmlstring = htmlstring.encode('UTF-8', 'replace')
|
|
|
|
|
assert isinstance(htmlstring, str)
|
|
|
|
|
if option.webcheck:
|
|
|
|
|
webcheck.check_html(htmlstring)
|
|
|
|
|
else:
|
|
|
|
|
py.test.skip("pass --webcheck to validate html produced in tests "
|
|
|
|
|
"(partial skip: the test has succeeded up until here)")
|
|
|
|
|
|
|
|
|
|
def _checkhtmlsnippet(htmlstring):
|
|
|
|
|
# XXX wrap page around snippet and validate
|
|
|
|
|
pass
|
|
|
|
|
#newstring = """<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
|
|
|
#"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\n""" + unicode(h)
|
|
|
|
|
#_checkhtml(newstring)
|
|
|
|
|
|
|
|
|
|
class AbstractBuilderTest(object):
|
|
|
|
|
def setup_class(cls):
|
|
|
|
|
cls.fs_root, cls.pkg_name = setup_fs_project()
|
|
|
|
|
cls.ds, cls.dsa = get_dsa(cls.fs_root, cls.pkg_name)
|
|
|
|
|
cls.project = Project()
|
|
|
|
|
|
|
|
|
|
def setup_method(self, meth):
|
|
|
|
|
class LinkerForTests(Linker):
|
|
|
|
|
def get_target(self, linkid):
|
|
|
|
|
try:
|
|
|
|
|
return super(LinkerForTests, self).get_target(linkid)
|
|
|
|
|
except KeyError:
|
|
|
|
|
return 'unknown_link_%s' % (linkid,)
|
|
|
|
|
self.base = base = py.test.ensuretemp('%s_%s' % (
|
|
|
|
|
self.__class__.__name__, meth.im_func.func_name))
|
|
|
|
|
self.linker = linker = LinkerForTests()
|
|
|
|
|
self.apb = ApiPageBuilder(base, linker, self.dsa, self.fs_root)
|
|
|
|
|
self.spb = SourcePageBuilder(base, linker, self.fs_root)
|
|
|
|
|
self.namespace_tree = create_namespace_tree(['main.sub',
|
|
|
|
|
'main.sub.func',
|
|
|
|
|
'main.SomeClass',
|
|
|
|
|
'main.SomeSubClass',
|
|
|
|
|
'main.SomeInstance',
|
|
|
|
|
'other.foo',
|
|
|
|
|
'other.bar'])
|
|
|
|
|
|
|
|
|
|
class TestApiPageBuilder(AbstractBuilderTest):
|
|
|
|
|
def test_build_callable_view(self):
|
|
|
|
|
ds, dsa = get_dsa(self.fs_root, self.pkg_name)
|
|
|
|
|
t = Tracer(ds)
|
|
|
|
|
t.start_tracing()
|
|
|
|
|
pkg = __import__(self.pkg_name)
|
|
|
|
|
pkg.main.sub.func(10)
|
|
|
|
|
pkg.main.sub.func(pkg.main.SomeClass(10))
|
|
|
|
|
t.end_tracing()
|
|
|
|
|
apb = ApiPageBuilder(self.base, self.linker, dsa, self.fs_root)
|
|
|
|
|
snippet = apb.build_callable_view('main.sub.func')
|
|
|
|
|
html = snippet.unicode()
|
|
|
|
|
print html
|
|
|
|
|
run_string_sequence_test(html, [
|
2007-01-25 00:06:35 +08:00
|
|
|
'arg1 : AnyOf(',
|
2007-01-24 22:24:01 +08:00
|
|
|
'href="',
|
|
|
|
|
'Class SomeClass',
|
|
|
|
|
'Int>',
|
2007-01-25 00:06:35 +08:00
|
|
|
'return value:',
|
|
|
|
|
'<None>',
|
|
|
|
|
'source: %s' % (self.fs_root.join('pkg/func.py'),),
|
2007-01-24 22:24:01 +08:00
|
|
|
'def func(arg1):',
|
|
|
|
|
])
|
|
|
|
|
_checkhtmlsnippet(html)
|
|
|
|
|
|
|
|
|
|
def test_build_function_pages(self):
|
|
|
|
|
data = self.apb.prepare_function_pages(self.namespace_tree,
|
|
|
|
|
['main.sub.func'])
|
|
|
|
|
self.apb.build_function_pages(data, self.project)
|
|
|
|
|
funcfile = self.base.join('api/main.sub.func.html')
|
|
|
|
|
assert funcfile.check()
|
|
|
|
|
html = funcfile.read()
|
|
|
|
|
_checkhtml(html)
|
|
|
|
|
|
|
|
|
|
def test_build_class_view(self):
|
|
|
|
|
snippet = self.apb.build_class_view('main.SomeClass')
|
|
|
|
|
html = snippet.unicode()
|
|
|
|
|
_checkhtmlsnippet(html)
|
|
|
|
|
|
|
|
|
|
def test_build_class_pages(self):
|
|
|
|
|
data, methodsdata = self.apb.prepare_class_pages(self.namespace_tree,
|
|
|
|
|
['main.SomeClass',
|
|
|
|
|
'main.SomeSubClass'])
|
|
|
|
|
self.apb.build_class_pages(data, self.project)
|
|
|
|
|
clsfile = self.base.join('api/main.SomeClass.html')
|
|
|
|
|
assert clsfile.check()
|
|
|
|
|
html = clsfile.read()
|
|
|
|
|
_checkhtml(html)
|
|
|
|
|
|
|
|
|
|
def test_build_class_pages_instance(self):
|
|
|
|
|
data, methodsdata = self.apb.prepare_class_pages(self.namespace_tree,
|
|
|
|
|
['main.SomeClass',
|
|
|
|
|
'main.SomeSubClass',
|
|
|
|
|
'main.SomeInstance'])
|
|
|
|
|
self.apb.build_class_pages(data, self.project)
|
|
|
|
|
clsfile = self.base.join('api/main.SomeInstance.html')
|
|
|
|
|
assert clsfile.check()
|
|
|
|
|
html = clsfile.read()
|
|
|
|
|
print html
|
|
|
|
|
run_string_sequence_test(html, [
|
|
|
|
|
'instance of SomeClass()',
|
|
|
|
|
])
|
|
|
|
|
|
|
|
|
|
def test_build_class_pages_nav_links(self):
|
|
|
|
|
data, methodsdata = self.apb.prepare_class_pages(self.namespace_tree,
|
|
|
|
|
['main.SomeSubClass',
|
|
|
|
|
'main.SomeClass'])
|
|
|
|
|
# fake some stuff that would be built from other methods
|
|
|
|
|
self.linker.set_link('', 'api/index.html')
|
|
|
|
|
self.linker.set_link('main', 'api/main.html')
|
|
|
|
|
self.apb.build_class_pages(data, self.project)
|
|
|
|
|
clsfile = self.base.join('api/main.SomeClass.html')
|
|
|
|
|
assert clsfile.check()
|
|
|
|
|
html = clsfile.read()
|
|
|
|
|
print html
|
|
|
|
|
run_string_sequence_test(html, [
|
|
|
|
|
'href="../style.css"',
|
|
|
|
|
'href="index.html">pkg',
|
|
|
|
|
'href="main.html">main',
|
|
|
|
|
'href="main.SomeClass.html">SomeClass',
|
|
|
|
|
'href="main.SomeSubClass.html">SomeSubClass',
|
|
|
|
|
])
|
|
|
|
|
assert not 'href="main.sub.func.html"' in html
|
|
|
|
|
py.test.skip('WOP from here')
|
|
|
|
|
assert 'href="main.sub.html">sub' in html
|
|
|
|
|
_checkhtml(html)
|
|
|
|
|
|
|
|
|
|
def test_build_class_pages_base_link(self):
|
|
|
|
|
data, methodsdata = self.apb.prepare_class_pages(self.namespace_tree,
|
|
|
|
|
['main.SomeSubClass',
|
|
|
|
|
'main.SomeClass'])
|
|
|
|
|
self.apb.build_class_pages(data, self.project)
|
|
|
|
|
clsfile = self.base.join('api/main.SomeSubClass.html')
|
|
|
|
|
assert clsfile.check()
|
|
|
|
|
html = clsfile.read()
|
|
|
|
|
print html
|
|
|
|
|
run_string_sequence_test(html, [
|
|
|
|
|
'href="../style.css"',
|
|
|
|
|
'href="main.SomeClass.html">main.SomeClass',
|
|
|
|
|
])
|
|
|
|
|
_checkhtml(html)
|
|
|
|
|
|
|
|
|
|
def test_source_links(self):
|
|
|
|
|
data, methodsdata = self.apb.prepare_class_pages(self.namespace_tree,
|
|
|
|
|
['main.SomeSubClass',
|
|
|
|
|
'main.SomeClass'])
|
|
|
|
|
sourcedata = self.spb.prepare_pages(self.fs_root)
|
|
|
|
|
self.apb.build_class_pages(data, self.project)
|
|
|
|
|
self.spb.build_pages(sourcedata, self.project, self.fs_root)
|
|
|
|
|
funchtml = self.base.join('api/main.SomeClass.html').read()
|
|
|
|
|
assert funchtml.find('href="../source/pkg/someclass.py.html"') > -1
|
|
|
|
|
_checkhtml(funchtml)
|
|
|
|
|
|
|
|
|
|
def test_build_namespace_pages(self):
|
|
|
|
|
data = self.apb.prepare_namespace_pages(self.namespace_tree)
|
|
|
|
|
self.apb.build_namespace_pages(data, self.project)
|
|
|
|
|
mainfile = self.base.join('api/main.html')
|
|
|
|
|
assert mainfile.check()
|
|
|
|
|
html = mainfile.read()
|
|
|
|
|
print html
|
|
|
|
|
run_string_sequence_test(html, [
|
|
|
|
|
'index of main namespace',
|
|
|
|
|
])
|
|
|
|
|
otherfile = self.base.join('api/other.html')
|
|
|
|
|
assert otherfile.check()
|
|
|
|
|
otherhtml = otherfile.read()
|
|
|
|
|
print otherhtml
|
|
|
|
|
run_string_sequence_test(otherhtml, [
|
|
|
|
|
'index of other namespace',
|
|
|
|
|
])
|
|
|
|
|
_checkhtml(html)
|
|
|
|
|
_checkhtml(otherhtml)
|
|
|
|
|
|
|
|
|
|
def test_build_namespace_pages_index(self):
|
|
|
|
|
data = self.apb.prepare_namespace_pages(self.namespace_tree)
|
|
|
|
|
self.apb.build_namespace_pages(data, self.project)
|
|
|
|
|
pkgfile = self.base.join('api/index.html')
|
|
|
|
|
assert pkgfile.check()
|
|
|
|
|
html = pkgfile.read()
|
|
|
|
|
assert 'index of project pkg namespace'
|
|
|
|
|
_checkhtml(html)
|
|
|
|
|
|
|
|
|
|
def test_build_namespace_pages_subnamespace(self):
|
|
|
|
|
data = self.apb.prepare_namespace_pages(self.namespace_tree)
|
|
|
|
|
self.apb.build_namespace_pages(data, self.project)
|
|
|
|
|
subfile = self.base.join('api/main.sub.html')
|
|
|
|
|
assert subfile.check()
|
|
|
|
|
html = subfile.read()
|
|
|
|
|
_checkhtml(html)
|
|
|
|
|
|
|
|
|
|
def test_build_function_api_pages_nav(self):
|
|
|
|
|
data = self.apb.prepare_function_pages(self.namespace_tree,
|
|
|
|
|
['main.sub.func'])
|
|
|
|
|
self.linker.set_link('', 'api/index.html')
|
|
|
|
|
self.linker.set_link('main', 'api/main.html')
|
|
|
|
|
self.linker.set_link('main.sub', 'api/main.sub.html')
|
|
|
|
|
self.apb.build_function_pages(data, self.project)
|
|
|
|
|
funcfile = self.base.join('api/main.sub.func.html')
|
|
|
|
|
html = funcfile.read()
|
|
|
|
|
print html
|
|
|
|
|
run_string_sequence_test(html, [
|
|
|
|
|
'<a href="index.html">',
|
|
|
|
|
'<a href="main.html">',
|
|
|
|
|
'<a href="main.sub.html">',
|
|
|
|
|
'<a href="main.sub.func.html">',
|
|
|
|
|
])
|
|
|
|
|
_checkhtml(html)
|
|
|
|
|
|
|
|
|
|
def test_build_function_navigation(self):
|
|
|
|
|
self.apb.prepare_namespace_pages(self.namespace_tree)
|
|
|
|
|
self.apb.prepare_function_pages(self.namespace_tree, ['main.sub.func'])
|
|
|
|
|
nav = self.apb.build_navigation('main.sub', ['main.sub.func'],
|
|
|
|
|
'main.sub.func')
|
|
|
|
|
html = nav.unicode(indent=0)
|
|
|
|
|
print html.encode('UTF-8')
|
|
|
|
|
assert (u'<div><a href="api/index.html">pkg</a></div>'
|
|
|
|
|
u'<div>\xa0\xa0<a href="api/main.html">main</a></div>'
|
|
|
|
|
u'<div>\xa0\xa0\xa0\xa0'
|
|
|
|
|
u'<a href="api/main.sub.html">sub</a></div>'
|
|
|
|
|
u'<div class="selected">\xa0\xa0\xa0\xa0\xa0\xa0'
|
|
|
|
|
u'<a href="api/main.sub.func.html">func</a></div>'
|
|
|
|
|
) in html
|
|
|
|
|
|
|
|
|
|
def test_build_root_namespace_view(self):
|
|
|
|
|
data = self.apb.prepare_namespace_pages(self.namespace_tree)
|
|
|
|
|
self.apb.build_namespace_pages(data, self.project)
|
|
|
|
|
rootfile = self.base.join('api/index.html')
|
|
|
|
|
assert rootfile.check()
|
|
|
|
|
html = rootfile.read()
|
|
|
|
|
assert '<a href="main.html">' in html
|
|
|
|
|
_checkhtml(html)
|
|
|
|
|
|
|
|
|
|
class TestSourcePageBuilder(AbstractBuilderTest):
|
|
|
|
|
def test_build_pages(self):
|
|
|
|
|
data = self.spb.prepare_pages(self.fs_root)
|
|
|
|
|
self.spb.build_pages(data, self.project, self.fs_root)
|
|
|
|
|
somesource = self.base.join('source/pkg/func.py.html').read()
|
|
|
|
|
_checkhtml(somesource)
|
|
|
|
|
|
|
|
|
|
def test_build_pages_nav(self):
|
|
|
|
|
data = self.spb.prepare_pages(self.fs_root)
|
|
|
|
|
self.spb.build_pages(data, self.project, self.fs_root)
|
|
|
|
|
funcsource = self.base.join('source/pkg/func.py.html')
|
|
|
|
|
assert funcsource.check(file=True)
|
|
|
|
|
html = funcsource.read()
|
|
|
|
|
print html
|
|
|
|
|
run_string_sequence_test(html, [
|
|
|
|
|
'href="../../style.css"',
|
|
|
|
|
'<a href="../index.html">root</a>',
|
|
|
|
|
'<a href="index.html">pkg</a>',
|
|
|
|
|
'<a href="someclass.py.html">someclass.py</a>',
|
|
|
|
|
'<a href="somesubclass.py.html">somesubclass.py</a>',
|
|
|
|
|
])
|
|
|
|
|
|
|
|
|
|
def test_build_dir_page(self):
|
|
|
|
|
data = self.spb.prepare_pages(self.fs_root)
|
|
|
|
|
self.spb.build_pages(data, self.project, self.fs_root)
|
|
|
|
|
pkgindex = self.base.join('source/pkg/index.html')
|
|
|
|
|
assert pkgindex.check(file=True)
|
|
|
|
|
html = pkgindex.read()
|
|
|
|
|
print html
|
|
|
|
|
run_string_sequence_test(html, [
|
|
|
|
|
'href="../../style.css"',
|
|
|
|
|
'<a href="../index.html">root</a>',
|
|
|
|
|
'<a href="index.html">pkg</a>',
|
|
|
|
|
'<a href="func.py.html">func.py</a>',
|
|
|
|
|
'<a href="someclass.py.html">someclass.py</a>',
|
|
|
|
|
'<a href="somesubclass.py.html">somesubclass.py</a>',
|
|
|
|
|
'<h2>directories</h2>',
|
|
|
|
|
'<h2>files</h2>'])
|
|
|
|
|
_checkhtml(html)
|
|
|
|
|
|
|
|
|
|
def test_build_navigation_root(self):
|
|
|
|
|
self.spb.prepare_pages(self.fs_root)
|
|
|
|
|
nav = self.spb.build_navigation(self.fs_root.join('pkg'))
|
|
|
|
|
html = nav.unicode(indent=0)
|
|
|
|
|
print html.encode('UTF-8')
|
|
|
|
|
run_string_sequence_test(html, [
|
|
|
|
|
'href="source/index.html">root',
|
|
|
|
|
'href="source/pkg/index.html">pkg',
|
|
|
|
|
'href="source/pkg/func.py.html">func.py',
|
|
|
|
|
'href="source/pkg/someclass.py.html">someclass.py',
|
|
|
|
|
'href="source/pkg/somesubclass.py.html">somesubclass.py',
|
|
|
|
|
])
|
|
|
|
|
|
