Module `pedantic.tests.tests_combination_of_decorators`

Expand source code

import unittest
from abc import ABC, abstractmethod

from pedantic.decorators.class_decorators import pedantic_class, for_all_methods
from pedantic.decorators.fn_deco_validate.exceptions import ParameterException
from pedantic.decorators.fn_deco_validate.validators import Min
from pedantic.exceptions import PedanticException, PedanticTypeCheckException, PedanticCallWithArgsException
from pedantic.decorators.fn_deco_pedantic import pedantic
from pedantic import overrides
from pedantic.decorators.fn_deco_validate.fn_deco_validate import validate, Parameter, ReturnAs


class TestCombinationOfDecorators(unittest.TestCase):
    def test_pedantic_overrides(self):
        class MyClass(ABC):
            @pedantic
            @abstractmethod
            def op(self, a: int) -> None:
                pass

        class Child(MyClass):
            a = 0

            @pedantic
            @overrides(MyClass)
            def op(self, a: int) -> None:
                self.a = a

        c = Child()
        c.op(a=42)

    def test_pedantic_below_validate(self):
        @validate(
            Parameter(name='x', validators=[Min(0)]),
            return_as=ReturnAs.KWARGS_WITH_NONE,
        )
        @pedantic
        def some_calculation(x: int) -> int:
            return x

        some_calculation(x=42)
        some_calculation(42)

        with self.assertRaises(expected_exception=ParameterException):
            some_calculation(x=-1)
        with self.assertRaises(expected_exception=ParameterException):
            some_calculation(x=-42)
        with self.assertRaises(expected_exception=PedanticTypeCheckException):
            some_calculation(x=1.0)

    def test_pedantic_above_validate(self):
        @pedantic
        @validate(
            Parameter(name='x', validators=[Min(0)]),
        )
        def some_calculation(x: int) -> int:
            return x

        some_calculation(x=42)

        with self.assertRaises(expected_exception=ParameterException):
            some_calculation(x=-1)
        with self.assertRaises(expected_exception=ParameterException):
            some_calculation(x=-42)
        with self.assertRaises(expected_exception=PedanticTypeCheckException):
            some_calculation(x=1.0)
        with self.assertRaises(expected_exception=PedanticException):
            some_calculation(42)

    def test_pedantic_above_validate_on_instance_method(self):
        class MyClass:
            @pedantic
            @validate(
                Parameter(name='x', validators=[Min(0)]),
            )
            def some_calculation(self, x: int) -> int:
                return x

        m = MyClass()
        m.some_calculation(x=42)
        with self.assertRaises(expected_exception=ParameterException):
            m.some_calculation(x=-1)
        with self.assertRaises(expected_exception=ParameterException):
            m.some_calculation(x=-42)
        with self.assertRaises(expected_exception=PedanticTypeCheckException):
            m.some_calculation(x=1.0)
        with self.assertRaises(expected_exception=PedanticCallWithArgsException):
            m.some_calculation(42)

    def test_pedantic_below_validate_on_instance_method(self):
        class MyClass:
            @validate(
                Parameter(name='x', validators=[Min(0)]),
            )
            @pedantic
            def some_calculation(self, x: int) -> int:
                return x

        m = MyClass()
        m.some_calculation(x=42)
        m.some_calculation(42)

        with self.assertRaises(expected_exception=ParameterException):
            m.some_calculation(x=-1)
        with self.assertRaises(expected_exception=ParameterException):
            m.some_calculation(x=-42)
        with self.assertRaises(expected_exception=PedanticTypeCheckException):
            m.some_calculation(x=1.0)

    def test_pedantic_class_with_validate_instance_method(self):
        @pedantic_class
        class MyClass:
            @validate(
                Parameter(name='x', validators=[Min(0)]),
            )
            def some_calculation(self, x: int) -> int:
                return x

        m = MyClass()
        m.some_calculation(x=42)
        with self.assertRaises(expected_exception=ParameterException):
            m.some_calculation(x=-1)
        with self.assertRaises(expected_exception=ParameterException):
            m.some_calculation(x=-42)
        with self.assertRaises(expected_exception=PedanticTypeCheckException):
            m.some_calculation(x=1.0)
        with self.assertRaises(expected_exception=PedanticCallWithArgsException):
            m.some_calculation(42)

    def test_pedantic_class_static_method_1(self):
        @pedantic_class
        class MyClass:
            @staticmethod
            def some_calculation(x: int) -> int:
                return x

        m = MyClass()
        m.some_calculation(x=42)
        MyClass.some_calculation(x=45)

    def test_pedantic_class_static_method_2(self):
        """Never do this, but it works"""
        @for_all_methods(staticmethod)
        @pedantic_class
        class MyClass:
            def some_calculation(x: int) -> int:
                return x

        m = MyClass()
        m.some_calculation(x=42)
        with self.assertRaises(expected_exception=PedanticTypeCheckException):
            m.some_calculation(x=42.0)
        MyClass.some_calculation(x=45)
        with self.assertRaises(expected_exception=PedanticTypeCheckException):
            MyClass.some_calculation(x=45.0)

    def test_pedantic_static_method_1(self):
        class MyClass:
            @staticmethod
            @pedantic
            def some_calculation(x: int) -> int:
                return x

        m = MyClass()
        m.some_calculation(x=42)
        MyClass.some_calculation(x=45)

