The sloth API

Most of the code is kept in submodules, not the sloth namespace. Eg timers are in the sloth.timers module. The only function in the main sloth namespace is compare_sloth, which is documented below.

API

• sloth.timers: Timing functions and classes
• sloth.simple: Simple timing functions
• sloth.raw: The base API
  • sloth.raw.tests: Standard tests classes
  • sloth.raw.runners: Multiple test runners
  • sloth.raw.base: The abstract base classes for testing

sloth.compare_sloth(against)

Returns a string which is the result of comparing sloth to against.

Parameters

against (module) – Module/Package to compare sloth to.

Returns

String describing sloth vs against

Return type

str