Skip to content

Latest commit

 

History

History
80 lines (51 loc) · 1.93 KB

README.rst

File metadata and controls

80 lines (51 loc) · 1.93 KB

narcolepsy

pypi badge downloads badge

Overview

The narcolepsy package contains code which alters the behavior of your application/api by injecting random sleep calls into decorated functions.

Usage

The following code is an example of using the @narcoleptic decorator.

from narcolepsy import narcoleptic

@narcoleptic(max=5)  # sleep for 5 seconds at max
def foobar():
    for x in xrange(1024):
        nested_function(x)

The @narcoleptic decorator takes three parameters (all optional):

  • min: The minimum sleep time in seconds.
  • max: The maximum sleep time in seconds.
  • chance: The maximum number of lines that will be executed before a sleep() call is injected.

If no min or max are passed in, the constants defined in narcolepsy.constants will be used instead. If no chance is passed in, a value will be derived from the number of lines in the input function.

Installation

The easiest way to install narcolepsy is via pip:

$ pip install narcolepsy

Known Issues

As mentioned in the official documentation, sys.settrace() isn't part of the Python language definition and thus, may not be available to all Python implementations.

Why?

In theory this could help test time-critical code (multi-producer/consumer concurrent applications), but I mostly just wanted to play around with line tracers.

Disclaimer

This is a proof of concept. Use at your own risk!

LICENSE

See the LICENSE file for details.