Skip to main content

An object-oriented API to test doctests using unittest runners.

Project description

An object-oriented API to test doctests using unittest runners.

Module providing classes which extend doctest module so as to achieve better integration with unittest.

It is different from the Pyhton 2.4 doctest unittest API because:

  • A new unitest.TestLoader descendant now allows to load instances of TestCases for doctests using unittest-style, supports building complex test suites in a more natural way, and eases the use of specialized instances of TestCase built out of doctest examples.

  • Other loaders allow users to extract TestCase instances out of TestCase descendants and doctests (and any other format) in a single step.

  • In this case unittest.TestResult instances report whether individual examples have been successfully executed, or otherwise have failed or raised an unexpected exception. Formerly TestResult objects contained the whole report outputted by doctest module.

  • Test analysis require no further parsing to retrieve detailed information about failures.

  • A whole new unittest API for doctest adds object orientation and eliminates functions with big signatures.

  • It is not necessary to use DocTestRunner output streams in order to collect test results.

  • A new hierarchy of doctest TestCases is now possible so for example, setUp and tearDown may be redefined across a hierarchy of TestCases instead of providing this methods as parameters to a function (breaking OOP philosophy and logic); or maybe even failures and errors can be represented in a custom way.

  • Allows to perform regression testing over tests written using doctest.

  • Fixes a minor bug related with specifying different verbosity levels from the command line to unittest.TestProgram (alias main).

  • Loads by default test cases for doctests plus those formerly loaded by unittest.TestLoader

It is similar to the Pyhton 2.4 doctest unittest API because:

  • Provides integration with TestProgram and unittest test runners.

  • Allows to parameterize doctest behavior via doctest options

A fuller explanation can be found in the following article:

“Doctest and unittest… now they’ll live happily together”, O. Lang (2008) The Python Papers, Volume 3, Issue 1, pp. 31:51

Note: The contents of this module were first implemented by the module oop.utils.testing contained in PyOOP package.

What’s new in version 0.2.2:

  • Bug fixed… The class PackageTestLoader loaded the tests defined in a packages’ chldren but not those specified in the top-level module. Now the tests specified in the module supplied in to loadTestsFromModule method are also included in the resulting test suite.

What’s new in version 0.2.1:

  • PackageTestLoader class added to dutest module. It loads all the tests found throughout a package hierarchy using another loader. The later is used for retrieving the tests contained inside every module matching a specified pattern.

  • DocTestLoader class in oop.utils.dutest does not raise ValueError exception if no doctests are found in a module. This is doctest behavior. It was assumed up to this point, but now it has proven to be a headache when these loaders are used together with instances of PackageTestLoader in order to retrieve all the tests defined across a package hierarchy.

What’s new in version 0.1.2:

  • Bug fixed… DocTestCase instances could not be instantiated because None was supplied in to the initializer as the test method name. This bug remained hidden somehow while executing the test using oop.test.check_oopdbc(), and even when importing oop.utils.dutest (which is actually the same implementation).

What’s new in version 0.1.1:

  • The class oop.utils.testing.VerboseTestProgram has been moved onto dutest module. Release 0.1.0 did not include it. Thanks to Michal Kwiatkowski for notifying me so [1].

  • Default test loader and runner have been added to this module as well. The default loader is an instance of MultiTestLoader that combines the suites loaded by unittest.TestLoader and dutest.DocTestLoader.

  • dutest.main is an alias for dutest.VerboseTestProgram. This class fixes a minor bug (… IMO) I found while specifying different verbosity levels from the command line to unittest.TestProgram. It also employs by default dutest.defaultTestLoader instead of unittest.defaultTestLoader.

What’s new in version 0.1.0:

doctest / unittest extensions:

  • A whole new unittest API to integrate doctest with unittest runners.

  • It allows to report the individual results of each and every interactive example executed during the test run. A separate entry is created in the corresponding TestResult instance containing the expected value and the actual result.

  • Since the match made for individual examples is reported one by one by instances of TestResult, it is quite easier to automate post-testing activities (e.g. automated test analysis). Formerly access to this information required extra work (i.e. the full report provided by doctest had to be parsed).

  • You do not need to use DocTestRunner output streams to collect test results.

  • A new hierarchy of TestCase descendants (extensions of DocTestCase class) is now possible so for example, setUp and tearDown may be redefined across a hierarchy of TestCases instead of providing this methods as parameters to a function (breaking OOP philosophy and logic); or maybe even to represent failures and errors in a custom way.

  • A new TestLoader descendant now allows to load (using unittest-style) TestCases which check the match made for doctests. It provides integration with TestProgram, supports building complex TestSuites in a more natural way, and eases the use of specialized instances of TestCases built out of doctest examples.

  • Allows to perform regression testing over tests written using doctest.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dutest-0.2.2.zip (13.4 kB view details)

Uploaded Source

Built Distributions

dutest-0.2.2.win32.exe (78.3 kB view details)

Uploaded Source

dutest-0.2.2-py2.5.egg (17.9 kB view details)

Uploaded Source

File details

Details for the file dutest-0.2.2.zip.

File metadata

  • Download URL: dutest-0.2.2.zip
  • Upload date:
  • Size: 13.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for dutest-0.2.2.zip
Algorithm Hash digest
SHA256 cf03b1fc6e6783dd702a44b23c87f0591f8e0a088c5b733a73af15d2820ac664
MD5 a766d6b57f038f48a068dfa9712dca08
BLAKE2b-256 b96997ea4a67a66b45aeead289c7520858d528240ae1142f9dc0bbfea4617d79

See more details on using hashes here.

File details

Details for the file dutest-0.2.2.win32.exe.

File metadata

  • Download URL: dutest-0.2.2.win32.exe
  • Upload date:
  • Size: 78.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for dutest-0.2.2.win32.exe
Algorithm Hash digest
SHA256 78692434e6b0b27860bab52fdd5f2064282365f8981f61e13aca06daca982a41
MD5 8e09b5038ea619d40da47fd0b9cd8d92
BLAKE2b-256 de7c87466af360e53a08bbd98d5d021aa2e25fcc09025196841e81138ab13b09

See more details on using hashes here.

File details

Details for the file dutest-0.2.2-py2.5.egg.

File metadata

  • Download URL: dutest-0.2.2-py2.5.egg
  • Upload date:
  • Size: 17.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for dutest-0.2.2-py2.5.egg
Algorithm Hash digest
SHA256 b7bd5dfa0c1e4030fa8e18a30a4fbc0c9195bb8215b7c3d31e6113d506a67e9c
MD5 1ba141b608a5840d3fc4b34bf15a7ad1
BLAKE2b-256 2b98dce6c19560f73e7b8973a53a9a22c663efc6b55b45750cf7ddae296f1fef

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page