ParametersSectionBase

class ParametersSectionBase(params=None, **kwargs)

Bases: ParametersAbstract[T_Section]

Parameters are stored in a Section object.

Set and reset methods rely on Section.update() to merge the new parameters values to params.

Parameters:

• params (Any | None)

• kwargs (Any)

allow_new: bool = True

If True (default), allow to create new traits when using update() and set().

get(key, default=None)

Return a parameter value.

Parameters:

• key (str) – Name of the parameter to retrieve.

• default (Any) – Return this value if the parameters is not found.

Return type:

Any

reset()

Reset section to its default values.

Return type:

None

set(key, value)

Set a parameter to value.

Parameters:

• value (Any) – Value to set. If allow_new is True, can be a traitlets.TraitType to add to parameters.

• key (str)

Return type:

None

update(params=None, **kwargs)

Update one or more parameters values.

Parameters:

• params (Any | None) – Mapping of parameters to set.

• kwargs (Any) – Other parameters to set (takes precedence over params).

Return type:

None