Package zope :: Package testing :: Module doctest :: Class DocTestParser
[show private | hide private]
[frames | no frames]

Class DocTestParser


A class used to parse strings containing doctest examples.


Method Summary
  get_doctest(self, string, globs, name, filename, lineno)
Extract all doctest examples from the given string, and collect them into a DocTest object.
  get_examples(self, string, name)
Extract all doctest examples from the given string, and return them as a list of Example objects.
  parse(self, string, name)
Divide the given string into examples and intervening text, and return them as a list of alternating Examples and strings.

Method Details

get_doctest(self, string, globs, name, filename, lineno)

Extract all doctest examples from the given string, and collect them into a DocTest object.

globs, name, filename, and lineno are attributes for the new DocTest object. See the documentation for DocTest for more information.

get_examples(self, string, name='<string>')

Extract all doctest examples from the given string, and return them as a list of Example objects. Line numbers are 0-based, because it's most common in doctests that nothing interesting appears on the same line as opening triple-quote, and so the first interesting line is called "line 1" then.

The optional argument name is a name identifying this string, and is only used for error messages.

parse(self, string, name='<string>')

Divide the given string into examples and intervening text, and return them as a list of alternating Examples and strings. Line numbers for the Examples are 0-based. The optional argument name is a name identifying this string, and is only used for error messages.


Generated by Epydoc 2.1 on Fri Jun 24 12:01:21 2005 http://epydoc.sf.net