Table of Contents

Class: DocTest ./src/peak/util/_doctest.py

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.

Methods   
__cmp__
__init__
__repr__
  __cmp__ 
__cmp__ ( self,  other )

This lets us sort tests by name:

  __init__ 
__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`.

  __repr__ 
__repr__ ( self )


Table of Contents

This document was automatically generated on Mon Mar 25 01:11:05 2024 by HappyDoc version 2.1