File size: 11,753 Bytes
870ab6b |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 |
"""gr.Dropdown() component."""
from __future__ import annotations
import warnings
from typing import Any, Callable, Literal
from gradio_client.documentation import document, set_documentation_group
from gradio_client.serializing import SimpleSerializable
from gradio.components.base import FormComponent, IOComponent, _Keywords
from gradio.deprecation import warn_style_method_deprecation
from gradio.events import (
Changeable,
EventListenerMethod,
Focusable,
Inputable,
Selectable,
)
set_documentation_group("component")
@document()
class Dropdown(
FormComponent,
Changeable,
Inputable,
Selectable,
Focusable,
IOComponent,
SimpleSerializable,
):
"""
Creates a dropdown of choices from which entries can be selected.
Preprocessing: passes the value of the selected dropdown entry as a {str} or its index as an {int} into the function, depending on `type`.
Postprocessing: expects a {str} corresponding to the value of the dropdown entry to be selected.
Examples-format: a {str} representing the drop down value to select.
Demos: sentence_builder, titanic_survival
"""
def __init__(
self,
choices: list[str | int | float | tuple[str, str | int | float]] | None = None,
*,
value: str | int | float | list[str | int | float] | Callable | None = None,
type: Literal["value", "index"] = "value",
multiselect: bool | None = None,
allow_custom_value: bool = False,
max_choices: int | None = None,
filterable: bool = True,
label: str | None = None,
info: str | None = None,
every: float | None = None,
show_label: bool | None = None,
container: bool = True,
scale: int | None = None,
min_width: int = 160,
interactive: bool | None = None,
visible: bool = True,
elem_id: str | None = None,
elem_classes: list[str] | str | None = None,
**kwargs,
):
"""
Parameters:
choices: A list of string options to choose from. An option can also be a tuple of the form (name, value), where name is the displayed name of the dropdown choice and value is the value to be passed to the function, or returned by the function.
value: default value(s) selected in dropdown. If None, no value is selected by default. If callable, the function will be called whenever the app loads to set the initial value of the component.
type: Type of value to be returned by component. "value" returns the string of the choice selected, "index" returns the index of the choice selected.
multiselect: if True, multiple choices can be selected.
allow_custom_value: If True, allows user to enter a custom value that is not in the list of choices.
max_choices: maximum number of choices that can be selected. If None, no limit is enforced.
filterable: If True, user will be able to type into the dropdown and filter the choices by typing. Can only be set to False if `allow_custom_value` is False.
label: component name in interface.
info: additional component description.
every: If `value` is a callable, run the function 'every' number of seconds while the client connection is open. Has no effect otherwise. Queue must be enabled. The event can be accessed (e.g. to cancel it) via this component's .load_event attribute.
show_label: if True, will display label.
container: If True, will place the component in a container - providing some extra padding around the border.
scale: relative width compared to adjacent Components in a Row. For example, if Component A has scale=2, and Component B has scale=1, A will be twice as wide as B. Should be an integer.
min_width: 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.
interactive: if True, choices in this dropdown will be selectable; if False, selection will be disabled. If not provided, this is inferred based on whether the component is used as an input or output.
visible: If False, component will be hidden.
elem_id: An optional string that is assigned as the id of this component in the HTML DOM. Can be used for targeting CSS styles.
elem_classes: 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.
"""
self.choices = (
[c if isinstance(c, tuple) else (str(c), c) for c in choices]
if choices
else []
)
valid_types = ["value", "index"]
if type not in valid_types:
raise ValueError(
f"Invalid value for parameter `type`: {type}. Please choose from one of: {valid_types}"
)
self.type = type
self.multiselect = multiselect
if multiselect and isinstance(value, str):
value = [value]
if not multiselect and max_choices is not None:
warnings.warn(
"The `max_choices` parameter is ignored when `multiselect` is False."
)
if not filterable and allow_custom_value:
filterable = True
warnings.warn(
"The `filterable` parameter cannot be set to False when `allow_custom_value` is True. Setting `filterable` to True."
)
self.max_choices = max_choices
self.allow_custom_value = allow_custom_value
self.interpret_by_tokens = False
self.filterable = filterable
self.select: EventListenerMethod
"""
Event listener for when the user selects Dropdown option.
Uses event data gradio.SelectData to carry `value` referring to label of selected option, and `index` to refer to index.
See EventData documentation on how to use this event data.
"""
IOComponent.__init__(
self,
label=label,
info=info,
every=every,
show_label=show_label,
container=container,
scale=scale,
min_width=min_width,
interactive=interactive,
visible=visible,
elem_id=elem_id,
elem_classes=elem_classes,
value=value,
**kwargs,
)
def api_info(self) -> dict[str, dict | bool]:
if self.multiselect:
type = {
"type": "array",
"items": {"type": "string"},
"description": f"List of options from: {self.choices}",
}
else:
type = {"type": "string", "description": f"Option from: {self.choices}"}
return {"info": type, "serialized_info": False}
def example_inputs(self) -> dict[str, Any]:
if self.multiselect:
return {
"raw": [self.choices[0]] if self.choices else [],
"serialized": [self.choices[0]] if self.choices else [],
}
else:
return {
"raw": self.choices[0] if self.choices else None,
"serialized": self.choices[0] if self.choices else None,
}
def get_config(self):
return {
"choices": self.choices,
"value": self.value,
"multiselect": self.multiselect,
"max_choices": self.max_choices,
"allow_custom_value": self.allow_custom_value,
"container": self.container,
"filterable": self.filterable,
**IOComponent.get_config(self),
}
@staticmethod
def update(
value: Any | Literal[_Keywords.NO_VALUE] | None = _Keywords.NO_VALUE,
choices: str | list[str | tuple[str, str]] | None = None,
label: str | None = None,
info: str | None = None,
show_label: bool | None = None,
filterable: bool | None = None,
container: bool | None = None,
scale: int | None = None,
min_width: int | None = None,
interactive: bool | None = None,
placeholder: str | None = None,
visible: bool | None = None,
):
choices = (
None
if choices is None
else [c if isinstance(c, tuple) else (str(c), c) for c in choices]
)
return {
"choices": choices,
"label": label,
"info": info,
"show_label": show_label,
"container": container,
"scale": scale,
"min_width": min_width,
"visible": visible,
"value": value,
"interactive": interactive,
"placeholder": placeholder,
"filterable": filterable,
"__type__": "update",
}
def preprocess(
self, x: str | int | float | list[str | int | float] | None
) -> str | int | float | list[str | int | float] | list[int | None] | None:
"""
Parameters:
x: selected choice(s)
Returns:
selected choice(s) as string or index within choice list or list of string or indices
"""
if self.type == "value":
return x
elif self.type == "index":
choice_values = [value for _, value in self.choices]
if x is None:
return None
elif self.multiselect:
assert isinstance(x, list)
return [
choice_values.index(choice) if choice in choice_values else None
for choice in x
]
else:
return choice_values.index(x) if x in choice_values else None
else:
raise ValueError(
f"Unknown type: {self.type}. Please choose from: 'value', 'index'."
)
def _warn_if_invalid_choice(self, y):
if self.allow_custom_value or y in [value for _, value in self.choices]:
return
warnings.warn(
f"The value passed into gr.Dropdown() is not in the list of choices. Please update the list of choices to include: {y} or set allow_custom_value=True."
)
def postprocess(self, y):
if y is None:
return None
if self.multiselect:
[self._warn_if_invalid_choice(_y) for _y in y]
else:
self._warn_if_invalid_choice(y)
return y
def set_interpret_parameters(self):
"""
Calculates interpretation score of each choice by comparing the output against each of the outputs when alternative choices are selected.
"""
return self
def get_interpretation_neighbors(self, x):
choices = list(self.choices)
choices.remove(x)
return choices, {}
def get_interpretation_scores(
self, x, neighbors, scores: list[float | None], **kwargs
) -> list:
"""
Returns:
Each value represents the interpretation score corresponding to each choice.
"""
scores.insert(self.choices.index(x), None)
return scores
def style(self, *, container: bool | None = None, **kwargs):
"""
This method is deprecated. Please set these arguments in the constructor instead.
"""
warn_style_method_deprecation()
if container is not None:
self.container = container
return self
def as_example(self, input_data):
return next((c[0] for c in self.choices if c[1] == input_data), None)
|