GitLocker: The Coding Marketplace

Description:

gradiogradiodatetime 0.0.4

tags: [gradio-custom-component, DateTime, datetime, safari]
title: gradio_gradio_datetime
short_description: datetime for safari
colorFrom: blue
colorTo: yellow
sdk: gradio
pinned: false
app_file: space.py
gradio_gradio_datetime

datetime for safari
Installation
pip install gradio_gradio_datetime

Usage
import gradio as gr
from gradio_gradio_datetime import gradio_datetime

example = gradio_datetime().example_value()

demo = gr.Interface(
lambda x:x,
gradio_datetime(), # interactive version of your component
gradio_datetime(), # static version of your component
# examples=[[example]], # uncomment this line to view the "example version" of your component
)

if __name__ == "__main__":
demo.launch()

gradio_datetime
Initialization

name
type
default
description

value

float | str | datetime.datetime | None

None
default value for datetime.

include_time

bool

True
If True, the component will include time selection. If False, only date selection will be available.

type

"timestamp" | "datetime" | "string"

"timestamp"
The type of the value. Can be "timestamp", "datetime", or "string". If "timestamp", the value will be a number representing the start and end date in seconds since epoch. If "datetime", the value will be a datetime object. If "string", the value will be the date entered by the user.

timezone

str | None

None
The timezone to use for timestamps, such as "US/Pacific" or "Europe/Paris". If None, the timezone will be the local timezone.

label

str | None

None
The label for this component. Appears above the component and is also used as the header if there are a table of examples for this component. If None and used in a `gr.Interface`, the label will be the name of the parameter this component is assigned to.

show_label

bool | None

None
if True, will display label.

info

str | None

None
additional component description.

every

float | None

None
If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute.

scale

int | None

None
relative size compared to adjacent Components. For example if Components A and B are in a Row, and A has scale=2, and B has scale=1, A will be twice as wide as B. Should be an integer. scale applies in Rows, and to top-level Components in Blocks where fill_height=True.

min_width

int

160
minimum pixel width, will wrap if not sufficient screen space to satisfy this value. If a certain scale value results in this Component being narrower than min_width, the min_width parameter will be respected first.

visible

bool

True
If False, component will be hidden.

elem_id

str | None

None
None

elem_classes

list[str] | str | None

None
An optional list of strings that are assigned as the classes of this component in the HTML DOM. Can be used for targeting CSS styles.

render

bool

True
If False, component will not render be rendered in the Blocks context. Should be used if the intention is to assign event listeners now but render the component later.

key

int | str | None

None
if assigned, will be used to assume identity across a re-render. Components that have the same key across a re-render will have their value preserved.

Events

name
description

change
Triggered when the value of the gradio_datetime changes either because of user input (e.g. a user types in a textbox) OR because of a function update (e.g. an image receives a value from the output of an event trigger). See .input() for a listener that is only triggered by user input.

submit
This listener is triggered when the user presses the Enter key while the gradio_datetime is focused.

User function
The impact on the users predict function varies depending on whether the component is used as an input or output for an event (or both).

When used as an Input, the component only impacts the input signature of the user function.
When used as an output, the component only impacts the return signature of the user function.

The code snippet below is accurate in cases where the component is used as both an input and an output.

As output: Is passed, passes text value as a {str} into the function.
As input: Should return, expects a tuple pair of datetimes.

def predict(
value: str | float | datetime.datetime | None
) -> float | datetime.datetime | str | None:
return value