blark.summary.PropertySummary

class blark.summary.PropertySummary(comments: List[str], pragmas: List[str], filename: Path | None, meta: Meta | None, name: str, getter: PropertyGetSetSummary, setter: PropertyGetSetSummary, source_code: str)[source]

Bases: Summary

Summary representation of a single property.

Methods

__init__(comments, pragmas, filename, meta, ...)

from_property(property[, source_code, filename])

Attributes

name

getter

setter

source_code

comments

pragmas

filename

meta

name: str
getter: PropertyGetSetSummary
setter: PropertyGetSetSummary
source_code: str
classmethod from_property(property: Property, source_code: str | None = None, filename: Path | None = None) PropertySummary[source]
__init__(comments: List[str], pragmas: List[str], filename: Path | None, meta: Meta | None, name: str, getter: PropertyGetSetSummary, setter: PropertyGetSetSummary, source_code: str) None