"""Tests for [the `parsers.docstrings.google` module][pytkdocs.parsers.docstrings.google]."""

import inspect
from textwrap import dedent
from typing import Any, Optional

import pytest

from pytkdocs.loader import Loader
from pytkdocs.objects import Object
from pytkdocs.parsers.docstrings.base import AnnotatedObject, Attribute, Parameter, Section, empty
from pytkdocs.parsers.docstrings.restructured_text import RestructuredText
from pytkdocs.serializer import serialize_attribute


class DummyObject:
    def __init__(self, signature, return_type):  # noqa: D107, ANN001
        self.path = "o"
        self.signature = signature
        self.type = return_type


SOME_NAME = "foo"
SOME_TEXT = "descriptive test text"
SOME_EXTRA_TEXT = "more test text"
SOME_EXCEPTION_NAME = "SomeException"
SOME_OTHER_EXCEPTION_NAME = "SomeOtherException"


def dedent_strip(text: str) -> str:
    return dedent(text).strip()


def parse(obj: Any, *, strip_docstring: bool = True) -> tuple[list[Section], list[str]]:
    """Helper to parse a docstring."""
    return parse_detailed(inspect.getdoc(obj) or "", inspect.signature(obj), strip_docstring=strip_docstring)


def parse_detailed(
    docstring: str,
    signature: Optional[inspect.Signature] = None,
    return_type: Any = inspect.Signature.empty,
    *,
    strip_docstring: bool = True,
) -> tuple[list[Section], list[str]]:
    """Helper to parse a docstring."""
    docstring = dedent_strip(docstring) if strip_docstring else dedent(docstring)

    return RestructuredText().parse(docstring, {"obj": DummyObject(signature, return_type)})


def assert_parameter_equal(actual: Parameter, expected: Parameter) -> None:
    assert actual.name == expected.name
    assert_annotated_obj_equal(actual, expected)
    assert actual.kind == expected.kind
    assert actual.default == expected.default


def assert_attribute_equal(actual: Attribute, expected: Attribute) -> None:
    assert actual.name == expected.name
    assert_annotated_obj_equal(actual, expected)


def assert_annotated_obj_equal(actual: AnnotatedObject, expected: AnnotatedObject) -> None:
    assert actual.annotation == expected.annotation
    assert actual.description == expected.description


def get_rst_object_documentation(dotted_fixture_subpath: str) -> Object:
    return Loader(docstring_style="restructured-text").get_object_documentation(
        f"tests.fixtures.parsing.restructured_text.{dotted_fixture_subpath}",
    )


@pytest.mark.parametrize(
    "docstring",
    [
        "One line docstring description",
        """
        Multiple line docstring description.

        With more text.
        """,
    ],
)
def test_parse__description_only_docstring__single_markdown_section(docstring: str) -> None:
    sections, errors = parse_detailed(docstring)

    assert len(sections) == 1
    assert sections[0].type == Section.Type.MARKDOWN
    assert sections[0].value == dedent_strip(docstring)
    assert not errors


def test_parse__no_description__single_markdown_section() -> None:
    sections, errors = parse_detailed("")

    assert len(sections) == 1
    assert sections[0].type == Section.Type.MARKDOWN
    assert sections[0].value == ""
    assert not errors


def test_parse__multiple_blank_lines_before_description__single_markdown_section() -> None:
    sections, errors = parse_detailed(
        """
    
    
    Now text""",  # noqa: W293
        strip_docstring=False,
    )

    assert len(sections) == 1
    assert sections[0].type == Section.Type.MARKDOWN
    assert sections[0].value == "Now text"
    assert not errors


def test_parse__description_with_initial_newline__single_markdown_section() -> None:
    docstring = """
    With initial newline
    """
    sections, errors = parse_detailed(docstring, strip_docstring=False)

    assert len(sections) == 1
    assert sections[0].type == Section.Type.MARKDOWN
    assert sections[0].value == dedent_strip(docstring)
    assert not errors


