doctestcompare

lxml-based doctest output comparison.

Note: normally, you should just import the lxml.usedoctest and lxml.html.usedoctest modules from within a doctest, instead of this one:

>>> import lxml.usedoctest # for XML output

>>> import lxml.html.usedoctest # for HTML output

To use this module directly, you must call lxmldoctest.install(), which will cause doctest to use this in all subsequent calls.

This changes the way output is checked and comparisons are made for XML or HTML-like content.

XML or HTML content is noticed because the example starts with < (it’s HTML if it starts with <html). You can also use the PARSE_HTML and PARSE_XML flags to force parsing.

Some rough wildcard-like things are allowed. Whitespace is generally ignored (except in attributes). In text (attributes and text in the body) you can use ... as a wildcard. In an example it also matches any trailing tags in the element, though it does not match leading tags. You may create a tag <any> or include an any attribute in the tag. An any tag matches any tag, while the attribute matches any and all attributes.

When a match fails, the reformatted example and gotten text is displayed (indented), and a rough diff-like output is given. Anything marked with + is in the output but wasn’t supposed to be, and similarly - means its in the example but wasn’t in the output.

You can disable parsing on one line with # doctest:+NOPARSE_MARKUP

Module Contents

Classes

LXMLOutputChecker()
LHTMLOutputChecker()
_RestoreChecker(self,dt_self,old_checker,new_checker,check_func,clone_func,del_module)

Functions

strip(v)
norm_whitespace(v)
html_fromstring(html)
install(html=False) Install doctestcompare for all future doctests.
temp_install(html=False,del_module=None) Use this inside a doctest to enable this checker for this
_find_doctest_frame()
strip(v)
norm_whitespace(v)
html_fromstring(html)
class LXMLOutputChecker
get_default_parser()
check_output(want, got, optionflags)
get_parser(want, got, optionflags)
_looks_like_markup(s)
compare_docs(want, got)
text_compare(want, got, strip)
tag_compare(want, got)
output_difference(example, got, optionflags)
html_empty_tag(el, html=True)
format_doc(doc, html, indent, prefix="")
format_text(text, strip=True)
format_tag(el)
format_end_tag(el)
collect_diff(want, got, html, indent)
collect_diff_tag(want, got)
collect_diff_end_tag(want, got)
collect_diff_text(want, got, strip=True)
class LHTMLOutputChecker
get_default_parser()
install(html=False)

Install doctestcompare for all future doctests.

If html is true, then by default the HTML parser will be used; otherwise the XML parser is used.

temp_install(html=False, del_module=None)

Use this inside a doctest to enable this checker for this doctest only.

If html is true, then by default the HTML parser will be used; otherwise the XML parser is used.

class _RestoreChecker(dt_self, old_checker, new_checker, check_func, clone_func, del_module)
__init__(dt_self, old_checker, new_checker, check_func, clone_func, del_module)
install_clone()
uninstall_clone()
install_dt_self()
uninstall_dt_self()
uninstall_module()
__call__(*args, **kw)
call_super(*args, **kw)
_find_doctest_frame()