Skip to content

Commit

Permalink
[ENG-4165] Consider default and default_factory for state vars (#4510)
Browse files Browse the repository at this point in the history
* [ENG-4165] Consider default and default_factory for state vars

When determining whether a state var should be marked as optional, check that
it is missing both default and default_factory and is not required.

Fix #4471

* add test for default factory with rx.foreach (#4515)

---------

Co-authored-by: benedikt-bartscher <31854409+benedikt-bartscher@users.noreply.github.com>
  • Loading branch information
masenf and benedikt-bartscher authored Dec 12, 2024
1 parent 1b6f539 commit adfda8a
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
1 change: 1 addition & 0 deletions reflex/state.py
Original file line number Diff line number Diff line change
Expand Up @@ -1097,6 +1097,7 @@ def _set_default_value(cls, prop: Var):
if (
not field.required
and field.default is None
and field.default_factory is None
and not types.is_optional(prop._var_type)
):
# Ensure frontend uses null coalescing when accessing.
Expand Down
18 changes: 18 additions & 0 deletions tests/units/components/core/test_foreach.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
from typing import Dict, List, Set, Tuple, Union

import pydantic.v1
import pytest

from reflex import el
from reflex.base import Base
from reflex.components.component import Component
from reflex.components.core.foreach import (
Foreach,
Expand All @@ -18,6 +20,12 @@
from reflex.vars.sequence import ArrayVar


class ForEachTag(Base):
"""A tag for testing the ForEach component."""

name: str = ""


class ForEachState(BaseState):
"""A state for testing the ForEach component."""

Expand Down Expand Up @@ -46,6 +54,8 @@ class ForEachState(BaseState):
bad_annotation_list: list = [["red", "orange"], ["yellow", "blue"]]
color_index_tuple: Tuple[int, str] = (0, "red")

default_factory_list: list[ForEachTag] = pydantic.v1.Field(default_factory=list)


class ComponentStateTest(ComponentState):
"""A test component state."""
Expand Down Expand Up @@ -290,3 +300,11 @@ def test_foreach_component_state():
ForEachState.colors_list,
ComponentStateTest.create,
)


def test_foreach_default_factory():
"""Test that the default factory is called."""
_ = Foreach.create(
ForEachState.default_factory_list,
lambda tag: text(tag.name),
)

0 comments on commit adfda8a

Please sign in to comment.