Skip to content
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.

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

Display valid Enum values in Coerce #450

Merged
merged 1 commit into from
Mar 10, 2022
Merged
Changes from all commits
Commits
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
Display valid Enum values in Coerce
epenet committed Mar 10, 2022
commit a3e6ece3c5b1d5cd82b3106e842cfecfd849658e
37 changes: 37 additions & 0 deletions voluptuous/tests/tests.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import copy
import collections
from enum import Enum
import os
import sys

@@ -1599,3 +1600,39 @@ def test_any_with_discriminant():
assert_equal(str(e), 'expected bool for dictionary value @ data[\'implementation\'][\'c-value\']')
else:
assert False, "Did not raise correct Invalid"

def test_coerce_enum():
"""Test Coerce Enum"""
class Choice(Enum):
Easy = 1
Medium = 2
Hard = 3

class StringChoice(str, Enum):
Easy = "easy"
Medium = "medium"
Hard = "hard"

schema = Schema(Coerce(Choice))
string_schema = Schema(Coerce(StringChoice))

# Valid value
assert schema(1) == Choice.Easy
assert string_schema("easy") == StringChoice.Easy

# Invalid value
try:
schema(4)
except Invalid as e:
assert_equal(str(e),
"expected Choice or one of 1, 2, 3")
else:
assert False, "Did not raise Invalid for String"

try:
string_schema("hello")
except Invalid as e:
assert_equal(str(e),
"expected StringChoice or one of 'easy', 'medium', 'hard'")
else:
assert False, "Did not raise Invalid for String"
3 changes: 3 additions & 0 deletions voluptuous/validators.py
Original file line number Diff line number Diff line change
@@ -4,6 +4,7 @@
import sys
from functools import wraps
from decimal import Decimal, InvalidOperation
from enum import Enum

from voluptuous.schema_builder import Schema, raises, message
from voluptuous.error import (MultipleInvalid, CoerceInvalid, TrueInvalid, FalseInvalid, BooleanInvalid, Invalid,
@@ -95,6 +96,8 @@ def __call__(self, v):
return self.type(v)
except (ValueError, TypeError, InvalidOperation):
msg = self.msg or ('expected %s' % self.type_name)
if not self.msg and issubclass(self.type, Enum):
msg += " or one of %s" % str([e.value for e in self.type])[1:-1]
raise CoerceInvalid(msg)

def __repr__(self):