def test_parse__param_field__param_section() -> None:
    """Parse a simple docstring."""
    sections, errors = parse_detailed(
        f"""
        Docstring with one line param.

        :param {SOME_NAME}: {SOME_TEXT}
        """,
    )
    assert len(sections) == 2
    assert sections[1].type == Section.Type.PARAMETERS
    assert_parameter_equal(
        sections[1].value[0],
        Parameter(SOME_NAME, annotation=empty, description=SOME_TEXT, kind=empty),
    )


def test_parse__only_param_field__empty_markdown() -> None:
    sections, errors = parse_detailed(":param foo: text")
    assert len(sections) == 2
    assert sections[0].type == Section.Type.MARKDOWN
    assert sections[0].value == ""


@pytest.mark.parametrize(
    "param_directive_name",
    [
        "param",
        "parameter",
        "arg",
        "argument",
        "key",
        "keyword",
    ],
)
def test_parse__all_param_names__param_section(param_directive_name: str) -> None:
    sections, errors = parse_detailed(
        f"""
        Docstring with one line param.

        :{param_directive_name} {SOME_NAME}: {SOME_TEXT}
        """,
    )
    assert len(sections) == 2
    assert sections[1].type == Section.Type.PARAMETERS
    assert_parameter_equal(
        sections[1].value[0],
        Parameter(SOME_NAME, annotation=empty, description=SOME_TEXT, kind=empty),
    )


@pytest.mark.parametrize(
    "docstring",
    [
        f"""
        Docstring with param with continuation, no indent.

        :param {SOME_NAME}: {SOME_TEXT}
        {SOME_EXTRA_TEXT}
        """,
        f"""
        Docstring with param with continuation, with indent.

        :param {SOME_NAME}: {SOME_TEXT}
          {SOME_EXTRA_TEXT}
        """,
    ],
)
def test_parse__param_field_multi_line__param_section(docstring: str) -> None:
    """Parse a simple docstring."""
    sections, errors = parse_detailed(docstring)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.PARAMETERS
    assert_parameter_equal(
        sections[1].value[0],
        Parameter(SOME_NAME, annotation=empty, description=f"{SOME_TEXT} {SOME_EXTRA_TEXT}", kind=empty),
    )


def test_parse__param_field_for_function__param_section_with_kind() -> None:
    """Parse a simple docstring."""

    def f(foo):  # noqa: ANN202, ANN001
        """Docstring with line continuation.

        :param foo: descriptive test text
        """

    sections, errors = parse(f)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.PARAMETERS
    assert_parameter_equal(
        sections[1].value[0],
        Parameter(SOME_NAME, annotation=empty, description=SOME_TEXT, kind=inspect.Parameter.POSITIONAL_OR_KEYWORD),
    )


def test_parse__param_field_docs_type__param_section_with_type() -> None:
    """Parse a simple docstring."""

    def f(foo):  # noqa: ANN202, ANN001
        """Docstring with line continuation.

        :param str foo: descriptive test text
        """

    sections, errors = parse(f)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.PARAMETERS
    assert_parameter_equal(
        sections[1].value[0],
        Parameter(SOME_NAME, annotation="str", description=SOME_TEXT, kind=inspect.Parameter.POSITIONAL_OR_KEYWORD),
    )


def test_parse__param_field_type_field__param_section_with_type() -> None:
    """Parse a simple docstring."""

    def f(foo):  # noqa: ANN202, ANN001
        """Docstring with line continuation.

        :param foo: descriptive test text
        :type foo: str
        """

    sections, errors = parse(f)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.PARAMETERS
    assert_parameter_equal(
        sections[1].value[0],
        Parameter(SOME_NAME, annotation="str", description=SOME_TEXT, kind=inspect.Parameter.POSITIONAL_OR_KEYWORD),
    )


def test_parse__param_field_type_field_first__param_section_with_type() -> None:
    """Parse a simple docstring."""

    def f(foo):  # noqa: ANN202, ANN001
        """Docstring with line continuation.

        :type foo: str
        :param foo: descriptive test text
        """

    sections, errors = parse(f)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.PARAMETERS
    assert_parameter_equal(
        sections[1].value[0],
        Parameter(SOME_NAME, annotation="str", description=SOME_TEXT, kind=inspect.Parameter.POSITIONAL_OR_KEYWORD),
    )


