setuptools.tests.doctest.DocTest Class Reference

Public Member Functions
def	__init__
def	__repr__
def	__cmp__

Public Attributes
	examples
	docstring
	globs
	name
	filename
	lineno

Detailed Description

A collection of doctest examples that should be run in a single
namespace.  Each `DocTest` defines the following attributes:

  - examples: the list of examples.

  - globs: The namespace (aka globals) that the examples should
    be run in.

  - name: A name identifying the DocTest (typically, the name of
    the object whose docstring this DocTest was extracted from).

  - filename: The name of the file that this DocTest was extracted
    from, or `None` if the filename is unknown.

  - lineno: The line number within filename where this DocTest
    begins, or `None` if the line number is unavailable.  This
    line number is zero-based, with respect to the beginning of
    the file.

  - docstring: The string that the examples were extracted from,
    or `None` if the string is unavailable.

Constructor & Destructor Documentation

def setuptools.tests.doctest.DocTest.__init__	(		self,
			examples,
			globs,
			name,
			filename,
			lineno,
			docstring
	)

Create a new DocTest containing the given examples.  The
DocTest's globals are initialized with a copy of `globs`.

Member Function Documentation

def setuptools.tests.doctest.DocTest.__cmp__	(		self,
			other
	)

def setuptools.tests.doctest.DocTest.__repr__

(

self

)

Member Data Documentation

setuptools.tests.doctest.DocTest.docstring

setuptools.tests.doctest.DocTest.examples

setuptools.tests.doctest.DocTest.filename

setuptools.tests.doctest.DocTest.globs

setuptools.tests.doctest.DocTest.lineno

setuptools.tests.doctest.DocTest.name

---

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

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