plinder.data.annotations.utils

plinder.data.annotations.utils.description_excluded_from_column_docs(description: str | None) → bool

Return whether a field is intentionally absent from column docs.

plinder.data.annotations.utils.description_excluded_from_flat_export(description: str | None) → bool

Return whether automatic flat export must skip a field.

plinder.data.annotations.utils.column_description_text(description: str | None) → str

Return public prose with any export marker removed.

class plinder.data.annotations.utils.DocBaseModel

Bases: BaseModel

classmethod get_descriptions_and_types() → dict[str, tuple[str | None, str | None]]

Returns a dictionary mapping attribute and property names to their descriptions and types.

classmethod document_properties(prefix: str) → Generator[tuple[str, str | None, str], Any, Any]

classmethod document_properties_to_tsv(prefix: str, filename: Path, nested: bool = False) → None

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].