diff --git a/stubs/WTForms/@tests/test_cases/check_optional_attributes.py b/stubs/WTForms/@tests/test_cases/check_optional_attributes.py new file mode 100644 index 000000000000..9a14eefec7ff --- /dev/null +++ b/stubs/WTForms/@tests/test_cases/check_optional_attributes.py @@ -0,0 +1,30 @@ +from __future__ import annotations + +from collections.abc import Callable +from datetime import tzinfo +from typing import Any +from typing_extensions import assert_type + +from wtforms import DateTimeLocalField, Form, SelectField, StringField +from wtforms.fields.core import _Text +from wtforms.meta import _SupportsGettextAndNgettext +from wtforms.validators import DateRange + +# render_kw is None unless it was passed to the field +field = StringField() +assert_type(field.render_kw, dict[str, Any] | None) +if field.render_kw is not None: + field.render_kw["class"] = "form-control" + +# DefaultMeta.get_translations() returns None unless `locales` is set (the default is False) +form = Form() +translations = form.meta.get_translations(form) +if translations is not None: + translations.gettext("Not a valid choice.") +assert_type(form.meta.translations_cache, dict[tuple[str, ...] | None, _SupportsGettextAndNgettext]) + +# the messages of validators and fields are None unless passed explicitly +assert_type(DateRange().message, _Text | None) +assert_type(SelectField().invalid_choice_message, _Text | None) + +assert_type(DateTimeLocalField().tz, tzinfo | Callable[[], tzinfo | None] | None) diff --git a/stubs/WTForms/wtforms/fields/choices.pyi b/stubs/WTForms/wtforms/fields/choices.pyi index 47d8a475a318..de6db7496e82 100644 --- a/stubs/WTForms/wtforms/fields/choices.pyi +++ b/stubs/WTForms/wtforms/fields/choices.pyi @@ -91,7 +91,7 @@ class SelectFieldBase(Field): class SelectField(SelectFieldBase): coerce: Callable[[Any], Any] validate_choice: bool - invalid_choice_message: _Text + invalid_choice_message: _Text | None @overload @deprecated("Starting with WTForms 3.4 only SelectChoice will be supported as choices inputs") diff --git a/stubs/WTForms/wtforms/fields/core.pyi b/stubs/WTForms/wtforms/fields/core.pyi index c835c0a856b7..cc53c1741cf1 100644 --- a/stubs/WTForms/wtforms/fields/core.pyi +++ b/stubs/WTForms/wtforms/fields/core.pyi @@ -49,7 +49,7 @@ class Field: meta: DefaultMeta default: Any | None description: _Text - render_kw: dict[str, Any] + render_kw: dict[str, Any] | None filters: Sequence[_Filter] flags: Flags name: str diff --git a/stubs/WTForms/wtforms/fields/datetime.pyi b/stubs/WTForms/wtforms/fields/datetime.pyi index d9a63d4b9cc7..bc9a05a603b5 100644 --- a/stubs/WTForms/wtforms/fields/datetime.pyi +++ b/stubs/WTForms/wtforms/fields/datetime.pyi @@ -130,6 +130,7 @@ class WeekField(DateField): ) -> None: ... class DateTimeLocalField(DateTimeField): + tz: tzinfo | Callable[[], tzinfo | None] | None def __init__( self, label: _Text | None = None, diff --git a/stubs/WTForms/wtforms/meta.pyi b/stubs/WTForms/wtforms/meta.pyi index ee207e7e782d..1d87a641928c 100644 --- a/stubs/WTForms/wtforms/meta.pyi +++ b/stubs/WTForms/wtforms/meta.pyi @@ -52,8 +52,9 @@ class DefaultMeta: def build_csrf(self, form: BaseForm) -> Any: ... locales: Literal[False] | Collection[str] cache_translations: bool - translations_cache: dict[str, _SupportsGettextAndNgettext] - def get_translations(self, form: BaseForm) -> _SupportsGettextAndNgettext: ... + translations_cache: dict[tuple[str, ...] | None, _SupportsGettextAndNgettext] + # returns None if `locales` is False, which is the default + def get_translations(self, form: BaseForm) -> _SupportsGettextAndNgettext | None: ... def update_values(self, values: SupportsItems[str, Any]) -> None: ... # since meta can be extended with arbitrary data we add a __getattr__ # method that returns Any diff --git a/stubs/WTForms/wtforms/validators.pyi b/stubs/WTForms/wtforms/validators.pyi index 24d26e6f9838..0b14c16a42fe 100644 --- a/stubs/WTForms/wtforms/validators.pyi +++ b/stubs/WTForms/wtforms/validators.pyi @@ -88,7 +88,7 @@ class NumberRange: class DateRange: min: date | datetime | Callable[[], date | datetime | None] | None max: date | datetime | Callable[[], date | datetime | None] | None - message: _Text + message: _Text | None field_flags: dict[str, Any] def __init__( self,