Module pedantic.tests.tests_pedantic_class_docstring

Classes

class TestPedanticClassDocstring (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 TestPedanticClassDocstring(unittest.TestCase):
    def test_require_docstring(self):
        @pedantic_class_require_docstring
        class MyClass:
            def __init__(self, s: str) -> None:
                """Constructor

                Args:
                    s (str): name
                """
                self.s = s

            def double(self, b: int) -> str:
                """some method

                Args:
                    b (int): magic number

                Returns:
                    str: cool stuff

                """
                return self.s + str(b)

            @staticmethod
            def generator() -> 'MyClass':
                """Static

                Returns:
                    MyClass: instance
                """
                return MyClass(s='generated')

        m = MyClass.generator()
        m.double(b=42)

    def test_typo_docstring(self):
        with self.assertRaises(expected_exception=PedanticDocstringException):
            @pedantic_class_require_docstring
            class MyClass:
                def __init__(self, s: str) -> None:
                    """Constructor

                    Args:
                        s (str): name
                    """
                    self.s = s

                @staticmethod
                def generator() -> 'MyClass':
                    """Static

                    Returns:
                        MyClas: instance
                    """
                    return MyClass(s='generated')

    def test_wrong_docstring(self):
        with self.assertRaises(expected_exception=PedanticDocstringException):
            @pedantic_class_require_docstring
            class MyClass:
                def __init__(self, s: str) -> None:
                    """Constructor

                    Args:
                        s (str): name
                    """
                    self.s = s

                def double(self, b: int) -> str:
                    """some method

                    Args:
                        b (float): magic number

                    Returns:
                        str: cool stuff

                    """
                    return self.s + str(b)

Ancestors

• unittest.case.TestCase

Methods

def test_require_docstring(self)

Expand source code

def test_require_docstring(self):
    @pedantic_class_require_docstring
    class MyClass:
        def __init__(self, s: str) -> None:
            """Constructor

            Args:
                s (str): name
            """
            self.s = s

        def double(self, b: int) -> str:
            """some method

            Args:
                b (int): magic number

            Returns:
                str: cool stuff

            """
            return self.s + str(b)

        @staticmethod
        def generator() -> 'MyClass':
            """Static

            Returns:
                MyClass: instance
            """
            return MyClass(s='generated')

    m = MyClass.generator()
    m.double(b=42)

def test_typo_docstring(self)

Expand source code

def test_typo_docstring(self):
    with self.assertRaises(expected_exception=PedanticDocstringException):
        @pedantic_class_require_docstring
        class MyClass:
            def __init__(self, s: str) -> None:
                """Constructor

                Args:
                    s (str): name
                """
                self.s = s

            @staticmethod
            def generator() -> 'MyClass':
                """Static

                Returns:
                    MyClas: instance
                """
                return MyClass(s='generated')

def test_wrong_docstring(self)

Expand source code

def test_wrong_docstring(self):
    with self.assertRaises(expected_exception=PedanticDocstringException):
        @pedantic_class_require_docstring
        class MyClass:
            def __init__(self, s: str) -> None:
                """Constructor

                Args:
                    s (str): name
                """
                self.s = s

            def double(self, b: int) -> str:
                """some method

                Args:
                    b (float): magic number

                Returns:
                    str: cool stuff

                """
                return self.s + str(b)