kb_python.dry

Submodules

Package Contents

Functions

is_dry()

Return whether the current run is a dry run.

dryable(dry_func)

Function decorator to set a function as dryable.

dummy_function(*args, **kwargs)

A dummy function that doesn’t do anything and just returns.

kb_python.dry.is_dry()

Return whether the current run is a dry run.

Returns

whether the current run is a dry run

Return type

bool

kb_python.dry.dryable(dry_func)

Function decorator to set a function as dryable.

When this decorator is applied, the provided dry_func will be called instead of the actual function when the current run is a dry run.

Parameters

dry_func (function) – function to call when it is a dry run

Returns

wrapped function

Return type

function

kb_python.dry.dummy_function(*args, **kwargs)

A dummy function that doesn’t do anything and just returns. Used for making functions dryable.