TypeDocLine
Auto-generated documentation for builder.mypy_boto3_builder.parsers.docstring_parser.type_doc_line module.
Structure for parsed as dict :type:
or :rtype:
nested lines.
- mypy-boto3 / Modules /
Builder
/ Mypy Boto3 Builder / Parsers / Docstring Parser / TypeDocLine
TypeDocLine
class TypeDocLine():
def __init__(
name: str = '',
type_name: str = '',
line: Iterable[str] = tuple(),
description: str = '',
indented: Iterable[Any] = tuple(),
) -> None:
Structure for parsed as dict :type:
or :rtype:
nested lines.
Arguments
name
- Argument or TypedDict key nametype_name
- Argument or TypedDict key type string.line
- Raw original line parts.description
- Rest of line for argument or TypedDict key definition.indented
- Intended lines.
TypeDocLine().indented
@property
def indented() -> List['TypeDocLine']:
Get indented lines list.
Returns
A list of TypeDocLine.
TypeDocLine().render
def render() -> str:
Get original string with indentation.
Returns
A string as close as possible to original.
TypeDocLine().required
@property
def required() -> bool:
Whether the argument or TypedDict key is required.