blark.summary.FunctionSummary

class blark.summary.FunctionSummary(comments: ~typing.List[str], pragmas: ~typing.List[str], filename: ~pathlib.Path | None, meta: ~blark.transform.Meta | None, name: str, item: ~blark.transform.Function, return_type: str | None, source_code: str, implementation: ~blark.transform.StatementList | None = None, declarations: ~typing.Dict[str, ~blark.summary.DeclarationSummary] = <factory>)[source]

Bases: Summary

Summary representation of a single function.

Methods

`__init__`(comments, pragmas, filename, meta, ...)
`from_function`(func[, source_code, filename])

Attributes

`declarations_by_block`
`implementation`
`name`
`item`
`return_type`
`source_code`
`declarations`
`comments`
`pragmas`
`filename`
`meta`

name: str

item: Function

return_type: str | None

source_code: str

implementation: StatementList | None = None

declarations: Dict[str, DeclarationSummary]

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

classmethod from_function(func: Function, source_code: str | None = None, filename: Path | None = None) → FunctionSummary[source]

__init__(comments: ~typing.List[str], pragmas: ~typing.List[str], filename: ~pathlib.Path | None, meta: ~blark.transform.Meta | None, name: str, item: ~blark.transform.Function, return_type: str | None, source_code: str, implementation: ~blark.transform.StatementList | None = None, declarations: ~typing.Dict[str, ~blark.summary.DeclarationSummary] = <factory>) → None