blark.summary.InterfaceSummary

class blark.summary.InterfaceSummary(comments: ~typing.List[str], pragmas: ~typing.List[str], filename: ~pathlib.Path | None, meta: ~blark.transform.Meta | None, name: str, source_code: str, item: ~blark.transform.Interface, extends: str | None, squashed: bool, declarations: ~typing.Dict[str, ~blark.summary.DeclarationSummary] = <factory>, methods: ~typing.List[~blark.summary.MethodSummary] = <factory>, properties: ~typing.List[~blark.summary.PropertySummary] = <factory>)[source]

Bases: Summary

Summary representation of an Interfae.

Methods

`__init__`(comments, pragmas, filename, meta, ...)
`from_interface`(itf[, source_code, filename])
`squash_base_extends`(interfaces)	Squash the "EXTENDS" INTERFACE into this one.

Attributes

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

name: str

source_code: str

item: Interface

extends: str | None

squashed: bool

declarations: Dict[str, DeclarationSummary]

methods: List[MethodSummary]

properties: List[PropertySummary]

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

classmethod from_interface(itf: Interface, source_code: str | None = None, filename: Path | None = None) → InterfaceSummary[source]

squash_base_extends(interfaces: Dict[str, InterfaceSummary]) → InterfaceSummary[source]: Squash the “EXTENDS” INTERFACE into this one.

__init__(comments: ~typing.List[str], pragmas: ~typing.List[str], filename: ~pathlib.Path | None, meta: ~blark.transform.Meta | None, name: str, source_code: str, item: ~blark.transform.Interface, extends: str | None, squashed: bool, declarations: ~typing.Dict[str, ~blark.summary.DeclarationSummary] = <factory>, methods: ~typing.List[~blark.summary.MethodSummary] = <factory>, properties: ~typing.List[~blark.summary.PropertySummary] = <factory>) → None