From e56f64218a912d23f1313b5d596bc7ec2890adf8 Mon Sep 17 00:00:00 2001 From: Rapptz Date: Sun, 20 Feb 2022 11:02:48 -0500 Subject: [PATCH] Rename default_value to default for TextInput --- discord/components.py | 18 +++++++++++++----- discord/ui/text_input.py | 20 ++++++++++---------- 2 files changed, 23 insertions(+), 15 deletions(-) diff --git a/discord/components.py b/discord/components.py index 5e024d20b..0c6ec9004 100644 --- a/discord/components.py +++ b/discord/components.py @@ -391,7 +391,7 @@ class TextInput(Component): The style of the text input. placeholder: Optional[:class:`str`] The placeholder text to display when the text input is empty. - default_value: Optional[:class:`str`] + value: Optional[:class:`str`] The default value of the text input. required: :class:`bool` Whether the text input is required. @@ -406,7 +406,7 @@ class TextInput(Component): 'label', 'custom_id', 'placeholder', - 'default_value', + 'value', 'required', 'min_length', 'max_length', @@ -420,7 +420,7 @@ class TextInput(Component): self.label: str = data['label'] self.custom_id: str = data['custom_id'] self.placeholder: Optional[str] = data.get('placeholder') - self.default_value: Optional[str] = data.get('value') + self.value: Optional[str] = data.get('value') self.required: bool = data.get('required', True) self.min_length: Optional[int] = data.get('min_length') self.max_length: Optional[int] = data.get('max_length') @@ -437,8 +437,8 @@ class TextInput(Component): if self.placeholder: payload['placeholder'] = self.placeholder - if self.default_value: - payload['value'] = self.default_value + if self.value: + payload['value'] = self.value if self.min_length: payload['min_length'] = self.min_length @@ -448,6 +448,14 @@ class TextInput(Component): return payload + @property + def default(self) -> Optional[str]: + """Optional[:class:`str`]: The default value of the text input. + + This is an alias to :attr:`value`. + """ + return self.value + def _component_factory(data: ComponentPayload) -> Component: component_type = data['type'] diff --git a/discord/ui/text_input.py b/discord/ui/text_input.py index fd2a3cca0..5ab3d24aa 100644 --- a/discord/ui/text_input.py +++ b/discord/ui/text_input.py @@ -65,7 +65,7 @@ class TextInput(Item[V]): The style of the text input. placeholder: Optional[:class:`str`] The placeholder text to display when the text input is empty. - default_value: Optional[:class:`str`] + default: Optional[:class:`str`] The default value of the text input. required: :class:`bool` Whether the text input is required. @@ -94,14 +94,14 @@ class TextInput(Item[V]): style: TextStyle = TextStyle.short, custom_id: str = MISSING, placeholder: Optional[str] = None, - default_value: Optional[str] = None, + default: Optional[str] = None, required: bool = True, min_length: Optional[int] = None, max_length: Optional[int] = None, row: Optional[int] = None, ) -> None: super().__init__() - self._value: Optional[str] = default_value + self._value: Optional[str] = default self._provided_custom_id = custom_id is not MISSING custom_id = os.urandom(16).hex() if custom_id is MISSING else custom_id self._underlying = TextInputComponent._raw_construct( @@ -110,7 +110,7 @@ class TextInput(Item[V]): style=style, custom_id=custom_id, placeholder=placeholder, - default_value=default_value, + value=default, required=required, min_length=min_length, max_length=max_length, @@ -193,13 +193,13 @@ class TextInput(Item[V]): self._underlying.style = value @property - def default_value(self) -> Optional[str]: + def default(self) -> Optional[str]: """:class:`str`: The default value of the text input.""" - return self._underlying.default_value + return self._underlying.value - @default_value.setter - def default_value(self, value: Optional[str]) -> None: - self._underlying.default_value = value + @default.setter + def default(self, value: Optional[str]) -> None: + self._underlying.value = value def to_component_dict(self) -> TextInputPayload: return self._underlying.to_dict() @@ -217,7 +217,7 @@ class TextInput(Item[V]): style=component.style, custom_id=component.custom_id, placeholder=component.placeholder, - default_value=component.default_value, + default=component.value, required=component.required, min_length=component.min_length, max_length=component.max_length,