Releases#
Version 2.2.0#
Date: 2024-12-16
This minor release brings a few enhancements and bugfixes. Importantly, it includes some breaking changes, removing deprecated APIs or raising errors during unsafe operations which would previously only emit warnings. Many thanks to @gandhis1 and @JRRudy1 for their first contributions, and to @hoxbro, @maximlt,and @MarcSkovMadsen for their continued maintenance and development efforts.
Enhancements:
Annotate
depends
andaccept_arguments
decorators (#962)Stop directly importing numpy and add
gen_types
decorator (#966)
Bug Fixes:
Added missing
super().__init_subclass__
call in_ParameterBase.__init_subclass__
(#969)Remove
_dict_update
(#980)
Documentation:
Breaking changes / Deprecations:
Remove
_param_watchers
, raiseRuntimeError
on unsafe ops during init, and failed validation of a parameter default after inheritance (#973)Promote many deprecation warnings to future warnings (#974)
Compatibility:
Infrastructure / Tests:
Version 2.1.1#
Date: 2024-06-25
This minor release contains bug fixes for reactive expressions and a few minor documentation improvements. Thanks to @jrycw for their first contribution! And to @ahuang11, @maximlt, and @philippjfr for their continued maintenance and development efforts.
Bug fixes:
Ensure
rx._callback
resolves accessors (#949)Ensure refs can be updated by watcher of the same parameter (#929)
Recursively resolve references on args and kwargs passed to a reactive operation (#944)
Only override the name of a Parameterized instance on Parameter instantiation when
instantiate=True
(#938)
Documentation:
Maintenance:
Fix
test_reactive_logic_unary_ops
on Python 3.12 (#946)
Version 2.1.0#
Date: 2024-03-22
This minor release focuses on improving reactive expressions and support for asynchronous (and synchronous) generators. Many thanks to @maximlt, @Hoxbro and @philippjfr for their continued maintenance and development efforts.
Enhancements:
Improvements for synchronous and asychronous generators (#908)
Additions to the .rx namespace including
and_
,bool
,map
,not_
,or_
andupdating
(#906)Add support for adding asynchronous watcher to
rx
(#917)Make it possible to resolve reactive expressions recursively with
.rx.resolve
(#918)Add support for async and generator functions in
.rx.pipe
(#924)
Bug fixes:
Ensure that
.param.update
context manager restore refs (#915)Avoid overeager root invalidation on
rx
leading to unnecessary evaluation (#919)
Deprecations:
Passing positional arguments to
Parameter
now raises aParamDeprecationWarning
(#921)
Version 2.0.2#
Date: 2024-01-17
This patch release fixes a few bugs and introduces a performance enhancement. Many thanks to @alfredocarella for their first contribution, and to the maintainers @maximlt and @philippjfr for contributing to this release.
Optimization:
Minor optimizations in hot codepaths accessing class parameters (#893)
Bug fixes:
Unpack partial callables in
iscoroutinefunction
(#894)Fix building Param with
setuptools-scm<7
(#903)
Documentation:
Version 2.0.1#
Date: 2023-11-08
This minor release fixes a number of bugs, including a regression introduced by the replacement of the build backend (setuptools
for hatchling
) which led to the doc
folder being wrongly packaged. Many thanks to @SultanOrazbayev for their first contribution, to @musicinmybrain for spotting the regression and submitting fixes, and to the maintainers @Hoxbro, @jbednar and @maximlt for contributing to this release.
Bug fixes:
Do not install
doc
folder in site-packages (#878)Drop the
feather-format
test dependency (#879)Add
tables
to thetests-deser
extra (#880)Fix
_state_push
and_state_pop
(#884)version.py
: new process should not create a window on Windows (#882, #886)Don’t import
setuptools_scm
if the.git
folder doesn’t exist (#885)
Documentation:
Version 2.0.0#
Date: 2023-10-24
20 years after its creation, Param has reached version 2.0! Can you guess when Param 3.0 will be released?
Param 2.0 is a major new release available for Python 3.8 and above, significantly streamlining, simplifying, and improving the Param API. Many long-supported but also long-obsolete functions, methods, and usages will now warn loudly so that you can make sure your code is only using the fully supported and safe current approaches. Because upgrading to Param 2 is likely to reveal compatibility issues with older codebases, new releases in the 1.x series are expected to continue for some time, focused on compatibility with the ecosystem rather than adding new features. Thus you can keep using Param 1.x with your older code, but Param 2 is the future!
We would like to thank @minimav for their first contribution, and @droumis, @Hoxbro, @jbednar, @maximlt, @philippjfr and @sdrobert for their contributions. We would also like to thank @ceball, who made the first plans for Param 2.0 quite a few years ago, and we are glad to be delivering on them at last!
Major enhancements and features#
Parameter slot values are now all inherited correctly across a hierarchy of Parameterized classes, making their behavior much clearer and more consistent. Let’s say we have class
B
being a subclass ofA
, itself being a subclass ofparam.Parameterized
. IfA
definesx = Number(1, bounds=(0, 10))
andB
definesx = Number(2)
,B.param['x'].bounds
is now going to be inherited fromA
and equal to(0, 10)
as you would expect. Parameterized classes have always supported inheritance, but the previous mechanism was based on usingNone
to indicate which values should be inherited, which was highly problematic becauseNone
was also a valid value for many slots. All Parameter slot signatures now default to the newUndefined
sentinel, finally allowingNone
to be inherited where appropriate. (#605, #771, #791, #874)The
objects
slot of a Selector was previously highly confusing, because it accepted either a dictionary or a list for initialization but then was accessible only as a list, making it difficult to watch or update the objects. There is now aListProxy
wrapper aroundSelector.objects
(with forward and backward compatibility) to easily updateobjects
and watchobjects
updates (#598, #825)Parameterized classes and instances now have a rich HTML representation that is displayed automatically in a Jupyter/IPython notebook. For a class or instance
p
, just returnp.param
in a notebook cell to see a table of all the Parameters of the class/instance, their state, type, and range, plus the docstring on hover. It is likely we will improve the content and design of this repr based on feedback, so please let us know what you think! (#425, #781, #821, #831)Parameters have all gained the
allow_refs
andnested_refs
attributes, bringing an exceptionally useful feature that was available in Panel since version 1.2 to Param. Declaring a Parameter withallow_refs=True
(False
by default) allows setting this Parameter value with a reference to automatically mirror the value of the reference. Supported references include class/instance Parameter objects, functions/methods decorated withparam.depends
, reactive functions and expressions, asynchronous generators and custom objects transformed into a valid reference with a hook registered withparam.parameterized.register_reference_transform
.nested_refs
indicate whether references should be resolved even when they are nested inside a container (#843, #845, #849, #865, #862, #876)Experimental new
rx
reactive expressions: Param is widely used for building web apps in the HoloViz ecosystem, where packages have added various mechanisms for dynamic updates (e.g.pn.bind
andpn.depends
in Panel, and.interactive
in hvPlot). These mechanisms were already built on Param and can be used far more widely than just in those packages, so that functionality has now been generalized, streamlined, and moved into Param. Nearly any Python expression can now be made reactive withparam.rx()
, at which point it will collect and be able to replay any operations (e.g. method calls) performed on them. This reactive programming approach lets you take just about any existing Python workflow and replace attributes with widgets or other reactive values, creating an app with fine-grained user control without having to design callbacks, event handlers, or any other complex logic!rx
support is still experimental while we get feedback about the API, packaging, and documentation, but it’s fully ready to try out and give us suggestions! (#460, #842, #841, #844, #846, #847, #850, #851, #856, #860, #854, #859, #858, #873)
Enhancements#
Parameter slot values that are set to mutable containers (e.g.
Selector(objects=a_list)
) will now be shallow-copied on instantiation, so that the container is no longer confusingly shared between the class and its subclasses and instances (#826)To further clean up the Parameterized namespace (first started in version 1.7.0), the remaining private attributes haven been collected under two private namespaces
_param__private
and_param__parameters
(#766, #790)You can now use
.param.update
as a context manager for applying temporary updates (#779)The
name
Parameter has always had special behavior dating to its use in labeling objects in a GUI context, but this behavior is now able to be overriden at the class and instance level (#740)Improved Parameter signatures for static and dynamic code analysis (#742)
Removed inferred Parameterized docstring signature and add basic
__signature__
support (#802)For speed, only generate the Parameter docstring in an IPython context (#774)
Improve Parameter validation error messages (#808)
Support for deserialization of file types into
Array
andDataFrame
(#482)Integer
now acceptsnumpy.integer
values (#735)Range
now does stricter validation of the slot values (#725, #824)Path
now hascheck_exists
attribute, leading it to raise an error ifpath
is not found on parameter instantiation (#800)Add top-level
__all__
and move Parameter classes toparameters.py
(#853)
Bug fixes#
Allow type change for
DateRange
andDate
(#733)Ensure class watchers are not inherited by instance parameter (#833)
Fix multi-level indirection in Parameters access (#840)
Ensure non-function types are not resolved as empty function declarations (#753)
Fix watchers support when the Parameterized instance is falsy (#769)
Fix depending on the method of a sub-parameter object (#765)
Raise an error on bad non-watched references (#777)
Ensure that the root dependency can be resolved, and error otherwise (#813)
Validate that
self
is present in the__init__
signature of a Parameterized class (#786)No longer force
instantiate
to True whenconstant
is True (#776)Instantiate default Parameter values based on all the Parameters available (#798)
Array
: fixparam.pprint
(#795)Array
: don’t hard-codeallow_None
toTrue
(#726)Boolean
: validate the default type (#722)FileSelector
: made more consistent withSelector
by defaulting to the first globbed path (#801)FileSelector
: ensure path separators are consistent on Windows (#805)Path
: raise aValueError
if set toNone
while not allowed (#799)Selector
: populateobjects
whencheck_on_set
is False anddefault
is not inobjects
(#794, #817)File/MultiFileSelector
: updatingpath
updatesobjects
(#814)
Documentation#
Infrastructure#
Increase the test suite coverage (#716, #717, #719, #720, #739, #775, #778)
Turn warnings into exceptions in the test suite (#738)
Add notebook smoke tests (#750)
Upgrades to leverage
hatch
,pyproject.toml
andpre-commit
(#749, #772)Add basic benchmark suite using
asv
(#788)Reduce the number of tested Python versions (#732)
Run the tests with Python 3.12 (#863)
Compatibility#
Breaking changes#
While it’s a major improvement to the definition of Parameters, properly inheriting Parameter slots can result in some Parameter slot values being different in Param 2, because Param 1 was sometimes silently not inheriting slot values.
User-defined
Parameter
classes should be updated to useUndefined
as the formal default for any new slots, with the actual default defined on the new_slot_defaults
dictionary. Otherwise, any new slot will fail to support inheritance, even if it was set toNone
, which would previously support inheritance.Parameterized
methods that were deprecated since Param 1.7.0 have finally been removed. These are now mostly available on the.param
namespace (#592)No longer supports setting non-Parameter class attributes during initialization, and no longer warns when setting non-Parameter class attributes directly (#729)
instance.param.watchers
no longer returns the transient dict of watchers but instead returns the instance watchers, as the now deprecatedinstance._param_watchers
(#797)Removed deprecated
Parameterized.pprint
,Parameterized._pprint
,Parameterized.script_repr
,ParameterizedFunction.script_repr
(#767)Removed
Time.next
method needed only for Python 2, and movedParameterized.state_pop
andParameterized.state_push
to the.param
namespace (#767)Some removals were considered harmless and thus implemented immediately without a deprecation period:
Deprecations#
This section lists functionality that is expected to be removed sometime in the next couple of 2.x releases, so if you use Param 2, please take care of these warnings as soon as you encounter them, and certainly before you upgrade to the next release!
Param 2.0 adds a validation step of the default value of a Parameter after the inheritance mechanism has completed if its type has changed (e.g. x
in class A
is a Number
and in class B(A)
is an Integer
) or one of its slot values has changed (#812, #820, #857). We have decided to only emit a warning when this validation fails to make your life easier when upgrading your code from Param 1 to 2, as the validation is performed on class creation which means that any validation error breaks importing your code. You should definitely take care of these warnings, they indicate a Parameter is in an invalid state!
We continue to clean up Param’s API (#734, #751, #768, #797, #834, #838) but have decided to do it in a gentle way, emitting deprecation warnings for a period of time before proceeding with removals. You will find below the complete list of deprecation warnings added in Param 2.0.
Parameter signature:
Instantiating most parameters with positional arguments beyond
default
is deprecated:String('prefix-test', '^prefix')
: deprecated!String('prefix-test', regex='^prefix')
: OKString(default='prefix-test', regex='^prefix')
: OK
For
Selector
parameters that acceptobjects
as first positional argument, andClassSelector
parameters that acceptclass_
as first positional argument, passing any argument by position is deprecated:Selector([1, 2])
: deprecated!Selector(objects=[1, 2])
: OKClassSelector((str, int))
: deprecated!ClassSelector(class_=(str, int))
: OKIt’s possible that in the future the signature of these two parameters will be aligned with the other parameters to accept
default
as first and only positional argument, but for now please use an explicit keyword so that your code will be compatible with all versions.
Parameter slots:
List._class
: use insteaditem_type
.Number.set_hook
: no replacement
param.__init__
module:param.produce_value
: no replacementparam.as_unicode
: no replacementparam.is_ordered_dict
: no replacementparam.is_ordered_dict
: no replacementparam.hashable
: no replacementparam.named_objs
: no replacementparam.normalize_path
: no replacementparam.abbreviate_paths
: no replacement
param.parameterized
module:param.parameterized.all_equal
: no replacementparam.parameterized.add_metaclass
: no replacementparam.parameterized.batch_watch
: use insteadbatch_call_watchers
param.parameterized.recursive_repr
: no replacementparam.parameterized.overridable_property
: no replacement
Parameterized
.param
namespace; many of these methods have been deprecated since version 1.12.0, however, this was just announced in the release notes and we realised many users missed them, sometimes even us included! They now all emit deprecation warnings when executed and are clearly marked as deprecated in the API reference:.param.set_default
: use insteadfor k,v in p.param.objects().items(): print(f"{p.__class__.name}.{k}={repr(v.default)}")
.param._add_parameter
: use instead.param.add_parameter
.param.params
: use instead.param.values()
or.param['param']
.param.set_param
: use instead.param.update
.param.get_param_values
: use instead.param.values().items()
(or.param.values()
for the common case ofdict(....param.get_param_values())
).param.params_depended_on
: use instead.param.method_dependencies
.param.defaults
: use instead{k:v.default for k,v in p.param.objects().items()}
.param.print_param_defaults
: use insteadfor k,v in p.param.objects().items(): print(f"{p.__class__.name}.{k}={repr(v.default)}")
.param.print_param_values
: use insteadfor k,v in p.param.objects().items(): print(f"{p.__class__.name}.{k}={repr(v.default)}")
.param.message
: use instead.param.log(param.MESSAGE, ...)
.param.verbose
: use instead.param.log(param.VERBOSE, ...)
.param.debug
: use instead.param.log(param.DEBUG, ...)
Running unsafe operations during Parameterized instance initialization, instead run these operations after having called
super().__init__(**params)
:instance.param.objects(instance=True)
instance.param.trigger("<param_name>")
instance.param.watch(callback, "<param_name>")
Parameterized namespace:
instance._param_watchers
(getter and setter): use instead the propertyinst.param.watchers
Version 1.13.0#
Date: 2023-03-14
The 1.13.0
is the last release of Param before the 2.0 release. However, Param 1.13 is meant to receive long-term support; security patches and fixes to critical bugs are planned to be backported to the 1.13.x series.
This release includes a new Bytes
Parameter and a few important bug fixes. This release is also marked by the adoption of a formal project governance, ensuring Param’s future as a healthy open-source project. Many thanks to @ovidner and @droumis for their first contributions! And to @maximlt, @Hoxbro, @jlstevens, @philippjfr and @jbednar for their continuing support to fixing and improving Param.
Bug fixes:
Fix copying when having watchers on e.g. bounds on inherited Parameter types (#675)
Allow JSON serialization to work with
json.dumps
(#655)ListSelector
restricted tolist
type objects (#531)Fix
depends
async wrapper (#684)Allow named colors to be any case (#711)
New features:
Add Bytes parameter (#542)
Documentation:
Fix param module link (#682)
Project governance:
Create initial project governance docs (#674)
Maintenance:
Version 1.12.3#
Date: 2022-12-06
The 1.12.3
release adds support for Python 3.11. Many thanks to @musicinmybrain (first contribution!) and @maximlt for contributing to this release.
Enhancements:
Version 1.12.2#
Date: 2022-06-14
The 1.12.2
release fixes a number of bugs and adds support again for Python 2.7, which was unfortunately no longer supported in the last release. Note however that Param 2.0 will still drop support of Python 2.7 as already announced. Many thanks to @Hoxbro and the maintainers @jbednar, @jlstevens, @maximlt and @philippjfr for contributing to this release.
Bug fixes:
Match against complete spec name when determining dynamic watchers (#615)
Ensure async functionality does not cause python2 syntax errors (#624)
Allow (de)serializing
CalendarRange
andDateRange
Parameters
(#625)Improve
DateRange
validation (#627)Fix regression in
@param.depends
execution ordering (#628)Ensure
named_objs
does not fail on unhashable objects (#632)Support comparing date-like objects (#629)
Fixed
BinaryPower
example in the docs to use the correct nameEvenInteger
(#634)
Version 1.12.1#
The 1.12.1 release fixes a number of bugs related to async callback handling when using param.depends
and .param.watch
and a number of documentation and error messages. Many thanks to @HoxBro and the maintainers @jbednar, @jlstevens, @maximlt and @philippjfr for contributing to this release.
Error handling and documentation:
Fixed description of shared_parameters (#568)
Improve the error messages of Date and DateRange (#579)
Clarified step error messages and other docs and links (#604)
Bug fixes:
Make iscoroutinefunction more robust (#572)
Fix for handling misspelled parameter (#575)
Handle None serialization for Date, CalendarDate, Tuple, Array, and DataFrame (#582)
Support async coroutines in param.depends (#591)
Handle async functions in depends with watch=True (#611)
Avoid equality check on Watcher (#612)
Documentation:
Version 1.12.0#
Version 1.12.0 introduces a complete user manual and website (for the first time since 2003!) along with extensive API improvements gearing up for the 2.0 release (which will be Python3 only).
The pre-2.0 API is still being preserved and no new warnings are added in this release, so the older API can continue to be used with this release, but the next 1.x release is expected to enable warnings for deprecated API. If you have older code using the deprecated Param features below, please update your API calls as described below to be compatible with the 2.0 release when it comes out (or pin to param<2 if you don’t need any new Param features). For new users, just use the API documented on the website, and you should be ready to go for either 1.12+ or 2.0+.
Thanks to James A. Bednar for the user guide and 2.0 API support, to Philipp Rudiger for improvements and new capabilities for handling dependencies on subobjects, and to Maxime Liquet and Philipp Rudiger for extensive improvements to the website/docs/package-building/testing.
New features:
Added future-facing API for certain Parameterized().param methods (see Compatibility below; #556, #558, #559)
New option
on_init=True
for@depends
decorator, to run the method in the constructor to ensure initial state is consistent when appropriate (#540)Now resolves subobject dependencies dynamically, allowing dependencies on internal parameters of subobjects to resolve appropriately as those objects are replaced. (#552)
Added prettyprinting for numbergen expressions (#525)
Improved JSON schema generation (#458)
Added more-usable script_repr command, availabie in param namespace, with default values, and showing imports (#522)
Added Parameterized.param.pprint(); underlying implementation of script_repr but with defaults suitable for interactive usage rather than generating a .py script. (#522)
Watchers can now declare precedence so that events are triggered in the desired order (#552, #557)
Bug fixes:
Fix bug setting attributes in some cases before class is initialized (#544)
Ensure None is supported on ListSelector (#511)
Switched from deprecated
inspect.getargspec
to the py3 versioninspect.getfullargspec
, which is similar but splitskeyword
args intovarkw
(**) and kw-only args. Falls back to getargspec on Python2. (#521)
Doc improvements (including complete user guide for the first time!):
Misc comments/docstrings/docs cleanup (#507, #518, #528, #553)
Added comparison with pydantic (#523)
Added new user guide sections:
Infrastructure:
Added testing on Python 3.10 and on Mac OS X and removed slow PyPy/pandas/numpy tests (#548, #549, #526)
Docs/tests/build infrastructure improvements (#509, #521, #529, #530, #537, #538, #539, #547, #548, #555)
Compatibility (see #543 for the complete list):
Calendardate now accepts date values only (#517)
No longer allows modifying name of a Parameter once it is in a Parameterized class, to avoid confusion (#541)
Renamed (with old name still accepted for compatibility until 2.0):
.param._add_parameter()
: Now public.param.add_parameter()
; too useful to keep private! (#559).param.params_depended_on
: Now.param.method_dependencies
to indicate that it accepts a method name and returns its dependencies (#559).pprint
: Now private._pprint
; use public.param.pprint
instead (#559)batch_watch
: Nowbatch_call_watchers
, to declare that it does not set up watching, it just invokes it. Removed unused operation argument (#536)
Deprecated (but not yet warning unless noted):
.param.debug()
: Use.param.log(param.DEBUG, ...)
instead (#556).param.verbose()
: Use.param.log(param.VERBOSE, ...)
instead (#556).param.message()
: Use.param.log(param.MESSAGE, ...)
instead (#556).param.defaults()
: Use{k:v.default for k,v in p.param.objects().items()}
instead (#559).param.deprecate()
: To be repurposed or deleted after 2.0 (#559).param.params()
: Use.param.values()
or.param['param']
instead (#559).param.print_param_defaults()
: Usefor k,v in p.param.objects().items(): print(f"{p.__class__.name}.{k}={repr(v.default)}")
instead (#559).param.print_param_values()
: Usefor k,v in p.param.values().items(): print(f"{p.name}.{k}={v}")
instead (#559).param.set_default()
: Usep.param.default=
instead (#559).param.set_param()
: Had tricky API; use.param.update
instead (#558).param.get_param_values()
: Use.param.values().items()
instead (or.param.values()
for the common case ofdict(....param.get_param_values())
) (#559).state_pop()
: Will be renamed to._state_pop
to make private.state_push()
: Will be renamed to._state_push
to make private.initialized
: Will be renamed to._initialized
to make privateMost methods on Parameterized itself have already been deprecated and warning for some time now; see #543 for the list. Use the corresponding method on the
.param
accessor instead.
Added:
.param.watchers
: Read-only version of private_watchers
(#559).param.log()
: Subsumes .debug/verbose/message; all are logging calls. (#556).param.update()
: Dictionary-style updates to parameter values, as a drop-in replacement forset_param
except for its optional legacy positional-arg syntax (#558).values()
: Dictionary of name:value pairs for parameter values, replacingget_param_values
but now a dict since python3 preserves order (#558).param.log()
: General-purpose interface to the logging module functionailty; replaces .debug, .verbose, .message (#556)
Version 1.11.1#
(including changes in 1.11.0; 1.11.1 adds only a minor change to fix param.List(None)
.)
Version 1.11 contains entirely new documentation, plus various enhancements and bugfixess. Thanks to James A. Bednar for the documentation, Philipp Rudiger for the website setup and for many of the other fixes and improvements below, and others as noted below.
Documentation:
Brand-new website, with getting started, user manual, reference manual, and more! Some user guide sections are still under construction. (#428,#464,#479,#483,#501,#502,#503,#504)
New intro video with examples/Promo.ipynb notebook, thanks to Marc Skov Madsen and Egbert Ammicht (#488)
Sort docstring by definition order and precedence, thanks to Andrew Huang (#445)
Enhancements:
Allow printing representations for recursively nested Parameterized objects (#499)
Allow named colors for param.Color (#472)
Allow FileSelector and MultiFileSelector to accept initial values (#497)
Add Step slot to Range, thanks to Simon Hansen (#467)
Update FileSelector and MultiFileSelector parameters when setting path (#476)
Improved error messages (#475)
Bug Fixes:
Fix Path to allow folders, as documented but previously not supported (#495)
Fix previously unimplemented Parameter._on_set (#484)
Fix Python2 IPython output parameter precedence (#477)
Fix allow_None for param.Series and param.DataFrame (#473)
Fix behavior when both
instantiate
andconstant
areTrue
(#474)Fix for versioning when param is inside a separate git-controlled repo (port of fix from autover/pull/67) (#469)
Compatibility:
Swapped ObjectSelector and Selector in the inheritance hierarchy, to allow ObjectSelector to be deprecated. (#497)
Now
get_soft_bounds
silently crops softbounds to any hard bounds supplied ; previously soft bounds would be returned even if they were outside the hard bounds (#498)Rename
class_
toitem_type
in List parameter, to avoid clashing semantics with ClassSelector and others with aclass_
slot.class_
is still accepted as a keyword but is stored initem_type
. (#456)
Version 1.10.1#
Minor release for Panel-related bugfixes and minor features, from @philippjfr.
Version 1.10.0#
Version 1.9.3#
Fixed ClassSelector.get_range when a tuple of types is supplied (#360)
Version 1.9.2#
Version 1.9.1#
Enhancements:
Allow param.depends to annotate functions (#334)
Add context managers to manage events and edit constant parameters
Bug fixes:
Version 1.9.0#
Full release with new functionality and some fixes. New features:
Added support for instance parameters, allowing parameter metadata to be modified per instance and allowing parameter objects to be passed to Panel objects (#306)
Added label slot to Parameter, to allow overriding attribute name for display (#319)
Added step slot to Parameter, e.g. to control Panel widget step size (#326)
Added keywords_to_params utility for deducing Parameter types and ranges automatically (#317)
Added support for multiple outputs from a Parameterized (#312)
Added Selector as a more user-friendly version of ObjectSelector, accepting a list of options as a positional argument (#316)
Changes affecting backwards compatibility:
Changed from root logger to a param-specific logger; no change to API but will change format of error and warning messages (#330)
Old abstract class Selector renamed to SelectorBase; should be no change unless user code added custom classes inherited from Selector without providing a constructor (#316)
Bugfixes and other improvements:
For more details, you can see a full list of changes since the previous release.
Version 1.8.2#
Minor release:
For more details, you can see a full list of changes since the previous release.
Version 1.8.1#
Minor release:
Added positional default arguments for nearly all Parameter subclasses (apart from ClassSelector)
Minor bugfixes for watching callbacks
For more details, you can see a full list of changes since the previous release.
Version 1.8.0#
Major new feature set: comprehensive support for events, watching, callbacks, and dependencies
Parameterized methods can now declare
@depends(p,q)
to indicate that they depend on parametersp
andq
(defaulting to all parameters)Parameterized methods can depend on subobjects with
@depends(p.param,q.param.r)
, wherep.param
indicates dependencies on all parameters ofp
andq.param.r
indicates a dependency on parameterr
ofq
.Functions and methods can
watch
parameter values, re-running when those values change or when an explicit trigger is issued, and can unwatch them later if needed.Multiple events can be batched to trigger callbacks only once for a coordinated set of changes
Other new features:
Added support in ObjectSelector for selecting lists and dicts (#268)
Added pandas DataFrame and Series parameter types (#285)
Added support for regular expression validation to String Parameter (#241, #245)
For more details, you can see a full list of changes since the previous release.
Version 1.7.0#
Since the previous release (1.6.1), there should be no changes that affect existing code, only additions:
A new param namespace object, which in future will allow subclasses of Parameterized to have much cleaner namespaces (#230).
Started testing on python 3.7-dev (#223).
param.version now provides functions to simplify dependants’ setup.py/setup.cfg files (see https://github.com/holoviz-dev/autover/pull/49).
Although param should still work on python 3.3, we are no longer testing against it (unsupported by our test environment; #234).
For more details, you can see a full list of changes since the previous release.
Version 1.6.1#
Restores support for the previous versioning system (pre 1.6; see #225), and fixes a number of issues with the new versioning system:
Allow package name to differ from repository name (https://github.com/holoviz-dev/autover/pull/39)
Allow develop install to work when repository is dirty (https://github.com/holoviz-dev/autover/pull/41)
Fixed failure to report dirty when commit count is 0 (https://github.com/holoviz-dev/autover/pull/44)
Version 1.6.0#
Notable changes, fixes, and additions since the previous release (1.5.1) are listed below. You can also see a full list of changes since the previous release.
Changes:
param.__version__
is now a stringparam.version.Version
now supports a tag-based versioning workflow; if using theVersion
class, you will need to update your workflow (see autover for more details).Dropped support for python 2.6 (#175).
No longer attempt to cythonize param during installation via pip (#166, #194).
Fixes:
Allow
get_param_values()
to work on class (#162).Fixed incorrect default value for
param.Integer
(#151).Allow a
String
to beNone
if its default isNone
(#104).Fixed
ListSelector.compute_default()
(#212).Fixed checks for
None
in variousParameter
subclasses (#208); fixes problems for subclasses ofParameterized
that define a custom__nonzero__
or__len__
.
Additions:
Added
DateRange
parameter.
Miscellaneous:
No longer tested on python 3.2 (unsupported by our test environment; #218).
Version 1.5.1#
Fixed error messages for ClassSelector with tuple of classes
Added get and contains methods for ParamOverrides
A full list of changes since the previous release is available here.
Version 1.5.0#
Added Range, Color, and Date parameters
Improved ObjectSelector error messages
Minor bugfixes
A full list of changes since the previous release is available here.
Version 1.4.2#
Improved version reporting from version module
Minor bugfixes
A full list of changes since the previous release is available here.
Version 1.4.1#
Selector parameters now respect order of options supplied
Allowed softbounds to be accessed like an attribute
A full list of changes since the previous release is available on GitHub.
Version 1.4.0 (2016/07)#
Added support for new ParamNB project
Added new parameter types Action, FileSelector, and ListSelector
A full list of changes since the previous release is available on GitHub.
Version 1.3.2 (2015/04)#
Added Unicode support for param.String.
Minor bugfixes.
A full list of changes since the previous release is available on GitHub.
Version 1.3.1 (2015/03)#
Minor bugfix release to restore pre-1.3.0 script_repr behavior (accidentally changed in 1.3.0) and to fix issues with logging.
Param’s logging interface now matches that of Python’s logging module, making it simpler to use logging (see Python’s logging module for details). Note therefore that Param’s logging methods (a) no longer call functions that are passed as arguments (instead, Python’s logging module does lazy string merges), and (b) no longer automatically combine strings passed as arguments (instead, Python’s logging module supports string formatting).
Improved set_param() method, now allowing multiple parameters to be set easily via keyword arguments (as on initialization).
A full list of changes since the previous release is available on GitHub.
Version 1.3.0 (2015/03)#
Added ‘allow_None’ support to all Parameters. Any subclass of Parameter that checks types and/or values should be modified to add appropriate handling of allow_None.
Improved pretty printing (script_repr) of Parameterized instances, and made available via the pprint method. The script_repr name will be removed in a future release.
Added (reproducible) time-dependent random streams (numbergen.TimeAwareRandomState).
Added label and unit parameters to param.Time class.
Improved optional IPython extension.
A full list of changes since the previous release is available on GitHub.
Version 1.2.1 (2014/06)#
Minor bugfix release to fix issues with version when param is installed in a foreign git repository
Made version module optional
Improved ClassSelector and ParamOverrides
A full list of changes since the previous release is available on GitHub.
Version 1.2.0 (2014/06)#
Added support for Python 3 (thanks to Marco Elver).
Dropped support for Python 2.5.
Added version module.
Added optional numbergen package.
A full list of changes since the previous release is available on GitHub.
Version 1.1.0 (2014/05)#
Switched to Python’s own logging module.
Improved support for time when using Dynamic parameters.
Optional extension for IPython users.
A full list of changes since the previous release is available on GitHub.
Version 1.0.0 (2012/07)#
First standalone release.
Pre-1.0 (2003)#
Param was originally developed as part of Topographica, and has been in heavy usage as part of that project since 2003.