"""Example module

This is a description
"""

from .subpackage.submodule import function as aliased_function
from .subpackage.submodule import not_in_all_function

__all__ = (
    "aliased_function",
    "Class",
    "DATA",
    "function",
    "MyException",
)

DATA = 42


def function(foo, bar):
    """A module level function"""


class Class(object):
    """This is a class."""

    class_var = 42
    """Class var docstring"""

    class NestedClass(object):
        """A nested class just to test things out"""

        @classmethod
        def a_classmethod():
            """A class method"""
            return True

    def method_okay(self, foo=None, bar=None):
        """This method should parse okay"""
        return True

    def method_multiline(self, foo=None, bar=None, baz=None):
        """This is on multiple lines, but should parse okay too

        pydocstyle gives us lines of source. Test if this means that multiline
        definitions are covered in the way we're anticipating here
        """
        return True

    def method_tricky(self, foo=None, bar=dict(foo=1, bar=2)):
        """This will likely fail our argument testing

        We parse naively on commas, so the nested dictionary will throw this off
        """
        return True

    def method_sphinx_docs(self, foo, bar=0):
        """This method is documented with sphinx style docstrings.

        :param foo: The first argument.
        :type foo: int

        :param int bar: The second argument.

        :returns: The sum of foo and bar.
        :rtype: int
        """
        return foo + bar

    def method_google_docs(self, foo, bar=0):
        """This method is documented with google style docstrings.

        Args:
            foo (int): The first argument.
            bar (int): The second argument.

        Returns:
            int: The sum of foo and bar.
        """
        return foo + bar


class MyException(Exception):
    """This is an exception."""