`msmu.pv.log`

Log one public call. Nested msmu calls are represented by their outer call.

Parameters:

Name	Type	Description	Default
`func`	`Callable \| None`	Function to decorate. Omit when using `@mm.pv.log(capture=(... ,))`.	`None`
`capture`	`tuple[str, ...]`	Tuple of parameter names whose values are stored in full rather than summarized, for example `("values",)`.	`()`
`file_inputs`	`tuple[str, ...]`	Parameter names whose local string values are input paths, including strings in nested containers. URLs, path objects and DataFrames are detected directly.	`()`

Returns:

Name	Type	Description
`wrapped`	`Callable`	A wrapped function, or a decorator when `func` is omitted. Successful calls attach history to participating `MuData` objects.

Notes

Nested recorded calls are represented by the outer call. Full captures may increase history size. Recording a custom function does not make it replayable: replay only executes supported public msmu functions. assign is the supported operation for recording column values.

Examples:

import msmu as mm
@mm.pv.log(capture=("label",))
def annotate(mdata, label):
    mdata.uns["label"] = label
    return mdata