def test_parse__param_field_type_field_or_none__param_section_with_optional() -> None:
    """Parse a simple docstring."""

    def f(foo):  # noqa: ANN202, ANN001
        """Docstring with line continuation.

        :param foo: descriptive test text
        :type foo: str or None
        """

    sections, errors = parse(f)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.PARAMETERS
    assert_parameter_equal(
        sections[1].value[0],
        Parameter(
            SOME_NAME,
            annotation="Optional[str]",
            description=SOME_TEXT,
            kind=inspect.Parameter.POSITIONAL_OR_KEYWORD,
        ),
    )


def test_parse__param_field_type_none_or_field__param_section_with_optional() -> None:
    """Parse a simple docstring."""

    def f(foo):  # noqa: ANN202, ANN001
        """Docstring with line continuation.

        :param foo: descriptive test text
        :type foo: None or str
        """

    sections, errors = parse(f)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.PARAMETERS
    assert_parameter_equal(
        sections[1].value[0],
        Parameter(
            SOME_NAME,
            annotation="Optional[str]",
            description=SOME_TEXT,
            kind=inspect.Parameter.POSITIONAL_OR_KEYWORD,
        ),
    )


def test_parse__param_field_type_field_or_int__param_section_with_union() -> None:
    """Parse a simple docstring."""

    def f(foo):  # noqa: ANN202, ANN001
        """Docstring with line continuation.

        :param foo: descriptive test text
        :type foo: str or int
        """

    sections, errors = parse(f)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.PARAMETERS
    assert_parameter_equal(
        sections[1].value[0],
        Parameter(
            SOME_NAME,
            annotation="Union[str,int]",
            description=SOME_TEXT,
            kind=inspect.Parameter.POSITIONAL_OR_KEYWORD,
        ),
    )


def test_parse__param_field_type_multiple__param_section_with_union() -> None:
    """Parse a simple docstring."""

    def f(foo):  # noqa: ANN202, ANN001
        """Docstring with line continuation.

        :param foo: descriptive test text
        :type foo: str or int or float
        """

    sections, errors = parse(f)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.PARAMETERS
    assert_parameter_equal(
        sections[1].value[0],
        Parameter(
            SOME_NAME,
            annotation="Union[str,int,float]",
            description=SOME_TEXT,
            kind=inspect.Parameter.POSITIONAL_OR_KEYWORD,
        ),
    )


def test_parse__param_field_annotate_type__param_section_with_type() -> None:
    """Parse a simple docstring."""

    def f(foo: str):  # noqa: ANN202
        """Docstring with line continuation.

        :param foo: descriptive test text
        """

    sections, errors = parse(f)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.PARAMETERS
    assert_parameter_equal(
        sections[1].value[0],
        Parameter(SOME_NAME, annotation=str, description=SOME_TEXT, kind=inspect.Parameter.POSITIONAL_OR_KEYWORD),
    )


def test_parse__param_field_no_matching_param__result_from_docstring() -> None:
    """Parse a simple docstring."""

    def f(foo: str):  # noqa: ANN202
        """Docstring with line continuation.

        :param other: descriptive test text
        """

    sections, errors = parse(f)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.PARAMETERS
    assert_parameter_equal(
        sections[1].value[0],
        Parameter("other", annotation=empty, description=SOME_TEXT, kind=empty),
    )


def test_parse__param_field_with_default__result_from_docstring() -> None:
    """Parse a simple docstring."""

    def f(foo=""):  # noqa: ANN202, ANN001
        """Docstring with line continuation.

        :param foo: descriptive test text
        """

    sections, errors = parse(f)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.PARAMETERS
    assert_parameter_equal(
        sections[1].value[0],
        Parameter(
            "foo",
            annotation=empty,
            description=SOME_TEXT,
            default="",
            kind=inspect.Parameter.POSITIONAL_OR_KEYWORD,
        ),
    )


