Skip to content

Latest commit

 

History

History
45 lines (41 loc) · 6.72 KB

deprecations.md

File metadata and controls

45 lines (41 loc) · 6.72 KB

Deprecations and Removals

List of currently deprecated APIs:

Warning Description
ParamPendingDeprecationWarning since 2.3.0 param.parameterized module / Setting a parameter value before full instance initialization
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0 Parameter slots / List._class: use instead item_type
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0 Parameter slots / Number.set_hook: no replacement
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0 param.__init__ module / param.produce_value: no replacement
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0 param.__init__ module / param.as_unicode: no replacement
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0 param.__init__ module / param.is_ordered_dict: no replacement
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0 param.__init__ module / param.hashable: no replacement
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0 param.__init__ module / param.named_objs: no replacement
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0 param.__init__ module / param.normalize_path: no replacement
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0 param.__init__ module / param.abbreviate_paths: no replacement
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0 param.parameterized module / param.parameterized.all_equal: no replacement
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0 param.parameterized module / param.parameterized.add_metaclass: no replacement
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0 param.parameterized module / param.parameterized.batch_watch: use instead batch_call_watchers
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0 param.parameterized module / param.parameterized.recursive_repr: no replacement
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0 param.parameterized module / param.parameterized.overridable_property: no replacement
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0, soft-deprecated since 1.12.0 Parameterized .param namespace / .param.set_default: use instead for k,v in p.param.objects().items(): print(f"{p.__class__.name}.{k}={repr(v.default)}
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0, soft-deprecated since 1.12.0 Parameterized .param namespace / .param._add_parameter: use instead .param.add_parameter
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0, soft-deprecated since 1.12.0 Parameterized .param namespace / .param.params: use instead .param.values() or .param['param']
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0, soft-deprecated since 1.12.0 Parameterized .param namespace / .param.set_param: use instead .param.update
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0, soft-deprecated since 1.12.0 Parameterized .param namespace / .param.get_param_values: use instead .param.values().items() (or .param.values() for the common case of dict(....param.get_param_values()))
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0, soft-deprecated since 1.12.0 Parameterized .param namespace / .param.params_depended_on: use instead .param.method_dependencies
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0, soft-deprecated since 1.12.0 Parameterized .param namespace / .param.defaults: use instead {k:v.default for k,v in p.param.objects().items()}
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0, soft-deprecated since 1.12.0 Parameterized .param namespace / .param.print_param_defaults: use instead for k,v in p.param.objects().items(): print(f"{p.__class__.name}.{k}={repr(v.default)}")
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0, soft-deprecated since 1.12.0 Parameterized .param namespace / .param.print_param_values: use instead for k,v in p.param.objects().items(): print(f"{p.__class__.name}.{k}={repr(v.default)}")
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0, soft-deprecated since 1.12.0 Parameterized .param namespace / .param.message: use instead .param.log(param.MESSAGE, ...)
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0, soft-deprecated since 1.12.0 Parameterized .param namespace / .param.verbose: use instead .param.log(param.VERBOSE, ...)
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.0.0, soft-deprecated since 1.12.0 Parameterized .param namespace / .param.debug: use instead .param.log(param.DEBUG, ...)
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.1.0, ParamPendingDeprecationWarning since 2.0.0 Instantiating most parameters with positional arguments beyond default is deprecated
ParamFutureWarning since 2.2.0, ParamDeprecationWarning since 2.1.0, ParamPendingDeprecationWarning since 2.0.0 For Selector parameters that accept objects as first positional argument, and ClassSelector parameters that accept class_ as first positional argument, passing any argument by position is deprecated.

List (created after the release of version 2.2.0) of removed APIs:

Removed in Warning Description
2.2.0 ParamFutureWarning since 2.0.0 Parameterized namespace / instance._param_watchers (getter and setter): use instead the property inst.param.watchers
2.2.0 ParamFutureWarning since 2.0.0 Warn on failed validation of the default value of a Parameter after the inheritance mechanism has completed
2.2.0 ParamFutureWarning since 2.0.0 Running unsafe instance.param.objects(instance=True) during Parameterized instance initialization, instead run it after having called super().__init__(**params)
2.2.0 ParamFutureWarning since 2.0.0 Running unsafe instance.param.objects(instance=True) during Parameterized instance initialization, instead run it after having called super().__init__(**params)
2.2.0 ParamFutureWarning since 2.0.0 Running unsafe instance.param.watch(callback, "<param_name>") during Parameterized instance initialization, instead run it after having called super().__init__(**params)