def _date_input( self, label: str, value=None, min_value=None, max_value=None, key: Optional[Key] = None, help: Optional[str] = None, on_change: Optional[WidgetCallback] = None, args: Optional[WidgetArgs] = None, kwargs: Optional[WidgetKwargs] = None, *, # keyword-only arguments: disabled: bool = False, ctx: Optional[ScriptRunContext] = None, ) -> Union[date, Tuple[date, ...]]: key = to_key(key) check_callback_rules(self.dg, on_change) check_session_state_rules(default_value=value, key=key) # Set value default. if value is None: value = datetime.now().date() single_value = isinstance(value, (date, datetime)) range_value = isinstance(value, (list, tuple)) and len(value) in (0, 1, 2) if not single_value and not range_value: raise StreamlitAPIException( "DateInput value should either be an date/datetime or a list/tuple of " "0 - 2 date/datetime values") if single_value: value = [value] value = [v.date() if isinstance(v, datetime) else v for v in value] if isinstance(min_value, datetime): min_value = min_value.date() elif min_value is None: if value: min_value = value[0] - relativedelta.relativedelta(years=10) else: min_value = date.today() - relativedelta.relativedelta( years=10) if isinstance(max_value, datetime): max_value = max_value.date() elif max_value is None: if value: max_value = value[-1] + relativedelta.relativedelta(years=10) else: max_value = date.today() + relativedelta.relativedelta( years=10) if value: start_value = value[0] end_value = value[-1] if (start_value < min_value) or (end_value > max_value): raise StreamlitAPIException( f"The default `value` of {value} " f"must lie between the `min_value` of {min_value} " f"and the `max_value` of {max_value}, inclusively.") date_input_proto = DateInputProto() date_input_proto.is_range = range_value if help is not None: date_input_proto.help = dedent(help) date_input_proto.label = label date_input_proto.default[:] = [ date.strftime(v, "%Y/%m/%d") for v in value ] date_input_proto.min = date.strftime(min_value, "%Y/%m/%d") date_input_proto.max = date.strftime(max_value, "%Y/%m/%d") date_input_proto.form_id = current_form_id(self.dg) date_input_proto.disabled = disabled def deserialize_date_input(ui_value, widget_id=""): if ui_value is not None: return_value = [ datetime.strptime(v, "%Y/%m/%d").date() for v in ui_value ] else: return_value = value return return_value[0] if single_value else tuple(return_value) def serialize_date_input(v): range_value = isinstance(v, (list, tuple)) to_serialize = list(v) if range_value else [v] return [date.strftime(v, "%Y/%m/%d") for v in to_serialize] current_value, set_frontend_value = register_widget( "date_input", date_input_proto, user_key=key, on_change_handler=on_change, args=args, kwargs=kwargs, deserializer=deserialize_date_input, serializer=serialize_date_input, ctx=ctx, ) if set_frontend_value: date_input_proto.value[:] = serialize_date_input(current_value) date_input_proto.set_value = True self.dg._enqueue("date_input", date_input_proto) return cast(date, current_value)
def date_input( self, label: str, value=None, min_value=None, max_value=None, key: Optional[Key] = None, help: Optional[str] = None, on_change: Optional[WidgetCallback] = None, args: Optional[WidgetArgs] = None, kwargs: Optional[WidgetKwargs] = None, ) -> date: """Display a date input widget. Parameters ---------- label : str A short label explaining to the user what this date input is for. value : datetime.date or datetime.datetime or list/tuple of datetime.date or datetime.datetime or None The value of this widget when it first renders. If a list/tuple with 0 to 2 date/datetime values is provided, the datepicker will allow users to provide a range. Defaults to today as a single-date picker. min_value : datetime.date or datetime.datetime The minimum selectable date. If value is a date, defaults to value - 10 years. If value is the interval [start, end], defaults to start - 10 years. max_value : datetime.date or datetime.datetime The maximum selectable date. If value is a date, defaults to value + 10 years. If value is the interval [start, end], defaults to end + 10 years. key : str or int An optional string or integer to use as the unique key for the widget. If this is omitted, a key will be generated for the widget based on its content. Multiple widgets of the same type may not share the same key. help : str An optional tooltip that gets displayed next to the input. on_change : callable An optional callback invoked when this date_input's value changes. args : tuple An optional tuple of args to pass to the callback. kwargs : dict An optional dict of kwargs to pass to the callback. Returns ------- datetime.date The current value of the date input widget. Example ------- >>> d = st.date_input( ... "When\'s your birthday", ... datetime.date(2019, 7, 6)) >>> st.write('Your birthday is:', d) """ key = to_key(key) check_callback_rules(self.dg, on_change) check_session_state_rules(default_value=value, key=key) # Set value default. if value is None: value = datetime.now().date() single_value = isinstance(value, (date, datetime)) range_value = isinstance(value, (list, tuple)) and len(value) in (0, 1, 2) if not single_value and not range_value: raise StreamlitAPIException( "DateInput value should either be an date/datetime or a list/tuple of " "0 - 2 date/datetime values") if single_value: value = [value] date_input_proto = DateInputProto() date_input_proto.is_range = range_value if help is not None: date_input_proto.help = dedent(help) value = [v.date() if isinstance(v, datetime) else v for v in value] date_input_proto.label = label date_input_proto.default[:] = [ date.strftime(v, "%Y/%m/%d") for v in value ] if isinstance(min_value, datetime): min_value = min_value.date() elif min_value is None: if value: min_value = value[0] - relativedelta.relativedelta(years=10) else: min_value = date.today() - relativedelta.relativedelta( years=10) if isinstance(max_value, datetime): max_value = max_value.date() elif max_value is None: if value: max_value = value[-1] + relativedelta.relativedelta(years=10) else: max_value = date.today() + relativedelta.relativedelta( years=10) date_input_proto.min = date.strftime(min_value, "%Y/%m/%d") date_input_proto.max = date.strftime(max_value, "%Y/%m/%d") date_input_proto.form_id = current_form_id(self.dg) def deserialize_date_input(ui_value, widget_id=""): if ui_value is not None: return_value = [ datetime.strptime(v, "%Y/%m/%d").date() for v in ui_value ] else: return_value = value return return_value[0] if single_value else tuple(return_value) def serialize_date_input(v): to_serialize = [v] if single_value else list(v) return [date.strftime(v, "%Y/%m/%d") for v in to_serialize] current_value, set_frontend_value = register_widget( "date_input", date_input_proto, user_key=key, on_change_handler=on_change, args=args, kwargs=kwargs, deserializer=deserialize_date_input, serializer=serialize_date_input, ) if set_frontend_value: date_input_proto.value[:] = serialize_date_input(current_value) date_input_proto.set_value = True self.dg._enqueue("date_input", date_input_proto) return cast(date, current_value)