def test_parse__param_field_no_matching_param__error_message() -> None:
    """Parse a simple docstring."""

    def f(foo: str):  # noqa: ANN202
        """Docstring with line continuation.

        :param other: descriptive test text
        """

    sections, errors = parse(f)
    assert "No matching parameter for 'other'" in errors[0]


def test_parse__invalid_param_field_only_initial_marker__error_message() -> None:
    """Parse a simple docstring."""

    def f(foo: str):  # noqa: ANN202
        """Docstring with line continuation.

        :param foo descriptive test text
        """

    sections, errors = parse(f)
    assert "Failed to get ':directive: value' pair" in errors[0]


def test_parse__invalid_param_field_wrong_part_count__error_message() -> None:
    """Parse a simple docstring."""

    def f(foo: str):  # noqa: ANN202
        """Docstring with line continuation.

        :param: descriptive test text
        """

    sections, errors = parse(f)
    assert "Failed to parse field directive" in errors[0]


def test_parse__param_twice__error_message() -> None:
    """Parse a simple docstring."""

    def f(foo: str):  # noqa: ANN202
        """Docstring with line continuation.

        :param foo: descriptive test text
        :param foo: descriptive test text again
        """

    sections, errors = parse(f)
    assert "Duplicate parameter entry for 'foo'" in errors[0]


def test_parse__param_type_twice_doc__error_message() -> None:
    """Parse a simple docstring."""

    def f(foo):  # noqa: ANN202, ANN001
        """Docstring with line continuation.

        :param str foo: descriptive test text
        :type foo: str
        """

    sections, errors = parse(f)
    assert "Duplicate parameter information for 'foo'" in errors[0]


def test_parse__param_type_twice_type_directive_first__error_message() -> None:
    """Parse a simple docstring."""

    def f(foo):  # noqa: ANN202, ANN001
        """Docstring with line continuation.

        :type foo: str
        :param str foo: descriptive test text
        """

    sections, errors = parse(f)
    assert "Duplicate parameter information for 'foo'" in errors[0]


def test_parse__param_type_twice_annotated__error_message() -> None:
    """Parse a simple docstring."""

    def f(foo: str):  # noqa: ANN202
        """Docstring with line continuation.

        :param str foo: descriptive test text
        :type foo: str
        """

    sections, errors = parse(f)
    assert "Duplicate parameter information for 'foo'" in errors[0]


def test_parse__param_type_no_type__error_message() -> None:
    """Parse a simple docstring."""

    def f(foo: str):  # noqa: ANN202
        """Docstring with line continuation.

        :param str foo: descriptive test text
        :type str
        """

    sections, errors = parse(f)
    assert "Failed to get ':directive: value' pair from" in errors[0]


def test_parse__param_type_no_name__error_message() -> None:
    """Parse a simple docstring."""

    def f(foo: str):  # noqa: ANN202
        """Docstring with line continuation.

        :param str foo: descriptive test text
        :type: str
        """

    sections, errors = parse(f)
    assert "Failed to get parameter name from" in errors[0]


@pytest.mark.parametrize(
    "docstring",
    [
        f"""
        Docstring with param with continuation, no indent.

        :var {SOME_NAME}: {SOME_TEXT}
        {SOME_EXTRA_TEXT}
        """,
        f"""
        Docstring with param with continuation, with indent.

        :var {SOME_NAME}: {SOME_TEXT}
          {SOME_EXTRA_TEXT}
        """,
    ],
)
def test_parse__attribute_field_multi_line__param_section(docstring: str) -> None:
    """Parse a simple docstring."""
    sections, errors = parse_detailed(docstring)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.ATTRIBUTES
    assert_attribute_equal(
        sections[1].value[0],
        Attribute(SOME_NAME, annotation=empty, description=f"{SOME_TEXT} {SOME_EXTRA_TEXT}"),
    )


