Skip to content

fix: intersect OneOf and Equal choices in field2choices #1069

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alexchen-sys wants to merge 2 commits into
base: dev
Choose a base branch
from
+80 −23
Open

fix: intersect OneOf and Equal choices in field2choices #1069

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
81d38f7
Fix field2choices to intersect OneOf and Equal choices (fixes #198)
alexchen-sys Aug 14, 2026
e485237
Factorize multiple OneOf/Equal intersection tests into parametrized t…
alexchen-sys Aug 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 8 additions & 15 deletions src/apispec/ext/marshmallow/field_converter.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -242,21 +242,14 @@ def field2choices(
"""
attributes = {}

comparable = [
validator.comparable
for validator in field.validators
if hasattr(validator, "comparable")
]
if comparable:
attributes["enum"] = comparable
else:
choices = [
OrderedSet(validator.choices)
for validator in field.validators
if hasattr(validator, "choices")
]
if choices:
attributes["enum"] = list(functools.reduce(operator.and_, choices))
choices = []

@lafrech lafrech Aug 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've been wondering why we don't use a set here and update it in the loop.

This is probably due to a slight performance advantage doing it this way.

for validator in field.validators:
if hasattr(validator, "choices"):
choices.append(OrderedSet(validator.choices))
elif hasattr(validator, "comparable"):
choices.append(OrderedSet([validator.comparable]))
if choices:
attributes["enum"] = list(functools.reduce(operator.and_, choices))

if field.allow_none:
enum = attributes.get("enum")
Expand Down
80 changes: 72 additions & 8 deletions tests/test_ext_marshmallow_field.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,15 +190,79 @@ def test_only_allows_valid_properties_in_metadata(spec_fixture):
assert "not_valid" not in res


def test_field_with_choices_multiple(spec_fixture):
field = fields.Str(
validate=[
validate.OneOf(["freddie", "brian", "john"]),
validate.OneOf(["brian", "john", "roger"]),
]
)
@pytest.mark.parametrize(
("validators", "expected_enum"),
[
(
[
validate.OneOf(["freddie", "brian", "john"]),
validate.OneOf(["brian", "john", "roger"]),
],
{"brian", "john"},
),
(
[
validate.OneOf(["freddie", "brian"]),
validate.OneOf(["john", "roger"]),
],
set(),
),
],
)
def test_field_with_multiple_oneof(spec_fixture, validators, expected_enum):
field = fields.Str(validate=validators)
res = spec_fixture.openapi.field2property(field)
assert set(res["enum"]) == expected_enum


@pytest.mark.parametrize(
("validators", "expected_enum"),
[
(
[
validate.Equal("brian"),
validate.Equal("brian"),
],
{"brian"},
),
(
[
validate.Equal("freddie"),
validate.Equal("brian"),
],
set(),
),
],
)
def test_field_with_multiple_equal(spec_fixture, validators, expected_enum):
field = fields.Str(validate=validators)
res = spec_fixture.openapi.field2property(field)
assert set(res["enum"]) == expected_enum


@pytest.mark.parametrize(
("validators", "expected_enum"),
[
(
[
validate.OneOf(["freddie", "brian", "john"]),
validate.Equal("brian"),
],
{"brian"},
),
(
[
validate.OneOf(["freddie", "brian"]),
validate.Equal("john"),
],
set(),
),
],
)
def test_field_with_oneof_and_equal(spec_fixture, validators, expected_enum):
field = fields.Str(validate=validators)
res = spec_fixture.openapi.field2property(field)
assert set(res["enum"]) == {"brian", "john"}
assert set(res["enum"]) == expected_enum


def test_field_with_additional_metadata(spec_fixture):
Expand Down