Skip to content

Commit

Permalink
Display valid Enum values in Coerce
Browse files Browse the repository at this point in the history
  • Loading branch information
epenet authored and alecthomas committed Mar 10, 2022
1 parent 980a55f commit 6cf017e
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 0 deletions.
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

Expand Down Expand Up @@ -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
Expand Up @@ -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,
Expand Down Expand Up @@ -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):
Expand Down

0 comments on commit 6cf017e

Please sign in to comment.