Module pedantic.tests.test_with_decorated_methods

Classes

class Decorators (*args, **kwds)

The interface that defines all possible decorators types.

The values of this enum are used as property names and the properties are added to the decorated functions. So I would recommend naming them with a leading underscore to keep them private and also write it lowercase.

Example

>>> class Decorators(DecoratorType):
...     FOO = '_foo'

Expand source code

class Decorators(DecoratorType):
    FOO = '_foo'
    BAR = '_bar'

Ancestors

• DecoratorType
• enum.StrEnum
• builtins.str
• enum.ReprEnum
• enum.Enum

Class variables

var BAR

var FOO

class TestWithDecoratedMethods (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 TestWithDecoratedMethods(unittest.TestCase):
    def test_with_decorated_methods_sync(self):
        class MyClass(WithDecoratedMethods[Decorators]):
            @foo(42)
            def m1(self) -> None:
                print('bar')

            @foo(value=43)
            def m2(self) -> None:
                print('bar')

            @bar(value=44)
            def m3(self) -> None:
                print('bar')

        instance = MyClass()
        expected = {
            Decorators.FOO: {
                instance.m1: 42,
                instance.m2: 43,
            },
            Decorators.BAR: {
                instance.m3: 44,
            }
        }
        assert instance.get_decorated_functions() == expected

    def test_with_decorated_methods_async(self):
        class MyClass(WithDecoratedMethods[Decorators]):
            @foo(42)
            async def m1(self) -> None:
                print('bar')

            @foo(value=43)
            async def m2(self) -> None:
                print('bar')

            @bar(value=44)
            async def m3(self) -> None:
                print('bar')

        instance = MyClass()
        expected = {
            Decorators.FOO: {
                instance.m1: 42,
                instance.m2: 43,
            },
            Decorators.BAR: {
                instance.m3: 44,
            }
        }
        assert instance.get_decorated_functions() == expected

Ancestors

• unittest.case.TestCase

Methods

def test_with_decorated_methods_async(self)

Expand source code

def test_with_decorated_methods_async(self):
    class MyClass(WithDecoratedMethods[Decorators]):
        @foo(42)
        async def m1(self) -> None:
            print('bar')

        @foo(value=43)
        async def m2(self) -> None:
            print('bar')

        @bar(value=44)
        async def m3(self) -> None:
            print('bar')

    instance = MyClass()
    expected = {
        Decorators.FOO: {
            instance.m1: 42,
            instance.m2: 43,
        },
        Decorators.BAR: {
            instance.m3: 44,
        }
    }
    assert instance.get_decorated_functions() == expected

def test_with_decorated_methods_sync(self)

Expand source code

def test_with_decorated_methods_sync(self):
    class MyClass(WithDecoratedMethods[Decorators]):
        @foo(42)
        def m1(self) -> None:
            print('bar')

        @foo(value=43)
        def m2(self) -> None:
            print('bar')

        @bar(value=44)
        def m3(self) -> None:
            print('bar')

    instance = MyClass()
    expected = {
        Decorators.FOO: {
            instance.m1: 42,
            instance.m2: 43,
        },
        Decorators.BAR: {
            instance.m3: 44,
        }
    }
    assert instance.get_decorated_functions() == expected