setuptools.tests.doctest.OutputChecker Class Reference

Public Member Functions
def	check_output
def	output_difference

Private Member Functions
def	_do_a_fancy_diff

Detailed Description

A class used to check the whether the actual output from a doctest
example matches the expected output.  `OutputChecker` defines two
methods: `check_output`, which compares a given pair of outputs,
and returns true if they match; and `output_difference`, which
returns a string describing the differences between two outputs.

Member Function Documentation

def setuptools.tests.doctest.OutputChecker._do_a_fancy_diff (   self,   want,   got,   optionflags  )

private

def setuptools.tests.doctest.OutputChecker.check_output	(		self,
			want,
			got,
			optionflags
	)

Return True iff the actual output from an example (`got`)
matches the expected output (`want`).  These strings are
always considered to match if they are identical; but
depending on what option flags the test runner is using,
several non-exact match types are also possible.  See the
documentation for `TestRunner` for more information about
option flags.

def setuptools.tests.doctest.OutputChecker.output_difference	(		self,
			example,
			got,
			optionflags
	)

Return a string describing the differences between the
expected output for a given example (`example`) and the actual
output (`got`).  `optionflags` is the set of option flags used
to compare `want` and `got`.

---

The documentation for this class was generated from the following file:

• orbits/lib/python2.7/site-packages/setuptools/tests/doctest.py