thepipe.tools

Manipulating time and so…

Module Contents

class thepipe.tools.Timer(message='It', precision=3, callback=print)

A very simple, accurate and easy to use timer context

start(self)

Starts the timers

stop(self)

Stops the timer

property seconds(self)

The elapsed time in seconds

property cpu_seconds(self)

The elapsed CPU time in seconds

log(self)

Call the callback function with the logging message

class thepipe.tools.Cuckoo(interval=0, callback=print)

A timed callback caller, which only executes once in a given interval.

reset(self)

Reset the timestamp

thepipe.tools.ignored(*exceptions)

Ignore-context for a given list of exceptions.

Example:

with ignored(AttributeError):

foo.a = 1

thepipe.tools.peak_memory_usage()

Return peak memory usage in MB

thepipe.tools.ATTRIBUTES

thepipe.tools.ATTRIBUTES_RE

thepipe.tools.HIGHLIGHTS

thepipe.tools.HIGHLIGHTS_RE

thepipe.tools.COLORS

thepipe.tools.COLORS_RE

thepipe.tools.RESET = \033[0m

thepipe.tools.RESET_RE = \033\[0m

thepipe.tools.colored(text, color=None, on_color=None, attrs=None, ansi_code=None)

Colorize text, while stripping nested ANSI color sequences.

Author: Konstantin Lepa <konstantin.lepa@gmail.com> / termcolor

Available text colors:

red, green, yellow, blue, magenta, cyan, white.

Available text highlights:

on_red, on_green, on_yellow, on_blue, on_magenta, on_cyan, on_white.

Available attributes:

bold, dark, underline, blink, reverse, concealed.

Example:

colored(‘Hello, World!’, ‘red’, ‘on_grey’, [‘blue’, ‘blink’]) colored(‘Hello, World!’, ‘green’)

thepipe.tools.cprint(text, color=None, on_color=None, attrs=None)

Print colorize text.

Author: Konstantin Lepa <konstantin.lepa@gmail.com> / termcolor

It accepts arguments of print function.

thepipe.tools.isnotebook()

Check if running within a Jupyter notebook

thepipe.tools.supports_color()

Checks if the terminal supports color.