call_report.fca.FCADomainDataset#

class call_report.fca.FCADomainDataset(*values)[source]#

Bases: StrEnum

A curated domain dataset this package ships for FCA Call Report data.

Each member names a view assembled from several schedules, with the row key and every output column chosen rather than derived mechanically from the source layout. That curation is what separates a domain dataset from FCACallReport.to_code_grain_format, which reshapes whatever schedules it is given under the source’s own names.

Examples

>>> FCADomainDataset.LOAN_PORTFOLIO
<FCADomainDataset.LOAN_PORTFOLIO: 'loan_portfolio'>

classmethod coerce(*, value: FCADomainDataset | str) → FCADomainDataset[source]#

Coerce a domain dataset value into an FCADomainDataset member.

Accepts either an existing FCADomainDataset member (returned unchanged) or a dataset name string, matched case-insensitively. The domain dataset counterpart to FCASchedule.coerce.

Parameters:

valueFCADomainDataset or str: The domain dataset to coerce.

Returns:

FCADomainDataset: The matching enum member.

Raises:

DomainDatasetNotFoundError: If value is a string that does not match any shipped dataset name.

Examples

>>> FCADomainDataset.coerce(value="LOAN_PORTFOLIO")
<FCADomainDataset.LOAN_PORTFOLIO: 'loan_portfolio'>