Allow None as value for text widgets
#7313
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
LukasMasuch
requested review from
vdonato and
sfc-gh-mnowotka
as code owners
vdonato
approved these changes
Sep 12, 2023
Comment on lines
+74
to
+95
| @overload | ||
| def text_input( | ||
| self, | ||
| label: str, | ||
| value: SupportsStr = "", | ||
| max_chars: Optional[int] = None, | ||
| key: Optional[Key] = None, | ||
| value: str = "", | ||
| max_chars: int | None = None, | ||
| key: Key | None = None, | ||
| type: Literal["default", "password"] = "default", | ||
| help: Optional[str] = None, | ||
| autocomplete: Optional[str] = None, | ||
| on_change: Optional[WidgetCallback] = None, | ||
| args: Optional[WidgetArgs] = None, | ||
| kwargs: Optional[WidgetKwargs] = None, | ||
| help: str | None = None, | ||
| autocomplete: str | None = None, | ||
| on_change: WidgetCallback | None = None, | ||
| args: WidgetArgs | None = None, | ||
| kwargs: WidgetKwargs | None = None, | ||
| *, # keyword-only arguments: | ||
| placeholder: Optional[str] = None, | ||
| placeholder: str | None = None, | ||
| disabled: bool = False, | ||
| label_visibility: LabelVisibility = "visible", | ||
| ) -> str: | ||
| pass | ||
|
|
||
| @overload | ||
| def text_input( |
There was a problem hiding this comment.
Hm, would it make more sense for the first @overload for this widget to take a value with type SupportsStr and return a str, then the second @overload is where value has type None and returns None (it might be necessary to make the None case the first overload in the list in case order is important)
I think this should be equivalent but a bit more clear
(same comment for text_area below)
There was a problem hiding this comment.
That was my initial try as well, but it's giving me a mypy error:
Overloaded function signature 2 will never be matched: signature 1's parameter type(s) are the same or broader [misc]
and if I change the order:
Overloaded function signatures 1 and 2 overlap with incompatible return types
The main issue seems to be with the SupportsStr protocol since this also includes None and it requires non-overlapping types here :( With the workaround by adding str explicitly, I can at least provide optimized typing for all uses with a normal string (which are most uses anyways).
There was a problem hiding this comment.
I played around today a bit more with the overloads but didn't really find a way to get it to work other than the current workaround :(
2 tasks
eric-skydio
pushed a commit
to eric-skydio/streamlit
that referenced
this pull request
Dec 20, 2023
* Initial commit * Implement none support for text input and area * docstring change * Update unit tests * Finish unit tests * Remove outdated widgets * Update snapshots * Update snapshots * Add playwright script * Change test id * Add playwright e2e test * Add text area test * Fix e2e test * Update snapshots * Skip test in firefox * Fix e2e test * Update tests based on review comments * Explicitly type None * Use v for return value * Rename return values to v
zyxue
pushed a commit
to zyxue/streamlit
that referenced
this pull request
Mar 22, 2024
* Initial commit * Implement none support for text input and area * docstring change * Update unit tests * Finish unit tests * Remove outdated widgets * Update snapshots * Update snapshots * Add playwright script * Change test id * Add playwright e2e test * Add text area test * Fix e2e test * Update snapshots * Skip test in firefox * Fix e2e test * Update tests based on review comments * Explicitly type None * Use v for return value * Rename return values to v
zyxue
pushed a commit
to zyxue/streamlit
that referenced
this pull request
Apr 16, 2024
* Initial commit * Implement none support for text input and area * docstring change * Update unit tests * Finish unit tests * Remove outdated widgets * Update snapshots * Update snapshots * Add playwright script * Change test id * Add playwright e2e test * Add text area test * Fix e2e test * Update snapshots * Skip test in firefox * Fix e2e test * Update tests based on review comments * Explicitly type None * Use v for return value * Rename return values to v
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe your changes
This PR adds support for setting
Noneas the value inst.text_inputandst.text_area. Usingvalue=Nonewill render an empty text input that returnsNoneas long as the user hasn't provided an input. Once the user has typed into the text_input field, it will always return a string, even when empty (different to theNonesupport of other widgets).Testing Plan
Contribution License Agreement
By submitting this pull request you agree that all contributions to this project are made under the Apache 2.0 license.