param.parameterized.Parameters.objects#

Parameters.objects(instance: Literal[True, False, 'existing'] = True) → dict[str, Parameter][source]#

Return the Parameters of this instance or class.

This method provides access to Parameter objects defined on a Parameterized class or instance, depending on the value of the instance argument.

Parameters:

instance (bool or {'existing'}, default=True) –

  • True: Return instance-specific parameters, creating them if necessary. This requires the instance to be fully initialized.

  • False: Return class-level parameters without creating instance-specific copies.

  • 'existing': Returns a mix of instance parameters that already exist and class parameters, avoiding creation of new instance-specific parameters.

Returns:

A dictionary mapping parameter names to their corresponding Parameter objects.

Return type:

dict[str, Parameter]

Examples

Accessing class-level Parameters:

>>> import param
>>> class MyClass(param.Parameterized):
...     param1 = param.Number(default=1)
>>> MyClass.param.objects(instance=False)
{'name': <param.parameterized.String at 0x...>}

Accessing instance-level Parameters:

>>> obj = MyClass()
>>> obj.param.objects()
{'name': <param.parameterized.String at 0x...>}