tests.py

from doctools import (append_to_docs, append_var_to_docs,
        include_docs_from, _getindent)


def test_append_to_docs():
    def foo():
        """some

        multiline
        docstring"""
        pass

    append_to_docs(foo, 'more random docs')
    assert foo.__doc__ == """some

        multiline
        docstring

        more random docs"""


def test_append_to_docs_undocumented():
    def foo():
        pass

    append_to_docs(foo, 'some documentation')
    assert foo.__doc__ == 'some documentation'


def test_append_var_to_docs():
    def foo():
        """some

        docstring"""
        pass

    append_var_to_docs(foo, 'My Var', [1, 2, 3, 4])
    assert foo.__doc__ == """some

        docstring

        My Var:
            [1, 2, 3, 4]"""


def test_getindent():
    assert _getindent("""Foo

            bar
            baz""") == 12


def test_getindent():
    assert _getindent("foo") == 0


def test_getindent_multiline_no_default_indent():
    assert _getindent("foo\nbar\n    baz") == 0


def test_include_docs_from():
    def foo():
        """foo docs."""

    @include_docs_from(foo)
    def bar():
        """bar docs."""

    assert bar.__doc__ == 'bar docs.\n\nfoo docs.'


def test_include_docs_from_undocumented():
    def foo():
        pass

    @include_docs_from(foo)
    def bar():
        """bar docs."""

    assert bar.__doc__ == 'bar docs.'