Classes

class TestCombinationOfDecorators (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 TestCombinationOfDecorators(unittest.TestCase):
    def test_pedantic_overrides(self):
        class MyClass(ABC):
            @pedantic
            @abstractmethod
            def op(self, a: int) -> None:
                pass

        class Child(MyClass):
            a = 0

            @pedantic
            @overrides(MyClass)
            def op(self, a: int) -> None:
                self.a = a

        c = Child()
        c.op(a=42)

    def test_pedantic_below_validate(self):
        @validate(
            Parameter(name='x', validators=[Min(0)]),
            return_as=ReturnAs.KWARGS_WITH_NONE,
        )
        @pedantic
        def some_calculation(x: int) -> int:
            return x

        some_calculation(x=42)
        some_calculation(42)

        with self.assertRaises(expected_exception=ParameterException):
            some_calculation(x=-1)
        with self.assertRaises(expected_exception=ParameterException):
            some_calculation(x=-42)
        with self.assertRaises(expected_exception=PedanticTypeCheckException):
            some_calculation(x=1.0)

    def test_pedantic_above_validate(self):
        @pedantic
        @validate(
            Parameter(name='x', validators=[Min(0)]),
        )
        def some_calculation(x: int) -> int:
            return x

        some_calculation(x=42)

        with self.assertRaises(expected_exception=ParameterException):
            some_calculation(x=-1)
        with self.assertRaises(expected_exception=ParameterException):
            some_calculation(x=-42)
        with self.assertRaises(expected_exception=PedanticTypeCheckException):
            some_calculation(x=1.0)
        with self.assertRaises(expected_exception=PedanticException):
            some_calculation(42)

    def test_pedantic_above_validate_on_instance_method(self):
        class MyClass:
            @pedantic
            @validate(
                Parameter(name='x', validators=[Min(0)]),
            )
            def some_calculation(self, x: int) -> int:
                return x

        m = MyClass()
        m.some_calculation(x=42)
        with self.assertRaises(expected_exception=ParameterException):
            m.some_calculation(x=-1)
        with self.assertRaises(expected_exception=ParameterException):
            m.some_calculation(x=-42)
        with self.assertRaises(expected_exception=PedanticTypeCheckException):
            m.some_calculation(x=1.0)
        with self.assertRaises(expected_exception=PedanticCallWithArgsException):
            m.some_calculation(42)

    def test_pedantic_below_validate_on_instance_method(self):
        class MyClass:
            @validate(
                Parameter(name='x', validators=[Min(0)]),
            )
            @pedantic
            def some_calculation(self, x: int) -> int:
                return x

        m = MyClass()
        m.some_calculation(x=42)
        m.some_calculation(42)

        with self.assertRaises(expected_exception=ParameterException):
            m.some_calculation(x=-1)
        with self.assertRaises(expected_exception=ParameterException):
            m.some_calculation(x=-42)
        with self.assertRaises(expected_exception=PedanticTypeCheckException):
            m.some_calculation(x=1.0)

    def test_pedantic_class_with_validate_instance_method(self):
        @pedantic_class
        class MyClass:
            @validate(
                Parameter(name='x', validators=[Min(0)]),
            )
            def some_calculation(self, x: int) -> int:
                return x

        m = MyClass()
        m.some_calculation(x=42)
        with self.assertRaises(expected_exception=ParameterException):
            m.some_calculation(x=-1)
        with self.assertRaises(expected_exception=ParameterException):
            m.some_calculation(x=-42)
        with self.assertRaises(expected_exception=PedanticTypeCheckException):
            m.some_calculation(x=1.0)
        with self.assertRaises(expected_exception=PedanticCallWithArgsException):
            m.some_calculation(42)

    def test_pedantic_class_static_method_1(self):
        @pedantic_class
        class MyClass:
            @staticmethod
            def some_calculation(x: int) -> int:
                return x

        m = MyClass()
        m.some_calculation(x=42)
        MyClass.some_calculation(x=45)

    def test_pedantic_class_static_method_2(self):
        """Never do this, but it works"""
        @for_all_methods(staticmethod)
        @pedantic_class
        class MyClass:
            def some_calculation(x: int) -> int:
                return x

        m = MyClass()
        m.some_calculation(x=42)
        with self.assertRaises(expected_exception=PedanticTypeCheckException):
            m.some_calculation(x=42.0)
        MyClass.some_calculation(x=45)
        with self.assertRaises(expected_exception=PedanticTypeCheckException):
            MyClass.some_calculation(x=45.0)

    def test_pedantic_static_method_1(self):
        class MyClass:
            @staticmethod
            @pedantic
            def some_calculation(x: int) -> int:
                return x

        m = MyClass()
        m.some_calculation(x=42)
        MyClass.some_calculation(x=45)

Ancestors

unittest.case.TestCase

Methods

def test_pedantic_above_validate(self)

Expand source code

def test_pedantic_above_validate(self):
    @pedantic
    @validate(
        Parameter(name='x', validators=[Min(0)]),
    )
    def some_calculation(x: int) -> int:
        return x

    some_calculation(x=42)

    with self.assertRaises(expected_exception=ParameterException):
        some_calculation(x=-1)
    with self.assertRaises(expected_exception=ParameterException):
        some_calculation(x=-42)
    with self.assertRaises(expected_exception=PedanticTypeCheckException):
        some_calculation(x=1.0)
    with self.assertRaises(expected_exception=PedanticException):
        some_calculation(42)

def test_pedantic_above_validate_on_instance_method(self)

Expand source code

def test_pedantic_above_validate_on_instance_method(self):
    class MyClass:
        @pedantic
        @validate(
            Parameter(name='x', validators=[Min(0)]),
        )
        def some_calculation(self, x: int) -> int:
            return x

    m = MyClass()
    m.some_calculation(x=42)
    with self.assertRaises(expected_exception=ParameterException):
        m.some_calculation(x=-1)
    with self.assertRaises(expected_exception=ParameterException):
        m.some_calculation(x=-42)
    with self.assertRaises(expected_exception=PedanticTypeCheckException):
        m.some_calculation(x=1.0)
    with self.assertRaises(expected_exception=PedanticCallWithArgsException):
        m.some_calculation(42)

def test_pedantic_below_validate(self)

Expand source code

def test_pedantic_below_validate(self):
    @validate(
        Parameter(name='x', validators=[Min(0)]),
        return_as=ReturnAs.KWARGS_WITH_NONE,
    )
    @pedantic
    def some_calculation(x: int) -> int:
        return x

    some_calculation(x=42)
    some_calculation(42)

    with self.assertRaises(expected_exception=ParameterException):
        some_calculation(x=-1)
    with self.assertRaises(expected_exception=ParameterException):
        some_calculation(x=-42)
    with self.assertRaises(expected_exception=PedanticTypeCheckException):
        some_calculation(x=1.0)

def test_pedantic_below_validate_on_instance_method(self)

Expand source code

def test_pedantic_below_validate_on_instance_method(self):
    class MyClass:
        @validate(
            Parameter(name='x', validators=[Min(0)]),
        )
        @pedantic
        def some_calculation(self, x: int) -> int:
            return x

    m = MyClass()
    m.some_calculation(x=42)
    m.some_calculation(42)

    with self.assertRaises(expected_exception=ParameterException):
        m.some_calculation(x=-1)
    with self.assertRaises(expected_exception=ParameterException):
        m.some_calculation(x=-42)
    with self.assertRaises(expected_exception=PedanticTypeCheckException):
        m.some_calculation(x=1.0)

def test_pedantic_class_static_method_1(self)

Expand source code

def test_pedantic_class_static_method_1(self):
    @pedantic_class
    class MyClass:
        @staticmethod
        def some_calculation(x: int) -> int:
            return x

    m = MyClass()
    m.some_calculation(x=42)
    MyClass.some_calculation(x=45)

def test_pedantic_class_static_method_2(self)

Never do this, but it works

Expand source code

def test_pedantic_class_static_method_2(self):
    """Never do this, but it works"""
    @for_all_methods(staticmethod)
    @pedantic_class
    class MyClass:
        def some_calculation(x: int) -> int:
            return x

    m = MyClass()
    m.some_calculation(x=42)
    with self.assertRaises(expected_exception=PedanticTypeCheckException):
        m.some_calculation(x=42.0)
    MyClass.some_calculation(x=45)
    with self.assertRaises(expected_exception=PedanticTypeCheckException):
        MyClass.some_calculation(x=45.0)

def test_pedantic_class_with_validate_instance_method(self)

Expand source code

def test_pedantic_class_with_validate_instance_method(self):
    @pedantic_class
    class MyClass:
        @validate(
            Parameter(name='x', validators=[Min(0)]),
        )
        def some_calculation(self, x: int) -> int:
            return x

    m = MyClass()
    m.some_calculation(x=42)
    with self.assertRaises(expected_exception=ParameterException):
        m.some_calculation(x=-1)
    with self.assertRaises(expected_exception=ParameterException):
        m.some_calculation(x=-42)
    with self.assertRaises(expected_exception=PedanticTypeCheckException):
        m.some_calculation(x=1.0)
    with self.assertRaises(expected_exception=PedanticCallWithArgsException):
        m.some_calculation(42)

def test_pedantic_overrides(self)

Expand source code

def test_pedantic_overrides(self):
    class MyClass(ABC):
        @pedantic
        @abstractmethod
        def op(self, a: int) -> None:
            pass

    class Child(MyClass):
        a = 0

        @pedantic
        @overrides(MyClass)
        def op(self, a: int) -> None:
            self.a = a

    c = Child()
    c.op(a=42)

def test_pedantic_static_method_1(self)

Expand source code

def test_pedantic_static_method_1(self):
    class MyClass:
        @staticmethod
        @pedantic
        def some_calculation(x: int) -> int:
            return x

    m = MyClass()
    m.some_calculation(x=42)
    MyClass.some_calculation(x=45)