@pytest.mark.parametrize(
    "attribute_directive_name",
    [
        "var",
        "ivar",
        "cvar",
    ],
)
def test_parse__all_attribute_names__param_section(attribute_directive_name: str) -> None:
    sections, errors = parse_detailed(
        f"""
        Docstring with one line attribute.

        :{attribute_directive_name} {SOME_NAME}: {SOME_TEXT}
        """,
    )
    assert len(sections) == 2
    assert sections[1].type == Section.Type.ATTRIBUTES
    assert_attribute_equal(
        sections[1].value[0],
        Attribute(SOME_NAME, annotation=empty, description=SOME_TEXT),
    )


def test_parse__class_attributes__attributes_section() -> None:
    class Foo:
        """Class docstring with attributes.

        :var foo: descriptive test text
        """

    sections, errors = parse(Foo)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.ATTRIBUTES
    assert_attribute_equal(
        sections[1].value[0],
        Attribute(SOME_NAME, annotation=empty, description=SOME_TEXT),
    )


def test_parse__class_attributes_with_type__annotation_in_attributes_section() -> None:
    class Foo:
        """Class docstring with attributes.

        :vartype foo: str
        :var foo: descriptive test text
        """

    sections, errors = parse(Foo)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.ATTRIBUTES
    assert_attribute_equal(
        sections[1].value[0],
        Attribute(SOME_NAME, annotation="str", description=SOME_TEXT),
    )


def test_parse__attribute_invalid_directive___error() -> None:
    class Foo:
        """Class docstring with attributes.

        :var descriptive test text
        """

    sections, errors = parse(Foo)
    assert "Failed to get ':directive: value' pair from" in errors[0]


def test_parse__attribute_no_name__error() -> None:
    class Foo:
        """Class docstring with attributes.

        :var: descriptive test text
        """

    sections, errors = parse(Foo)
    assert "Failed to parse field directive from" in errors[0]


def test_parse__attribute_duplicate__error() -> None:
    class Foo:
        """Class docstring with attributes.

        :var foo: descriptive test text
        :var foo: descriptive test text
        """

    sections, errors = parse(Foo)
    assert "Duplicate attribute entry for 'foo'" in errors[0]


def test_parse__class_attributes_type_invalid__error() -> None:
    class Foo:
        """Class docstring with attributes.

        :vartype str
        :var foo: descriptive test text
        """

    sections, errors = parse(Foo)
    assert "Failed to get ':directive: value' pair from " in errors[0]


def test_parse__class_attributes_type_no_name__error() -> None:
    class Foo:
        """Class docstring with attributes.

        :vartype: str
        :var foo: descriptive test text
        """

    sections, errors = parse(Foo)
    assert "Failed to get attribute name from" in errors[0]


def test_parse__return_directive__return_section_no_type() -> None:
    def f(foo: str):  # noqa: ANN202
        """Function with only return directive.

        :return: descriptive test text
        """
        return foo

    sections, errors = parse(f)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.RETURN
    assert_annotated_obj_equal(
        sections[1].value,
        AnnotatedObject(annotation=empty, description=SOME_TEXT),
    )


def test_parse__return_directive_rtype__return_section_with_type() -> None:
    def f(foo: str):  # noqa: ANN202
        """Function with only return & rtype directive.

        :return: descriptive test text
        :rtype: str
        """
        return foo

    sections, errors = parse(f)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.RETURN
    assert_annotated_obj_equal(
        sections[1].value,
        AnnotatedObject(annotation="str", description=SOME_TEXT),
    )


def test_parse__return_directive_rtype_first__return_section_with_type() -> None:
    def f(foo: str):  # noqa: ANN202
        """Function with only return & rtype directive.

        :rtype: str
        :return: descriptive test text
        """
        return foo

    sections, errors = parse(f)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.RETURN
    assert_annotated_obj_equal(
        sections[1].value,
        AnnotatedObject(annotation="str", description=SOME_TEXT),
    )


def test_parse__return_directive_annotation__return_section_with_type() -> None:
    def f(foo: str) -> str:
        """Function with return directive, rtype directive, & annotation.

        :return: descriptive test text
        """
        return foo

    sections, errors = parse(f)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.RETURN
    assert_annotated_obj_equal(
        sections[1].value,
        AnnotatedObject(annotation=str, description=SOME_TEXT),
    )


