"""
Module containing a class, global function, exception, type variable and type alias.
The type variable gets included in the list of variables captured by the template and so is
automatically summarised and documented.
For some reason, the type alias doesn't. However, it can be documented manually using
the `autodata` directive, ie::
.. autodata:: myTypeAlias
.. autodata:: myTypeAlias
"""
from typing import List, Tuple, Union, TypeVar
myTypeAlias = Union[List[str], Tuple[int, int]]
"""This is a type alias."""
myTypeVar = TypeVar("T", bound=int)
"""This is a type variable."""
[docs]class myClass1:
"""
This is a base class.
"""
def __init__(self, arg1: myTypeAlias, arg2: str):
"""
:param arg1: Pass a :data:`~mytoolbox.mymodule1.myTypeAlias` in first.
:param arg2: Pass a string in second.
"""
self.arg = arg1
[docs] def __call__(self, arg: int) -> str:
"""
This class is callable.
:param arg: Pass one of these in.
:return: Get one of these out.
"""
[docs] def myMethod1(self, arg: myTypeVar) -> str:
"""
This is the first public method.
:param arg: Pass a :data:`~mytoolbox.mymodule1.myTypeVar` in.
:return: Get one of these out.
"""
pass
[docs] def myMethod2(self) -> str:
"""This is the second public method."""
pass
@property
def myAttribute(self) -> int:
"""This is a public attribute."""
pass
def _myPrivateMethod(self):
"""This is a private method, so this docstring shouldn't be visible."""
pass
[docs]def myGlobalFunction(arg1: str, arg2: bool) -> bool:
"""
This is a global function.
:param arg1: Pass this in first.
:param arg2: Pass this in second.
:return: Whether to go (`True`) or not go (`False`).
"""
pass
[docs]class myError(Exception):
"""
This is a custom error.
"""
pass