TypeDocLine
mypy-boto3-builder Index / Mypy Boto3 Builder / Parsers / Docstring Parser / TypeDocLine
Auto-generated documentation for mypy_boto3_builder.parsers.docstring_parser.type_doc_line module.
TypeDocLine
Show source in type_doc_line.py:10
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.
Signature
class TypeDocLine:
def __init__(
self,
name: str = "",
type_name: str = "",
line: Iterable[str] = tuple(),
description: str = "",
indented: Iterable[Mapping[str, object]] = tuple(),
) -> None:
...
TypeDocLine().indented
Show source in type_doc_line.py:36
Get indented lines list.
Returns
A list of TypeDocLine.
Signature
@property
def indented(self: _R) -> list[_R]:
...
TypeDocLine().render
Show source in type_doc_line.py:56
Get original string with indentation.
Returns
A string as close as possible to original.
Signature
def render(self) -> str:
...
TypeDocLine().required
Show source in type_doc_line.py:49
Whether the argument or TypedDict key is required.
Signature
@property
def required(self) -> bool:
...