def test_parse__return_directive_annotation__return_section_with_type_error() -> None:
    def f(foo: str) -> str:
        """Function with return directive, rtype directive, & annotation.

        :return: descriptive test text
        :rtype: str
        """
        return foo

    sections, errors = parse(f)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.RETURN
    assert_annotated_obj_equal(
        sections[1].value,
        AnnotatedObject(annotation=str, description=SOME_TEXT),
    )
    assert "Duplicate type information for return" in errors[0]


def test_parse__return_invalid__error() -> None:
    def f(foo: str):  # noqa: ANN202
        """Function with only return directive.

        :return descriptive test text
        """
        return foo

    sections, errors = parse(f)
    assert "Failed to get ':directive: value' pair from " in errors[0]


def test_parse__rtype_invalid__error() -> None:
    def f(foo: str):  # noqa: ANN202
        """Function with only return directive.

        :rtype str
        """
        return foo

    sections, errors = parse(f)
    assert "Failed to get ':directive: value' pair from " in errors[0]


def test_parse__raises_directive__exception_section() -> None:
    def f(foo: str):  # noqa: ANN202
        """Function with only return directive.

        :raise SomeException: descriptive test text
        """
        return foo

    sections, errors = parse(f)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.EXCEPTIONS
    assert_annotated_obj_equal(
        sections[1].value[0],
        AnnotatedObject(annotation=SOME_EXCEPTION_NAME, description=SOME_TEXT),
    )


def test_parse__multiple_raises_directive__exception_section_with_two() -> None:
    def f(foo: str):  # noqa: ANN202
        """Function with only return directive.

        :raise SomeException: descriptive test text
        :raise SomeOtherException: descriptive test text
        """
        return foo

    sections, errors = parse(f)
    assert len(sections) == 2
    assert sections[1].type == Section.Type.EXCEPTIONS
    assert_annotated_obj_equal(
        sections[1].value[0],
        AnnotatedObject(annotation=SOME_EXCEPTION_NAME, description=SOME_TEXT),
    )
    assert_annotated_obj_equal(
        sections[1].value[1],
        AnnotatedObject(annotation=SOME_OTHER_EXCEPTION_NAME, description=SOME_TEXT),
    )


@pytest.mark.parametrize(
    "attribute_directive_name",
    [
        "raises",
        "raise",
        "except",
        "exception",
    ],
)
def test_parse__all_exception_names__param_section(attribute_directive_name: str) -> None:
    sections, errors = parse_detailed(
        f"""
        Docstring with one line attribute.

        :{attribute_directive_name} {SOME_EXCEPTION_NAME}: {SOME_TEXT}
        """,
    )
    assert len(sections) == 2
    assert sections[1].type == Section.Type.EXCEPTIONS
    assert_annotated_obj_equal(
        sections[1].value[0],
        AnnotatedObject(annotation=SOME_EXCEPTION_NAME, description=SOME_TEXT),
    )


def test_parse__raise_invalid__error() -> None:
    def f(foo: str):  # noqa: ANN202
        """Function with only return directive.

        :raise descriptive test text
        """
        return foo

    sections, errors = parse(f)
    assert "Failed to get ':directive: value' pair from " in errors[0]


def test_parse__raise_no_name__error() -> None:
    def f(foo: str):  # noqa: ANN202
        """Function with only return directive.

        :raise: descriptive test text
        """
        return foo

    sections, errors = parse(f)
    assert "Failed to parse exception directive from" in errors[0]


# -------------------------------
# Fixture tests
# -------------------------------


