blark.summary.DataTypeSummary

class blark.summary.DataTypeSummary(comments: ~typing.List[str], pragmas: ~typing.List[str], filename: ~pathlib.Path | None, meta: ~blark.transform.Meta | None, name: str, item: ~blark.transform.ArrayTypeDeclaration | ~blark.transform.StructureTypeDeclaration | ~blark.transform.StringTypeDeclaration | ~blark.transform.SimpleTypeDeclaration | ~blark.transform.SubrangeTypeDeclaration | ~blark.transform.EnumeratedTypeDeclaration | ~blark.transform.UnionTypeDeclaration, source_code: str, type: str, extends: str | None, squashed: bool = False, declarations: ~typing.Dict[str, ~blark.summary.DeclarationSummary] = <factory>)[source]

Bases: Summary

Summary representation of a single data type.

Methods

`__init__`(comments, pragmas, filename, meta, ...)
`from_data_type`(dtype[, source_code, filename])
`squash_base_extends`(data_types)	Squash the "EXTENDS" function block into this one.

Attributes

`declarations_by_block`
`squashed`
`name`
`item`
`source_code`
`type`
`extends`
`declarations`
`comments`
`pragmas`
`filename`
`meta`

name: str

item: ArrayTypeDeclaration | StructureTypeDeclaration | StringTypeDeclaration | SimpleTypeDeclaration | SubrangeTypeDeclaration | EnumeratedTypeDeclaration | UnionTypeDeclaration

source_code: str

type: str

extends: str | None

squashed: bool = False

declarations: Dict[str, DeclarationSummary]

property declarations_by_block: Dict[str, Dict[str, DeclarationSummary]]

classmethod from_data_type(dtype: ArrayTypeDeclaration | StructureTypeDeclaration | StringTypeDeclaration | SimpleTypeDeclaration | SubrangeTypeDeclaration | EnumeratedTypeDeclaration | UnionTypeDeclaration, source_code: str | None = None, filename: Path | None = None) → DataTypeSummary[source]

squash_base_extends(data_types: Dict[str, DataTypeSummary]) → DataTypeSummary[source]: Squash the “EXTENDS” function block into this one.

__init__(comments: ~typing.List[str], pragmas: ~typing.List[str], filename: ~pathlib.Path | None, meta: ~blark.transform.Meta | None, name: str, item: ~blark.transform.ArrayTypeDeclaration | ~blark.transform.StructureTypeDeclaration | ~blark.transform.StringTypeDeclaration | ~blark.transform.SimpleTypeDeclaration | ~blark.transform.SubrangeTypeDeclaration | ~blark.transform.EnumeratedTypeDeclaration | ~blark.transform.UnionTypeDeclaration, source_code: str, type: str, extends: str | None, squashed: bool = False, declarations: ~typing.Dict[str, ~blark.summary.DeclarationSummary] = <factory>) → None