l.t.systemdocs : module documentation

Part of lp.testing

Infrastructure for setting up doctests.
Function strip_prefix Return path with the Launchpad tree root removed.
Class FilePrefixStrippingDocTestParser A DocTestParser that strips a prefix from doctests.
Class StdoutHandler A logging handler that prints log messages to sys.stdout.
Function LayeredDocFileSuite Create a DocFileSuite, optionally applying a layer to it.
Function ordered_dict_as_string Return the contents of a dict as an ordered string.
Function stop Undocumented
Function setGlobs Add the common globals for testing system documentation.
Function setUp Setup the common globals and login for testing system documentation.
Function tearDown Tear down the common system documentation test.
def strip_prefix(path):
Return path with the Launchpad tree root removed.
def LayeredDocFileSuite(paths, id_extensions=None, **kw):
Create a DocFileSuite, optionally applying a layer to it.

In addition to the standard DocFileSuite arguments, the following optional keyword arguments are accepted:

Parametersstdout_loggingIf True, log messages are sent to the doctest's stdout (defaults to True).
stdout_logging_levelThe logging level for the above.
layerA Zope test runner layer to apply to the tests (by default no layer is applied).
def ordered_dict_as_string(dict):
Return the contents of a dict as an ordered string.

The output will be ordered by key, so {'z': 1, 'a': 2, 'c': 3} will be printed as {'a': 2, 'c': 3, 'z': 1}.

We do this because dict ordering is not guaranteed.

def stop():
Undocumented
def setGlobs(test, future=False):
Add the common globals for testing system documentation.
def setUp(test, future=False):
Setup the common globals and login for testing system documentation.
def tearDown(test):
Tear down the common system documentation test.
API Documentation for Launchpad, generated by pydoctor at 2018-10-17 00:00:11.