param.CalendarDate#
- class param.CalendarDate(default: dt.date | None = None, *, allow_None: bool = False, bounds: tuple[float | int | None, float | int | None] | None=None, softbounds: tuple[float | int | None, float | int | None] | None=None, inclusive_bounds: tuple[bool, bool]=(True, True), step: float | int | None = None, set_hook: t.Callable[..., t.Any] | None=<Undefined>, doc: str | None = None, label: str | None = None, precedence: float | None = None, instantiate: bool = False, constant: bool = False, readonly: bool = False, pickle_default_value: bool = True, per_instance: bool = True, allow_refs: bool = False, nested_refs: bool = False, default_factory: Callable[[], t.Any] | None=None, metadata: dict[str, t.Any] | None=None)[source]#
Parameter specifically allowing dates (not datetimes).
- __init__(default: date | None = None, *, allow_None: Literal[False] = False, doc: str | None = None, label: str | None = None, precedence: float | None = None, instantiate: bool = False, constant: bool = False, readonly: bool = False, pickle_default_value: bool = True, per_instance: bool = True, allow_refs: bool = False, nested_refs: bool = False, default_factory: Callable[[], Any] | None = None, metadata: dict[str, Any] | None = None, bounds: tuple[date | None, date | None] | None = None, softbounds: tuple[date | None, date | None] | None = None, inclusive_bounds: tuple[bool, bool] = (True, True), step: int | None = None, set_hook: Callable[[...], Any] | None = None) None[source]#
- __init__(default: date | None = None, *, allow_None: Literal[True] = True, **kwargs: Unpack[_CalendarDateInitKwargs]) None
Initialize this parameter object and store the bounds.
Non-dynamic default values are checked against the bounds.
Methods
__init__(, step, set_hook, ...)Initialize this parameter object and store the bounds.
crop_to_bounds(val)Return the given value cropped to be within the hard bounds for this parameter.
deserialize(value)Given a serializable Python value, return a value that the parameter can be set to.
get_soft_bounds()schema([safe, subset, mode])Generate a schema for the parameters of the
Parameterizedobject.serialize(value)Given the parameter value, return a Python value suitable for serialization.
set_in_bounds(obj, val)Set to the given value, but cropped to be within the legal bounds.
Attributes
allow_Noneallow_refsboundsconstantdefaultdefault_factorydocinclusive_boundsinstantiatelabelGet the label for this parameter.
metadatanamenested_refsownerper_instancepickle_default_valueprecedencereadonlyrxThe reactive operations namespace.
softboundssteptime_dependenttime_fnwatchers