Module pedantic.tests.validate.test_validator_is_enum

Classes

class MyEnum (*args, **kwds)

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

• attribute access:

Color.RED

• value lookup:

Color(1)

• name lookup:

Color['RED']

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

Expand source code

class MyEnum(Enum):
    RED = 'RED'
    BLUE = 'BLUE'

Ancestors

• enum.Enum

Class variables

var BLUE

var RED

class MyIntEnum (*args, **kwds)

Enum where members are also (and must be) ints

Expand source code

class MyIntEnum(IntEnum):
    RED = 1
    BLUE = 2

Ancestors

• enum.IntEnum
• builtins.int
• enum.ReprEnum
• enum.Enum

Class variables

var BLUE

var RED

class TestValidatorIsEnum (methodName='runTest')

A class whose instances are single test cases.

By default, the test code itself should be placed in a method named 'runTest'.

If the fixture may be used for many test cases, create as many test methods as are needed. When instantiating such a TestCase subclass, specify in the constructor arguments the name of the test method that the instance is to execute.

Test authors should subclass TestCase for their own tests. Construction and deconstruction of the test's environment ('fixture') can be implemented by overriding the 'setUp' and 'tearDown' methods respectively.

If it is necessary to override the init method, the base class init method must always be called. It is important that subclasses should not change the signature of their init method, since instances of the classes are instantiated automatically by parts of the framework in order to be run.

When subclassing TestCase, you can set these attributes: * failureException: determines which exception will be raised when the instance's assertion methods fail; test methods raising this exception will be deemed to have 'failed' rather than 'errored'. * longMessage: determines whether long messages (including repr of objects used in assert methods) will be printed on failure in addition to any explicit message passed. * maxDiff: sets the maximum length of a diff in failure messages by assert methods using difflib. It is looked up as an instance attribute so can be configured by individual tests if required.

Create an instance of the class that will use the named test method when executed. Raises a ValueError if the instance does not have a method with the specified name.

Expand source code

class TestValidatorIsEnum(TestCase):
    def test_validator_is_enum_convert_true(self) -> None:
        @validate(Parameter(name='x', validators=[IsEnum(MyEnum, convert=True)]))
        def foo(x):
            return x

        self.assertEqual(MyEnum.RED, foo('RED'))
        self.assertEqual(MyEnum.BLUE, foo('BLUE'))

        for value in ['fred', 1, 'GREEN']:
            with self.assertRaises(expected_exception=ParameterException):
                foo(value)

    def test_validator_is_enum_int_enum_convert_true(self) -> None:
        @validate(Parameter(name='x', validators=[IsEnum(MyIntEnum, convert=True)]))
        def foo(x):
            return x

        self.assertEqual(MyIntEnum.RED, foo('1'))
        self.assertEqual(MyIntEnum.BLUE, foo('2'))
        self.assertEqual(MyIntEnum.RED, foo(1))
        self.assertEqual(MyIntEnum.BLUE, foo(2))

        for value in ['fred', 3, 'GREEN']:
            with self.assertRaises(expected_exception=ParameterException):
                foo(value)

    def test_validator_is_enum_convert_false(self) -> None:
        @validate(Parameter(name='x', validators=[IsEnum(MyEnum, convert=False)]))
        def foo(x):
            return x

        self.assertEqual('RED', foo('RED'))
        self.assertEqual('BLUE', foo('BLUE'))

        for value in ['fred', 1, 'GREEN']:
            with self.assertRaises(expected_exception=ParameterException):
                foo(value)

    def test_validator_is_enum_to_upper_case(self) -> None:
        @validate(Parameter(name='x', validators=[IsEnum(MyEnum, convert=False)]))
        def foo(x):
            return x

        self.assertEqual('RED', foo('red'))
        self.assertEqual('BLUE', foo('blue'))
        self.assertEqual('BLUE', foo('bLUe'))

    def test_validator_is_enum_to_upper_case_disabled(self) -> None:
        @validate(Parameter(name='x', validators=[IsEnum(MyEnum, convert=False, to_upper_case=False)]))
        def foo(x): print(x)

        for value in ['red', 'blue', 'Red', 'bLUe']:
            with self.assertRaises(expected_exception=ParameterException):
                foo(value)

Ancestors

• unittest.case.TestCase

Methods

def test_validator_is_enum_convert_false(self) ‑> None

Expand source code

def test_validator_is_enum_convert_false(self) -> None:
    @validate(Parameter(name='x', validators=[IsEnum(MyEnum, convert=False)]))
    def foo(x):
        return x

    self.assertEqual('RED', foo('RED'))
    self.assertEqual('BLUE', foo('BLUE'))

    for value in ['fred', 1, 'GREEN']:
        with self.assertRaises(expected_exception=ParameterException):
            foo(value)

def test_validator_is_enum_convert_true(self) ‑> None

Expand source code

def test_validator_is_enum_convert_true(self) -> None:
    @validate(Parameter(name='x', validators=[IsEnum(MyEnum, convert=True)]))
    def foo(x):
        return x

    self.assertEqual(MyEnum.RED, foo('RED'))
    self.assertEqual(MyEnum.BLUE, foo('BLUE'))

    for value in ['fred', 1, 'GREEN']:
        with self.assertRaises(expected_exception=ParameterException):
            foo(value)

def test_validator_is_enum_int_enum_convert_true(self) ‑> None

Expand source code

def test_validator_is_enum_int_enum_convert_true(self) -> None:
    @validate(Parameter(name='x', validators=[IsEnum(MyIntEnum, convert=True)]))
    def foo(x):
        return x

    self.assertEqual(MyIntEnum.RED, foo('1'))
    self.assertEqual(MyIntEnum.BLUE, foo('2'))
    self.assertEqual(MyIntEnum.RED, foo(1))
    self.assertEqual(MyIntEnum.BLUE, foo(2))

    for value in ['fred', 3, 'GREEN']:
        with self.assertRaises(expected_exception=ParameterException):
            foo(value)

def test_validator_is_enum_to_upper_case(self) ‑> None

Expand source code

def test_validator_is_enum_to_upper_case(self) -> None:
    @validate(Parameter(name='x', validators=[IsEnum(MyEnum, convert=False)]))
    def foo(x):
        return x

    self.assertEqual('RED', foo('red'))
    self.assertEqual('BLUE', foo('blue'))
    self.assertEqual('BLUE', foo('bLUe'))

def test_validator_is_enum_to_upper_case_disabled(self) ‑> None

Expand source code

def test_validator_is_enum_to_upper_case_disabled(self) -> None:
    @validate(Parameter(name='x', validators=[IsEnum(MyEnum, convert=False, to_upper_case=False)]))
    def foo(x): print(x)

    for value in ['red', 'blue', 'Red', 'bLUe']:
        with self.assertRaises(expected_exception=ParameterException):
            foo(value)