TypeDocLine

Auto-generated documentation for mypy_boto3_builder.parsers.docstring_parser.type_doc_line module.

Structure for parsed as dict :type: or :rtype: nested lines.

TypeDocLine

[find in source code]

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 name
  • type_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

[find in source code]

@property
def indented() -> List['TypeDocLine']:

Get indented lines list.

Returns

A list of TypeDocLine.

TypeDocLine().render

[find in source code]

def render() -> str:

Get original string with indentation.

Returns

A string as close as possible to original.

TypeDocLine().required

[find in source code]

@property
def required() -> bool:

Whether the argument or TypedDict key is required.