param.edit_constant

param.edit_constant(parameterized: Parameterized) → Generator[None, None, None]

Context manager to temporarily set parameters on a Parameterized object to constant=False to allow editing them.

The edit_constant context manager allows temporarily disabling the constant property of all parameters on the given Parameterized object, enabling them to be modified. Once the context exits, the original constant states are restored.

Parameters:

parameterized (Parameterized) – The Parameterized object whose parameters will have their constant property temporarily disabled.

Yields:

None – A context where all parameters of the Parameterized object can be modified.

Examples

>>> import param
>>> class MyClass(param.Parameterized):
...     constant_param = param.Number(default=10, constant=True)
>>> p = MyClass()

Use edit_constant to modify the constant parameter:

>>> with param.edit_constant(p):
...     p.constant_param = 20
>>> p.constant_param
20