pydoctor.napoleon.docstring.TypeDocstring

class documentation

class TypeDocstring: (source)

Constructor: TypeDocstring(annotation, warns_on_unknown_tokens)

Convert natural language type strings to reStructuredText.

Syntax is based on numpydoc type specification with additionnal recognition of PEP 484-like type annotations (with parentheses or square brackets characters).

Exemples of valid type strings and output
Type string	Output
List[str] or list(bytes), optional	`List`[`str`] or `list`(`bytes`), optional
{"html", "json", "xml"}, optional	`{"html", "json", "xml"}`, optional
list of int or float or None, default: None	`list` of `int` or `float` or `None`, default: `None`
`complicated string` or `strIO <twisted.python.compat.NativeStringIO>`	`complicated string` or `strIO`

Method	`__init__`	Undocumented
Method	`__str__`	No summary
Instance Variable	`warnings`	Undocumented
Static Method	`_convert_type_spec_to_rst`	Undocumented
Class Variable	`_ast_like_delimiters_regex`	Undocumented
Class Variable	`_ast_like_delimiters_regex_str`	Undocumented
Class Variable	`_default_regex`	Undocumented
Class Variable	`_natural_language_delimiters_regex`	Undocumented
Class Variable	`_natural_language_delimiters_regex_str`	Undocumented
Class Variable	`_token_regex`	Undocumented
Instance Variable	`_tokens`	Undocumented