.param namespace#

These methods and properties are available under the .param namespace of Parameterized classes and instances.

add_parameter(param_name, param_obj)

Add a new Parameter object into this object's class.

debug(msg, *args, **kw)

Print msg merged with args as a debugging statement.

defaults()

Return {parameter_name:parameter.default} for all non-constant Parameters.

deserialize_parameters(serialization[, ...])

deserialize_value(pname, value[, mode])

force_new_dynamic_value(name)

Force a new value to be generated for the dynamic attribute name, and return it.

get_param_values([onlychanged])

Return a list of name,value pairs for all Parameters of this object.

get_value_generator(name)

Return the value or value-generating object of the named attribute.

inspect_value(name)

Return the current value of the named attribute without modifying it.

log(level, msg, *args, **kw)

Print msg merged with args as a message at the indicated logging level.

message(msg, *args, **kw)

Print msg merged with args as a message.

method_dependencies(name[, intermediate])

Given the name of a method, returns a PInfo object for each dependency of this method.

objects([instance])

Returns the Parameters of this instance or class

outputs()

Returns a mapping between any declared outputs and a tuple of the declared Parameter type, the output method, and the index into the output if multiple outputs are returned.

params([parameter_name])

Return the Parameters of this class as the dictionary {name: parameter_object}

params_depended_on(*args, **kwargs)

Given the name of a method, returns a PInfo object for each dependency of this method.

pprint([imports, prefix, unknown_value, ...])

(Experimental) Pretty printed representation that may be evaluated with eval.

print_param_defaults()

Print the default values of all cls's Parameters.

print_param_values()

Print the values of all this object's Parameters.

schema([safe, subset, mode])

Returns a schema for the parameters on this Parameterized object.

set_default(param_name, value)

Set the default value of param_name.

set_dynamic_time_fn(time_fn[, sublistattr])

Set time_fn for all Dynamic Parameters of this class or instance object that are currently being dynamically generated.

set_param(*args, **kwargs)

For each param=value keyword argument, sets the corresponding parameter of this object or class to the given value.

serialize_parameters([subset, mode])

serialize_value(pname[, mode])

trigger(*param_names)

Trigger watchers for the given set of parameter names.

unwatch(watcher)

Remove the given Watcher object (from watch or watch_values) from this object's list.

update([arg])

For the given dictionary or iterable or set of param=value keyword arguments, sets the corresponding parameter of this object or class to the given value.

values([onlychanged])

Return a dictionary of name,value pairs for the Parameters of this object.

verbose(msg, *args, **kw)

Print msg merged with args as a verbose message.

warning(msg, *args, **kw)

Print msg merged with args as a warning, unless module variable warnings_as_exceptions is True, then raise an Exception containing the arguments.

watch(fn, parameter_names[, what, ...])

Register the given callback function fn to be invoked for events on the indicated parameters.

watch_values(fn, parameter_names[, what, ...])

Easier-to-use version of watch specific to watching for changes in parameter values.

watchers

Dictionary of instance watchers.