def test_parse_module_attributes_section__expected_attributes_section() -> None:
    """Parse attributes section in modules."""
    obj = get_rst_object_documentation("docstring_attributes_section")
    assert len(obj.docstring_sections) == 2
    attr_section = obj.docstring_sections[1]
    assert attr_section.type == Section.Type.ATTRIBUTES
    assert len(attr_section.value) == 5
    expected = [
        {"name": "A", "annotation": "int", "description": "Alpha."},
        # type annotation takes preference over docstring
        {"name": "B", "annotation": "str", "description": "Beta."},
        {"name": "C", "annotation": "bool", "description": "Gamma."},
        {"name": "D", "annotation": "", "description": "Delta."},
        {"name": "E", "annotation": "float", "description": "Epsilon."},
    ]
    assert [serialize_attribute(attr) for attr in attr_section.value] == expected


def test_parse_module_attributes_section__expected_docstring_errors() -> None:
    """Parse attributes section in modules."""
    obj = get_rst_object_documentation("docstring_attributes_section")
    assert len(obj.docstring_errors) == 1
    assert "Duplicate attribute information for 'B'" in obj.docstring_errors[0]


def test_property_docstring__expected_description() -> None:
    """Parse a property docstring."""
    class_ = get_rst_object_documentation("class_docstrings:NotDefinedYet")
    prop = class_.attributes[0]
    sections = prop.docstring_sections
    assert len(sections) == 2
    assert sections[0].type == Section.Type.MARKDOWN
    assert (
        sections[0].value
        == "This property returns `self`.\n\nIt's fun because you can call it like `obj.ha.ha.ha.ha.ha.ha...`."
    )


def test_property_docstring__expected_return() -> None:
    """Parse a property docstring."""
    class_ = get_rst_object_documentation("class_docstrings:NotDefinedYet")
    prop = class_.attributes[0]
    sections = prop.docstring_sections
    assert len(sections) == 2
    assert sections[1].type == Section.Type.RETURN
    assert_annotated_obj_equal(sections[1].value, AnnotatedObject("NotDefinedYet", "self!"))


def test_property_class_init__expected_description() -> None:
    class_ = get_rst_object_documentation("class_docstrings:ClassInitFunction")
    init = class_.methods[0]
    sections = init.docstring_sections
    assert len(sections) == 2
    assert sections[0].type == Section.Type.MARKDOWN
    assert sections[0].value == "Initialize instance."


def test_class_init__expected_param() -> None:
    class_ = get_rst_object_documentation("class_docstrings:ClassInitFunction")
    init = class_.methods[0]
    sections = init.docstring_sections
    assert len(sections) == 2
    assert sections[1].type == Section.Type.PARAMETERS
    param_section = sections[1]
    assert_parameter_equal(
        param_section.value[0],
        Parameter("value", str, "Value to store", kind=inspect.Parameter.POSITIONAL_OR_KEYWORD),
    )
    assert_parameter_equal(
        param_section.value[1],
        Parameter("other", "int", "Other value with default", kind=inspect.Parameter.POSITIONAL_OR_KEYWORD, default=1),
    )


def test_member_function___expected_param() -> None:
    class_ = get_rst_object_documentation("class_docstrings:ClassWithFunction")
    init = class_.methods[0]
    sections = init.docstring_sections
    assert len(sections) == 3
    param_section = sections[1]
    assert param_section.type == Section.Type.PARAMETERS
    assert_parameter_equal(
        param_section.value[0],
        Parameter("value", str, "Value to store", kind=inspect.Parameter.POSITIONAL_OR_KEYWORD),
    )
    assert_parameter_equal(
        param_section.value[1],
        Parameter("other", "int", "Other value with default", kind=inspect.Parameter.POSITIONAL_OR_KEYWORD, default=1),
    )


def test_member_function___expected_return() -> None:
    class_ = get_rst_object_documentation("class_docstrings:ClassWithFunction")
    init = class_.methods[0]
    sections = init.docstring_sections
    assert len(sections) == 3
    assert sections[2].type == Section.Type.RETURN
    assert_annotated_obj_equal(sections[2].value, AnnotatedObject(str, "Concatenated result"))


def test_property_docstring__no_errors() -> None:
    """Parse a property docstring."""
    class_ = get_rst_object_documentation("class_docstrings:NotDefinedYet")
    prop = class_.attributes[0]
    assert not prop.docstring_errors
