goldpan.status

Development-status tagging for functions in this library.

Usage:

from goldpan.status import status, DONE, UNDER_DEVELOPMENT

@status(DONE)
def pretrigger_mean(pulses, config):
    ...

@status(UNDER_DEVELOPMENT, note="fraction=0.5 crossing heuristic, lightly validated")
def rise_sample(pulses, config, fraction=0.5):
    ...

DONE functions are called normally. UNDER_DEVELOPMENT functions still run, but emit a UserWarning on every call (with the note, if given) so it’s obvious in notebook output when a result depends on something not yet considered settled. Use list_statuses(module) to get an overview of a whole module at a glance.

Functions

list_statuses(module)	Return {function_name: (status, note)} for every status-tagged function defined in module (skips imports from other modules).
status(level[, note])	Decorator: tag a function with a development status.

goldpan.status.status(level, note=None)

Decorator: tag a function with a development status.

Attaches .status and .status_note to the function either way. For UNDER_DEVELOPMENT, also wraps the function to emit a UserWarning on every call.

goldpan.status.list_statuses(module)

Return {function_name: (status, note)} for every status-tagged function defined in module (skips imports from other modules).